Java module-info模块系统

开源项目SDK：https://github.com/mingyang66/spring-parent
个人文档：https://mingyang66.github.io/raccoon-docs/#/

从Java9开始引入了模块系统（Jigsaw项目），用于更好的管理代码依赖和封装性。模块系统允许你定义模块，并指定模块之间的依赖关系，以及哪些包应该被到处或暴露给其它模块。

一、Java模块

假设我们有两个模块：module-a和module-b,下面我们定义源代码和模块描述文件module-info.java

# 目录结构
my-project/
├── module-a/
│   ├── src/
│   │   └── main/
│   │       └── java/
│   │           └── com/
│   │               └── example/
│   │                   └── modulea/
│   │                       └── ClassA.java
│   └── module-info.java
└── module-b/
    ├── src/
    │   └── main/
    │       └── java/
    │           └── com/
    │               └── example/
    │                   └── moduleb/
    │                       └── ClassB.java
    └── module-info.java

1. 在每个模块的根目录下创建module-info.java文件，这个文件定义了模块名称、到处的包级所需的依赖。

module-a/module-info.java

// 声明模块
module module.a {
    exports com.example.modulea;
}

module-b/module-info.java

// 声明模块
module module.b {
    requires module.a;
    exports com.example.moduleb;
}

• requires：依赖其它模块导出的包；
• exports：导出指定的包，供其它模块依赖使用；
• module module.b声明了一个名为module.b的模块；

二、模块中未定义module-info.java

模块中如果未定义module-info.java，那么我们在自己的项目中通过module-info.java定义依赖的时候是否可以使用？

答案：是可以的，如依赖的包名为a-b-c-starter，则系统自动会解析成模块名为a.b.c.starter,此模块中的所有包都导出

三、模块module-info.java定义模块名有没有指定的规则

官方没有明确指定具体的命名规则，只要遵从通用准则一般不会有问题，如：唯一性、建议小写字母、点号分割、允许字母数字混合。

反例：druid-spring-boot-3-starter在版本1.2.23版本及之前是没有定义module-info.java的，模块名会本默认解析为druid.spring.boot.3.starter，这样就是一个错误的模块名，会报如下错误提示：

package 'com.alibaba.druid.spring.boot3.autoconfigure.stat' is declared in module with an invalid name ('druid.spring.boot.3.starter')

四、模块系统支持单元测试

对于包含module-info.java的模块的单元测试，需要使用支持java模块系统的测试框架和构建配置，一下是设置单元测试的步骤。

• 在pom.xml文件中配置JUnit5的依赖：

        <dependency>
            <groupId>org.junit.jupiter</groupId>
            <artifactId>junit-jupiter-api</artifactId>
            <version>5.xx.xx</version>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.junit.jupiter</groupId>
            <artifactId>junit-jupiter-engine</artifactId>
            <version>5.xx.xx</version>
            <scope>test</scope>
        </dependency>

• 配置maven surefire插件，确保可以运行单元测试

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-surefire-plugin</artifactId>
            <version>3.x.x</version>
            <configuration>
                <!-- 如果需要，添加模块路径配置 -->
            </configuration>
        </plugin>
    </plugins>
</build>

• 在在路径module/src/test/java/下新建module-info.java文件

module oceansky.sensitive.test {
    requires oceansky.sensitive;
    requires org.junit.jupiter.api;
    requires org.junit.platform.engine;
    requires org.junit.platform.commons;
    opens com.emily.infrastructure.sensitive.test.entity;
    exports com.emily.infrastructure.sensitive.test;
}

以上就是配置模块系统单元测试的简单步骤，接下来就可以使用mvn clean package或mvn test命令来执行单元测试了。

五、opens指令

module-info.java文件中有一个opens指令，如下：

module your.module.name {
    opens com.emily.infrastructure.sensitive.test.entity; //开放给所有模块
    opens com.oceansky.logger to oceansky.core; //开放给特定的模块
}

• opens指令意味着这个模块开放了com.emily.infrastructure.sensitive.test.entity包，允许其它模块通过反射来访问这个包中的类、方法或字段，即使这些成员不是公共的。
• opens指令通常用于框架或库，他们需要在运行时通过反射来访问用户模块中的非公共成员，而又不想破话封装性，即不希望将包导出（exports）给所有模块。
• module-info.java文件应该放在模块的源代码的根目录下，与其他java源文件一起编译。

六、uses指令

uses指令在module-info.java中用于声明模块希望使用的服务接口，这些服务接口不必由当前模块提供，但他们将由当前模块通过服务加载机制来使用，如下：

module my.module {
    requires java.sql;
    uses java.sql.Driver;
}

这意味着my.module不提供java.sql.Driver的实现，但是可以通过服务加载机制（ServiceLoader）来查找和使用这些实现。

七、provides … with …指令

provides …with…是module-info.java中的一个指令，用于声明模块提供的服务，具体来说，它声明了模块提供哪些服务接口的实现，即：SPI的具体实现类

示例如下：

open module oceansky.logger {
    requires ch.qos.logback.classic;
    requires ch.qos.logback.core;
    requires org.slf4j;
    uses com.emily.infrastructure.logback.configuration.context.Context;
    provides com.emily.infrastructure.logback.configuration.context.Context with com.emily.infrastructure.logback.configuration.context.impl.LogbackContext;
    exports com.emily.infrastructure.logback;
    exports com.emily.infrastructure.logback.factory;
    exports com.emily.infrastructure.logback.common;
    exports com.emily.infrastructure.logback.configuration.context;
}

provides com.emily.infrastructure.logback.configuration.context.Context with com.emily.infrastructure.logback.configuration.context.impl.LogbackContext指令声明了模块oceansky.logger提供了Context接口的实现类LogbackContext，必须这样指定SPI服务，否则其它模块引用此服务的时候SPI无法加载实现类。