大家写代码肯定遇到过这样的情况:
代码里有getter
,setter
,toString
,异常处理,I/O流的关闭操作等等代码,这些代码和业务无关,但是在代码中还要占地方,看着就很别扭,于是出现了可以以注解方式来替换它们的框架:Lombok
有人说Lombok
在团队开发时具有很强的侵入性,一个人用的话整个团队必须一起用,所以大家使用的时候尽量思考一下
使用
-
引入Maven依赖
<dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>版本号</version> <scope>provided</scope> </dependency>
Lombok在编译期将带Lombok注解的Java文件正确编译为完整的Class文件
所以依赖中
scope:provide
,只在编译阶段生效,不需要打入包中 -
让Lombok注解在编译阶段起到作用。
原理
Java 6起,javac就支持“JSR 269 Pluggable Annotation Processing API”规范,只要程序实现了该API,就能在javac运行的时候得到调用。
Lombok就是一个实现了"JSR 269 API"的程序
主要步骤如下:
-
javac对源代码进行分析,生成一棵抽象语法树(AST)
-
javac编译过程中调用Lombok程序(该程序实现了实现了JSR 269)
-
此时Lombok就对第一步骤得到的AST进行处理,找到Lombok注解所在类对应的语法树 (AST),然后修改该语法树(AST),增加Lombok注解定义的相应树节点
-
javac使用修改后的抽象语法树(AST)生成字节码文件
常用注解
- @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变量,严格意义来说是常量。
参考:
https://www.jianshu.com/p/2543c71a8e45
https://baike.baidu.com/item/Lombok/23780246?fr=aladdin