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

相关文章

JVM 的类初始化机制

前言 当你在 Java 程序中new对象时,有没有考虑过 JVM 是如何把静态的字节码(byte code)转化为运行时对象的呢,这个问题看似简单,但清楚的同学相信也不会太多,这篇文章首先介绍 JVM 类初始化的机制,然后给出几个易出错的实例来分析,帮助大家更好理解这个知识点。 JVM 将字节码转化为运行时对象分为三个阶段,分别是:loading 、Linking、initialization

Spring Security 基于表达式的权限控制

前言 spring security 3.0已经可以使用spring el表达式来控制授权,允许在表达式中使用复杂的布尔逻辑来控制访问的权限。 常见的表达式 Spring Security可用表达式对象的基类是SecurityExpressionRoot。 表达式描述hasRole([role])用户拥有制定的角色时返回true (Spring security默认会带有ROLE_前缀),去

浅析Spring Security认证过程

类图 为了方便理解Spring Security认证流程,特意画了如下的类图,包含相关的核心认证类 概述 核心验证器 AuthenticationManager 该对象提供了认证方法的入口,接收一个Authentiaton对象作为参数; public interface AuthenticationManager {Authentication authenticate(Authenti

Spring Security--Architecture Overview

1 核心组件 这一节主要介绍一些在Spring Security中常见且核心的Java类,它们之间的依赖,构建起了整个框架。想要理解整个架构,最起码得对这些类眼熟。 1.1 SecurityContextHolder SecurityContextHolder用于存储安全上下文(security context)的信息。当前操作的用户是谁,该用户是否已经被认证,他拥有哪些角色权限…这些都被保

Spring Security基于数据库验证流程详解

Spring Security 校验流程图 相关解释说明(认真看哦) AbstractAuthenticationProcessingFilter 抽象类 /*** 调用 #requiresAuthentication(HttpServletRequest, HttpServletResponse) 决定是否需要进行验证操作。* 如果需要验证,则会调用 #attemptAuthentica

Spring Security 从入门到进阶系列教程

Spring Security 入门系列 《保护 Web 应用的安全》 《Spring-Security-入门(一):登录与退出》 《Spring-Security-入门(二):基于数据库验证》 《Spring-Security-入门(三):密码加密》 《Spring-Security-入门(四):自定义-Filter》 《Spring-Security-入门(五):在 Sprin

Java架构师知识体认识

源码分析 常用设计模式 Proxy代理模式Factory工厂模式Singleton单例模式Delegate委派模式Strategy策略模式Prototype原型模式Template模板模式 Spring5 beans 接口实例化代理Bean操作 Context Ioc容器设计原理及高级特性Aop设计原理Factorybean与Beanfactory Transaction 声明式事物

不懂推荐算法也能设计推荐系统

本文以商业化应用推荐为例,告诉我们不懂推荐算法的产品,也能从产品侧出发, 设计出一款不错的推荐系统。 相信很多新手产品,看到算法二字,多是懵圈的。 什么排序算法、最短路径等都是相对传统的算法(注:传统是指科班出身的产品都会接触过)。但对于推荐算法,多数产品对着网上搜到的资源,都会无从下手。特别当某些推荐算法 和 “AI”扯上关系后,更是加大了理解的难度。 但,不了解推荐算法,就无法做推荐系

基于人工智能的图像分类系统

目录 引言项目背景环境准备 硬件要求软件安装与配置系统设计 系统架构关键技术代码示例 数据预处理模型训练模型预测应用场景结论 1. 引言 图像分类是计算机视觉中的一个重要任务,目标是自动识别图像中的对象类别。通过卷积神经网络(CNN)等深度学习技术,我们可以构建高效的图像分类系统,广泛应用于自动驾驶、医疗影像诊断、监控分析等领域。本文将介绍如何构建一个基于人工智能的图像分类系统,包括环境

水位雨量在线监测系统概述及应用介绍

在当今社会,随着科技的飞速发展,各种智能监测系统已成为保障公共安全、促进资源管理和环境保护的重要工具。其中,水位雨量在线监测系统作为自然灾害预警、水资源管理及水利工程运行的关键技术,其重要性不言而喻。 一、水位雨量在线监测系统的基本原理 水位雨量在线监测系统主要由数据采集单元、数据传输网络、数据处理中心及用户终端四大部分构成,形成了一个完整的闭环系统。 数据采集单元:这是系统的“眼睛”,