Lombok框架
Lombok简介
Lombok是一个java库,能自动增强你的编辑器和构建工具,简化java开发。通过使用注解,可以自动帮你生成类的setter()、getter()、equals()等方法,生成日志变量,等等很多功能。
Lombok使用
- 添加Maven依赖:
xml
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.24</version>
</dependency>- 在idea的plugins中安装并启用Lombok插件

- 在idea中启用注解处理器

常用注解
@Setter注解在类或字段,注解在类时为所有字段生成setter方法,注解在字段上时只为该字段生成setter方法。@Getter使用方法同上,区别在于生成的是getter方法。@ToString注解在类,添加toString方法。@EqualsAndHashCode注解在类,生成hashCode和equals方法。@NoArgsConstructor注解在类,生成无参的构造方法。@RequiredArgsConstructor注解在类,为类中需要特殊处理的字段生成构造方法,比如final和被@NonNull注解的字段。@AllArgsConstructor注解在类,生成包含类中所有字段的构造方法。@Data注解在类,生成setter/getter、equals、canEqual、hashCode、toString方法,如为final属性,则不会为该属性生成setter方法。@Slf4j注解在类,生成log变量,严格意义来说是常量。private static final Logger log = LoggerFactory.getLogger(UserController.class);
Lombok的工作原理
Lombok本质上就是一个实现了“JSR 269 API”的程序。在使用javac的过程中,它产生作用的具体流程如下:
- javac对源代码进行分析,生成了一棵抽象语法树(AST)
- 运行过程中调用实现了“JSR 269 API”的Lombok程序
- 此时Lombok就对第一步骤得到的AST进行处理,找到
@Data注解所在类对应的语法树(AST),然后修改该语法树(AST),增加getter和setter方法定义的相应树节点 - javac使用修改后的抽象语法树(AST)生成字节码文件,即给class增加新的节点(代码块) 通过读Lombok源码,发现对应注解的实现都在
HandleXXX中,比如@Getter注解的实现在HandleGetter.handle()。还有一些其它类库使用这种方式实现,比如Google Auto、Dagger等等。
Lombok优缺点
优点:
- 能已注解形式生成类的常用方法。
- 让代码变得简洁,不用过多关注基础的方法。
- 属性修改时,也简化维护属性所需要的setter/getter方法。
缺点:
- 降低了代码的完整性和可读性
- 代码与lombok耦合。