Lombok的基本使用

矫情吗；* 2022-09-07 09:23 139阅读 0赞

#### 前言： ####

以前的Java项目中，充斥着太多不友好的代码：POJO的getter/setter/toString；异常处理；I/O流的关闭操作等等，这些样板代码既没有技术含量，又影响着代码的美观，Lombok应运而生。  
**Lombok 官方稳定版本注解地址： [https://projectlombok.org/features/all][https_projectlombok.org_features_all]**

#### Idea 配置： ####

Idea 添加Lombok 插件， 配置： File -->> Setting -->> Plugin -->> Marketplace 搜索 lombok 选中 install 重启 Idea 即可  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5neW9uZzAxMjQ1_size_16_color_FFFFFF_t_70]  
Idea 配置注解生效：  
File -->> Setting -->> Build,Execution,Deployment -->> Compiler -->> Annotation Processors 如下图所示，选中  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5neW9uZzAxMjQ1_size_16_color_FFFFFF_t_70 1]

##### Lombok 常用注解以及作用 #####

*  @Getter/@Setter：
    
     *  作用类上，生成所有成员变量的getter/setter方法；
     *  作用于成员变量上，生成该成员变量的getter/setter方法。
     *  可以设定访问权限及是否懒加载等。
     *  官网地址： [https://projectlombok.org/features/GetterSetter][https_projectlombok.org_features_GetterSetter]  
        ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5neW9uZzAxMjQ1_size_16_color_FFFFFF_t_70 2]
 *  @Data：
    
     *  作用于类上，是以下注解的集合：@ToString @EqualsAndHashCode @Getter @Setter @RequiredArgsConstructor
     *  官网地址： [https://projectlombok.org/features/Data][https_projectlombok.org_features_Data]
     *  官方解释： All together now: A shortcut for @ToString, @EqualsAndHashCode, @Getter on all fields, and @Setter on all non-final fields, and @RequiredArgsConstructor!
 *  @ToString：
    
     *  作用于类，覆盖默认的toString()方法，可以通过of属性限定显示某些字段，通过exclude属性排除某些字段。
     *  官网地址： [https://projectlombok.org/features/ToString][https_projectlombok.org_features_ToString]  
        ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5neW9uZzAxMjQ1_size_16_color_FFFFFF_t_70 3]
 *  @EqualsAndHashCode：
    
     *  作用于类，覆盖默认的equals和hashCode
     *  官网地址： [https://projectlombok.org/features/EqualsAndHashCode][https_projectlombok.org_features_EqualsAndHashCode]  
        ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5neW9uZzAxMjQ1_size_16_color_FFFFFF_t_70 4]
 *  @NonNull
    
     *  主要作用于成员变量和参数中，标识不能为空，否则抛出空指针异常。
     *  官网地址： [https://projectlombok.org/features/NonNull][https_projectlombok.org_features_NonNull]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5neW9uZzAxMjQ1_size_16_color_FFFFFF_t_70 5]

*  @NoArgsConstructor, @RequiredArgsConstructor and @AllArgsConstructor
    
     *  @NoArgsConstructor：生成无参构造器；
     *  @RequiredArgsConstructor：生成包含final和@NonNull注解的成员变量的构造器；
     *  @AllArgsConstructor：生成全参构造器  
        ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5neW9uZzAxMjQ1_size_16_color_FFFFFF_t_70 6]
 *  @Builder ：
    
     *  作用于类上，将类转变为建造者模式
     *  官网地址： [https://projectlombok.org/features/Builder][https_projectlombok.org_features_Builder]  
        ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5neW9uZzAxMjQ1_size_16_color_FFFFFF_t_70 7]  
        ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5neW9uZzAxMjQ1_size_16_color_FFFFFF_t_70 8]
 *  @**SneakyThrows：** 非常Nice
    
     *  可以对受检异常进行捕捉包装并抛出 RuntimeException 异常， 毕竟 RuntimeException 在程序运行时时不需要进行显式捕获的， 避免 try\{\}catch 影响代码可读性~
     *  官方文档： [https://projectlombok.org/features/SneakyThrows][https_projectlombok.org_features_SneakyThrows]  
        ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5neW9uZzAxMjQ1_size_16_color_FFFFFF_t_70 9]  
        ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5neW9uZzAxMjQ1_size_16_color_FFFFFF_t_70 10]
 *  @Cleanup
    
     *  在IO流中，使用Cleanup关闭资源
     *  官方地址： [https://projectlombok.org/features/Cleanup][https_projectlombok.org_features_Cleanup]
     *  其他，也可以使用 try-with-resources 来关闭资源 【推荐，毕竟是 Java 提供的功能】  
        ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5neW9uZzAxMjQ1_size_16_color_FFFFFF_t_70 11]

##### 以上是博主工作中对 Lombok 的简单使用，大家可以再评论区多多沟通哟~ #####

[https_projectlombok.org_features_all]: https://projectlombok.org/features/all
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5neW9uZzAxMjQ1_size_16_color_FFFFFF_t_70]: /images/20220829/36416df301fa412bb1fa2a733e88c219.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5neW9uZzAxMjQ1_size_16_color_FFFFFF_t_70 1]: /images/20220829/cd60e23621f746a888c8958585ba7b7a.png
[https_projectlombok.org_features_GetterSetter]: https://projectlombok.org/features/GetterSetter
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5neW9uZzAxMjQ1_size_16_color_FFFFFF_t_70 2]: /images/20220829/f57addbfac404d72a0dc00d76f820e4d.png
[https_projectlombok.org_features_Data]: https://projectlombok.org/features/Data
[https_projectlombok.org_features_ToString]: https://projectlombok.org/features/ToString
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5neW9uZzAxMjQ1_size_16_color_FFFFFF_t_70 3]: /images/20220829/ebf7f6833d7244c3a833f2b45c552e87.png
[https_projectlombok.org_features_EqualsAndHashCode]: https://projectlombok.org/features/EqualsAndHashCode
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5neW9uZzAxMjQ1_size_16_color_FFFFFF_t_70 4]: /images/20220829/4392dcd5cd844bf99b7825dc707cd868.png
[https_projectlombok.org_features_NonNull]: https://projectlombok.org/features/NonNull
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5neW9uZzAxMjQ1_size_16_color_FFFFFF_t_70 5]: /images/20220829/18bf6536f2a64b9d9794a12d0f74b822.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5neW9uZzAxMjQ1_size_16_color_FFFFFF_t_70 6]: /images/20220829/55dcfafe4a734789ac29d02ad02c3edc.png
[https_projectlombok.org_features_Builder]: https://projectlombok.org/features/Builder
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5neW9uZzAxMjQ1_size_16_color_FFFFFF_t_70 7]: /images/20220829/7ff2042fea5b4ff8820e8a82f931b53b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5neW9uZzAxMjQ1_size_16_color_FFFFFF_t_70 8]: /images/20220829/618b1e76a57b4b1b9b633348f06b63f7.png
[https_projectlombok.org_features_SneakyThrows]: https://projectlombok.org/features/SneakyThrows
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5neW9uZzAxMjQ1_size_16_color_FFFFFF_t_70 9]: /images/20220829/9703354f0eb94d4bb849ff3530041407.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5neW9uZzAxMjQ1_size_16_color_FFFFFF_t_70 10]: /images/20220829/a77e40c8e8e946f4a452889a82ddd6fd.png
[https_projectlombok.org_features_Cleanup]: https://projectlombok.org/features/Cleanup
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5neW9uZzAxMjQ1_size_16_color_FFFFFF_t_70 11]: /images/20220829/95ab7f46d23a443a874521db20219e1c.png