Code Review

主题：后端代码规范 日期：2024年6月7日 参加人：OSCE项目组 主持人：刁宇航

示例代码：OSCE部分待优化代码

现存问题及解决方案

一、规范命名及合理的代码注释

规范的命名，更容易被理解和阅读

• 示例：boolean flag = true;
• 解决：应避免flag、data、list等模糊命名，并赋予合理的注释，老生常谈了，但很重要；

二、重复代码

减少重复代码是提高软件开发效率、保证代码质量、降低维护成本

• 重复查询逻辑，应统一封装；

• 提供统一鉴权接口；

三、避免编写无效代码

• 避免无效的判断逻辑；

• 无效的convert，增加编译时间；

• 无用的mapper；

• 不再使用的代码，应标注**@Deprecated**，或直接删除；

四、代码可读性

• 现状：部分Service方法，存在大段逻辑；
• 解决：封装多个私有方法，并配好代码注释说明含义；

五、性能优化

• 避免循环嵌套查询数据库、访问Redis等大量I/O读写；
• 合理架设缓存层，避免高频查询；
• 避免接口返回数据量过大，尤其监控类频繁访问的接口，占用大量带宽；