maven插件lombok

本文详细解析了Lombok的工作原理,介绍了如何通过JSR269 API在编译阶段自动生成getter、setter等方法,同时提供了Maven项目的配置示例。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

lombok主要作用是针对代码开发中,针对实体经常需要大量的setter、getter、 hashCode、 equals、 toString方法,通过此工具可以免去相关处理。

原理如下:

接下来进行lombok能够工作的原理分析,以Oracle的javac编译工具为例。 
自从Java 6起,javac就支持“JSR 269 Pluggable Annotation Processing API”规范,只要程序实现了该API,就能在javac运行的时候得到调用。 
举例来说,现在有一个实现了”JSR 269 API”的程序A,那么使用javac编译源码的时候具体流程如下: 
1) javac对源代码进行分析,生成一棵抽象语法树(AST) 
2) 运行过程中调用实现了”JSR 269 API”的A程序 
3) 此时A程序就可以完成它自己的逻辑,包括修改第一步骤得到的抽象语法树(AST) 
4) javac使用修改后的抽象语法树(AST)生成字节码文件 
详细的流程图如下: 
这里写图片描述

lombok本质上就是这样的一个实现了”JSR 269 API”的程序。在使用javac的过程中,它产生作用的具体流程如下: 
1)javac对源代码进行分析,生成一棵抽象语法树(AST) 
2)运行过程中调用实现了”JSR 269 API”的lombok程序 
3)此时lombok就对第一步骤得到的AST进行处理,找到@Data注解所在类对应的语法树(AST),然后修改该语法树(AST),增加getter和setter方法定义的相应树节点 
4)javac使用修改后的抽象语法树(AST)生成字节码文件

支持的编译工具:

  1. 由“三、原理分析”可知,Oracle javac直接支持lombok
  2. 常用的项目管理工具Maven所使用的java编译工具来源于配置的第三方工具,如果我们配置这个第三方工具为Oracle javac的话,那么Maven也就直接支持lombok了
  3. Intellij Idea配置的编译工具为Oracle javac的话,也就直接支持lombok了。
  4. Eclipse中使用的不是Oracle javac这个编译工具,而是自己实现的Eclipse Compiler for Java (ECJ).要想使ECJ支持lombok,得进行设置,具体是在Eclipse程序目录中的eclipse.ini文件中添加如下两行设置: 
    -javaagent:[lombok.jar所在路径] 
    -Xbootclasspath/a:[lombok.jar所在路径]

****************************************************************************************************************************

针对maven项目配置如下

1、引入依赖

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

2、配置插件

<build>
<plugins>
<plugin>
<groupId>org.projectlombok</groupId>
<artifactId>lombok-maven-plugin</artifactId>
<version>1.16.18.1</version>
<executions>
<execution>
<phase>generate-sources</phase>
<goals>
<goal>delombok</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>

只有在install的时候才会在对应实体生成方法(eclipse中RUN AS -> INSTALL)

### 如何在 Maven 项目中使用 Lombok 进行开发 #### 添加 Lombok 依赖 为了使 Maven 项目能够利用 Lombok 提供的功能,在 `pom.xml` 文件内需加入如下所示的依赖项: ```xml <dependencies> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.18.20</version> <!-- 版本号可根据实际需求调整 --> <scope>provided</scope> </dependency> </dependencies> ``` 上述代码展示了如何向 Maven 的 POM 文件添加 Lombok 作为编译时依赖,其中 `<scope>` 设置为 `provided` 表明该库仅用于编译阶段而不会被打包至最终的应用程序中[^1]。 #### 安装 Lombok 插件 对于集成开发环境(IDE),如 IntelliJ IDEA 或 Eclipse 来说,还需要额外安装对应的 Lombok 插件来支持注解处理器的工作。这一步骤确保 IDE 能够识别由 Lombok 注解生成的方法和字段,从而提供更好的编码体验以及防止潜在错误的发生[^3]。 #### 使用 Lombok 注解简化代码编写 一旦完成了以上两步操作之后就可以开始享受 Lombok 带来的便利之处了。下面是一些常用的 Lombok 注解及其作用简介: - **@Data**: 自动生成 getter/setter 方法、toString() 和 equals()/hashCode() 实现; - **@Slf4j/@Log4j**: 自动创建日志记录器实例; - **@AllArgsConstructor/@NoArgsConstructor/@RequiredArgsConstructor**: 自动生成不同类型的构造函数; 通过这些强大的功能可以帮助开发者减少样板代码的数量,提高生产力的同时也降低了出错的概率。 #### 修改版本管理 当需要更改所使用的 Lombok 库的具体版本时,可以通过访问官方提供的 [Maven 中央仓库](https://mvnrepository.com/artifact/org.projectlombok/lombok)[^2] 查找最新的发布版本,并将其更新到项目的 pom 文件当中去。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值