Android Studio 和 lombok 的版本适配、gradle依赖配置、插件安装及使用_android studio lombok

Intro

用惯了 Java+Maven+IDEA 开发后端服务，突然有一天用 Java+Gradle+AndroidStudio 开发安卓。
在写一个bean的时候，想到了之前用过的lombok依赖。
那么在使用gradle管理依赖的安卓开发过程中，如果新增lombok依赖呢？

注意事项

• 选择大于努力

先选择合适的 Android Studio 版本，再找与之兼容的 lombok 插件。
【并不是每个版本的 Android Studio 都有与之对应的 lombok jar包可用！如：官网信息表示，2022年的所有版本的 Android Studio 都没有对应的 lombok】

• lombok 插件分两步
  1. 对已安装的Android Studio软件，需要为其安装一个plugin：lombok。【这个动作是一次性的，安装一次插件以后次次可用】
  2. 对需要用到 lombok 注解及相关特性的项目，需要在 gradle 的配置文件中添加相关依赖（依赖不能漏）。

Android Studio 和 lombok 的版本选择及下载

下载链接

• Android Studio 的历史版本： https://developer.android.google.cn/studio/archive
• lombok 插件的可用版本： https://plugins.jetbrains.com/plugin/6317-lombok/versions/stable

再次注意：找一个有着可用版本的lombok插件的Android Studio去下载。

我的选择：
macOS m1版本：https://redirector.gvt1.com/edgedl/android/studio/install/2023.3.1.14/android-studio-2023.3.1.14-mac_arm.dmg
windows版本: https://redirector.gvt1.com/edgedl/android/studio/install/2023.3.1.14/android-studio-2023.3.1.14-windows.exe

下载安装之后，打开 Android Studio ，看About信息：

Android Studio Jellyfish | 2023.3.1 Beta 1
Build #AI-233.14808.21.2331.11574862, built on March 14, 2024
Runtime version: 17.0.10+0-17.0.10b1087.17-11446219 aarch64
VM: OpenJDK 64-Bit Server VM by JetBrains s.r.o.
macOS 14.4
GC: G1 Young Generation, G1 Old Generation
Memory: 2048M
Cores: 8
Metal Rendering is ON
Non-Bundled Plugins:
  Lombook Plugin (233.14808.21)
  com.dguner.lombok-builder-helper (1.5.0)
1
2
3
4
5
6
7
8
9
10
11
12

拿着版本信息中的 233.14808 去 Lombok页面搜索：
下载搜到的版本： https://plugins.jetbrains.com/plugin/download?rel=true&updateId=502595

在 Android Studio 中安装一次 lombok 插件

官网：https://projectlombok.org/setup/android

不过官网提供的这个安装方法并不是最通用的（也许你是在公司开发，无法联网下载插件，也许你的网络环境搜不到某些插件）。
更通用的方式是：下载好插件，然后从本地磁盘文件中安装下载好的插件。

File --> Settings --> Plugins --> Installed --> 设置按钮小齿轮⚙️ --> Install Plugin from Disk...

选择刚才提前下载好的 lombok（这一步经我测试，zip或解压后的jar都可以直接选）。

之后的 Android Studio 设置界面：

重启一下 Android Studio，lombok 这个插件就算是安装好了。

在每个 gradle 项目中添加 lombok 相关依赖(如要用到)

官网： https://projectlombok.org/setup/gradle
在你需要用到 lombok 的项目中，要添加的Lombok相关依赖共有4行：

compileOnly 'org.projectlombok:lombok:1.18.32'
annotationProcessor 'org.projectlombok:lombok:1.18.32'

testCompileOnly 'org.projectlombok:lombok:1.18.32'
testAnnotationProcessor 'org.projectlombok:lombok:1.18.32'
1
2
3
4
5

使用

@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor

Xxx.builder().xxx.build()
1
2
3
4
5
6

如果：我们只在gradle配置里加 lombok 相关依赖，则：
lombok相关注解可以使用，也不会报错。
但是：Xxx.builder().build() 方法却无法识别。为 Android Studio 安装 lombok 插件之后，则相关的lombok生成代码才可以正常调用。

ref

• 解决在Android Studio中Lombok不起作用的问题

这里提到了一种解决Android Studio 只能安装指定版本lombok插件文件的方法：去lombok插件文件中修改前文提到过的build版本号。
我测试了，未成功。