项目规则
代码风格
- 使用Google Java代码风格
- 类名使用UpperCamelCase
- 方法名和变量名使用lowerCamelCase
- 常量使用UPPER_SNAKE_CASE
- 缩进使用Tab
- 禁止使用lombok
- 所有类都必须有注释
- 所有方法都必须有注释
- 所有常量都必须有注释
- 单个函数的行数不超过100行
- 禁用存储过程
- 异常信息根据异常类别进行分类
- 异常分类根据每种类别创建常量
- 常量中明确注明异常信息和异常代码
- 所有RESTful API返回值需要统一
- 统一返回的对象为Result
- 需要提供尽可能多的重载静态函数,便于调用
- 包含状态码、消息和数据
- 状态码为0表示成功,其他表示失败
- 数据统一放在data字段中,且必须是一个可被序列化的对象
- 消息可以为空,也可以是一个字符串,也可以是一个字符串数组
- 配置文件用application.yml
项目结构
- 遵循标准的Spring Boot项目结构
- 控制器放在controller包中
- 服务放在service包中
- 数据库的service不要写接口的方式,直接用服务类
- 实体放在entity包中
- 仓库放在repository包中
- 配置放在config包中
- 工具类放在util包中
- 异常处理放在exception包中
- 常量放在constant包中
技术栈
- JDK 21
- Spring Boot 3.2
- Maven
- PostgreSQL
- Redis
- Spring Security
- Swagger
- Mybatis-flex
提交规范
- 提交信息使用中文
- 提交信息格式：[类型] 描述
- 类型包括：新增、修复、优化、重构、文档、测试
测试要求
- 所有服务类必须有单元测试
- 测试覆盖率不低于80%
- 需要确保swagger文档不被spring security拦截
文档要求
- 所有公共API必须有JavaDoc注释
- README.md必须包含项目描述、环境要求和启动方法
存储
- postgresql
- ip:localhost
- post:5432
- username:postgres
- password:super
- Redis
- ip:localhost
- port:6379
- password: redis_bwN6js
错误码规范
系统错误码采用数字编码，按照不同的业务模块和错误类型进行分类：
- 系统级错误: 1000-9999
- 系统内部错误: 1000
- 认证相关错误: 2000-2999
- 资源相关错误: 3000-3999
- 用户相关错误: 4000-4999
- 角色相关错误: 5000-5999
- 权限相关错误: 6000-6999
- 参数验证错误: 9000-9999
- 业务级错误: 10000-99999
- 通用业务错误: 10001-10099
- 用户业务相关错误: 10400-10499
- 文件处理相关错误: 10500-10599
注释使用以下格式
/*** 功能简述:* 〈 功能简述说明 〉** @Param: [param 参数]* @Return: 返回类型* @Author: Jan* @Date: 当前时间*/