优雅的使用Lombok进行代码开发

优雅的使用Lombok进行代码开发

• 首先使用Lombok IDE需要配合使用lombok插件

  • 插件下载
  • Eclipse安装Lombok 插件：
    • 第一步使用cmd 进入刚才下载的 lombok.jar 目录中 使用命令java -jar lombok.jar( 前提是你的计算机中已经安装jdk并配置环境变量)
    • 出现如下窗口
      
    • 进入eclipse的安装目录中如果出现一个lombok.jar的jar包表示安装成功
  • IDEA 安装插件
    • IDEA中无需下载lombok包 在IDEA插件市场搜索lombok 点击安装即可（由于较简单步骤不再列出）

• 在项目中安装lombok依赖

  • Maven 安装依赖

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

  • Gradle 安装依赖

    // https://mvnrepository.com/artifact/org.projectlombok/lombok
    provided group: 'org.projectlombok', name: 'lombok', version: '1.18.6'
    

• 代码展示

  • 未使用lombok

    public class Person {
      private String id;
      private String name;
    
      public String getId() {
          return id;
      }
    
      public void setId(String id) {
          this.id = id;
      }
    }
    

  • 使用lombok

    @Data
     public class Person {
         private String id;
         private String name;
     }
    

    以上只是使用了Lombok的 @Data 注解 还有其他注解下面简单介绍一下

• 常用注解说明

  解	说明
  val	用在局部变量前面，相当于将变量声明为final
  @NonNull	给方法参数增加这个注解会自动在方法内对该参数进行是否为空的校验，如果为空，则抛出NPE（NullPointerException）
  @Cleanup	自动管理资源，用在局部变量之前，在当前变量范围内即将执行完毕退出之前会自动清理资源，自动生成try-finally这样的代码来关闭流
  @Getter/@Setter	用在属性上，再也不用自己手写setter和getter方法了，还可以指定访问范围
  @ToString	用在类上，可以自动覆写toString方法，当然还可以加其他参数，例如@ToString(exclude=”id”)排除id属性，或者@ToString(callSuper=true, includeFieldNames=true)调用父类的toString方法，包含所有属性
  @EqualsAndHashCode	用在类上，自动生成equals方法和hashCode方法
  @NoArgsConstructor, @RequiredArgsConstructor and @AllArgsConstructor	用在类上，自动生成无参构造和使用所有参数的构造函数以及把所有@NonNull属性作为参数的构造函数，如果指定staticName = “of”参数，同时还会生成一个返回类对象的静态工厂方法，比使用构造函数方便很多
  @Data	注解在类上，相当于同时使用了@ToString、@EqualsAndHashCode、@Getter、@Setter和@RequiredArgsConstrutor这些注解，对于POJO类十分有用
  @Value	用在类上，是@Data的不可变形式，相当于为属性添加final声明，只提供getter方法，而不提供setter方法
  @Builder	用在类、构造器、方法上，为你提供复杂的builder APIs，让你可以像如下方式一样调用Person.builder().name(“Adam Savage”).city(“San Francisco”).job(“Mythbusters”).job(“Unchained Reaction”).build();更多说明参考Builder
  @SneakyThrows	自动抛受检异常，而无需显式在方法上使用throws语句
  @Synchronized	用在方法上，将方法声明为同步的，并自动加锁，而锁对象是一个私有的属性$lock或$LOCK，而java中的synchronized关键字锁对象是this，锁在this或者自己的类对象上存在副作用，就是你不能阻止非受控代码去锁this或者类对象，这可能会导致竞争条件或者其它线程错误
  @Getter(lazy=true)	可以替代经典的Double Check Lock样板代码
  @Log	根据不同的注解生成不同类型的log对象，但是实例名称都是log，有六种可选实现类

• Lombok原理分析

  • 我们在编码的时候在要想动态修改一个类的属性方法等 首先想到的是 反射 但是反射有个局限性就是它只有在运行期才能进行动态修改或者错误反馈，使得在编译代码时效率低下，而Lombok是在编译期间（也就是生成.class文件期间）进行类的动态修改，在代码进行AST(抽象语法树)时候通过注解处理类进行修改代码。（至于什么是AST网上有很多介绍在这里就不再赘述）

  • 在使用IDE（IDEA，eclipse等）时候 如果不安装lombok插件，如果一个类调用另一个类实例的属性时候由于没有get set 方法 编译器不知道@Data等注解是什么意思就会报错，其实如果运行代码是没有错的，安装lombok插件目的是在编辑代码期间防止报错

  • 整个过程 为Source file(源文件)->Pares(分析生成语法树)->AST(抽象语法树)->Annotation Processing(注解处理)->Lombok Annotation Processing(lombok注解处理)->AST(抽象语法树)->Lombok Annotation Handler(lombok注解处理器)->Modified AST(修正语法树)->Analyze and Generate( 分析并生成)->Byte code(字节码文件)。

  • 抽象语法树