Java module-info模块系统

2024-06-23 04:12
文章标签 java 模块 系统 module info

本文主要是介绍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无法加载实现类。

这篇关于Java module-info模块系统的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1086190

相关文章

如何通过海康威视设备网络SDK进行Java二次开发摄像头车牌识别详解

《如何通过海康威视设备网络SDK进行Java二次开发摄像头车牌识别详解》:本文主要介绍如何通过海康威视设备网络SDK进行Java二次开发摄像头车牌识别的相关资料,描述了如何使用海康威视设备网络SD... 目录前言开发流程问题和解决方案dll库加载不到的问题老旧版本sdk不兼容的问题关键实现流程总结前言作为

SpringBoot中使用 ThreadLocal 进行多线程上下文管理及注意事项小结

《SpringBoot中使用ThreadLocal进行多线程上下文管理及注意事项小结》本文详细介绍了ThreadLocal的原理、使用场景和示例代码,并在SpringBoot中使用ThreadLo... 目录前言技术积累1.什么是 ThreadLocal2. ThreadLocal 的原理2.1 线程隔离2

springboot将lib和jar分离的操作方法

《springboot将lib和jar分离的操作方法》本文介绍了如何通过优化pom.xml配置来减小SpringBoot项目的jar包大小,主要通过使用spring-boot-maven-plugin... 遇到一个问题,就是每次maven package或者maven install后target中的ja

Java中八大包装类举例详解(通俗易懂)

《Java中八大包装类举例详解(通俗易懂)》:本文主要介绍Java中的包装类,包括它们的作用、特点、用途以及如何进行装箱和拆箱,包装类还提供了许多实用方法,如转换、获取基本类型值、比较和类型检测,... 目录一、包装类(Wrapper Class)1、简要介绍2、包装类特点3、包装类用途二、装箱和拆箱1、装

如何利用Java获取当天的开始和结束时间

《如何利用Java获取当天的开始和结束时间》:本文主要介绍如何使用Java8的LocalDate和LocalDateTime类获取指定日期的开始和结束时间,展示了如何通过这些类进行日期和时间的处... 目录前言1. Java日期时间API概述2. 获取当天的开始和结束时间代码解析运行结果3. 总结前言在J

Java深度学习库DJL实现Python的NumPy方式

《Java深度学习库DJL实现Python的NumPy方式》本文介绍了DJL库的背景和基本功能,包括NDArray的创建、数学运算、数据获取和设置等,同时,还展示了如何使用NDArray进行数据预处理... 目录1 NDArray 的背景介绍1.1 架构2 JavaDJL使用2.1 安装DJL2.2 基本操

最长公共子序列问题的深度分析与Java实现方式

《最长公共子序列问题的深度分析与Java实现方式》本文详细介绍了最长公共子序列(LCS)问题,包括其概念、暴力解法、动态规划解法,并提供了Java代码实现,暴力解法虽然简单,但在大数据处理中效率较低,... 目录最长公共子序列问题概述问题理解与示例分析暴力解法思路与示例代码动态规划解法DP 表的构建与意义动

Java多线程父线程向子线程传值问题及解决

《Java多线程父线程向子线程传值问题及解决》文章总结了5种解决父子之间数据传递困扰的解决方案,包括ThreadLocal+TaskDecorator、UserUtils、CustomTaskDeco... 目录1 背景2 ThreadLocal+TaskDecorator3 RequestContextH

在不同系统间迁移Python程序的方法与教程

《在不同系统间迁移Python程序的方法与教程》本文介绍了几种将Windows上编写的Python程序迁移到Linux服务器上的方法,包括使用虚拟环境和依赖冻结、容器化技术(如Docker)、使用An... 目录使用虚拟环境和依赖冻结1. 创建虚拟环境2. 冻结依赖使用容器化技术(如 docker)1. 创

关于Spring @Bean 相同加载顺序不同结果不同的问题记录

《关于Spring@Bean相同加载顺序不同结果不同的问题记录》本文主要探讨了在Spring5.1.3.RELEASE版本下,当有两个全注解类定义相同类型的Bean时,由于加载顺序不同,最终生成的... 目录问题说明测试输出1测试输出2@Bean注解的BeanDefiChina编程nition加入时机总结问题说明