7.5 KiB

Raw Blame History

Maven-aggregation Quickstart

Maven-aggregation Quickstart is an IntelliJ IDEA plugin designed to quickly generate standard multi-module Maven project structures. With this plugin, you can create modular projects with one click and automatically configure dependencies between modules. It also supports custom module names and Java versions, making it perfect for rapid Java project startup.

📌 Key Features

One-click creation of Maven multi-module project structure
Automatic generation of dependencies between modules
Support for custom module names
Support for Java version selection (8/11/17/21)
Automatic generation of project README.md and .gitignore files
Support for both single-module DDD architecture and multi-module architecture
Automatic addition of common dependencies (Lombok, Hutool, SLF4J, Logback, Swagger, JUnit, etc.)

🚀 Usage

1. Install the Plugin

Open IntelliJ IDEA.
Go to Settings (Preferences) > Plugins.
Click on the Marketplace tab.
Search for Maven-aggregation Quickstart.
Click Install to install the plugin.
Restart IntelliJ IDEA.

2. Create a Project

Create an empty project in IntelliJ IDEA.
Click on the menu File > New > Create Maven Aggregation Project.
Fill in the following information:
- GroupId: The organization identifier for the Maven project (e.g. com.example)
- ArtifactId: Project name
- Version: Project version (default 1.0.0)
- Select architecture mode: Single-module DDD architecture or multi-module architecture
- Module names: Enter multiple module names (e.g. api, service, pojo)
- Java version: Select the Java version used by the project (8/11/17/21)
- Common dependencies: Select dependencies to add (Lombok, Hutool, SLF4J, etc.)
Click Finish, and the plugin will automatically generate the project structure.

📁 Project Structure Examples

Multi-module Architecture Project Structure

your-project-name/
├── api/              # API interface module exposed to the outside world
├── service/          # Business logic module
├── mapper/           # Data access layer module
├── pojo/             # Entity class module
├── common/           # Public utility class and common component module
└── pom.xml           # Parent Maven configuration file

Each module contains the following standard directory structure:
module-name/
├── src/
│   ├── main/
│   │   ├── java/           # Java source code
│   │   └── resources/      # Static resource files
│   └── test/
│       └── java/           # Test code
└── pom.xml                 # Module-level Maven configuration file

Single-module DDD Architecture Project Structure

your-project-name/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/example/yourproject/
│   │   │       ├── application/     # Application layer
│   │   │       ├── domain/          # Domain layer
│   │   │       ├── infrastructure/  # Infrastructure layer
│   │   │       └── interfaces/      # Interface layer
│   │   └── resources/
│   └── test/
│       └── java/
├── pom.xml
├── README.md
└── .gitignore

🧩 Module Descriptions

Multi-module Architecture Module Descriptions

Module Name	Description
`api`	API interface module exposed to the outside world
`common`	Public utility class and common component module
`mapper`	Data access layer module (usually used for database operations)
`pojo`	Entity class module
`service`	Business logic module

Note: You can customize module names, and the plugin will automatically recognize and generate corresponding descriptions.

Single-module DDD Architecture Layer Descriptions

Layer	Description
`application`	Application layer, responsible for business process control and use case implementation
`domain`	Domain layer, containing core business logic and domain models
`infrastructure`	Infrastructure layer, providing technical implementation and external dependencies
`interfaces`	Interface layer, responsible for providing external service interfaces

🧪 Building the Project

The generated Maven project can be built using standard Maven commands:

# Clean the project
mvn clean

# Compile the project
mvn compile

# Run tests
mvn test

# Package the project
mvn package

# Install to local repository
mvn install

🛠️ Plugin Development and Building

If you want to modify or build the plugin from source code, please follow these steps:

1. Clone the Repository

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

2. Build the Plugin

Use Gradle to build the plugin:

# Clean the project
./gradlew clean

# Build the project
./gradlew build

After building, the plugin .jar file will be generated in the build/libs/ directory.

3. Install the Plugin in IntelliJ IDEA

Open IntelliJ IDEA.
Go to Settings (Preferences) > Plugins.
Click Install Plugin from Disk....
Select build/libs/maven-aggregation-1.1.1.jar.
Install and restart IntelliJ IDEA.

💖 Support the Project

If you find this plugin helpful, please consider supporting the project. Your support will help us continue to improve and maintain this plugin. You can support us through the following ways:

Alipay (Chinese users)	WeChat Pay (Chinese users)	PayPal (International users)

Buy Me a Coffee (International users)	GitHub Sponsors (International users)	Open Collective (International users)