简化代码-Lombok

目录

一、简介

二、安装

三、Lombok使用

注解说明:

1、@Data

2、@Value

3、@AllArgsConstructor

4、@NoArgsConstructor

5、@RequiredArgsConstructor

6、@Slf4j

7、@NonNull

8、@Cleanup

9、@Builder

10、@Synchronized

​11、@SneakyThrows

12、@Accessors

 12-1 fluent 属性(默认为false)

 12-2 chain 属性(默认为false)

 12-3 prefix  属性

一、简介

       Lombok是一个Java库,能自动插入编辑器并构建工具,简化Java开发。通过添加注解的方式,不需要为类编写getter或eques方法,同时可以自动化日志变量。

        简而言之:以注解的形式简化java代码,提高开发效率。

二、安装

1、在idea插件商店中找到Lombok下载,下载完成后重启idea,插件才会生效。

2、项目中引入Lombok依赖

    <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.24</version>
            <scope>provided</scope>
    </dependency>

scope  provided 状态,此状态表示此依赖只在编译与测试时有效,当我们项目打包成 *.jar 的时候并不会打入进去。

三、Lombok使用

注解说明:

@Getter :添加在属性上,生成对应的 get方法。

@Setter :添加在属性上,生成对应的 set 方法。

@ToString:添加在上,生成 toString 方法。

@EqualsAndHashCode:添加在上,生成 equals 和 hashCode 方法。

@NoArgsConstructor、 @RequiredArgsConstructor 、@AllArgsConstructor :添加在上,为类自动生成对应参数的构造方法。

@Data :添加在上,是 5 个 Lombok 注解(@Getter、@Setter、@ToString、                                          @EqualsAndHashCode 和 @RequiredArgsConstructor )的组合。

  • 为所有属性,添加 @Getter@ToString@EqualsAndHashCode 注解的效果
  • 为非 final 修饰的属性,添加 @Setter 注解的效果
  • 为 final 修改的属性,添加 @RequiredArgsConstructor 注解的效果

@Value :添加在上,和 @Data 注解类似,区别在于它会把所有属性默认定义为 private final 修饰,所以不会生成 set 方法。

@CommonsLog、@Log、@Log4j、@Log4j2、@Slf4j、@XSlf4j :添加在上,自动为类添加对应的日志支持。

@NonNull:添加在方法参数类属性上,用于方法、属性空值校验。若为 null 时,抛出 NullPointerException 异常。

@Cleanup:添加在方法中的局部变量上,在作用域结束时会自动调用 #close() 方法,来释放资源。例如说,使用在 Java IO 流操作的时候。

@Builder:添加在类、构造器、方法上,给该类加个构造者模式 Builder 内部类。

@Synchronized:添加在方法上,添加同步锁。

@SneakyThrows:添加在方法上,给该方法添加 try catch 代码块。

@Accessors:添加在方法属性上,下有三大属性,fluent、chain、prefix,并设置 chain = true,实现链式编程。


1、@Data

右侧为已编译的class文件,可以看见生成了对应的getter\setter\toString\hashcode等方法。

2、@Value

与@Data的区别就是,属性是private final修饰,没有提供setter方法,只提供了有参构造、getter方法等。

3、@AllArgsConstructor

相当于生成所有字段的有参构造

4、@NoArgsConstructor

相当于无参构造

5、@RequiredArgsConstructor

会给有final修饰的属性@NonNull注解修饰的属性生成构造器。

6、@Slf4j

生成对应的日志

7、@NonNull

8、@Cleanup

9、@Builder

        在类上加上了该注解,在创建类的时候就可以进行属性链式赋值,不用在一个一个的set进实体类。

10、@Synchronized

会添加同步锁



11、@SneakyThrows

会为方法添加try...catch进行包裹。

12、@Accessors

@Accessors下有三个属性:fluent、chain、prefix 

 12-1 fluent 属性(默认为false)

当fluent属性为true时,给对象的属性赋值,会省略get和set。

 12-2 chain 属性(默认为false)

当chain属性为true时,给对象赋值可以链式赋值,并且会返回当前对象。

 12-3 prefix  属性

prefix属性中值是字符数组,设置了该属性。在set/get的时候会根据设置的值去掉属性的前缀进行使用。

### 关于 Jackson 和 Lombok 的集成 为了实现 `jackson-module-lombok` 的使用和配置,可以按照以下方式操作: #### 1. 添加 Maven 或 Gradle 依赖 在项目的 `pom.xml` 文件中添加如下依赖项来引入 `jackson-module-lombok` 及其相关组件[^5]。 ```xml <dependency> <groupId>com.fasterxml.jackson.module</groupId> <artifactId>jackson-module-lombok</artifactId> <version>2.15.0</version> <!-- 版本号需根据实际需求调整 --> </dependency> <!-- 同时确保已引入 Jackson 核心模块 --> <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-databind</artifactId> <version>2.15.0</version> <!-- 版本号需保持一致 --> </dependency> ``` 对于 Gradle 用户,则可以在 `build.gradle` 中添加以下内容: ```gradle implementation 'com.fasterxml.jackson.module:jackson-module-lombok:2.15.0' implementation 'com.fasterxml.jackson.core:jackson-databind:2.15.0' // 确保版本匹配 ``` #### 2. 配置 ObjectMapper 使用 Lombok Module 为了让 `ObjectMapper` 支持 Lombok 注解的功能(如 `@Getter`, `@Setter`, `@NoArgsConstructor`, `@AllArgsConstructor`),需要显式注册 `LombokModule`。以下是具体代码示例: ```java import com.fasterxml.jackson.databind.ObjectMapper; import com.fasterxml.jackson.module.lombok.LombokModule; public class JacksonConfig { public static void main(String[] args) throws Exception { // 创建并初始化 ObjectMapper 实例 ObjectMapper objectMapper = new ObjectMapper(); // 注册 LombokModule 到 ObjectMapper objectMapper.registerModule(new LombokModule()); System.out.println("Lombok module registered successfully."); } } ``` 此步骤确保了 Jackson 能够识别由 Lombok 自动生成的 getter/setter 方法以及构造函数等特性[^6]。 #### 3. 测试功能 创建一个简单的 Java 类,并应用 Lombok 提供的各种注解来进行测试。例如: ```java import lombok.Data; import lombok.NoArgsConstructor; import lombok.NonNull; @Data @NoArgsConstructor public class User { @NonNull private String name; private int age; } ``` 随后可以通过序列化/反序列化验证是否正常工作: ```java import java.io.IOException; public class TestJacksonWithLombok { public static void main(String[] args) throws IOException { ObjectMapper mapper = new ObjectMapper(); mapper.registerModule(new LombokModule()); // 序列化对象为 JSON 字符串 User user = new User(); user.setName("Alice"); user.setAge(30); String jsonString = mapper.writeValueAsString(user); System.out.println(jsonString); // 输出 {"name":"Alice","age":30} // 将 JSON 字符串解析回对象 User parsedUser = mapper.readValue("{\"name\":\"Bob\",\"age\":25}", User.class); System.out.println(parsedUser.getName() + ", " + parsedUser.getAge()); // 输出 Bob, 25 } } ``` 以上过程展示了如何利用 `jackson-module-lombok` 来简化基于 Lombok 注解的数据绑定流程[^7]。 --- ###
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

子笙—望舒

整理编写不易,希望能支持支持

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值