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

相关文章

Spring事务传播机制最佳实践

《Spring事务传播机制最佳实践》Spring的事务传播机制为我们提供了优雅的解决方案,本文将带您深入理解这一机制,掌握不同场景下的最佳实践,感兴趣的朋友一起看看吧... 目录1. 什么是事务传播行为2. Spring支持的七种事务传播行为2.1 REQUIRED(默认)2.2 SUPPORTS2

怎样通过分析GC日志来定位Java进程的内存问题

《怎样通过分析GC日志来定位Java进程的内存问题》:本文主要介绍怎样通过分析GC日志来定位Java进程的内存问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、GC 日志基础配置1. 启用详细 GC 日志2. 不同收集器的日志格式二、关键指标与分析维度1.

Java进程异常故障定位及排查过程

《Java进程异常故障定位及排查过程》:本文主要介绍Java进程异常故障定位及排查过程,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、故障发现与初步判断1. 监控系统告警2. 日志初步分析二、核心排查工具与步骤1. 进程状态检查2. CPU 飙升问题3. 内存

java中新生代和老生代的关系说明

《java中新生代和老生代的关系说明》:本文主要介绍java中新生代和老生代的关系说明,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、内存区域划分新生代老年代二、对象生命周期与晋升流程三、新生代与老年代的协作机制1. 跨代引用处理2. 动态年龄判定3. 空间分

Java设计模式---迭代器模式(Iterator)解读

《Java设计模式---迭代器模式(Iterator)解读》:本文主要介绍Java设计模式---迭代器模式(Iterator),具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,... 目录1、迭代器(Iterator)1.1、结构1.2、常用方法1.3、本质1、解耦集合与遍历逻辑2、统一

Java内存分配与JVM参数详解(推荐)

《Java内存分配与JVM参数详解(推荐)》本文详解JVM内存结构与参数调整,涵盖堆分代、元空间、GC选择及优化策略,帮助开发者提升性能、避免内存泄漏,本文给大家介绍Java内存分配与JVM参数详解,... 目录引言JVM内存结构JVM参数概述堆内存分配年轻代与老年代调整堆内存大小调整年轻代与老年代比例元空

深度解析Java DTO(最新推荐)

《深度解析JavaDTO(最新推荐)》DTO(DataTransferObject)是一种用于在不同层(如Controller层、Service层)之间传输数据的对象设计模式,其核心目的是封装数据,... 目录一、什么是DTO?DTO的核心特点:二、为什么需要DTO?(对比Entity)三、实际应用场景解析

Java 线程安全与 volatile与单例模式问题及解决方案

《Java线程安全与volatile与单例模式问题及解决方案》文章主要讲解线程安全问题的五个成因(调度随机、变量修改、非原子操作、内存可见性、指令重排序)及解决方案,强调使用volatile关键字... 目录什么是线程安全线程安全问题的产生与解决方案线程的调度是随机的多个线程对同一个变量进行修改线程的修改操

从原理到实战深入理解Java 断言assert

《从原理到实战深入理解Java断言assert》本文深入解析Java断言机制,涵盖语法、工作原理、启用方式及与异常的区别,推荐用于开发阶段的条件检查与状态验证,并强调生产环境应使用参数验证工具类替代... 目录深入理解 Java 断言(assert):从原理到实战引言:为什么需要断言?一、断言基础1.1 语

深度解析Java项目中包和包之间的联系

《深度解析Java项目中包和包之间的联系》文章浏览阅读850次,点赞13次,收藏8次。本文详细介绍了Java分层架构中的几个关键包:DTO、Controller、Service和Mapper。_jav... 目录前言一、各大包1.DTO1.1、DTO的核心用途1.2. DTO与实体类(Entity)的区别1