Skip to content

About the Project

Hei Boot provides an out-of-the-box rapid development solution, featuring comprehensive modules for permission management, system monitoring, code generation, and more. The framework adopts a front-end and back-end separation architecture, comes with a Vue3-based admin dashboard, and supports the rapid building of management systems.

Tech Stack

  • Java 21 + Spring Boot 3.5.9 + Maven
  • MyBatis-Plus 3.5.5 + Druid 1.2.21 + MySQL + Redis (Lettuce)
  • Sa-Token 1.44.0 + SM2
  • Knife4j 4.6.0
  • MapStruct 1.6.3 + Lombok 1.18.30
  • Easy-Trans 3.0.0
  • Hutool 5.8.25
  • Beetl 3.15.10.RELEASE + Fesod 2.0.1 (Excel Import & Export)
  • Multi-tenancy (MyBatis-Plus TenantLineHandler)
  • Jackson SNAKE_CASE / Snowflake ID / Logical Deletion / GMT+8 / UTF-8

Development Environment

  • Windows 11
  • PowerShell
  • Git
  • JDK 21
  • Maven 3.9.10

Project Structure

The Hei Boot framework uses Maven for multi-module management and adopts a modular development approach. To reduce coupling between modules, the basic specifications are as follows:

  • Submodules within hei-common can be referenced by other modules and provide basic rules.
  • Each hei-modules-xxx module has a corresponding hei-modules-xxx-api module interface, which is used for invocation by other modules.
  • The hei-modules-xxx-api module interface references the hei-common module, allowing modules to utilize the basic rules.
  • The hei-modules-xxx module is referenced by the main startup module hei-app and is loaded when the application starts.
  • Inter-module calls are only permitted through the API interface of the target module. Directly importing another module is strictly prohibited.
hei-boot
├── hei-common
│   ├── hei-common-core
│   ├── hei-common-xxx
│   └── ...
├── hei-modules
│   ├── hei-modules-system
│   ├── hei-modules-xxx
│   └── ...
├── hei-api
│   ├── hei-modules-system-api
│   ├── hei-modules-xxx-api
│   └── ...
└── hei-app

Maven Modular Build Commands

Updated Parameter Reference

ParameterDescription
-pl {module-path}Specifies the module path to build, e.g., hei-modules/hei-modules-sys
-amAlso builds modules that the current module depends on
-qQuiet mode, only outputs error messages
-DskipTestsSkips test execution
-DdryRunPreview mode, shows build plan without actual execution
bash
# Clean and compile the entire project
mvn clean compile

# Compile and package a specific module along with its dependencies
mvn clean package -pl {module-path} -am -q

# Compile a specific module (skip tests)
mvn clean compile -pl {module-path} -am -q -DskipTests

# Preview the build plan (dry run, no execution)
mvn clean compile -pl {module-path} -am -q -DdryRun

Released under the MIT License.