项目代码规范

结论: 1 .为每个类方法变量添加注释,清晰解释代码的复杂逻辑。
2 、日志打印要分级,关键信息要脱敏。
3 、命名规范:类接口首字母大写,方法变量小写,常量全部大写。
4 、先检查参数验证,再进行处理。
5 、如果获取到对象属性,则为空,未遍历之前为空。
6 . 异常处理捕获并记录特定信息以避免通配符。
7 、模块化设计,接口可扩展。
8 、并发控制:线程安全、数据库锁、分布式锁。
9 .单元测试覆盖率为7 5 %,包括边界异常并发幂等性。
1 0、代码格式:缩进4 个空格,每行8 0个字符,方法按顺序排列。
1 1 . 接口兼容性审查。
1 2 、逻辑清晰,优先顺序明确。
1 3 .安全性:输入验证,防止敏感信息注入和加密。
1 4 .事务编程,范围清晰,避免外部调用。
1 5 .幂等处理方案,唯一标签。
1 6 、数据库Redis的合理设置、异常处理和监控。
1 7 . 避免不良代码味道,例如重复、参数太多、太长和太多条件。
1 8 . 外部呼叫确认成功、异常处理、安全协议和服务质量。

JAVA编程规范之控制语句

昨天,我帮同事调试了一段Java代码。
他使用了 switch 语句,但为了以防万一忘记写了 break。
结果,执行停止,直到情况3 ,并且随后几天的所有测试数据都被删除。
这让我想起了 switch 规范中的要求:“每个实例必须通过中断、返回等显式终止”。
他在写代码的时候一定没有注意到这个细节。
等等,还有一件事。
它的if-else嵌套了五层,条件语句都是&&和||。
我翻了一下方法注释,发现是判断用户是否可以访问某个功能。
如果他用魏句来重构的话,或许就不会陷入现在的困境。
我突然想到,现在很多IDE都支持自动请求丢失switch中断,但是写代码的时候还是会出现这样的低级错误。

项目代码规范

必须严格执行代码规范。
注释应该简洁,描述逻辑,不要重复代码。
例如:2 02 3 年,项目所需的方法标注率将超过8 0%。
日志必须有时间戳和操作类型。
例如:支付接口日志包含订单号和金额。
变量名称应该清晰,例如 userAge 不带 a。
必须进行参数验证,先检查后处理。
例如:登录界面必须验证密码复杂度。
空判断处理应使用可选或三元表达式。
异常应该分类处理,比如IOException单独处理。
模块化应该是明确的,例如用户服务只关心用户。
使用synchronized或Lock来实现并发。
单元测试覆盖率应超过7 0%。
例如:Spring Boot项目使用JUnit进行测试。
代码格式统一,如IDEA自动格式化。
接口兼容性由版本号控制,例如V1 /V2 方法不宜太长。
例如,如果超过5 0行,就必须拆分。
使用 SonarQube 扫描安全检查。
事务用@Transactional 进行注释。
幂等使用Redis分布式锁。
Redis使用SETNX来实现锁。
RocketMQ使用MessageID来实现幂等。
审查应该寻找不良气味,例如长方法和重复代码。
你自己掂量一下吧。