Spring Boot 之 Lombok 使用详解

Lombok 是一个 Java 库,它通过注解自动生成样板代码,例如 getter、setter、构造函数、equals()、hashCode() 等,从而减少代码冗余,提高开发效率。在 Spring Boot 项目中使用 Lombok 可以使代码更加简洁易读。

本文将详细介绍 Lombok 在 Spring Boot 中的使用。

1. 添加 Lombok 依赖:

在你的 pom.xml 文件中添加以下依赖:

XML 复制代码
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <optional>true</optional>
</dependency>

optional 设置为 true 表示该依赖是可选的,不会传递到依赖项目中,避免冲突。

2. 安装 Lombok 插件 (IDE 支持):

为了使 IDE 能够正确识别 Lombok 生成的代码,需要安装 Lombok 插件。以 IntelliJ IDEA 为例,可以在 Settings/Preferences -> Plugins 中搜索 "Lombok" 并安装。(图标是一个红色的辣椒)安装后记得重启IDEA生效!

3. 常用注解:

Lombok 提供了丰富的注解,以下是一些常用的注解及其使用方法:

  • @Data: 这是一个组合注解,相当于 @Getter, @Setter, @ToString, @EqualsAndHashCode, @RequiredArgsConstructor 的组合。它会生成所有字段的 getter 和 setter 方法,toString()、equals() 和 hashCode() 方法,以及一个包含 final 字段和非空字段的构造函数。

    java 复制代码
    import lombok.Data;
    
    @Data
    public class User {
        private Long id;
        private String name;
        private String email;
    }
  • @Getter 和 @Setter: 分别生成 getter 和 setter 方法。可以作用于类或字段。

    java 复制代码
    import lombok.Getter;
    import lombok.Setter;
    
    public class Product {
        @Getter @Setter
        private Long id;
    
        @Getter
        private String name;
    
        @Setter
        private double price;
    }
  • @ToString: 生成 toString() 方法,可以自定义输出格式。

    java 复制代码
    import lombok.ToString;
    
    @ToString(exclude = {"password"}) // 排除 password 字段
    public class User {
        private String username;
        private String password;
        private String email;
    }
  • @EqualsAndHashCode: 生成 equals() 和 hashCode() 方法。可以指定参与比较的字段。

    java 复制代码
    import lombok.EqualsAndHashCode;
    
    @EqualsAndHashCode(of = {"id", "name"}) // 只比较 id 和 name 字段
    public class Product {
        private Long id;
        private String name;
        private double price;
    }
  • @NoArgsConstructor: 生成无参构造函数。

    java 复制代码
    import lombok.NoArgsConstructor;
    
    @NoArgsConstructor
    public class Order {
        private Long id;
        private String orderNumber;
    }
  • @AllArgsConstructor: 生成包含所有字段的构造函数。

    java 复制代码
    import lombok.AllArgsConstructor;
    
    @AllArgsConstructor
    public class Item {
        private Long id;
        private String name;
        private int quantity;
    }
  • @Builder: 生成 builder 模式代码,方便创建对象。这个还是比较好用的

    java 复制代码
    import lombok.Builder;
    
    @Builder
    public class Address {
        private String street;
        private String city;
        private String zipCode;
    
        public static void main(String[] args) {
            Address address = Address.builder()
                    .street("123 Main St")
                    .city("Anytown")
                    .zipCode("12345")
                    .build();
    
            System.out.println(address);
        }
    }
  • @Slf4j: 生成一个名为 log 的日志对象,可以直接使用 log.info() 等方法输出日志。 (需要添加 slf4j 依赖)

java 复制代码
import lombok.extern.slf4j.Slf4j;

@Slf4j
public class LogExample {
    public static void main(String[] args) {
        log.info("Hello, Lombok!");
    }
}

4. 在 Spring Boot 中使用 Lombok:

在实体类、控制器、服务等组件中都可以使用 Lombok 注解。

示例:创建一个 User 实体类:

java 复制代码
import lombok.Data;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;

@Entity
@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String name;
    private String email;
}

5. 总结:

Lombok 可以显著减少样板代码,提高开发效率。通过使用 Lombok 注解,可以使代码更加简洁易读,并减少出错的可能性。

额外提示:

  • 可以根据需要组合使用不同的 Lombok 注解。

  • 可以使用 @Accessors 注解自定义 getter 和 setter 方法的命名方式。

  • 可以使用 @SneakyThrows 注解简化异常处理。

希望这个上文能够帮助各位看官更好地理解和使用 Lombok! 记住要安装 IDE 插件才能使你的 IDE 正确识别 Lombok 生成的代码。

相关推荐
豌豆花下猫39 分钟前
Python 潮流周刊#118:Python 异步为何不够流行?(摘要)
后端·python·ai
尚学教辅学习资料1 小时前
Ruoyi-vue-plus-5.x第五篇Spring框架核心技术:5.1 Spring Boot自动配置
vue.js·spring boot·spring
晚安里1 小时前
Spring 框架(IoC、AOP、Spring Boot) 的必会知识点汇总
java·spring boot·spring
秋难降1 小时前
SQL 索引突然 “罢工”?快来看看为什么
数据库·后端·sql
上官浩仁2 小时前
springboot ioc 控制反转入门与实战
java·spring boot·spring
Access开发易登软件2 小时前
Access开发导出PDF的N种姿势,你get了吗?
后端·低代码·pdf·excel·vba·access·access开发
叫我阿柒啊3 小时前
从Java全栈到前端框架:一位程序员的实战之路
java·spring boot·微服务·消息队列·vue3·前端开发·后端开发
中国胖子风清扬3 小时前
Rust 序列化技术全解析:从基础到实战
开发语言·c++·spring boot·vscode·后端·中间件·rust
bobz9653 小时前
分析 docker.service 和 docker.socket 这两个服务各自的作用
后端
野犬寒鸦4 小时前
力扣hot100:旋转图像(48)(详细图解以及核心思路剖析)
java·数据结构·后端·算法·leetcode