整理项目文档索引和规范说明
This commit is contained in:
@@ -11,9 +11,13 @@
|
||||
- 后端基础结构、ID、审计字段、分页和 Mapper 规范参考 `docs/import/reusable/backend-base-structure-pagination-guidelines.md`。
|
||||
- Java 代码规范参考 `docs/import/reusable/alibaba-java-coding-guidelines-summary.md`。
|
||||
- SuperAgent 与 AgentBus 可移植集成经验参考 `docs/import/reusable/integrations/superagent-agentbus-portable-integration-guide.md`。
|
||||
- 当前项目专属文档总索引位于 `docs/project/README.md`。
|
||||
- 当前项目专属后端规范位于 `docs/project/backend-development-guidelines.md`。
|
||||
- 当前项目时间设计说明位于 `docs/project/backend-time-design.md`。
|
||||
- 当前项目专属前端规范位于 `docs/project/frontend-development-guidelines.md`。
|
||||
- 当前项目前后端协作入口位于 `docs/project/frontend-backend/README.md`。
|
||||
- 当前项目 SuperAgent 与 AgentBus 接入记录位于 `docs/project/integrations/superagent-agentbus-project-integration-guide.md`。
|
||||
- 当前项目 SuperAgent HTTP 对外接口总契约位于 `docs/project/integrations/superagent-api-contract.md`。
|
||||
- 当前项目 SuperAgent MCP 资料包位于 `docs/project/integrations/superagent-mcp/README.md`。
|
||||
|
||||
如本文件、`docs/project` 与 `docs/import/reusable` 中的通用规范冲突,以本文件和 `docs/project` 的当前项目补充为准。
|
||||
@@ -97,6 +101,8 @@
|
||||
- 集合、空值、字符串、时间、金额和 `BigDecimal` 使用安全写法。
|
||||
- 后端业务时间点统一按 UTC 处理:数据库 `LocalDateTime` 默认表示 UTC,API 返回时间点字段必须使用带 `Z` 的 ISO 8601 UTC 时间;新增响应 DTO 优先使用 `OffsetDateTime`,从数据库快照输出时使用 `UtcTimeFormatter` 统一转换。
|
||||
- 入住日期、离店日期、酒店营业日等酒店本地业务日期不得和 UTC 时间点混用,应使用 `LocalDate` 或明确酒店时区语义的字段。
|
||||
- 新增 MySQL 表必须显式使用 `ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_bin COMMENT='...'`;字符串默认按大小写敏感保存和比较,避免外部 opaque id、哈希、Token、状态码或业务代码因默认不区分大小写而误判。
|
||||
- 如某个业务查询确实需要大小写不敏感,应在查询层、搜索列或专门索引中明确实现,并在 migration 和文档中说明原因,不能依赖数据库默认 collation。
|
||||
- 异常不吞掉,日志有上下文但不输出 Secret 或个人敏感信息。
|
||||
- 写操作考虑幂等、并发版本、事务边界、审计和失败恢复。
|
||||
- 复杂业务规则、外部字段映射、脱敏和幂等逻辑必须有必要中文注释。
|
||||
|
||||
Reference in New Issue
Block a user