Java简易模块创建与验证指南

本文详细介绍了在java中创建和验证一个简单模块的完整过程。通过定义`module-info.java`文件来声明模块名称并导出包，然后将编译后的模块信息和类文件打包成符合特定结构的jar文件。最后，利用`jar --describe-module`命令验证所创建的jar文件是否成功成为一个模块，从而实现代码的封装与模块化管理。

1. Java模块系统概述

Java模块系统（Java Platform Module System, JPMS），也称为Jigsaw项目，是Java 9引入的一项重要特性。它旨在通过将Java平台和应用程序分解为一系列明确定义的模块来提高应用程序的可靠性、安全性、性能和可维护性。一个Java模块是一个命名的、自描述的代码和数据集合，它明确声明了其所依赖的其他模块以及它向外部世界提供的API。

2. 定义模块信息文件

创建Java模块的第一步是定义其模块描述符，即module-info.java文件。这个文件是模块的蓝图，通常放置在模块的顶级源代码目录中，与模块中的所有包目录同级。它声明了模块的唯一名称以及该模块向外部暴露的包。

例如，如果你的库包含一个名为org.foo.bar.pkgname的包，并且你希望将其作为一个名为org.foo.bar的模块导出，module-info.java文件内容应如下：

// module-info.java
module org.foo.bar {
    // 导出 org.foo.bar.pkgname 包，使其对其他模块可见
    exports org.foo.bar.pkgname;
}

• module org.foo.bar：定义了模块的唯一名称。遵循反向域名约定是一种推荐的做法。
• exports org.foo.bar.pkgname：此关键字声明org.foo.bar.pkgname包中的所有公共类型（类和接口）都将对其他模块可见和可用。未显式导出的包将被模块系统封装，外部模块无法直接访问其内容，从而实现强封装。

3. 构建模块化JAR包

在定义了module-info.java文件并编译了所有源代码后，下一步是将其打包成一个模块化的JAR文件。一个模块化的JAR文件与普通JAR文件的关键区别在于module-info.class文件的位置。

立即学习“Java免费学习笔记（深入）”；

为了使JAR文件被Java运行时识别为一个模块，编译后的module-info.class文件必须位于JAR包的根目录。典型的模块化JAR文件结构如下：

bar.jar
├── module-info.class  <-- 必须在根目录
├── org/
│   └── foo/
│       └── bar/
│           └── pkgname/
│               ├── X.class
│               └── Y.class
└── META-INF/
    └── MANIFEST.MF (可选，但常见)

你可以使用标准的javac编译器编译module-info.java和所有Java源文件，然后使用jar命令创建这样的JAR包。以下是一个示例构建流程：

假设你的源代码结构如下：

易企秀

易企秀，一体化创意设计营销平台。超100万模板1键套用3分钟制作，随时随地完成创意设计营销。

44

查看详情

project_root/
├── src/main/java/
│   ├── module-info.java
│   └── org/foo/bar/pkgname/
│       ├── MyClassX.java
│       └── MyClassY.java

编译步骤： 首先，编译所有Java源文件，包括module-info.java，并将编译后的类文件输出到一个临时目录（例如mods/org.foo.bar）：

# 1. 创建输出目录
mkdir -p mods/org.foo.bar

# 2. 编译模块信息文件和所有Java类文件
# -d 指定编译输出目录
javac -d mods/org.foo.bar src/main/java/module-info.java src/main/java/org/foo/bar/pkgname/*.java

打包步骤： 然后，使用jar命令创建模块化JAR包。关键在于使用-C选项将编译输出目录中的内容打包到JAR的根目录：

# 3. 创建模块化JAR包
# --create：创建新的JAR包
# --file：指定JAR包名称
# --module-version：可选，指定模块版本
# -C mods/org.foo.bar .：将 mods/org.foo.bar 目录下的所有内容打包到 JAR 的根目录
jar --create --file bar.jar --module-version 1.0 -C mods/org.foo.bar .

执行上述命令后，你将在当前目录中得到bar.jar文件，它是一个符合Java模块规范的模块化JAR包。

4. 验证模块

完成JAR包的创建后，你可以使用jar --describe-module命令来验证它是否成功被识别为一个Java模块，并查看其模块描述符信息。

jar --describe-module --file bar.jar

如果bar.jar是一个有效的模块，该命令将输出其模块名称、版本（如果有）、导出的包以及其依赖关系等信息。例如，你可能会看到类似如下的输出：

bar.jar
org.foo.bar@1.0
exports org.foo.bar.pkgname
requires java.base mandated

输出中的requires java.base mandated表示该模块隐式依赖于Java平台的基础模块java.base。java.base模块包含了所有Java应用程序的基础API，是所有Java模块的默认依赖，因此即使在module-info.java中没有显式声明，它也会被自动添加。

5. 总结与注意事项

创建Java模块的核心在于正确地定义module-info.java文件，并确保编译后的module-info.class文件位于最终JAR包的根目录。这种结构是Java运行时识别模块的关键。通过模块化，你可以更好地管理代码的可见性和依赖关系，从而构建更健壮、更安全、更易于维护的应用程序。

本教程仅涉及最简单的模块创建和包导出。在实际开发中，Java模块系统还包括其他重要的指令，例如：

• requires：声明对其他模块的依赖。
• uses：声明模块使用服务接口。
• provides ... with ...：声明模块提供服务接口的实现。
• opens：允许反射访问特定包中的所有类型。

理解并合理运用这些特性，将能充分发挥Java模块系统的强大功能，优化大型项目的结构和管理。

以上就是Java简易模块创建与验证指南的详细内容，更多请关注php中文网其它相关文章！