Lombok安装及使用技巧

1. 在以前的java代码中有很多不友好，重复的代码，POJO的getter/setter/toString；异常处理；I/O流的关闭操作等，既没什么技术含量，又影响代码的简洁度。于是lombok诞生了，它可以帮助我们通过注解的方式实现实体类的set/get/toString等相关的方法。

2. Lombok插件的安装

   1. 在file -> Settings ->Plugins -> Marketplace 下搜索lombok，点击安装，等安装结束后，重启idea即可
      
   2. 在idea 2018.03以后的版本在安装的时候会提示无法安装的情况，这时需要下载安装包到本地，通过本地安装，下载地址为： 链接：https://pan.baidu.com/s/1Bchhu0yZlPoy_99lWRONLw 提取码：8z26 ，将安装包下载到本地，点击 Settings ->Plugins 右上角的设置图标，选择 Install Plugin from Disk,选择下载好的安装包，安装即可。
      

3. Lombok的使用：

   1. 在项目中引入Lombok坐标

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

      Lombok的scope=provided，说明它只在编译阶段生效，不需要打入包中。Lombok在编译期将带Lombok注解的Java文件正确编译为完整的Class文件。

   2. Lombok的实现原理：

      自从Java 6起，javac就支持“JSR 269 Pluggable Annotation Processing API”规范，只要程序实现了该API，就能在javac运行的时候得到调用。

      Lombok就是一个实现了"JSR 269 API"的程序。在使用javac的过程中，它产生作用的具体流程如下：

      1. javac对源代码进行分析，生成一棵抽象语法树(AST)
      2. javac编译过程中调用实现了JSR 269的Lombok程序
      3. 此时Lombok就对第一步骤得到的AST进行处理，找到Lombok注解所在类对应的语法树(AST)，然后修改该语法树(AST)，增加Lombok注解定义的相应树节点
      4. javac使用修改后的抽象语法树(AST)生成字节码文件

   3. Lombok常用的注解

      1. 实体类常用注解

         1. @Getter/@Setter作用类上，生成所有成员变量的getter/setter方法；作用于成员变量上，生成该成员变量的getter/setter方法。可以设定访问权限及是否懒加载等

            import lombok.*;
            
            import java.util.Date;
            
            @Getter(value = AccessLevel.PUBLIC)
            @Setter(value = AccessLevel.PUBLIC)
            public class User {
                private Integer id;
                private String name;
                private String phone;
                private Date createDate;
                private Integer age;
                private String password;
            }
            

         2. @ToString：作用于类，覆盖默认的toString()方法，可以通过of属性限定显示某些字段，通过exclude属性排除某些字段

            import lombok.*;
            
            import java.util.Date;
            
            @Getter(value = AccessLevel.PUBLIC)
            @Setter(value = AccessLevel.PUBLIC)
            @ToString(of = {"name", "age"}, exclude = {"password"})
            public class User {
                private Integer id;
                private String name;
                private String phone;
                private Date createDate;
                private Integer age;
                private String password;
            }
            

         3. @EqualsAndHashCode：作用于类，覆盖默认的equals和hashCode

         4. @NonNull：主要作用于成员变量和参数中，标识不能为空，否则抛出空指针异常

            public class User {
                @NonNull private Integer id;
                private String name;
                private String phone;
            }
            

         5. @NoArgsConstructor：生成无参构造器

         6. @RequiredArgsConstructor：生成包含final和@NonNull注解的成员变量的构造器

         7. @AllArgsConstructor：生成全参构造器

         8. @Data：作用于类上，是以下注解的集合：

            @ToString @EqualsAndHashCode @Getter @Setter @RequiredArgsConstructor

         9. @Builder：作用于类上，将类转变为建造者模式

      2. 其他常用注解

         1. @Cleanup：自动关闭资源，针对实现了java.io.Closeable接口的对象有效，如IO对象

            public void readFile() throws IOException {
                File file = new File("d:\\test.txt");
                @Cleanup InputStream inputStream = new FileInputStream(file);
                int len;
                byte[] bs = new byte[1024];
                while((len = inputStream.read(bs)) != -1){
                    System.out.println(new String(bs, 0, len));
                }
            }
            

         2. @SneakyThrows：可以对受检异常进行捕捉并抛出,可将上面的代码修改为:

            @SneakyThrows
            public void readFile() {
                File file = new File("d:\\test.txt");
                @Cleanup InputStream inputStream = new FileInputStream(file);
                int len;
                byte[] bs = new byte[1024];
                while((len = inputStream.read(bs)) != -1){
                    System.out.println(new String(bs, 0, len));
                }
            }
            

         3. @Synchronized：作用于方法级别，可以替换synchronize关键字或lock锁