coding-standards.mdc 803 B

1234567891011121314151617181920212223242526272829
  1. ---
  2. description: 编码规范约定
  3. globs: src/**/*.java
  4. alwaysApply: false
  5. ---
  6. # 编码规范
  7. ## 命名规范
  8. - 类名:UpperCamelCase(如 `BaseDBService`)
  9. - 方法名/变量名:lowerCamelCase(如 `getUserById`)
  10. - 常量:UPPER_SNAKE_CASE(如 `ORDER_STATUS_PENDING`)
  11. - 包名:全小写(如 `com.example.project`)
  12. ## RESTful API 接口规范
  13. - 不带参数的查询请求用 `GET` 方法,带参数的查询请求用 `POST` 方法
  14. - 非查询请求全部使用 `POST` 方法
  15. - 所有 HTTP 请求的响应数据都用 `JSON` 格式返回
  16. - 统一响应格式 `ResponseRes<T>`:
  17. ```json
  18. {"rescode":"","resmsg":"","resdata":"","timestamp":0}
  19. ```
  20. ## 其他注意事项
  21. 1. **参数校验**:使用 Hibernate Validator + 自定义 `IntInitOrRange` / `StrNullOrSize` 等注解