Java代码辅助效率工具Lombok(注解,自动生成代码)

154人浏览

Lombok是一款小巧的代码生成工具。官方网址:http://projectlombok.org/ 

Lombok类似于一种IDE插件,在使用时Eclipse或IntelliJ IDEA都需要安装相应的插件,在编译器编译时通过操作AST改变字节码生成。它不像spring的依赖注入或者mybatis的ORM一样是运行时的特性,而是编译时的特性。

Lombok本质上是一个实现了“JSR 269 API”的程序。在使用javac的过程中,它产生作用的流程如下:

  • javac对源代码进行分析,生成了一棵抽象语法树(AST)
  • 运行过程中调用实现了“JSR 269 API”的Lombok程序
  • 此时Lombok就对第一步骤得到的AST进行处理,找到@Data注解所在类对应的语法树(AST),然后修改该语法树(AST),增加getter和setter方法定义的相应树节点
  • javac使用修改后的抽象语法树(AST)生成字节码文件,即给class增加新的节点(代码块)

Lombok优点

  • 注解驱动,在编译时自动为属性生成构造器getter/setter、equals、hashcode、toString,Constructor等方法代码;
  • 让代码变得简洁,减少大量冗余代码;
  • 修改属性对应方法自动调整,提高开发效率;

Lombok缺点

  • 降低了源代码的完整性;

 

安装插件

IntelliJ IDEA

查找插件 lombok plugin 安装即可。

Eclipse

java -jar lombok-1.16.20.jar
弹窗弹窗点击Specify location 选中eclipse安装路径 点击Install:

Maven工程

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

 

使用lombok前

public class Order {
	
    private String payId;
    private String orderId;
    private int payType;

    public Order(String payId, String orderId, int payType) {
        this.payId = payId;
        this.orderId = orderId;
        this.payType = payType;
    }

    public String getPayId() {
        return payId;
    }

    public void setPayId(String payId) {
        this.payId = payId;
    }

    public String getOrderId() {
        return orderId;
    }

    public void setOrderId(String orderId) {
        this.orderId = orderId;
    }

    public int getPayType() {
        return payType;
    }

    public void setPayType(int payType) {
        this.payType = payType;
    }
    
}

使用lombok后

@Data
@NoArgsConstructor
@AllArgsConstructor
public class Order {
	
    private String payId;
    private String orderId;
    private int payType;
    
}

 

常用注解

@Getter 生成成员变量的getter方法
@Setter 生成成员变量的getter方法
@NoArgsConstructor 生成无参构造器
@RequiredArgsConstructor 生成包含final和@NonNull注解的成员变量的构造器
@EqualsAndHashCode 生成覆盖默认的equals和hashCode
@ToString 生成覆盖默认的toString()方法
@Data 以上注解的集合:@ToString @EqualsAndHashCode @Getter @Setter @NoArgsConstructor
@AllArgsConstructor 生成全参构造器
@Log4j 生成log4j日志变量
@NonNull 作用于成员变量和参数中,标识不能为空,否则抛出空指针异常
@Cleanup 自动关闭资源
@SneakyThrows 检异常进行捕捉并抛出
@Synchronized 替换synchronize关键字或lock锁