rules.mdc 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. ---
  2. alwaysApply: true
  3. ---
  4. ## 需要告知
  5. 每次告诉我本次chat使用的模型
  6. ## 代码设计
  7. 设计逻辑参考 `a_docs/灵越智报2.0程序设计详解.md`
  8. ## 代码规范
  9. 1. **项目结构规范**
  10. * 统一父POM管理依赖版本,子模块按业务或功能划分。
  11. * 模块命名清晰,遵循`服务名-功能`格式(如`user-service`, `gateway-module`)。
  12. 2. **接口定义与契约**
  13. * 内部服务间HTTP API优先使用OpenAPI 3.0(SpringDoc)定义,并明确版本。
  14. * Feign Client接口需声明在独立模块,供消费者依赖;方法名与路径遵循RESTful风格。
  15. 3. **配置管理**
  16. * 敏感配置必须加密,环境相关配置与代码分离。
  17. 4. **服务治理与容错**
  18. * 服务注册发现:使用Spring Cloud原生客户端(如Nacos Discovery),确保实例元数据规范。
  19. * 熔断降级:统一使用Resilience4j,定义合理的熔断策略和降级逻辑。
  20. * 链路追踪:全服务集成Sleuth,日志中必须包含TraceID。
  21. 5. **日志与监控**
  22. * 日志格式统一为JSON,包含时间、级别、服务名、TraceID等关键字段。
  23. * 核心接口需通过Micrometer暴露指标,并与监控系统集成。
  24. 6. **安全与部署**
  25. * 配置文件禁止提交敏感信息(如密码、密钥)。
  26. * 容器化部署时,健康检查接口(`/actuator/health`)必须启用。
  27. 7. **版本约束**
  28. * 统一Spring Boot、Spring Cloud、Spring Cloud Alibaba的版本映射,避免兼容性问题。
  29. ## 代码检查
  30. chat进行新代码修改或新增,结束后检查整体逻辑