添加快速索引文件

2026-07-31 11:06:36 +08:00
parent 71c5f2f3b5
commit 4cee256f22
20 changed files with 512 additions and 1 deletions
@@ -0,0 +1,23 @@
+# Common Core 模块指引
+
+## 职责边界
+
+- 提供不依赖具体业务域的返回模型、异常、基础实体和 MyBatis-Plus 通用配置。
+- 不引入订单、仓库、租户等领域实体，不调用业务服务，也不承载 Controller。
+
+## 快速索引
+
+| 功能 | 入口 |
+|---|---|
+| 统一响应与分页 | `src/main/java/com/baiyue/common/core/api/ApiResponse.java`、`PageResult.java` |
+| 返回码 | `src/main/java/com/baiyue/common/core/api/ResultCode.java` |
+| 业务异常 | `src/main/java/com/baiyue/common/core/exception/BizException.java` |
+| 通用审计字段 | `src/main/java/com/baiyue/common/core/model/BaseEntity.java` |
+| MyBatis-Plus 与审计人 | `src/main/java/com/baiyue/common/core/mybatis/` |
+| 响应契约测试 | `src/test/java/com/baiyue/common/core/ApiResponseTest.java` |
+
+## 修改与验证
+
+- 公共响应、错误码或基础实体变化会影响所有服务；先检索消费者并保持序列化和数据库兼容。
+- 新能力只有被多个模块稳定复用时才放入本模块。
+- 从父目录运行 `mvn -pl common-core -am test`。