阅读时间:1 分钟
0 字

项目规范

以下规则适用于后端、网关、管理端、数据库、配置、脚本、测试和文档。各专题分别定义对应代码和交付物的合规条件,系统设计、开发指南、内置功能、运维和参考手册提供当前项目事实。

工程原则

  1. 工程验收原则
  2. 可预测的工程结构

通用规则

  1. 工程哲学与核心编码规则
  2. 验收规则
  3. 修改范围
  4. 代码结构与分包
  5. 命名、类型与显式契约
  6. 抽象与处理步骤
  7. 分层与 API
  8. 注释与成品文档
  9. 测试、评审与验收
  10. 代码评审覆盖规范

技术栈规则

  1. Java 与 Spring
  2. Java 工程完整审查
  3. MyBatis-Flex 与持久化
  4. SQL 与持久化分层完整审查
  5. PostgreSQL 与数据库
  6. Vue、TypeScript 与交互
  7. 前端质量与交互设计完整审查
  8. Sca4d-J 项目工程约定
  9. 格式化与构建

内置功能规则

  1. 认证
  2. 权限
  3. CurrentRequest
  4. 并发
  5. 消息
  6. 实时通信
  7. 文件
  8. 审计
  9. 应用日志
  10. 缓存
  11. 配置
  12. 管理端

规则冲突

两篇规则对同一实现提出不同要求时,必须先形成唯一要求并同步修正文档。存在冲突的实现不符合项目规范。

冲突不能通过选择要求更低的一项或新增中间层保留两种行为来解决。

验收入口

测试、评审与验收定义验证范围,代码评审覆盖规范定义修改文件的覆盖要求。

编译和测试通过不能替代分层、命名、类型、并发、日志、前端质量和文档审查。

最后更新 2026年7月18日 11:45