SpringBoot 使用Lombok插件

心已赠人 2022-10-02 10:42 205阅读 0赞

### 一、Lombok简介 ###

Lombok 是一个可以通过简单的注解的形式来帮助我们简化消除一些必须有但显得很臃肿的 Java 代码的工具，在我们项目开发中经常使用model，entity等类，绝大部分数据类类中都需要get、set、toString等方法，一般我们需要手动的添加这些属性， 但是如果我们受到业务的变更，字段的添加，修改等操作，我们需要更改实体类，但是使用了Lombok插件，只要我们定义了变量，例如使用@Data属性，lombok会在编译的时候，自动加上get set方法。

官方地址：[https://projectlombok.org/ ][https_projectlombok.org_]

github地址：[https://github.com/rzwitserloot/lombok][https_github.com_rzwitserloot_lombok]

**1、Intellij IDEA 安装 Lombok 插件**

ctrl + alt + s 打开如下图设置界面：  
      File–>Settings–>Plugins  在Marketplace中搜索Lombok,点击安装 安装成功之后，重启就可以使用 Lombok.

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDAyODU0_size_16_color_FFFFFF_t_70][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDAyODU0_size_16_color_FFFFFF_t_70 1][]

### 2、Lombok 常用注解 ###

*  @Data：注解在类上，相当于同时使用了@Setter+@Getter+@EqualsAndHashCode+@NoArgsConstructor+@ToString，对于POJO类十分有用
 *  @NonNull：注解在属性/方法参数上，如果方法内对该参数进行是否为空的校验，如果为null值，则抛出NPE（NullPointerException）
 *  @Cleanup：自动管理资源，用在局部变量之前，在当前变量范围内即将执行完毕退出之前会自动清理资源，自动生成try-finally这样的代码来关闭流
 *  @Getter/@Setter：注解在属性上，自动生成生成setter/getter方法，final变量不包含，还可以指定访问范围
 *  @ToString：注解在类上，可以自动覆写toString方法，当然还可以加其他参数，例如@ToString(exclude=”id”)排除id属性，或者@ToString(callSuper=true, includeFieldNames=true)调用父类的toString方法，包含所有属性
 *  @EqualsAndHashCode：注解在类上，自动生成equals()方法和hashCode方法
 *  @NoArgsConstructor：注解在类上，自动生成空参构造方法
 *  @AllArgsConstructor：注解在类上，自动生成全部参数构造方法
 *  @RequiredArgsConstructor：注解在类上，将标记为@NoNull的属性自动生成构造方法（如果运行中标记为@NoNull的属性为null,会抛出空指针异常）
 *  @Data：注解在类上，相当于同时使用了@ToString、@EqualsAndHashCode、@Getter、@Setter和@RequiredArgsConstrutor这些注解，对于POJO类十分有用
 *  @Value：注解在类上，是@Data的不可变形式， 两个主要区别就是如果变量不加@NonFinal ，@Value会给所有的弄成final的。当然如果是final的话，就没有set方法了。用于注解final类
 *  @Builder：用在类、构造器、方法上，为你提供复杂的builder APIs，让你可以像如下方式一样调用Person.builder().name("name").city("shanghai").build();更多说明参考Builder
 *  @SneakyThrows：自动抛受检异常，而无需显式在方法上使用throws语句。自动调用close方法关闭资源。
 *  @Synchronized：用在方法上，将方法声明为同步的，并自动加锁，而锁对象是一个私有的属性$lock或$LOCK，而java中的synchronized关键字锁对象是this，锁在this或者自己的类对象上存在副作用，就是你不能阻止非受控代码去锁this或者类对象，这可能会导致竞争条件或者其它线程错误
 *  @Getter(lazy=true)：可以替代经典的Double Check Lock样板代码
 *  @Log：注解在类上，根据不同的注解生成不同类型的log对象，但是实例名称都是log，有六种可选实现类
    
     *  `@CommonsLog` Creates log = org.apache.commons.logging.LogFactory.getLog(LogExample.class);
     *  `@Log` Creates log = java.util.logging.Logger.getLogger(LogExample.class.getName());
     *  `@Log4j` Creates log = org.apache.log4j.Logger.getLogger(LogExample.class);
     *  `@Log4j2` Creates log = org.apache.logging.log4j.LogManager.getLogger(LogExample.class);
     *  `@Slf4j` Creates log = org.slf4j.LoggerFactory.getLogger(LogExample.class);
     *  `@XSlf4j` Creates log = org.slf4j.ext.XLoggerFactory.getXLogger(LogExample.class);

**3、Lombok原理：参考[Java开发神器Lombok的使用与原理][Java_Lombok]**

Lombok这款插件正是依靠可插件化的Java自定义注解处理API（JSR 269: Pluggable Annotation Processing API）来实现在Javac编译阶段利用“Annotation Processor”对自定义的注解进行预处理后生成真正在JVM上面执行的“Class文件”。（底层使用字节码技术（ASM））

运行时解析

运行时能够解析的注解，必须将@Retention设置为RUNTIME，这样可以通过反射拿到该注解。java.lang.reflect反射包中提供了一个接口AnnotatedElement，该接口定义了获取注解信息的几个方法，Class、Constructor、Field、Method、Package等都实现了该接口，大部分开发者应该都很熟悉这种解析方式。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDAyODU0_size_16_color_FFFFFF_t_70 2][]     ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDAyODU0_size_16_color_FFFFFF_t_70 3][]

### **二、SpringBoot 使用Lombok** ###

**1、pom.xml 引入Lombok依赖 **

<dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
            </dependency>

**2、在 POJO类中测试**

**   ** 在IDEA点击View-->Tool Windows-->Structure，或者 Alt + 7    可以查看类中所有的方法和属性

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDAyODU0_size_16_color_FFFFFF_t_70 4][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDAyODU0_size_16_color_FFFFFF_t_70 5][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDAyODU0_size_16_color_FFFFFF_t_70 6][]

ends~

[https_projectlombok.org_]: https://projectlombok.org/
[https_github.com_rzwitserloot_lombok]: https://github.com/rzwitserloot/lombok
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDAyODU0_size_16_color_FFFFFF_t_70]: /images/20220112/6f6027ce1cfd4a16afd7785067f4b895.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDAyODU0_size_16_color_FFFFFF_t_70 1]: /images/20220112/2c43fbbf1c0947058aab3fd6bd23f617.png
[Java_Lombok]: https://www.jianshu.com/p/422f151fccd3
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDAyODU0_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20190618111321911.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDAyODU0,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDAyODU0_size_16_color_FFFFFF_t_70 3]: /images/20220112/8c94cf2f07744927bacfa7bd6054fcce.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDAyODU0_size_16_color_FFFFFF_t_70 4]: /images/20220112/cded47d3fe25441dbdc09cf3ed953f77.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDAyODU0_size_16_color_FFFFFF_t_70 5]: /images/20220112/6fe54bcfc9b2476e961475055ddad4dd.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDAyODU0_size_16_color_FFFFFF_t_70 6]: /images/20220112/04b701d47fab42e085dbcafefcc32622.png