# 后端集成开发规范索引

本目录包含后端（Java / Spring Boot）集成开发规范。生成或修改后端代码前，先按任务类型读取对应规范。

---

## 文件清单

| 序号 | 文件名 | 主要内容 |
| ---- | ------ | -------- |
| 01 | [后端分层开发与数据库设计规范.md](./后端分层开发与数据库设计规范.md) | Controller / Service / Manager / DAO 分层约束、数据库设计强制规则 |
| 02 | [多语言及全局异常处理规范.md](./多语言及全局异常处理规范.md) | 异常必须在 Server 层抛出、多语言消息、全局异常拦截 |
| 03 | [Liquibase 数据库变更管理规范.md](./Liquibase%20数据库变更管理规范.md) | 所有数据库变更必须走 Liquibase，禁止直接执行 SQL 不补录 |
| 04 | [Redis使用规范.md](./Redis使用规范.md) | 优先使用 `DawnRedis`，Key 命名规范、过期策略 |
| 05 | [ES使用规范.md](./ES使用规范.md) | 基于 `sieiot-es-plus-starter`（ES 8.x）静态链式 API 操作 Elasticsearch |
| 06 | [分布式锁规范.md](./分布式锁规范.md) | 两种分布式锁方式（Redis / 注解）适用场景与用法 |
| 07 | [IdToName使用规范.md](./IdToName使用规范.md) | 字段注解 + 方法开关注解 + AOP 自动完成 ID → 名称填充 |
| 08 | [编码自动生成规范.md](./编码自动生成规范.md) | 业务编码（客户、供应商、订单等）统一通过 `AutoCodeRuleService` 生成 |
| 09 | [文件中心使用规范.md](./文件中心使用规范.md) | 平台文件中心 `IotBaseAttachmentClient` 统一附件管理 |
| 10 | [流程中心接入规范.md](./流程中心接入规范.md) | 业务单据接入 BPM 流程中心（Kafka 异步 + 状态回调） |
| 11 | [通用工具类使用规范.md](./通用工具类使用规范.md) | 平台通用工具类选型约束，避免重复造轮子 |

---

## 按场景推荐阅读

### 新增业务模块（建工程）

1. `后端分层开发与数据库设计规范.md` — 先确定分层结构与数据库规范
2. `多语言及全局异常处理规范.md` — 异常处理与多语言消息
3. `Liquibase 数据库变更管理规范.md` — 数据库变更管理流程
4. `通用工具类使用规范.md` — 避免重复造轮子

### 新增 CRUD 接口

1. `后端分层开发与数据库设计规范.md` — 分层约束
2. `编码自动生成规范.md` — 业务编码生成
3. `IdToName使用规范.md` — 列表返回时自动翻译 ID 为名称
4. `多语言及全局异常处理规范.md` — 异常抛出与提示

### 涉及缓存 / 搜索 / 锁

1. `Redis使用规范.md` — 缓存读写
2. `ES使用规范.md` — 全文检索 / 复杂查询
3. `分布式锁规范.md` — 并发控制

### 文件 / 流程 / 附件

1. `文件中心使用规范.md` — 附件上传 / 查询 / 删除
2. `流程中心接入规范.md` — BPM 审批流接入

### 数据库变更

1. `Liquibase 数据库变更管理规范.md` — 强制走 Liquibase
2. `后端分层开发与数据库设计规范.md` — 表结构与索引设计约束

---

## 维护说明

- 新增规范文件时，同步更新本索引。
- 规范文件命名使用中文，便于阅读；文件名中的空格在链接中需要 URL 编码（如 `%20`）。
- 本目录规范与 `ant6-front-integration/`（前端规范）、`yudaocloud-end-integration/`（ECP 后端集成）互补，按技术栈选用。