1.8 KiB

Raw Blame History

inclusion
always

项目开发规范

语言和交流规范

所有回复、对话、文档和代码注释使用中文（简体中文）
保持技术术语的准确性和一致性

代码更改约定

修复问题后,对需不需要进行修复文档的新增进行询问,如果选择不新增,在对话框中修复情况进行说明即可

后端开发规范 (Spring Boot + MyBatis Plus)

项目结构

Controller层：处理HTTP请求，参数验证
Service层：业务逻辑处理，必须添加 @Transactional 注解
Mapper层：数据访问层，使用MyBatis Plus
Entity层：数据实体，使用Lombok注解简化代码
DTO层：数据传输对象，用于API请求响应

代码约定

统一返回格式：使用 Result<T> 包装所有API响应
异常处理：使用 @ControllerAdvice 全局异常处理
API文档：所有接口必须添加Swagger注解
数据库表名：统一使用 sys_ 前缀
API路径：统一使用 /api 前缀

前端开发规范 (Vue 3 + TypeScript)

项目结构

组件命名：使用PascalCase（如 UserManagement.vue）
状态管理：使用Pinia，store文件放在 src/stores/
API调用：统一封装在 src/api/ 目录
类型定义：放在 src/types/ 目录

开发约定

所有组件必须使用TypeScript
路由配置支持基于角色的权限控制
使用组合式API（Composition API）

架构和安全规范

认证授权

JWT Token认证机制
RBAC（基于角色的访问控制）权限模型
密码使用BCrypt加密存储

API设计

遵循RESTful设计原则
分页查询统一返回 PageResult<T> 格式
时间格式统一使用ISO 8601标准

数据库设计

主键统一使用Long类型的id
创建时间和更新时间字段必须包含
逻辑删除使用deleted字段标识