项目上下文与信息验证

写于 2025-05-02

项目上下文与信息验证

  1. 使用指定知识库：始终参考项目根目录下的 cursor_springboot_rules 文件夹作为知识库，了解项目上下文，不编写与该文件夹提供的规则和指南相悖的代码。编码前先检查此文件夹内容。
  2. 信息验证：在使用或展示任何信息前，必须验证其在项目上下文中的准确性，避免无依据的假设和推测。

功能开发与代码变更

  1. 遵循功能开发计划：实现新功能时，严格按照 springboot_implementation_plan.md 文档步骤执行，步骤按序完成。每完成一步，在文档对应步骤后添加 “Done” 标记，以记录工作进度和保持透明度。
  2. 逐文件变更：对代码进行修改时，逐文件操作，给代码审查者或使用者足够时间发现错误。
  3. 不随意改动：不进行未明确要求的代码变更，仅执行明确请求的开发任务。
  4. 保留现有代码：除非明确要删除的代码，否则不随意删除不相关代码或功能，维护现有代码结构完整性。
  5. 避免不必要更新：无实际需求时，不建议对文件进行更新或修改。

代码编写规范

  1. 命名规范：类名采用大驼峰命名法（如 UserController）；方法名、变量名采用小驼峰命名法（如 getUserList、userName）；常量全部大写，单词间用下划线分隔（如 MAX_PAGE_SIZE）。
  2. 分层架构遵循：严格按照 Spring Boot 经典三层架构组织代码，Controller 层处理 HTTP 请求和响应，Service 层处理业务逻辑，Repository 层负责数据库交互。不同层代码不混杂。
  3. 依赖注入规范：优先使用构造函数注入方式进行依赖注入，保证对象创建时依赖的完整性和可测试性。必要时可使用字段注入或 setter 注入，但需说明合理性。
  4. 避免魔术数字：将代码中硬编码的数值替换为有意义的命名常量，提升代码可读性和可维护性。
  5. 模块化设计：鼓励将功能拆分为可复用的模块，每个模块专注单一功能，提高代码的可维护性和重用性。

代码质量与安全

  1. 安全优先：修改或建议代码变更时，充分评估安全影响，遵循安全最佳实践，防止安全漏洞引入（如 SQL 注入、XSS 等）。
  2. 测试覆盖：新增或修改代码后，添加相应的单元测试，确保代码逻辑正确性。推荐使用 JUnit 等测试框架。
  3. 错误处理：实现健壮的错误处理机制，合理捕获异常并进行日志记录，便于问题排查和定位。
  4. 版本兼容性：确保代码变更与项目使用的 Spring Boot 及相关框架版本兼容，若遇版本冲突，及时调研并提供替代方案。

代码协作与沟通

  1. 单块编辑：提供代码修改建议或编辑内容时，以单块形式呈现，避免对同一文件给出多步指令或解释，保持清晰简洁。
  2. 不要求不必要确认：不请求确认项目上下文中已明确提供的信息。
  3. 不提供理解反馈：不在代码注释或项目文档中专门提供关于理解程度的反馈内容。
  4. 不建议空白更改：不针对代码中的空白（如空格、换行等）提出修改建议，除非影响代码可读性或格式规范。
  5. 不提供摘要：除非用户明确要求，否则不提供代码更改摘要，避免冗余信息。
  6. 提供真实文件链接：涉及文件引用时，提供项目中真实存在文件的链接，不使用上下文生成的虚拟文件链接。