Java中的模块
Source: Dev.to
介绍
Java 模块代表了 Java 应用程序在结构、构建和维护方式上的一次重大转变。模块在 Java 9 中作为 Java 平台模块系统（JPMS）的一部分引入，旨在解决大型代码库长期存在的可扩展性、可维护性和安全性问题。对于开发者、测试人员以及自动化爱好者来说，掌握 Java 模块是打造健壮、模块化应用程序的关键，这类应用程序更易于管理和演进。
本文将深入探讨 Java 模块是什么、它们为何重要，以及如何在项目中有效使用它们。
为什么模块在 Java 中重要
在模块引入之前，Java 应用程序在组织上严重依赖包和类路径。虽然包将相关类分组，但类路径并未提供严格的封装或明确的边界——无论是不同部分的应用程序之间，还是不同应用程序之间。
预模块化 Java 环境的主要痛点
- Classpath Hell – 在大型项目中手动管理依赖常导致冲突、版本问题或意外使用内部 API。
- Lack of Strong Encapsulation – 包不强制严格边界；任何公共类在类路径上的任何位置都可访问。
- Difficult Maintenance and Scalability – 大型单体 JAR 文件可能变得笨重，导致更新、重构和部署变得复杂。
- Runtime Performance and Security Issues – 预先加载类路径上的所有类会浪费资源或无意中暴露内部 API。
模块的引入正是为了解决这些问题。它们使开发者能够在比包更高的层次上定义清晰的依赖关系和可访问性规则，从而提升代码的模块化、安全性和可维护性。
什么是 Java 模块？
Java 模块是一个自包含的代码单元，明确声明它依赖的其他模块以及向外部导出的包。此声明位于模块内部的特殊文件 module-info.java 中。
Java 模块的关键特性
- Strong Encapsulation – 模块直接控制包对其他模块的可见性。
- Explicit Dependencies – 模块声明其运行所需的其他模块。
- Improved Security – 可以将内部 API 隐藏，防止外部访问。
- Better Performance – JVM 可以基于显式依赖优化模块加载。
Java 模块的结构
每个 Java 模块都包含一个名为 module-info.java 的描述符文件。该文件位于模块层次结构的根部，用来定义模块的名称、其依赖以及它向外暴露的内容。
示例：module-info.java
module com.example.myapp {
requires java.sql;
requires com.example.utils;
exports com.example.myapp.api;
}module com.example.myapp– 定义了一个名称为com.example.myapp的模块。requires java.sql– 声明对java.sql模块的依赖。requires com.example.utils– 依赖另一个自定义模块。exports com.example.myapp.api– 使com.example.myapp.api包对其他模块可访问。
使用模块：逐步指南
1. 创建模块
创建一个反映模块名称的项目目录结构：
myapp/
└─ src/
└─ com.example.myapp/
├─ module-info.java
└─ com/
└─ example/
└─ myapp/
└─ Main.javamodule-info.java 定义模块的元数据，而你的 Java 代码则放在相应的包目录中。
2. 编写模块描述符
在 module-info.java 中声明依赖和导出：
module com.example.myapp {
requires java.base; // 隐式必需，但可以显式声明
exports com.example.myapp.api;
}3. 编译模块
使用 javac 编译器并加上 --module-path 选项来编译模块：
javac -d out --module-source-path src $(find src -name "*.java")这会编译 src 目录下找到的所有模块，并将输出放入 out 目录。
4. 运行模块化应用
运行模块化应用时指定模块和主类：
java --module-path out -m com.example.myapp/com.example.myapp.Main模块的实际示例
考虑一个包含两个模块的简单项目：com.example.utils 和 com.example.myapp。
模块：com.example.utils
module-info.java
module com.example.utils {
exports com.example.utils.text;
}TextUtils.java
package com.example.utils.text;
public class TextUtils {
public static String toUpperCase(String input) {
return input.toUpperCase();
}
}模块：com.example.myapp
module-info.java
module com.example.myapp {
requires com.example.utils;
exports com.example.myapp.api;
}Main.java
package com.example.myapp.api;
import com.example.utils.text.TextUtils;
public class Main {
public static void main(String[] args) {
System.out.println(TextUtils.toUpperCase("hello, modules!"));
}
}使用前面展示的命令运行该应用程序将会输出：
HELLO, MODULES!其他示例
import com.example.utils.text.TextUtils;
public class Main {
public static void main(String[] args) {
String result = TextUtils.toUpperCase("hello modules");
System.out.println(result);
}
}模块依赖示例
com.example.myapp 依赖于 com.example.utils，但仅公开其自己的 API 包。
使用 Java 模块的优势
更好的可维护性
模块默认强制强封装，使代码随时间更易维护。内部实现细节被隐藏，因此模块内部的更改通常不会影响其他模块。
提升的安全性
由于模块除非显式导出，否则不会暴露内部包，敏感的内部 API 保持不可访问，从而降低攻击面。
依赖清晰
module‑info.java 清晰地声明每个模块所需的依赖，简化了构建和部署过程。
简化大型项目
模块将单体 JAR 拆分为更小、可重用的组件。团队可以独立地在不同模块上工作，促进更好的协作。
常见挑战与最佳实践
处理拆分包
拆分包是指两个模块导出相同的包名。这在模块系统中是不允许的，会导致运行时错误。
最佳实践： 通过重新组织代码，确保每个包仅由一个模块拥有，从而避免拆分包。
迁移遗留项目
遗留的 Java 项目通常拥有单体代码库且缺少模块描述符。迁移需要谨慎规划：
- 首先在较高层次上进行模块化。
- 在过渡期间使用
--patch-module选项。 - 逐步为关键模块添加
module-info.java文件。
模块命名约定
模块名称应遵循反向域名命名约定（例如 com.company.project）。这样可以避免冲突并确保唯一性。
模块与测试
对模块化应用进行测试时，需要确保测试代码能够访问被测试的模块。
测试方法
在模块中使用 opens 指令 – 允许基于反射的测试框架（如 JUnit）访问未导出的包。
module com.example.myapp {
exports com.example.myapp.api;
opens com.example.myapp.internal to org.junit.platform.commons;
}创建测试模块 – 可以在单独的模块中组织测试，并在其中声明 requires 以依赖被测试的模块。
Conclusion
Java 模块引入了一种现代、可扩展的组织应用程序和库的方法。它们解决了长期存在的依赖管理、封装和安全等诸多挑战。通过显式声明依赖并控制包的导出，模块提升了代码的清晰度、可维护性和运行时性能。
对于开发者和测试人员而言，拥抱模块系统为构建可靠且模块化的 Java 应用提供了结构化的基础。从正确的模块描述符文件入手并了解 JVM 的模块需求，能够确保项目具备面向未来的能力且更易于管理。
在采用模块时，关注明确的依赖关系，避免拆分包，并利用模块系统来保护内部 API。这样将带来更整洁的代码库、更顺畅的协作以及更强的应用鲁棒性。