1.7 KiB
1.7 KiB
Platform BOM 模块指引
数据库访问与中文注释约束
- 强制遵守根
../AGENTS.md的“数据库访问与中文代码注释”全部规则:正常业务访问统一为Controller → Service → Repository → Mapper,不得省略 Repository 或跨层直调;生产 SQL 由 Mapper 执行,Repository 不得直接使用 JdbcTemplate 或原生 JDBC。非 HTTP 入口从 Service 进入;无数据库模块不引入数据库访问。 - 每个手写方法及构造器须有简短中文说明;核心业务规则、复杂 SQL、事务、锁、幂等、并发及失败处理须补充适量中文注释,重点说明原因和边界。新增、修改方法立即执行,触及的存量代码同步整改。
职责边界
- 本模块只通过
pom.xml的dependencyManagement发布baiyue-platform-bom,统一管理本仓公共制品版本。 - 不在这里放 Java 业务代码、服务配置或具体依赖实现;第三方技术栈版本仍优先由父
pom.xml管理。
快速索引
| 修改目标 | 文件位置 |
|---|---|
| BOM 坐标与版本 | pom.xml 顶部 artifactId、version |
| 公共组件版本 | pom.xml 的 dependencyManagement/dependencies |
| 当前纳管制品 | baiyue-common-core、common-web、common-security、common-openapi、common-audit、common-event-contract |
修改与验证
- 新增条目前先确认制品确实需要被其他仓库按固定版本消费;业务服务依赖不要放入 BOM。
- 版本变化会影响所有 BOM 消费者;按当前正式依赖基线同步本仓与尾程仓消费者,不为旧坐标或旧版本保留兼容分支。若已有不可变外部依赖,另行建立升级规则。
- 从父目录运行
mvn -pl platform-bom -am validate。