Gradle的依赖方式——Lombok在Gradle中的正确配置姿势

写过java的都知道，lombok几乎在项目中处于不可或缺的一部分，但是lombok在Gradle的项目中配置并非人人都知道。

很多人在项目依赖中直接这样写

compile "org.projectlombok:lombok:1.18.4"

但这样的处理在Gradle 5.0以上被命令禁止了，在4.x的高级版本中编译时也会有对应的告警

The following annotation processors were detected on the compile classpath: 'lombok.launch.AnnotationProcessorHider$AnnotationProcessor' 
Detecting annotation processors on the compile classpath is deprecated and Gradle 5.0 will ignore them.
Please add them to the annotation processor path instead. 
If you did not intend to use annotation processors, 
you can use the '-proc:none' compiler argument to ignore them.

Gradle的几种依赖方式

下面先来了解下目前Gradle（4.1以上）的几种常见的依赖方式。

• api：与旧版的compile相同；
• implementation：解决重复依赖问题。例如A依赖B，B依赖C，那么A里面将不能调用C的方法；
• compile only：编译有效，打包无效。替代旧版的provider；
• runtime only：打包有效，编译无效；
• test、debug、release implementation：对应test、debug、release环境的implementation。

回到Lombok的使用上，我们知道lombok是可以简化编写的代码，可以让开发人员通过注解的形式少写一些重复具有模板形式的代码。然后这些注解可以在代码编译的时候，自动生成对应模板代码。

并且在打jar/war包的时候，并不需要把lombok的依赖打进包中，所以Lombok在依赖上应该是compile only（仅在编译时生效）才对。

在Gradle 5.0环境下，我们尝试下改成

compileOnly "org.projectlombok:lombok:1.18.4"

然后执行gradle build。会发现代码报错，找不到对应生成后的代码（如果用idea build则不会，因为自带了插件。4.4+的版本也不会报错，但会告警）。

Lombok的正确配置

在5.0的环境下，注解处理将不再compile classpath中，需要手动添加到annotation processor path。

最终的对应依赖如下

compileOnly 'org.projectlombok:lombok:1.18.4'
annotationProcessor 'org.projectlombok:lombok:1.18.4'
testCompileOnly 'org.projectlombok:lombok:1.18.4'
testAnnotationProcessor 'org.projectlombok:lombok:1.18.4'

P.S. 如果不配置compileOnly，只配annotationProcessor（gradle5.0以上才有），也会build成功，但会把依赖也打包进去。

针对5.0以下版本，对应依赖如下

compileOnly 'org.projectlombok:lombok:1.18.4'

看完后，大家可以动起来，把自己项目中的lombok配置改掉吧（注意gradle版本）。