外观
Nebula 开发规范
2026-04-01
Nebula 开发规范 是研发中心在多个项目实践中总结的编码约束与最佳实践,适用于所有基于 Nebula 框架的业务后端与前端开发。
为什么要有统一规范
Nebula 是面向多团队共用的企业级框架,统一规范的目的是:
- 降低接入成本:新成员参照规范,可以快速写出符合团队预期的代码
- 避免常见陷阱:多租户数据泄露、分布式锁误删、事务缺失等问题,都已有明确的禁止写法
- 提升可维护性:命名、分层、目录结构统一,跨团队 Code Review 更高效
规范文档导航
| 文档 | 内容 |
|---|---|
| 规范总览 | 框架基类速查表、命名规范、REST 接口设计、方法命名约定 |
| 后端开发规范 | 分层架构、禁止事项、DO/VO/MapperExt/Service/Controller 完整规范 |
| 数据库设计规范 | Flyway 命名、DDL 建表、BaseEntity 11 字段、索引、菜单字典 DML |
| 框架工具使用规范 | JsonUtils、分布式锁、Redis、RPC 三件套、多表事务、日志/traceId |
| 前端开发规范 | 技术栈、共享包、API 函数写法、TypeScript 类型、IceStark 生命周期 |
| 完整 CRUD 代码示例 | 前后端完整 CRUD 实现参考(可直接对照新建业务模块) |
