开发规范

规范与权威来源

按规则编号查找唯一正文,明确跨仓规范与冲突处理。

浏览全部手册
本页目录
文档来源与 Markdown 原文

权威正文:ineed-core/docs/standards/README.md。网站按工作区快照同步,原文中的历史日期和验证范围保留。

开始编码前核对同版本源码;跨仓文件引用可在源码定位目录查找。

下载 Markdown 原文 ↓

本页是规则索引。详细规范保留在已有专题中,避免迁移路径时复制两份正文。教程解释做法,规则正文定义约束;业务特有规则归所属模块需求。

编号 规则主题 唯一正文 适用范围与验证
CORE-LAYOUT-001 聚合、BOM、业务子模块及包结构 模块目录业务骨架分别负责通用目录与业务语义 新建或调整模块;核对 POM 与源码目录
CORE-LAYER-001 Controller → Service → Manager → Repository/Mapper 分层规范 业务代码;依赖检查和调用链审查
CORE-CONTRACT-001 contract、converter、返回体与异常 契约与错误 新增接口或字段;编译、校验与响应断言
CORE-STYLE-001 源码格式、Javadoc、字段与日志门面 代码风格 新增和修改 Java 源码;风格检查
CORE-TENANT-001 租户读取、写入和上下文边界 租户指南 租户实体及所有自定义访问;跨租户负向测试
CORE-AUTH-001 API 权限、数据范围与模块接入 授权指南 Web 和受保护业务动作;真实身份正反向验证
CORE-TX-001 事务、订阅期与副作用 事务指南 写用例、缓存、事件;提交/回滚测试
CORE-STATE-001 显式数据状态能力 状态指南 支持状态动作的实体;能力和接口对齐
CORE-DELETE-001 删除、恢复及级联时序 删除规范的删除章节 删除和恢复;引用、级联、回收站断言
CORE-CACHE-001 缓存运行时、租户键和失效 缓存指南 接入缓存的 Service;隔离、提交、回滚测试
CORE-EVENT-001 内部/蒸馏事件与事务时序 事件规范 事件发布与监听;开关和提交时序测试
CORE-STACK-001 同步/响应式与四数据栈对齐 业务骨架的跨模块对齐规则 公共能力和未限定单栈的新功能;同一业务场景验证
CORE-TEST-001 分层验证与证据 测试规范 所有交付;记录命令、数量、结果与边界

必须/禁止表示约束,建议表示默认做法。任务或业务需求明确限定技术栈时按其范围交付,并记录理由;不能用“以后补齐”隐去本次承诺的范围。

跨仓规范

以上外部链接适用于标准工作区布局。独立获取 Core 时需同时取得匹配版本的相关仓库;可以用 文档检查器--workspace 模式核对外部链接。

冲突处理

规范与源码不一致时,区分“规范过时”和“实现缺陷”,在变更中记录证据并修正对应来源。旧业务类只能作为实现参考,不能覆盖本页链接的现行规则。不得为通过检查而删除规则或降低测试范围。

仍有疑问?按反馈清单整理复现信息 →