Java简易模块构建教程-java教程-PHP中文网

Java简易模块构建教程

DDD

发布： 2025-11-07 19:46:33

原创

836人浏览过

Java简易模块构建教程

本教程旨在指导您如何在java中创建一个基础模块。核心步骤包括定义`module-info.java`文件以声明模块并导出其包，然后将编译后的`module-info.class`放置在jar包的根目录。文章将涵盖模块声明、jar包结构及模块验证方法，助您快速掌握java模块化的基础实践。

引言：Java模块化系统简介

自Java 9引入Java平台模块系统（JPMS，Project Jigsaw）以来，模块化成为了组织和管理大型Java应用程序的新标准。模块化旨在提高应用程序的可靠性、安全性、性能和可维护性。一个简单的Java模块，通常是一个包含特定功能集合的JAR文件，它明确声明了自己所依赖的其他模块以及对外提供的API（即导出的包）。

第一步：定义模块描述符 module-info.java

创建Java模块的第一步是编写一个模块描述符文件，命名为module-info.java。这个文件必须放置在模块源代码的根目录下。它用于声明模块的名称，并指定该模块导出的包（即哪些包可以被其他模块访问）以及它所依赖的其他模块。

对于一个只包含一个包的简单库，并且该库只依赖于java.base（所有Java模块都隐式依赖java.base），module-info.java文件的内容会非常简洁。

示例代码：

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

假设您的库包含在org.foo.bar.pkgname包中，模块描述符文件module-info.java将如下所示：

module org.foo.bar {
    // 声明模块名称为 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包中的公共类型（类和接口）可以被其他依赖此模块的模块访问。如果没有exports声明，即使是公共类也只能在模块内部使用。

第二步：编译与打包模块

完成module-info.java文件的编写后，接下来需要编译源代码并将其打包成一个JAR文件。

1. 编译模块：

使用javac命令编译您的Java源文件，包括module-info.java。

# 假设您的源代码结构如下：
# src/org.foo.bar/module-info.java
# src/org.foo.bar/org/foo/bar/pkgname/X.java
# src/org.foo.bar/org/foo/bar/pkgname/Y.java

# 编译模块源代码
javac -d out/org.foo.bar src/org.foo.bar/module-info.java src/org.foo.bar/org/foo/bar/pkgname/*.java

登录后复制

这会将编译后的.class文件（包括module-info.class）输出到out/org.foo.bar目录。

2. 打包为模块化JAR：

超级简历WonderCV

免费求职简历模版下载制作，应届生职场人必备简历制作神器

150

查看详情

使用jar命令将编译后的类文件打包成一个JAR文件。关键在于，编译后的module-info.class文件必须位于JAR包的根目录。

正确的JAR包内部结构示例：

bar.jar
├── module-info.class
└── org/
    └── foo/
        └── bar/
            └── pkgname/
                ├── X.class
                └── Y.class

登录后复制

要创建这样的JAR文件，可以执行以下命令：

# 进入编译输出目录
cd out/org.foo.bar

# 创建JAR文件
jar --create --file ../../bar.jar .
# 或者
# jar -c -f ../../bar.jar .

登录后复制

这里的--create（或-c）表示创建新的JAR文件，--file ../../bar.jar（或-f ../../bar.jar）指定JAR文件的名称和路径，.表示将当前目录下的所有内容（包括module-info.class和org目录）打包进去。

第三步：验证模块

完成打包后，您可以使用jar工具来验证您的JAR文件是否被正确识别为一个模块。

验证命令：

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

登录后复制

预期输出：

如果您的JAR文件被正确构建为模块，该命令将输出模块的详细信息，例如：

bar.jar
module org.foo.bar {
  exports org.foo.bar.pkgname;
  requires java.base; // 隐式依赖
}

登录后复制

这表明bar.jar被识别为一个名为org.foo.bar的模块，它导出了org.foo.bar.pkgname包，并且隐式依赖于java.base模块。

注意事项与最佳实践

模块路径与类路径： Java模块系统引入了“模块路径”（Module Path）的概念，与传统的“类路径”（Classpath）并行。当您使用模块时，需要将其放置在模块路径上，而不是类路径上。
依赖其他模块： 如果您的模块需要使用其他非java.base模块的功能，您需要在module-info.java中使用requires关键字明确声明这些依赖。例如：requires java.sql;。
模块命名： 遵循反向域名约定来命名模块，例如com.example.mymodule，以确保模块名称的全球唯一性。
开放包（Open Package）： 如果您需要允许其他模块通过反射访问您的包中的所有类型，可以使用opens关键字而不是exports。这在某些框架（如Spring、Hibernate）中可能需要。

总结

创建一个简单的Java模块主要涉及两个核心步骤：首先，定义一个module-info.java文件来声明模块名称并导出其公共包；其次，确保在将模块打包成JAR文件时，编译后的module-info.class文件位于JAR的根目录。通过遵循这些步骤并利用jar --describe-module命令进行验证，您可以轻松地将您的Java库转换为模块化的组件，从而更好地利用Java平台模块系统的优势。

以上就是Java简易模块构建教程的详细内容，更多请关注php中文网其它相关文章！