解决 Lombok 与 Java 模块系统的兼容性问题：从错误到解决方案

个人名片

作者简介：java领域优质创作者
个人主页：码农阿豪
工作室：新空间代码工作室（提供各种软件服务)
个人邮箱：[[email protected]]
个人微信：15279484656
个人导航网站：www.forff.top
座右铭：总有人要赢。为什么不能是我呢？

• 专栏导航：

码农阿豪系列专栏导航
面试专栏：收集了java相关高频面试题，面试实战总结️
Spring5系列专栏：整理了Spring5重要知识点与实战演练，有案例可直接使用
Redis专栏：Redis从零到一学习分享，经验总结，案例实战
全栈系列专栏：海纳百川有容乃大，可能你想要的东西里面都有

解决 Lombok 与 Java 模块系统的兼容性问题：从错误到解决方案

引言

随着 Java 9 引入模块系统（JPMS，Java Platform Module System），Java 开发进入了一个新的时代。模块系统为 Java 应用程序提供了更好的封装性和模块化管理能力，但同时也带来了一些兼容性问题，尤其是对于那些依赖内部 API 的库和工具。Lombok 作为一个广泛使用的 Java 库，用于通过注解简化代码，也遇到了与模块系统的兼容性问题。

本文将详细探讨 Lombok 在使用过程中遇到的模块系统错误，分析问题的根源，并提供多种解决方案，帮助开发者顺利解决这一问题。

---

问题描述

在使用 Lombok 时，你可能会遇到以下错误：

class lombok.javac.apt.LombokProcessor (in unnamed module @0x14d1737a) cannot access class com.sun.tools.javac.processing.JavacProcessingEnvironment (in module jdk.compiler) because module jdk.compiler does not export com.sun.tools.javac.processing to unnamed module @0x14d1737a

错误分析

1. LombokProcessor：这是 Lombok 的一个核心类，用于在编译时处理注解。
2. JavacProcessingEnvironment：这是 jdk.compiler 模块中的一个内部类，用于处理 Java 编译器的注解处理环境。
3. 未命名模块（unnamed module）：指的是没有显式声明模块信息的代码，通常是通过类路径加载的代码。
4. 模块封装：Java 9 引入的模块系统默认封装了内部 API，未命名模块无法直接访问这些 API。

问题的根源在于，jdk.compiler 模块没有将 com.sun.tools.javac.processing 包导出给未命名模块，而 Lombok 需要访问这个包来完成其功能。

---

解决方案

针对上述问题，以下是几种常见的解决方案，开发者可以根据自己的需求选择合适的方法。

1. 使用 --add-exports JVM 参数

--add-exports 是 Java 9 引入的一个 JVM 参数，用于显式地将某个模块的包导出给其他模块。通过这个参数，我们可以允许未命名模块访问 jdk.compiler 模块中的 com.sun.tools.javac.processing 包。

在 Maven 中配置

如果你使用 Maven 作为构建工具，可以在 pom.xml 中添加以下配置：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.pluginsgroupId>
            <artifactId>maven-compiler-pluginartifactId>
            <version>3.11.0version>
            <configuration>
                <compilerArgs>
                    <arg>--add-exportsarg>
                    <arg>jdk.compiler/com.sun.tools.javac.processing=ALL-UNNAMEDarg>
                compilerArgs>
            configuration>
        plugin>
    plugins>
build>

在 Gradle 中配置

如果你使用 Gradle 作为构建工具，可以在 build.gradle 中添加以下配置：

tasks.withType(JavaCompile) {
    options.compilerArgs += ["--add-exports", "jdk.compiler/com.sun.tools.javac.processing=ALL-UNNAMED"]
}

直接运行 Java 程序时

如果你直接通过命令行运行 Java 程序，可以在命令中添加以下参数：

java --add-exports jdk.compiler/com.sun.tools.javac.processing=ALL-UNNAMED -jar your-application.jar

2. 升级 Lombok

Lombok 的开发团队一直在努力改进其与 Java 模块系统的兼容性。如果你使用的是较旧版本的 Lombok，建议升级到最新版本。你可以访问 Lombok 官网 下载最新版本。

3. 使用兼容的 JDK 版本

某些 JDK 版本可能对 Lombok 的支持更好。例如，JDK 8 和 JDK 11 是 Lombok 广泛测试和支持的版本。如果你使用的是较新的 JDK 版本（如 JDK 17 或更高版本），可以尝试切换到 JDK 11 或 JDK 8，看看问题是否得到解决。

4. 手动添加模块信息（高级）

如果你的项目是一个模块化项目（即使用了 module-info.java 文件），你可以通过手动添加模块信息来解决这个问题。

示例 module-info.java

在 module-info.java 文件中，显式声明对 jdk.compiler 模块的依赖，并导出必要的包：

module your.module.name {
    requires jdk.compiler; // 依赖 jdk.compiler 模块
    requires lombok;       // 依赖 Lombok 模块
    exports com.yourpackage; // 导出你的包
}

这种方法适用于高级用户，通常需要你对模块系统有较深的理解。

5. 使用 --illegal-access=permit（不推荐）

作为临时解决方案，你可以使用 --illegal-access=permit 参数来允许访问内部 API。这个参数会绕过模块系统的封装，允许未命名模块访问所有内部 API。

java --illegal-access=permit -jar your-application.jar

注意：这种方法不推荐用于生产环境，因为它会破坏模块系统的封装性，可能导致未来的兼容性问题。

---

深入理解模块系统

为了更好地理解上述解决方案，我们需要对 Java 模块系统有一个基本的了解。

什么是模块系统？

Java 模块系统（JPMS）是 Java 9 引入的一个重要特性，旨在解决以下问题：

1. 强封装性：模块可以显式地声明其导出的包，其他模块只能访问这些导出的包。
2. 依赖管理：模块可以声明其依赖的其他模块，避免类路径冲突。
3. 可维护性：通过模块化，应用程序的结构更加清晰，便于维护和扩展。

模块描述文件

模块描述文件 module-info.java 是模块系统的核心，用于定义模块的名称、依赖关系和导出的包。例如：

module com.example.myapp {
    requires java.base;          // 依赖基础模块
    requires lombok;             // 依赖 Lombok 模块
    exports com.example.myapp;   // 导出自己的包
}

未命名模块

未命名模块是指没有显式声明模块信息的代码，通常是通过类路径加载的代码。未命名模块可以访问所有导出的包，但无法访问未导出的内部 API。

---

总结

Lombok 是一个强大的工具，能够显著简化 Java 代码的编写。然而，随着 Java 模块系统的引入，Lombok 也面临了一些兼容性问题。本文详细分析了 Lombok 在使用过程中可能遇到的模块系统错误，并提供了多种解决方案，包括：

1. 使用 --add-exports JVM 参数。
2. 升级 Lombok 到最新版本。
3. 使用兼容的 JDK 版本。
4. 手动添加模块信息（适用于模块化项目）。
5. 使用 --illegal-access=permit（不推荐）。

通过本文的指导，开发者可以更好地理解 Java 模块系统，并解决 Lombok 与模块系统的兼容性问题，从而更高效地进行 Java 开发。

---

参考资料

1. Lombok 官网
2. Java 模块系统官方文档
3. Maven 官方文档
4. Gradle 官方文档

希望本文对你有所帮助！如果你有任何问题或建议，欢迎在评论区留言讨论。