# enba-boot

**Repository Path**: mn_cxy/enba-boot

## Basic Information

- **Project Name**: enba-boot
- **Description**: 🚀enba-boot 脚手架是一个基于 Spring Boot 的开发脚手架，通过 Maven 模块化设计整合了多种常用中间件和功能组件，旨在帮助开发者快速搭建 Spring Boot 项目，减少重复开发工作，提高开发效率。
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-11-13
- **Last Updated**: 2025-10-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: SpringBoot脚手架

## README

# enba-boot 脚手架

[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/yourusername/enba-boot/blob/main/LICENSE)
[![Maven](https://img.shields.io/badge/maven-3.6.0+-blue.svg)](https://maven.apache.org/)
[![Spring Boot](https://img.shields.io/badge/jdk-1.8-green.svg)](https://spring.io/projects/spring-boot)
[![Spring Boot](https://img.shields.io/badge/spring%20boot-2.6.11-green.svg)](https://spring.io/projects/spring-boot)

`enba-boot` 脚手架是一个基于 Spring Boot 的开发脚手架，通过 Maven 模块化设计整合了多种常用中间件和功能组件，旨在帮助开发者快速搭建 Spring Boot 项目，减少重复开发工作，提高开发效率。

> **enba-boot**脚手架，作为脚手架项目，公司内部往往是会发布到maven私有仓库，方便公司内部各个业务系统开发使用。

## 核心特点

- **模块化设计**：所有功能组件集中在 `enba-boot-starters` 父模块下，每个子模块对应一类独立能力，支持按需引入
- **版本统一管理**：通过 `enba-boot-dependencies` 统一管理各组件版本，避免版本冲突
- **丰富组件集成**：涵盖数据库、缓存、安全、文件存储、API文档等多类常用组件
- **开箱即用**：提供完善的配置示例和使用文档，引入依赖即可快速使用
- **企业级支持**：整合多种企业级中间件，满足生产环境需求

## 核心依赖

|依赖|版本|
|---|---|
|spring-boot|2.6.11|
|spring-cloud|2021.0.4|
|spring-cloud-alibaba|2021.0.4.0|
|lombok|1.18.34|
|hutool|5.8.26|

---

## 模块说明

```
enba-boot
  ├─enba-boot-core ......................................................... 公共基础包：基础bean,枚举,错误码,异常等
  ├─enba-boot-dependencies ................................................. 对外暴露包定义，仅有pom文件
  ├─enba-boot-governance ................................................... 冶理相关的模块 
  ├─enba-boot-parent ....................................................... 全局jar版本控制，仅有pom文件
  ├─enba-boot-starters ...................................................... 各组件
  │     ├─enba-boot-starter ................................................. 包含所有组件总包
  │     ├─enba-boot-starter-api ............................................. 对外api组件
  │     ├─enba-boot-starter-business ......................................... 业务流程拦截组件：提供@business注解，讲业务信息添加到上下文
  │     ├─enba-boot-starter-cache ............................................ 缓存组件：提供redis实现
  │     ├─enba-boot-starter-db ............................................... 数据库组件：基于mybatis-plus 支持多数据源
  │     ├─enba-boot-starter-i18n ............................................. 国际化组件
  │     ├─enba-boot-starter-job .............................................. 调度任务组件
  │     ├─enba-boot-starter-log .............................................. 日志组件：基于logback
  │     ├─enba-boot-starter-message .......................................... 消息组件：提供阿里短信，钉钉等对接
  │     ├─enba-boot-starter-mongodb .......................................... mongodb组件
  │     ├─enba-boot-starter-openfeign ........................................ openfeign组件：支持jwt转发，超时配置，日志
  │     ├─enba-boot-starter-oss .............................................. 文件存储组件：基于阿里OSS
  │     ├─enba-boot-starter-request .......................................... 异步接口组件：用于处理异步接口
  │     ├─enba-boot-starter-security ......................................... 安全组件：token鉴权，jwt拦截等
  │     ├─enba-boot-starter-sentinel ......................................... sentinel组件
  │     ├─enba-boot-starter-swagger .......................................... swagger组件：支持聚合
  │     ├─enba-boot-starter-transaction ...................................... 事务组件：支持分布式事务
  │     ├─enba-boot-starter-uid .............................................. 分布式发号器组件：基于百度开源uidgenerator
  │     ├─enba-boot-starter-websocket ........................................ websocket组件
  │     └─ pom.xml ............................................................... 工程主pom
  ├─enba-boot-tools ........................................................ 基础工具类，兼容hutool工具包 
  └─ pom.xml ................................................................... 工程主pom
```

---

## 快速开始

方法1：继承脚手架enba-boot-parent

```xml

<parent>
  <groupId>com.enba.boot</groupId>
  <artifactId>enba-boot-parent</artifactId>
  <version>1.0.0-SNAPSHOT</version>
</parent>
```

方法2：引入脚手架enba-boot-dependencies

```xml

<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>com.enba.boot</groupId>
      <artifactId>enba-boot-dependencies</artifactId>
      <version>1.0.0-SNAPSHOT</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>
```

注释：引入成功后，方可使用脚手架的模块

## 模块引入说明

### 直接引入enba-boot-starter（无脑引入所有组件）

```xml

<dependency>
  <groupId>com.enba.boot</groupId>
  <artifactId>enba-boot-starter</artifactId>
</dependency>
```

### 引入具体组件（需要哪个引入哪个组件）

```xml

<dependencys>
  <dependency>
    <groupId>com.enba.boot</groupId>
    <artifactId>enba-boot-starter-log</artifactId>
  </dependency>
  <dependency>
    <groupId>com.enba.boot</groupId>
    <artifactId>enba-boot-starter-db</artifactId>
  </dependency>
</dependencys>
```

## 使用案例
参考此项目：https://gitee.com/mn_cxy/enba-boot-test

## 开源协议

本项目基于 [MIT](LICENSE) 协议开源。

## 贡献指南

1. Fork 本仓库
2. 创建特性分支 (`git checkout -b feature/amazing-feature`)
3. 提交更改 (`git commit -m 'Add some amazing feature'`)
4. 推送到分支 (`git push origin feature/amazing-feature`)
5. 打开 Pull Request