# mx-spring-modules

**Repository Path**: xjpVips/mx-spring-modules

## Basic Information

- **Project Name**: mx-spring-modules
- **Description**: springboot开发包
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2021-10-11
- **Last Updated**: 2026-09-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# mx-spring-modules

基于 Spring Boot 3.5.x / Java 21 的企业级快速开发模块库，提供可复用的功能组件，按需引入、开箱即用。

## 模块总览

| 模块                                                  | 说明        | 核心能力                                                                             |
|-------------------------------------------------------|-------------|--------------------------------------------------------------------------------------|
| **[mx-spring-dev](mx-spring-dev/)**                   | 💎 核心基础 | 统一响应 MxResult、全局异常、请求日志、分页、大数字序列化、CORS、IP 归属地、校验注解 |
| **[mx-spring-jdbc](mx-spring-jdbc/)**                 | 🗄️ 数据源   | MyBatis-Plus 增强、MxBaseMapper 批量操作、动态多数据源（MySQL + ClickHouse）         |
| **[mx-spring-redis](mx-spring-redis/)**               | 🚀 缓存/锁  | RedisTemplate 自动配置、Redisson 分布式锁（普通锁/公平锁/读写锁）                    |
| **[mx-spring-security](mx-spring-security/)**         | 🔐 安全认证 | Sa-Token RBAC、多租户、扫码登录、账号锁定、操作日志                                  |
| **[mx-spring-upload](mx-spring-upload/)**             | 📁 文件上传 | 统一 API，支持本地 / MinIO / 七牛 / 腾讯COS / 阿里OSS，缩略图生成                    |
| **[mx-spring-sms](mx-spring-sms/)**                   | 📩 短信     | 多通道切换：腾讯云 / 阿里云 / 中国网建                                               |
| **[mx-spring-captcha](mx-spring-captcha/)**           | 🔑 验证码   | 短信验证码服务，Caffeine / Redis 双后端，自动降级                                    |
| **[mx-spring-excel](mx-spring-excel/)**               | 📊 Excel    | 基于 Fesod，简单导入/流式大批量导入/多Sheet导出/模板填充，丰富数据转换器             |
| **[mx-spring-task](mx-spring-task/)**                 | ⏰ 定时任务 | Quartz 调度，7 字段 cron 含年份，动态注册/启停，一次性任务                           |
| **[mx-spring-netty](mx-spring-netty/)**               | 🌐 网络通信 | TCP Server/Client、WebSocket、心跳检测、断线重连、多实例管理                         |
| **[mx-spring-mqtt](mx-spring-mqtt/)**                 | 📡 MQTT     | Eclipse Paho 多客户端、SSL/TLS、遗嘱消息、自动重连                                   |
| **[mx-spring-modbus](mx-spring-modbus/)**             | ⚙️ 工业协议 | Modbus TCP 从站，多从站模式                                                          |
| **[mx-spring-work-robot](mx-spring-work-robot/)**     | 🤖 消息推送 | 企业微信机器人，文本 / Markdown                                                      |
| **[mx-spring-maven-plugin](mx-spring-maven-plugin/)** | 🔧 代码生成 | 根据数据库表自动生成实体类 + Mapper + XML                                            |
| **[mx-spring-package](mx-spring-package/)**           | 📦 打包部署 | Assembly 打包 + Shell 脚本（启停/注册服务）                                          |
| **[mx-spring-app](mx-spring-app/)**                   | 🏗️ 骨架项目 | Demo 业务骨架 + Admin 监控面板                                                       |
| **[misc](misc/)**                                     | 📖 配置参考 | 完整 application-full.yml，覆盖所有模块配置                                          |

## 环境要求

- **JDK** 21+
- **Maven** 3.6+
- **Spring Boot** 3.5.16

## 快速开始

```bash
# 1. 克隆并安装
git clone <url>
cd mx-spring-modules
mvn clean install -DskipTests

# 2. 运行骨架项目
cd mx-spring-app
mvn spring-boot:run -pl admin   # Admin 监控 → http://localhost:9090
mvn spring-boot:run -pl demo    # 业务服务 → http://localhost:8080
```

## 按需引入

在业务项目 pom.xml 中引入所需模块即可：

```xml

<dependency>
    <groupId>com.mx.modules</groupId>
    <artifactId>mx-spring-dev</artifactId>
</dependency>
<dependency>
<groupId>com.mx.modules</groupId>
<artifactId>mx-spring-jdbc</artifactId>
</dependency>
        <!-- 按需引入其他模块 -->
```

可能需要引入如下插件配置，用来解决@requestparam问题

```xml

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.11.0</version>
            <configuration>
                <source>${maven.compiler.source}</source>
                <target>${maven.compiler.target}</target>
                <encoding>${project.build.sourceEncoding}</encoding>
                <parameters>true</parameters>
                <annotationProcessorPaths>
                    <path>
                        <groupId>org.projectlombok</groupId>
                        <artifactId>lombok</artifactId>
                        <version>1.18.46</version>
                    </path>
                </annotationProcessorPaths>
            </configuration>
        </plugin>
    </plugins>

</build>
```

## 配置

完整配置参考：[misc/application-full.yml](misc/application-full.yml)

```yaml
mx:
  config:
    format-request: true        # 请求日志
  security:
    enabled: true               # 安全认证
  upload:
    type: local                 # 文件上传后端
  netty:
    server:
      enabled: true             # Netty 服务端
  mqtt:
    auto-init: true             # MQTT 自动连接
```

## 包扫描

确保启动类扫描 `com.mx`：

```java

@SpringBootApplication
@ComponentScan(basePackages = {"com.yourpackage", "com.mx"})
public class YourApplication {
}
```

## 骨架项目

`mx-spring-app` 包含两个子模块：

- **Admin**（端口 9090）：Spring Boot Admin 监控面板，默认账号 `admin / admin123`
- **Demo**（端口 8080）：业务骨架，已集成 Actuator、Admin Client、打包脚本

## License

MIT