1. 引言：Java模块化系统概述
java 9引入的模块化系统（java platform module system, jpms，也称jigsaw项目）是java平台架构的一次重大变革。它旨在提高应用程序的可靠性、安全性、性能和可维护性。通过模块化，开发者可以更清晰地定义组件之间的依赖关系，限制内部api的访问，从而构建更健壮的应用。
在现代集成开发环境（IDE）如IntelliJ IDEA中，正确配置和管理Java模块化项目至关重要。随着IntelliJ IDEA版本的不断更新，其对Java模块化的支持也日益完善。因此，确保IDE和JDK版本与项目需求兼容是成功运行模块化应用的第一步。
2. IntelliJ IDEA中Java模块化项目的基本设置
在IntelliJ IDEA中创建和配置Java模块化项目需要注意几个关键点，尤其是在处理多模块结构时。
2.1 确保IDE版本与JDK兼容性
首先，强烈建议使用最新版本的IntelliJ IDEA。新版本通常包含对最新JDK特性和Java模块化系统的优化支持，可以避免因IDE版本过旧而导致的兼容性问题，例如运行/调试选项灰色等。
-
更新IntelliJ IDEA: 确保您的IntelliJ IDEA是最新版本（例如2021.3.2或更高）。
立即学习“Java免费学习笔记（深入）”；
-
选择合适的JDK: 在项目设置中，确保已为项目和所有模块配置了Java 9或更高版本的JDK。
- 进入 File > Project Structure...。
- 在 Project Settings > Project 下，选择 Project SDK 为 Java 9+ 版本（例如 Java 11 或 Java 17）。
- 在 Project Settings > Modules 下，为每个模块（包括根项目模块，如果存在）设置正确的 Language level 和 Module SDK。
2.2 创建模块化项目结构
在IntelliJ IDEA中，一个Java模块化项目通常是一个多模块项目。
-
创建新项目:
- 选择 File > New > Project...。
- 选择 New Project，然后在左侧选择 Gradle 或 Maven（如果使用构建工具），或者选择 Java。
- 勾选 Create Git repository（可选）。
- 选择 JDK 为 Java 9+。
- 勾选 Add sample code（可选）。
- 点击 Next。
- 输入 GroupId、ArtifactId 和 Version。
- 点击 Create。
-
添加模块:
- 右键点击项目根目录，选择 New > Module。
- 选择 New Module，然后选择 Java。
- 输入模块名称（例如 app 或 lib）。
- 确保模块的JDK设置为Java 9+。
- 在每个模块的 src/main/java 目录下，创建 module-info.java 文件。
2.3 配置module-info.java
module-info.java是Java模块化系统的核心，它定义了模块的名称、导出的包、所需的依赖模块以及允许反射访问的包。
基本语法：
module com.example.mymodule {
// 导出包，允许其他模块访问这些包中的公共类型
exports com.example.mymodule.api;
// 声明对其他模块的依赖
requires java.base; // 隐式依赖，通常不需要显式声明
requires com.example.anothermodule;
// 允许其他模块通过反射访问此模块的特定包（即使不导出）
opens com.example.mymodule.internal to com.example.reflectionuser;
// 声明服务提供者
provides com.example.service.MyService with com.example.service.impl.MyServiceImpl;
// 声明服务消费者
uses com.example.service.AnotherService;
}3. 结合Gradle构建模块化项目
对于大型或多模块项目，使用Gradle等构建工具是最佳实践。Gradle能够很好地支持Java模块化项目。
3.1 build.gradle配置
在Gradle项目中，每个模块通常有自己的build.gradle文件。
根项目 settings.gradle：
rootProject.name = 'my-modular-app' include 'app', 'lib' // 包含子模块
库模块 (lib) 的 build.gradle：
plugins {
id 'java-library' // 适用于库模块
}
group 'com.example'
version '1.0-SNAPSHOT'
repositories {
mavenCentral()
}
dependencies {
// 库模块可能没有外部依赖，或者有内部依赖
testImplementation 'org.junit.jupiter:junit-jupiter-api:5.8.1'
testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.8.1'
}
java {
// 确保使用Java 9+版本
toolchain {
languageVersion = JavaLanguageVersion.of(17) // 或 11
}
}
test {
useJUnitPlatform()
}应用模块 (app) 的 build.gradle：
plugins {
id 'application' // 适用于包含主类的应用模块
}
group 'com.example'
version '1.0-SNAPSHOT'
repositories {
mavenCentral()
}
dependencies {
// 声明对库模块的依赖
implementation project(':lib')
// 其他外部依赖
testImplementation 'org.junit.jupiter:junit-jupiter-api:5.8.1'
testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.8.1'
}
java {
toolchain {
languageVersion = JavaLanguageVersion.of(17) // 或 11
}
}
// 配置主类，用于Gradle的'run'任务
application {
mainModule = 'com.example.app' // module-info.java 中定义的模块名
mainClass = 'com.example.app.Main' // 主类的全限定名
}
test {
useJUnitPlatform()
}3.2 运行配置
在IntelliJ IDEA中，当您正确配置了Gradle项目后，IntelliJ会自动识别并生成运行配置。
- 通过Gradle运行: 您可以直接在IntelliJ IDEA的Gradle工具窗口中，双击 app 模块下的 run 任务来运行应用程序。
- 通过IntelliJ IDEA运行: 如果mainModule和mainClass在build.gradle中正确配置，IntelliJ IDEA会识别到主类，并在Main.java文件中提供运行/调试选项。
4. 示例：一个简单的多模块应用
以下是一个简单的Java模块化多模块应用的示例结构和代码。
项目结构：
my-modular-app/ ├── app/ │ ├── src/main/java/com/example/app/ │ │ ├── module-info.java │ │ └── Main.java │ └── build.gradle ├── lib/ │ ├── src/main/java/com/example/lib/ │ │ ├── module-info.java │ │ └── MyService.java │ └── build.gradle ├── settings.gradle └── build.gradle (根项目，可选，通常用于定义所有子模块通用的配置)
lib/src/main/java/com/example/lib/module-info.java：
module com.example.lib {
exports com.example.lib; // 导出com.example.lib包
}lib/src/main/java/com/example/lib/MyService.java：
package com.example.lib;
public class MyService {
public String getMessage() {
return "Hello from MyService in lib module!";
}
}app/src/main/java/com/example/app/module-info.java：
module com.example.app {
requires com.example.lib; // 声明依赖com.example.lib模块
}app/src/main/java/com/example/app/Main.java：
package com.example.app;
import com.example.lib.MyService;
public class Main {
public static void main(String[] args) {
MyService service = new MyService();
System.out.println(service.getMessage());
}
}app/build.gradle (如前文所示):
// ... (plugins, group, version, repositories) ...
dependencies {
implementation project(':lib') // 依赖lib模块
}
// ... (java toolchain) ...
application {
mainModule = 'com.example.app'
mainClass = 'com.example.app.Main'
}
// ...5. 常见问题与解决方案
在配置和运行Java模块化项目时，可能会遇到一些问题。
5.1 运行/调试选项灰色
这是最常见的问题之一。如果您的main()方法旁边的运行/调试图标是灰色的，通常意味着IntelliJ IDEA未能正确识别该类为可执行的入口点。
可能的原因及解决方案：
- JDK版本问题: 确保项目和模块的SDK均设置为Java 9或更高版本。
-
module-info.java配置不正确:
- 确保模块中存在module-info.java文件。
- 如果主类在一个包中，确保该包被正确导出（尽管对于应用模块的主类，通常不需要导出）。
- 对于应用模块，module-info.java通常只包含requires语句。
-
IntelliJ IDEA缓存或同步问题:
- 尝试 File > Invalidate Caches / Restart...。
- 对于Gradle项目，在Gradle工具窗口中点击 Refresh 按钮，强制IntelliJ IDEA重新导入项目。
- 检查 Project Structure > Modules，确保每个模块的 Sources 路径正确，并且 module-info.java 被正确识别。
- 构建工具配置问题: 如果使用Gradle或Maven，请确保build.gradle或pom.xml中主类和主模块的配置正确无误。对于Gradle，确保application插件和mainModule/mainClass设置正确。
- 主类不在导出包中: 虽然不常见，但如果主类所在的包没有被module-info.java导出，可能会导致问题。通常，应用模块的主类不需要导出其包。
5.2 模块路径问题
当一个模块依赖另一个模块时，如果依赖关系未正确声明，可能会出现java.lang.module.FindException或package not found错误。
- 解决方案: 确保在依赖模块的module-info.java中通过requires语句声明了对被依赖模块的依赖。例如，如果app模块使用lib模块的功能，则app模块的module-info.java必须包含requires com.example.lib;。
5.3 资源文件访问问题
Java模块化系统对资源文件的访问也做了限制。如果需要访问模块内部的非代码资源文件，可能需要使用opens语句。
- exports vs opens: exports允许其他模块访问导出包中的公共类型，而opens允许其他模块通过反射访问指定包中的所有类型，即使它们不是公共的。
6. 总结
在现代IntelliJ IDEA中配置和运行Java模块化项目，关键在于理解Java模块化系统的核心概念（如module-info.java），并结合IDE和构建工具（如Gradle）进行正确配置。确保IDE和JDK版本是最新的，正确设置项目和模块的JDK，并仔细检查module-info.java和build.gradle中的依赖和导出声明，是避免常见问题的有效途径。通过遵循本教程的指导，您将能够更高效、更顺畅地开发和部署您的Java模块化应用程序。
