开发注意事项说明文档
文档基础信息
- 适用项目：reed系统
- 核心用途：明确reed系统全流程开发规范、禁忌要点、质量管控及风险规避要求，统一全体开发人员的开发标准，保障代码质量、项目进度与系统稳定性，减少开发bug、降低后期维护成本，助力项目高效落地。
开发前期准备注意事项
需求与设计确认
- 开发前务必熟读需求文档、功能设计文档、架构设计文档，吃透业务逻辑与功能细节，严禁未理解需求就盲目编码。
- 针对模糊、矛盾、缺失的需求点，及时同步产品与架构负责人，确认完毕后再开展开发工作，避免后期返工。
- 核对数据库设计、接口文档、字段规范，确保前后端开发口径统一，杜绝数据交互、接口对接冲突。
环境与配置规范
- 严格按照项目要求搭建开发环境，统一技术栈版本、依赖包版本，禁止私自升级/降级版本引发兼容性问题。
- 本地开发配置需与开发环境保持一致，区分开发、测试、生产环境配置，严禁将生产环境配置用于本地调试。
- 配置文件中敏感信息（数据库账号、密钥、Token）禁止明文书写，采用配置中心/加密方式处理，严禁上传至代码仓库。
代码开发规范注意事项
命名与格式规范
- 遵循项目统一命名规范，类名、方法名、变量名、数据库相关命名见名知意，禁止使用中文、无意义字符、拼音简写。
- 代码格式统一，缩进、换行、注释遵循标准化规范，使用团队统一格式化工具，保证代码可读性与美观度。
- 常量统一维护至常量类，禁止硬编码充斥代码，便于后期批量修改与维护。
代码编写核心要求
- 代码遵循高内聚、低耦合原则，模块化开发，抽取公共方法与工具类，杜绝冗余代码、重复代码。
- 关键业务逻辑、复杂方法、公共接口必须添加清晰注释，说明功能、参数、返回值、异常场景，便于他人阅读维护。
- 禁止编写死循环、内存泄漏、无效调用的代码，严控代码性能，避免拖慢系统运行速度。
- 遵循开闭原则，便于后续功能拓展，减少代码改动对原有功能的影响。
接口开发注意事项
- 严格按照RESTfulAPI规范开发接口，接口路径、请求方式、参数格式、返回值格式统一，前后端提前对齐接口文档。
- 接口必填参数必验，新增参数校验逻辑，拦截非法参数、空参数、恶意参数，避免参数异常导致业务报错。
- 接口返回统一响应格式，包含状态码、提示信息、数据体，清晰反馈执行结果，便于前端处理与问题排查。
- 核心接口添加限流、防重复提交机制，避免高并发场景下接口被恶意调用，保障接口稳定性。
第三方依赖添加注意事项
- 引入第三方依赖包需与技术负责人讨论，确定必须后才能引入
- 引入新的第三方依赖包时需分析是否与已存在包有冲突
- 确保引入包的版本号最新
数据库操作注意事项
- 严格遵循数据库设计规范，禁止私自修改表结构、字段类型、索引、约束，如需调整需提交申请并同步全体开发人员。
- 编写SQL语句需优化性能，原则上禁止多表关联查询。
- 核心业务数据操作必须添加事务控制，保证数据一致性与完整性，避免出现数据错乱、丢失问题。
- 严禁执行无where条件的update、delete语句，防止误删全表数据；批量操作需分批执行，避免锁表影响业务。
- 禁止在代码中拼接SQL语句，防止SQL注入风险，统一使用ORM框架自带的参数绑定方式。
- 数据库字段更新必须同步更新
create.sql文件，并将更新语句添加到update.sql中，由系统启动时自动执行，严禁手动修改数据库。 - 原则上不允许使用多表关联查询，若确实需要请与技术负责人讨论。
安全开发注意事项
- 用户身份认证采用Token令牌机制，接口添加权限校验，未登录、无权限用户禁止访问核心接口与敏感数据。
- 敏感数据（密码、手机号、身份证号）需加密存储、脱敏展示，传输过程中加密，严防数据泄露。
- 添加XSS攻击、CSRF攻击防护逻辑，过滤恶意请求内容，拦截非法入侵行为。
- 日志记录需规避敏感信息，禁止在日志中打印密码、密钥、身份证等隐私数据，避免日志泄露引发安全问题，临时调试时可打印，但提交代码时必须删除。
测试与提测注意事项
- 开发完成后必须进行本地自测，覆盖正常场景、异常场景、边界场景，确保功能无bug、逻辑无漏洞，再提交测试。
- 自测通过后，规范提交提测申请，注明开发完成内容、自测结果、注意事项，便于测试人员高效开展测试。
- 测试反馈bug需及时整改，修复完毕后回归测试，杜绝同一bug反复出现，严禁带病上线。
- 禁止直接修改测试环境代码，所有改动需通过本地开发、自测、提交代码仓库、部署上线的标准流程。
代码管理与协作注意事项
- 遵循团队Git代码管理规范，区分主分支、开发分支、功能分支，禁止直接向主分支提交代码、合并代码。
- 提交代码时备注清晰的提交信息，说明本次改动内容，便于后续代码回溯与版本管理。
- 多人协作开发时，避免同时修改同一代码块，提前沟通分工，合并代码前解决冲突，防止代码覆盖。
- 定期拉取远程仓库最新代码，保持本地代码同步，减少代码冲突与版本不一致问题。
上线部署注意事项
- 上线前核对代码版本、配置文件、数据库脚本，确保与测试环境一致，严禁错发、漏发代码。
- 生产环境数据执行变更操作前，务必备份数据，避免变更失败导致数据无法恢复。
- 上线后实时监控系统运行状态、接口响应、日志信息，发现异常立即排查处理，保障系统稳定运行。
- 严格遵循上线流程，业务低峰期执行上线操作，禁止私自上线、违规操作。