code review 注意事项

引言

似乎有段时间没写博客了，没事总结一下编码规范，和code review一般需要注意的地方
。

你的代码应该是写给下一个开发者的情书。

看到这句话我深以为然，不过对面写不完的需求只能是尽力而为保持代码质量了，😂😂😂

常规检查

• 目录设置是否合理、模块划分是否清晰、代码结构是否满足“高內聚、松耦合”?
• 是否遵循经典的设计原则和设计思想(SOLD、DRY、KSS、YAGN、LOD等)?
• 设计模式是否应用得当?是否有过度设计?
• 代码是否容易扩展?如果要添加新功能,是否容易实现?
• 代码是否可以复用?是否可以复用已有的项目代码或类库?是否有重复造轮子?
• 代码是否容易测试?单元测试是否全面覆盖各种正常和异常的情况?
• 代码是否易读?是否符合编码规范(比如命名和注释是否恰当、代码风格是否一致等)?

业务需求角度

• 代码是否实现了预期的业务需求?
• 逻辑是否正确?是否处理了各种异常情况?
• 日志打印是否得当?是否方便 debug排查问题?
• 接口是否易用?是否支持幂等、事务等?
• 代码是否存在并发问题?是否线程安全?
• 性能是否有优化空间,比如,SQL、算法是否可以优化?
• 是否有安全漏洞?比如,输入输出校验是否全面?

可读性，扩展性，性能的取舍

对于一般项目，我个人认为 扩展性 > 可读性 > 性能， 性能其实一般出现瓶颈的时候我们在特地优化即可