当前位置：首页 > article >正文

理解 maven-jar-plugin：如何使用 Add-Opens 配置解决 Java 模块访问问题

article 2025/1/8 2:41:51

随着 Java 9 引入的模块化系统，Java 应用的构建和部署变得更加灵活，同时也带来了一些挑战。特别是当你使用反射、动态代理或者访问内部 API 时，Java 的模块系统可能会阻止你访问某些类和包。为了应对这一问题，maven-jar-plugin 插件提供了 Add-Opens 配置项，允许开发者在构建阶段通过 JAR 文件的 MANIFEST.MF 文件指定开放的模块和包，使得这些包可以被其他模块访问。

本文将详细探讨如何在 maven-jar-plugin 插件中配置 Add-Opens，以及如何利用它来解决 Java 模块系统中的访问问题，特别是如何与 ALL-UNNAMED 模块交互。

1. 什么是 Java 模块系统？

Java 9 引入了模块化系统，使得 Java 平台的构建更加模块化、可维护、可扩展。模块是对 Java 类及其相关资源的一个逻辑分组，每个模块都有一个明确的声明，标明它暴露哪些包和功能，哪些是私有的。

通过模块化，Java 提供了强大的封装性和依赖管理能力，但也带来了一些挑战，特别是对于那些依赖于反射或者需要访问内部 API 的应用程序。

2. 为什么需要 `Add-Opens`？

Java 模块系统采用了严格的访问控制，限制了跨模块访问模块内部的类和包。在很多情况下，开发者可能希望在运行时访问某些 Java 内部的包，例如使用反射读取 java.lang 包中的类，或者访问 sun.security.action 等内部 API。

然而，这些内部包通常是封装的，无法直接访问。这时，Add-Opens 配置就显得尤为重要。它允许开发者在 JAR 文件的 MANIFEST.MF 文件中声明开放某些包，使得其他模块能够访问它们。

3. `Add-Opens` 的配置方式

maven-jar-plugin 插件提供了 <archive> 元素中的 <manifestEntries> 配置项，用于自定义 JAR 文件的 MANIFEST.MF 文件。通过添加 Add-Opens 配置，开发者可以声明特定模块开放某些包。

3.1 基本配置

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-jar-plugin</artifactId>
    <version>3.2.0</version>
    <configuration>
        <archive>
            <manifestEntries>
                <!-- 开放 java.base 模块中的多个包给指定模块 -->
                <Add-Opens>java.base/java.lang=com.example.myapp</Add-Opens>
                <Add-Opens>java.base/sun.security.action=com.example.myapp</Add-Opens>
                <Add-Opens>java.base/sun.net.www.protocol.http=com.example.myapp</Add-Opens>
            </manifestEntries>
        </archive>
    </configuration>
</plugin>

3.2 语法解析

在上述配置中，Add-Opens 的语法格式为：

Add-Opens:<module-name>/<package-name>=<target-module-name>

java.base/java.lang: 这是 Java 9 中的基础模块 java.base 下的 java.lang 包。通过 Add-Opens，你可以开放 java.lang 包的访问权限，允许目标模块（在此为 com.example.myapp）访问 java.lang 中的类和成员。
java.base/sun.security.action: sun.security.action 是 Java 内部的包，包含一些安全相关的类。在一些反射操作中，可能需要访问这个包中的类。通过 Add-Opens，你可以将其开放给指定的目标模块。
java.base/sun.net.www.protocol.http: 这是 Java 内部的网络协议处理包，通常用于处理 HTTP 协议的相关操作。你可以将该包开放给其他模块，特别是那些需要进行 HTTP 请求的库。

4. `Add-Opens` 的应用场景

Add-Opens 主要用于以下几种情况：

4.1 反射和动态代理

许多 Java 库（如日志框架、序列化库）依赖于反射或者动态代理来操作对象。在 Java 9 引入模块化系统后，这些库可能会遇到访问限制，因为反射通常涉及到访问类的私有字段和方法。Add-Opens 配置可以解除这些限制，使得反射操作可以继续执行。

例如，Log4j 等日志框架可能需要访问 java.lang 包中的类，通过 Add-Opens，这些日志框架可以正常工作。

4.2 序列化

Java 的序列化机制依赖于访问对象的字段和方法。在 Java 9 及以上版本，模块化系统可能会阻止这些操作，尤其是对私有字段的访问。通过配置 Add-Opens，可以确保序列化库继续工作。

4.3 第三方库的兼容性

一些第三方库可能没有适配 Java 9 的模块化系统，但它们可能依赖于访问 Java 内部包或通过反射操作私有 API。使用 Add-Opens，你可以帮助这些库在模块化的 Java 环境下继续工作。

5. 配置示例和最佳实践

5.1 开放多个包

有时你可能需要开放多个包，可以通过多个 Add-Opens 元素来进行配置：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-jar-plugin</artifactId>
    <version>3.2.0</version>
    <configuration>
        <archive>
            <manifestEntries>
                <Add-Opens>java.base/java.lang=com.example.myapp</Add-Opens>
                <Add-Opens>java.base/sun.security.action=com.example.myapp</Add-Opens>
                <Add-Opens>java.base/sun.net.www.protocol.http=com.example.myapp</Add-Opens>
                <Add-Opens>java.base/sun.reflect.annotation=com.example.myapp</Add-Opens>
            </manifestEntries>
        </archive>
    </configuration>
</plugin>

5.2 使用 `maven-jar-plugin` 与 `maven-compiler-plugin` 配合

通常，maven-compiler-plugin 用于编译 Java 代码，而 maven-jar-plugin 用于打包生成 JAR 文件。在处理模块化的 Java 应用时，你可以同时配置这两个插件，以确保代码正确编译并生成包含 Add-Opens 配置的 JAR 文件。

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.8.1</version>
            <configuration>
                <release>11</release>
            </configuration>
        </plugin>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-jar-plugin</artifactId>
            <version>3.2.0</version>
            <configuration>
                <archive>
                    <manifestEntries>
                        <Add-Opens>java.base/java.lang=com.example.myapp</Add-Opens>
                    </manifestEntries>
                </archive>
            </configuration>
        </plugin>
    </plugins>
</build>

6. `ALL-UNNAMED`：与未命名模块交互

在 Java 模块系统中，ALL-UNNAMED 是一个特殊的模块名称，用于表示没有命名的代码或 JAR 文件。具体来说，ALL-UNNAMED 包括那些没有明确声明模块名称的类或 JAR 文件。你可以将其理解为“传统的”非模块化代码。

如果你有旧版的 JAR 文件或未模块化的代码，并且希望它们与模块化系统中的其他代码进行交互，可以通过 Add-Opens 将 Java 内部包开放给 ALL-UNNAMED 模块。这使得旧版代码能够访问模块系统中的特定包。

示例配置：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-jar-plugin</artifactId>
    <version>3.2.0</version>
    <configuration>
        <archive>
            <manifestEntries>
                <!-- 开放 java.base 模块的包给 ALL-UNNAMED -->
                <Add-Opens>java.base/java.lang=ALL-UNNAMED</Add-Opens>
                <Add-Opens>java.base/sun.security.action=ALL-UNNAMED</Add-Opens>
                <Add-Opens>java.base/sun.net.www.protocol.http=ALL-UNNAMED</Add-Opens>
            </manifestEntries>
        </archive>
    </configuration>
</plugin>

7. 总结

通过 maven-jar-plugin 的 Add-Opens 配置，开发者可以在 Java 模块化系统中处理反射、动态代理、序列化等常见需求。特别是，当你需要让传统的 JAR 文件（即 ALL-UNNAMED 模块）与现代的模块化代码交互时，Add-Opens 提供了一种非常有用的手段。通过这些配置，你可以确保即使在严格的模块化环境下，传统代码依旧能够正常工作。

查看全文

http://www.kler.cn/a/470959.html