SpringBoot Lombok的使用

1、Lombok

使用步骤

  1. 首先是在pom.xml文件中进行如下配置
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
    </dependency>	
    
  2. 在idea中下载lombok插件,下载步骤如下
    • 点击file—>settings
    image.png
  • 点击plugins---->Marketplace
    image.png
    • 在下图的输入框中输入lombok
    image.png
    • 点击回车后悔在下面显示出如下图红色方框中的内容
    image.png
    • 最后点击Install就可以直接安装了
3. 当上面的操作完成后,下面就是具体的使用了
  1. 在实体类中的使用
    • @Data相当于以前的实体类中的getter和setter方法,也就是说当实体类中配置了该注解就不用在写getter和setter方法就可以直接使用了
    public Pet(String name) {
        this.name = name;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
  • @ToString相当于实体类中的toString方法
    @Override
    public String toString() {
        return "Pet{" +
                "name='" + name + '\'' +
                '}';
    }
  • @AllArgsConstructor相当于实体类中的全参构造函数
    public Car(String brand, Integer price) {
        this.brand = brand;
        this.price = price;
    }
  • @NoArgsConstructor相当于实体类中的无参构造函数
    public Car() {
        
    }
  1. 简化日志开发
    在controller层进行注解配置实现日志打印。
    配置方法:
    • 首先在controller层的类中配置@Slf4j注解
    • 然后在配有@RestController的方法中写log.info(“写入具体要输入的内容”)
    • 执行代码如下
import org.springframework.web.bind.annotation.RestController;

/**
 * @RestController专门用来配置控制器
 * 该注解是@Controller和@ResponseBody的结合体
 */
@Slf4j
@RestController
public class HelloController {


    @RequestMapping("/hello")//该注解直接将方法中的一段话返回给浏览器
    public String handle01() {
        log.info("你好");
        return "Hello, Spring Boot 2! 你好";
    }

}
Spring Boot 项目中使用 Lombok 是一种非常常见且推荐的做法,因为它可以显著减少样板代码的编写,例如 `getter`、`setter`、`toString()`、`equals()` 和 `hashCode()` 等方法[^2]。以下是关于如何在 Spring Boot 项目中正确引入和使用 Lombok 的详细指南。 ### 1. 添加 Lombok Maven 依赖 首先,需要在项目的 `pom.xml` 文件中添加 Lombok 的依赖。Lombok 通常以 `provided` 作用域引入,因为它仅在编译时和开发工具中使用,不需要打包到最终的 JAR 文件中[^3]。以下是一个典型的 Lombok 依赖配置: ```xml <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.18.24</version> <!-- 请使用最新版本 --> <scope>provided</scope> </dependency> ``` 确保版本号是最新的,或者与团队统一使用某个特定版本。 ### 2. 安装 IDE 插件 Lombok 是通过注解处理器在编译时生成代码的,因此大多数 IDE(如 IntelliJ IDEA 或 Eclipse)默认不会识别这些生成的代码。为了使 IDE 能够识别 Lombok 生成的方法,需要安装相应的插件: - **IntelliJ IDEA**: 1. 打开 `File` > `Settings`(或使用快捷键 `Ctrl + Alt + S`)。 2. 进入 `Plugins` 页面。 3. 搜索 `Lombok` 插件并安装。 4. 安装完成后重启 IDEA。 - **Eclipse**: 1. 下载 Lombok 的 JAR 文件(从 [Lombok 官网](https://projectlombok.org/) 获取)。 2. 双击运行 Lombok JAR 文件,选择 Eclipse 安装路径进行安装。 3. 重启 Eclipse。 安装插件后,IDE 将能够识别 Lombok 注解生成的代码,避免出现“找不到 getter/setter 方法”的错误[^1]。 ### 3. 使用 Lombok 注解 在实体类或需要简化代码的类中,可以使用常见的 Lombok 注解: - `@Data`:自动生成 `getter`、`setter`、`toString`、`equals` 和 `hashCode` 方法。 - `@NoArgsConstructor`:生成无参构造函数。 - `@AllArgsConstructor`:生成包含所有字段的构造函数。 - `@Builder`:生成构建器模式的代码。 - `@Slf4j`:为类注入一个 `Logger` 实例(如果使用 SLF4J)。 示例: ```java import lombok.Data; import lombok.AllArgsConstructor; import lombok.NoArgsConstructor; @Data @NoArgsConstructor @AllArgsConstructor public class User { private String name; private int age; } ``` 上述代码在编译后会自动生成所有必要的方法。 ### 4. 验证 Lombok 是否生效 可以通过以下方式验证 Lombok 是否正确生效: - **查看 IDE 是否识别方法**:例如,在调用 `user.getName()` 时,IDE 不应报错。 - **编译项目**:使用 Maven 或 Gradle 构建项目,确保没有编译错误。 - **反编译 class 文件**:通过反编译工具查看 `.class` 文件是否包含由 Lombok 生成的方法[^4]。 ### 5. 常见问题排查 - **注解未生效**:确认是否已安装 IDE 插件,并重启了 IDE。 - **依赖版本问题**:检查 `pom.xml` 中的 Lombok 版本是否为最新或兼容版本。 - **作用域问题**:确保 Lombok 的作用域为 `provided`,否则可能影响运行时行为。 - **Maven 未正确加载依赖**:执行 `mvn clean install` 并刷新项目依赖。 --- ###
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值