
本文将指导您如何在java中创建一个简单的模块。核心步骤包括定义`module-info.java`文件以导出您的包,并确保将其正确打包为一个jar文件,其中`module-info.class`位于根目录。文章还将演示如何使用`jar`工具验证您创建的模块。
引言:Java模块化系统(Jigsaw项目)
Java平台模块系统(JPMS),也被称为Jigsaw项目,自Java 9引入,旨在提高Java应用程序的可伸缩性、安全性和性能。它通过将JDK和应用程序分解为离散的模块,实现了更强的封装性和更清晰的依赖管理。创建一个简单的Java模块是掌握JPMS的基础。
一、定义模块信息:module-info.java
一个Java模块的核心是其模块描述符文件module-info.java。这个文件定义了模块的名称、它导出的包、它依赖的其他模块以及它提供的服务等信息。对于一个简单的库,如果它仅依赖于java.base(这是所有模块的隐式依赖),并且只需要对外暴露一个包,那么module-info.java的结构会非常简洁。
立即学习“Java免费学习笔记(深入)”;
1. 模块声明 在项目的顶层目录(通常是源代码根目录)创建module-info.java文件。
2. 导出包 使用exports关键字声明模块要对外提供的包。只有被导出的包,其公共类型才能被其他模块访问。
示例代码: 假设您的库包含在org.foo.bar.pkgname包中,您希望将其暴露给其他模块使用。
// src/main/java/module-info.java
module org.foo.bar {
exports org.foo.bar.pkgname;
}在这个例子中:
- org.foo.bar是您的模块名称。
- exports org.foo.bar.pkgname;表示模块org.foo.bar将org.foo.bar.pkgname包中的公共类和接口暴露给任何需要它的模块。
二、构建模块化的JAR文件
定义了module-info.java文件后,下一步是编译您的源代码并将其打包成一个可部署的JAR文件。这个JAR文件将成为一个“模块化JAR”(Modular JAR)。
1. 编译源代码 首先,您需要编译您的Java类和module-info.java文件。通常,您会使用javac命令。
# 假设您的源代码在 src/main/java 目录下 # 并且输出目录是 target/classes javac -d target/classes src/main/java/org/foo/bar/pkgname/*.java src/main/java/module-info.java
这一步会将.java文件编译成.class文件,包括module-info.class。
2. 打包为模块化JAR 使用jar命令将编译后的类文件和module-info.class打包成一个JAR文件。关键在于module-info.class必须位于JAR文件的根目录。
预期的JAR文件结构:
bar.jar
├── module-info.class
└── org/
└── foo/
└── bar/
└── pkgname/
├── X.class
└── Y.class示例打包命令:
采用目前业界最流行的模版编译系统,所有的页面都可以实现在线/离线修改,只需简单掌握HTML的知识,就可以轻松创建属于自己的个性化的专业用户界面,内建多语言包替换模块,独创的商品参数模版系统,强大的后台管理支持和数据备份功能
# 假设编译后的类文件在 target/classes 目录下 jar --create --file bar.jar -C target/classes .
这里的-C target/classes .命令指示jar工具将target/classes目录下的所有内容(包括module-info.class和org目录)添加到JAR的根目录。
三、验证模块
创建了模块化JAR之后,您可以使用jar工具的--describe-module选项来验证它是否被正确识别为一个模块,并查看其模块描述符信息。
示例验证命令:
jar --describe-module --file bar.jar
预期输出示例:
bar.jar org.foo.bar@1.0.0 exports org.foo.bar.pkgname requires java.base mandated
(注意:@1.0.0是版本信息,如果JAR清单中没有指定,可能不会显示。mandated表示java.base是隐式依赖。)
如果输出显示了模块名称、导出的包以及java.base的依赖,那么恭喜您,您已成功创建并验证了一个简单的Java模块。
四、注意事项与总结
- module-info.class的位置:务必确保module-info.class文件位于JAR的根目录。这是识别一个JAR为模块的关键。
- 隐式依赖:所有模块都隐式依赖java.base,因此您无需在module-info.java中明确声明requires java.base;。
- exports与opens:exports用于在编译时和运行时暴露包给其他模块访问。如果需要通过反射深度访问(即使是私有成员),则需要使用opens关键字。对于简单模块,exports通常足够。
-
更复杂的模块:当您的模块需要依赖其他自定义模块或JDK的其他模块(如java.sql, java.desktop等)时,您需要在module-info.java中使用requires关键字明确声明这些依赖。
module my.app { requires java.sql; // 声明对java.sql模块的依赖 exports my.app.api; } - 版本管理:虽然本教程未涉及,但在实际项目中,模块通常会包含版本信息,这可以在module-info.java中通过module org.foo.bar { version "1.0"; ... }来指定,或通过JAR清单文件。
通过遵循上述步骤,您可以轻松创建、打包并验证您的第一个Java模块。理解模块化对于构建可维护、可扩展的现代Java应用程序至关重要。









