Code Review的基本思路

发布于 2020-9-25 13:49
浏览
0收藏

一、业务检查


1. 业务流程正确性
代码实现的业务流程是否合理,是否按照产品需求设计,或者是否对之前的业务流程有影响。

 

2. 业务流程交互
业务流程的交互是否合理,即一个服务的多个接口的调用顺序是否符合用户习惯。

 

3. 业务的可拓展性
如某项业务数据的存储和结构是否能够支持未来业务的变化,如现在是统计A项数据,而未来可能统计与A相关的B项数据。

 

二、设计检查

 

1. 接口和方法设计

  • 传参是否合理,如是否存在冗余传参,参数数据类型是否合理;
  • 方法内部的相关判断和边界检查是否合理,如是否有考虑可能为null,0等情况;
  • 方法内部的数据类型选型是否合理,是否可能存在潜在问题,如可能存在并发的地方使用了hashmap,而不是concurrenthashmap;
  • 方法的数据字段的作用域是否合理,是否存在内存泄露风险,如静态集合类内部包含的对象会存在内存泄露的风险;
  • 方法涉及是否考虑了异常处理,异常打印是否包含了接口核心参数的打印;
  • 方法是否引入的新的第三方包的使用,第三方包是否存在风险,不同版本是否存在差异,如jackjson序列化包不同版本针对日期Date类型的序列化方式存在差异。


2. 数据库和缓存设计

  • 数据表是反应业务逻辑的,故表的字段类型,长度等是否合理,是否存在溢出风险;表之间的关联是否合理;字段是否存在冗余,冗余是否是有益的;
  • 分布式缓存和本地缓存是否合理,缓存失效和更新策略是否合理,是否存在缓存崩溃,缓存穿透问题;
  • 表名,字段名,缓存key的命名是否合理。

 

3. 可读性和可维护性

  • 注释与命名:关键设计是否有注释,接口、方法、字段命名是否能够反应业务含义;
  • 方法是否存在太大问题,如果逻辑太多,可以考虑拆分为多个小方法;
  • 代码风格问题,如缩进是否统一。

 

 

作者:服务端开发

来源:CSDN

标签
收藏
回复
举报
回复
添加资源
添加资源将有机会获得更多曝光,你也可以直接关联已上传资源 去关联
    相关推荐