后端开发技术代码编写规范

后端开发技术代码编写规范一、通用规范要求（一）编码风格统一。所有代码必须遵循统一的命名规则、缩进规范和注释标准，确保代码可读性。变量命名需使用驼峰式，类名使用帕斯卡式，方法名使用小写字母加下划线分隔。缩进统一使用4个空格，禁止混用Tab和空格。每行代码长度不超过120字符，超过部分需进行换行处理。（二）版本控制规范。所有代码提交必须遵循"提交信息-代码修改-测试验证"三步流程。提交信息格式为"模块-功能-描述"，例如"用户模块-新增登录接口-实现手机号登录功能"。禁止直接在主干上开发，所有新功能必须创建独立分支，完成测试后方可合并。二、代码结构规范（一）模块划分清晰。系统需按照功能模块进行划分，每个模块需包含独立的配置文件、业务逻辑文件和数据库映射文件。模块命名需与文件夹名称保持一致，采用名词形式表达，如"订单管理模块"、"支付服务模块"。（二）接口设计标准。所有对外提供的API必须遵循RESTful风格，路径设计需使用名词而非动词，参数命名需使用下划线分隔，例如"/api/v1/users/{userId}/profile"。响应状态码必须符合HTTP标准，自定义错误码需以"ERR_"为前缀，例如"ERR_400_INVALID参数"。三、数据库交互规范（一）SQL编写规范。所有数据库操作必须使用预编译语句，禁止动态拼接SQL。查询语句需避免使用SELECT*，必须明确指定字段名称。复杂查询需使用WITH语句进行逻辑拆分，避免超过3层嵌套。（二）ORM使用规范。使用ORM框架时，实体类命名需与数据库表名保持一致，字段映射关系必须明确配置。禁止在实体类中直接编写业务逻辑，所有业务处理需在服务层完成。懒加载机制必须开启，但需设置合理的缓存策略。四、安全防护要求（一）输入验证标准。所有用户输入必须进行严格验证，包括类型检查、长度限制、特殊字符过滤。验证规则需在控制器层统一配置，禁止分散在业务方法中。敏感信息（如密码、身份证号）必须进行加密存储，加密算法需使用SHA-256。（二）权限控制规范。系统需实现基于角色的访问控制（RBAC），权限检查必须放在方法执行前。禁止在业务逻辑中直接判断用户权限，所有权限验证需通过拦截器完成。操作日志必须记录用户ID、操作时间、操作内容，并设置不可篡改属性。五、性能优化标准（一）缓存使用规范。核心数据必须配置二级缓存，缓存失效策略需根据数据更新频率选择。缓存穿透问题必须通过布隆过滤器解决，缓存击穿问题需设置热点数据保护机制。缓存更新必须采用异步写入，避免阻塞主线程。（二）数据库优化标准。慢查询必须设置监控阈值，超过1秒的查询需进行索引优化。分库分表时需遵循"范围分表-哈希分表-垂直拆分"原则，分表键必须选择高基数字段。数据库连接池需配置合理的最大连接数和最小空闲数。六、异常处理规范（一）异常分类标准。系统需定义基础异常类，按异常类型分为系统异常、业务异常和验证异常。异常信息必须包含错误码、错误描述和详细原因，禁止使用中文描述。所有异常需经过全局处理器统一响应，禁止直接抛出原始异常。（二）错误监控规范。所有异常必须记录到监控平台，包括异常类型、发生时间、堆栈信息。严重异常需触发告警通知，告警规则需根据业务影响级别配置。异常处理流程必须包含"记录-通知-恢复"三个环节，确保问题可追溯。七、部署发布规范（一）发布流程标准。所有发布必须经过"测试环境验证-预发布验证-正式发布"三阶段，每个阶段需设置独立的发布窗口。发布操作必须使用自动化脚本，禁止手动操作。发布完成后需进行功能验证和性能测试，确保系统稳定性。（二）回滚机制规范。每个发布版本必须配置回滚方案，回滚脚本需与发布脚本保持同步。回滚操作必须记录详细日志，包括回滚时间、操作人、影响范围。系统需支持原子性回滚，确保数据一致性。八、文档维护规范（一）代码注释标准。所有方法必须添加Javadoc注释，注释内容包含功能描述、参数说明、返回值说明和异常说明。核心算法需添加流程图注释，复杂逻辑需使用伪代码说明。注释更新必须与代码同步，禁止过时注释。（二）设计文档规范。系统架构图、数据库设计图、接口文档必须使用统一模板，文档版本需与代码版本保持一致。设计文档需定期更新，更新记录必须包含修改内容、修改人和修改时间。文档存储需使用版本控制系统，确保可追溯性。九、团队协作规范（一）代码审查标准。所有代码提交必须经过至少两名成员的审查，审查内容包括代码风格、逻辑正确性、安全漏洞。审查意见必须通过代码审查工具反馈，被审查人需在24小时内完成修改。重大修改必须组织专题评审。（二）知识共享规范。团队