4.9 KiB

Raw Permalink Blame History

Maven-aggregation Quickstart

Maven-aggregation Quickstart 是一个 IntelliJ IDEA 插件，用于快速生成标准的多模块 Maven 项目结构。通过该插件，你可以一键创建模块化项目，并自动配置模块间的依赖关系，同时支持自定义模块名称和 Java 版本，非常适合用于 Java 项目的快速启动。

📌 主要功能

一键创建 Maven 多模块项目结构
自动生成模块间的依赖关系
支持自定义模块名称
支持选择 Java 版本（8/11/17/21）
自动生成项目 README.md 和 .gitignore 文件
支持单模块DDD架构和多模块架构两种模式
自动添加常用依赖（Lombok、Hutool、SLF4J、Logback、Swagger、JUnit等）

🚀 使用方法

1. 安装插件

打开 IntelliJ IDEA。
进入 Settings (Preferences) > Plugins。
点击 Marketplace 标签。
搜索 Maven-aggregation Quickstart。
点击 Install 安装插件。
重启 IntelliJ IDEA。

2. 创建项目

在 IntelliJ IDEA 中创建一个空项目（Empty Project）。
点击菜单 File > New > Create Maven Aggregation Project。
填写以下信息：
- GroupId: Maven 项目的组织标识（例如：com.example）
- ArtifactId: 项目名称
- Version: 项目版本（默认 1.0.0）
- 选择架构模式：单模块DDD架构或多模块架构
- 模块名称：输入多个模块名称（例如：api, service, pojo）
- Java 版本：选择项目使用的 Java 版本（8/11/17/21）
- 常用依赖：选择需要添加的依赖（Lombok、Hutool、SLF4J等）
点击 Finish，插件会自动生成项目结构。

📁 项目结构示例

多模块架构项目结构

your-project-name/
├── api/              # 对外暴露的 API 接口模块
├── service/          # 业务逻辑模块
├── mapper/           # 数据访问层模块
├── pojo/             # 实体类模块
├── common/           # 公共工具类和通用组件模块
└── pom.xml           # 父级 Maven 配置文件

每个模块都包含以下标准目录结构：
module-name/
├── src/
│   ├── main/
│   │   ├── java/           # Java 源代码
│   │   └── resources/      # 静态资源文件
│   └── test/
│       └── java/           # 测试代码
└── pom.xml                 # 模块级 Maven 配置文件

单模块DDD架构项目结构

your-project-name/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/example/yourproject/
│   │   │       ├── application/     # 应用层
│   │   │       ├── domain/          # 领域层
│   │   │       ├── infrastructure/  # 基础设施层
│   │   │       └── interfaces/      # 接口层
│   │   └── resources/
│   └── test/
│       └── java/
├── pom.xml
├── README.md
└── .gitignore

🧩 模块说明

多模块架构模块说明

模块名称	说明
`api`	对外暴露的 API 接口模块
`common`	公共工具类和通用组件模块
`mapper`	数据访问层模块（通常用于数据库操作）
`pojo`	实体类模块
`service`	业务逻辑模块

注意：你可以自定义模块名称，插件会自动识别并生成对应描述。

单模块DDD架构层级说明

层级	说明
`application`	应用层，负责业务流程控制和用例实现
`domain`	领域层，包含核心业务逻辑和领域模型
`infrastructure`	基础设施层，提供技术实现和外部依赖
`interfaces`	接口层，负责对外提供服务接口

🧪 构建项目

生成的 Maven 项目可以使用标准的 Maven 命令进行构建：

# 清理项目
mvn clean

# 编译项目
mvn compile

# 运行测试
mvn test

# 打包项目
mvn package

# 安装到本地仓库
mvn install

🛠️ 开发与构建插件

如果你希望修改插件或构建插件源码，请参考以下步骤：

1. 克隆仓库

git clone https://github.com/yourname/maven-aggregation.git
cd maven-aggregation

2. 构建插件

使用 Gradle 构建插件：

# 清理项目
./gradlew clean

# 构建项目
./gradlew build

构建完成后，插件的 .jar 文件会生成在 build/libs/ 目录下。

3. 安装插件到 IntelliJ IDEA

打开 IntelliJ IDEA。
进入 Settings (Preferences) > Plugins。
点击 Install Plugin from Disk...。
选择 build/libs/maven-aggregation-1.1.1.jar。
安装并重启 IntelliJ IDEA.

📞 联系我们

如果你有任何问题或建议，请联系：

📧 Email: 1938023944@qq.com
🌐 Website: https://www.wandong.com

4.9 KiB Raw Permalink Blame History