DigitalHainan Spring 微服务框架脚手架与集成指南,覆盖 POM、缓存、MyBatis、认证、OSS 等核心模块。

本文档为 DigitalHainan 后端框架 集成总览,帮助团队快速搭建微服务项目并按需接入框架能力。
使用方式:
- 根据业务需求,在下方「模块导航」或「场景速查」中找到对应模块
- 点击链接跳转到对应集成指南
- 按照指南中的「x.x.2 快速集成」完成基础集成
- 根据「功能集成决策索引」按需启用高级功能
digitalhainan-framework
├── 基础设施层
│ ├── digitalhainan-pom .............. 父 POM(版本管理 + 构建配置)
│ ├── digitalhainan-common ........... 通用基础组件(响应体 / 异常 / 分页 / 转换)
│ └── digitalhainan-config ........... Nacos 配置中心 + 服务发现
│
├── 数据层
│ ├── digitalhainan-mybatis .......... MyBatis Plus 增强(BaseMapper / 数据权限 / 多数据源)
│ ├── digitalhainan-cache ............ 缓存组件(Redis / 二级缓存 / 分布式锁)
│ ├── digitalhainan-elasticsearch .... ElasticSearch 搜索组件
│ └── digitalhainan-table-store ...... 阿里云表格存储(TableStore)
│
├── 服务层
│ ├── digitalhainan-ms-common ........ 微服务公共组件(i18n / Dubbo 增强 / Swagger / 线程池)
│ ├── digitalhainan-security + user .. 身份认证(Token 认证 / 多认证源 / 用户上下文)
│ ├── digitalhainan-log-starter ...... 日志组件(操作日志 / 链路追踪 / 日志上报)
│ └── digitalhainan-tools ............ 工具集(加解密 / 脱敏 / JSON / HTTP / 钉钉)
│
├── 存储层
│ └── digitalhainan-oss .............. 对象存储(阿里云 OSS / 华为云 OBS / S3 协议)
│
├── 运维 & 信创
│ └── digitalhainan-tongweb .......... 信创适配(TongWeb 容器替代 Tomcat)
│
└── 开发工具
└── digitalhainan-ms-devtools-mbg .. 代码生成器(Velocity 模板 / 分层代码骨架)| 序号 | 模块 | 必须/按需 | 定位 | 集成指南 |
|---|---|---|---|---|
| 01 | digitalhainan-pom | 必须 | 父 POM(版本管理 / 构建插件 / Profile) | POM依赖管理集成指南 |
| 02 | digitalhainan-common | 必须 | 通用基础组件(响应体 / 异常 / 分页 / 对象转换 / 脱敏) | 通用工具集成指南 |
| 03 | digitalhainan-config | 必须 | Nacos 配置中心 + 服务注册发现 | 配置中心集成指南 |
| 04 | digitalhainan-mybatis | 必须 | MyBatis Plus 增强(BaseMapper / 数据权限 / 多数据源) | MyBatis集成指南 |
| 05 | digitalhainan-cache | 必须 | 多级缓存 + 分布式锁(Redis + Caffeine + Redisson) | 缓存集成指南 |
| 06 | digitalhainan-ms-common | 必须 | 微服务公共组件(i18n / Dubbo / Swagger / 线程池) | 微服务公共组件集成指南 |
| 07 | digitalhainan-security + user | 必须 | 身份认证鉴权 + 用户上下文管理 | 身份认证集成指南 |
| 08 | digitalhainan-tools | 必须 | 工具集(加解密 / 脱敏 / JSON / HTTP / 钉钉 / 验证码) | 工具集集成指南 |
| 09 | digitalhainan-log-starter | 按需 | 操作日志 + 链路追踪 + 日志上报 | 日志组件集成指南 |
| 10 | digitalhainan-elasticsearch | 按需 | ElasticSearch 搜索(EasyES + Spring Data ES) | ElasticSearch集成指南 |
| 11 | digitalhainan-oss | 按需 | 对象存储统一接口(阿里云 OSS / 华为云 OBS / S3) | OSS对象存储集成指南 |
| 12 | digitalhainan-table-store | 按需 | 阿里云表格存储 TableStore | 表格存储集成指南 |
| 13 | digitalhainan-tongweb | 按需 | 信创适配(TongWeb 替代 Tomcat) | 信创适配集成指南 |
| 14 | digitalhainan-ms-devtools-mbg | 按需 | 代码生成器(数据库表 → 分层代码骨架) | 代码生成器集成指南 |
AI 执行指引: 根据业务场景在下表中找到对应模块,跳转到对应集成指南完成集成。
| 业务场景 | 所需模块 | 集成指南 |
|---|---|---|
| 新建微服务项目(搭建基础骨架) | pom → common → config → ms-common | POM → Common → Config → MS Common |
| 数据库 CRUD + 分页 | mybatis | MyBatis |
| Redis 缓存 / 分布式锁 / 二级缓存 | cache | Cache |
| 全文检索 / 搜索 | elasticsearch | ElasticSearch |
| 文件上传 / 下载 / 签名 URL | oss | OSS |
| 用户登录 / Token 认证 / 权限控制 | security + user | 身份认证 |
| 操作日志记录 / 链路追踪 | log-starter | 日志组件 |
| 加密解密 / 数据脱敏 / 钉钉通知 | tools | 工具集 |
| 阿里云表格存储(宽表场景) | table-store | 表格存储 |
| 信创合规(替换 Tomcat 为 TongWeb) | tongweb | 信创适配 |
| 根据数据库表生成代码骨架 | ms-devtools-mbg | 代码生成器 |
新项目建议按以下顺序逐步引入框架组件:
第一阶段:基础 + 核心(必须)
① digitalhainan-pom ............. 继承父 POM,统一版本管理
② digitalhainan-common .......... 引入响应体 / 异常 / 分页等基础能力
③ digitalhainan-config .......... 接入 Nacos 配置中心
④ digitalhainan-ms-common ....... 微服务公共能力(i18n / Dubbo / Swagger)
⑤ digitalhainan-mybatis ......... 数据库访问层
⑥ digitalhainan-cache ........... 缓存 + 分布式锁
⑦ digitalhainan-tools ........... 工具集(加解密 / 脱敏 / HTTP / 钉钉)
⑧ digitalhainan-security + user . 认证鉴权
第二阶段:扩展能力(按需)
⑨ digitalhainan-log-starter ..... 操作日志 + 链路追踪
⑩ digitalhainan-oss ............. 对象存储
⑪ digitalhainan-elasticsearch ... 全文检索
⑫ digitalhainan-table-store ..... 表格存储
第三阶段:运维 & 信创(按需)
⑬ digitalhainan-tongweb ......... 信创容器适配
⑭ digitalhainan-ms-devtools-mbg . 代码生成器所有集成指南遵循统一的文档结构(以模块编号为前缀,如 1.1 digitalhainan-pom → 1.1.1 / 1.1.2 …),方便导航与 AI 代理快速定位:
| 章节 | 内容 | 说明 |
|---|---|---|
| x.x.1 模块简介 | 模块定位、核心能力、Maven 坐标、前置依赖 | 了解模块是什么 |
| x.x.2 快速集成 | Step 1-N 步骤化指令 + 验证检查点 | 必须完成,完成后即可运行 |
| x.x.3 配置属性参考 | 配置参数表 + 完整 YAML 示例 | 按需查阅,调整配置 |
| x.x.4 核心功能使用 | 功能集成决策索引 + 各功能详述 | 按需启用高级功能 |
| x.x.5 版本变更记录 | 各版本变更详情 | 了解版本演进 |
| x.x.6 常见问题 | FAQ + 排查步骤 | 遇到问题时查阅 |
| x.x.7 版本兼容性矩阵 | 版本对应关系 + 注意事项 | 升级时参考 |
| 技术 | 版本 | 使用模块 |
|---|---|---|
| Spring Boot | 2.x / 3.x | 全部模块 |
| Spring Cloud Alibaba | - | config、ms-common |
| MyBatis Plus | - | mybatis |
| Redis(Lettuce)+ Redisson | - | cache |
| Caffeine | - | cache(二级缓存 L1) |
| Nacos | - | config |
| Dubbo | - | ms-common |
| ElasticSearch | - | elasticsearch |
| 阿里云 OSS / 华为云 OBS / S3 | - | oss |
| 阿里云 TableStore | - | table-store |
| 东方通 TongWeb | 8.0.E.9 嵌入式 | tongweb |
| Apache Velocity | - | ms-devtools-mbg |