京东资深架构师代码评审歪诗

开发 开发工具
架构师说, 用20个字描述代码评审的内容, 自省也省人。由于是一字一含义, 不连贯, 为了增强趣味性, 每句都增加对应的歪解。

贾言

贾言

架构师说, 用20个字描述代码评审的内容, 自省也省人。由于是一字一含义, 不连贯, 为了增强趣味性, 每句都增加对应的歪解。只是对常见评审的描述, 不尽之处,欢迎补充!

验幻空越重 -- 言欢空月虫

验: 公共方法都要做参数的校验,参数校验不通过明确抛出异常或对应响应码。

  • java bean验证已经是一个很古老的技术了,会避免我们很多问题,可参考:http://beanvalidation.org/ http://www.infoq.com/cn/news/2010/03/javaee6-validation https://www.sitepoint.com/using-java-bean-validation-method-parameters-return-values/
  • 在接口中也明确使用验证注解修饰参数和返回值, 作为一种协议要求调用方按验证注解约束传参, 返回值验证注解约束提供方按注解要求返回参数

幻: 在代码中要杜绝幻数,幻数可定义为枚举或常量以增强其可读性

空: 要时刻警惕空指针异常

  • 常见的 a.equals(b) 要把常量放到左侧
  • aInteger == 10 如果 aInteger 为空时会抛出空指针异常
  • 不确认返回集合是否可为空时要做非空判断, 再做for循环
  • 使用空对象模式, 约定返回空集合, 而非null
  • 使用StringUtils判断字符串非空

越: 如果方法传入数组下标作为参数,要在一开始就做下标越界的校验,避免下标越界异常

重: 不要写重复代码,重复代码要使用重构工具提取重构

命循频异长 - 明勋品宜昌

命: 包 / 类 / 方法 / 字段 / 变量 / 常量的命名要遵循规范,要名副其实, 这不但可以增加可读性,还可以在起名的过程中引导我们思考方法 / 变量 / 类的职责是否合适

有意义很重要, 典型无意义命名:

  1. public static final Integer CODE_39120 = 39120; 
  2. public static final String MESSAGE_39120 = "[包裹]与[库房号]不一致,确定装箱?"
  3.   
  4. public static final Integer CODE_39121 = 39121; 
  5. public static final String MESSAGE_39121 = "[包裹]与[箱号]的承运类型不一致,确定装箱?"
  6.   
  7. Rule rule1 = request.getRuleMap().get("1050"); 

CODE_39120这个名字和幻数没多大区别。

循: 不要在循环中调用服务,不要在循环中做数据库等跨网络操作

频: 写每一个方法时都要知道这个方法的调用频率,一天多少,一分多少,一秒多少,峰值可能达到多少,调用频率高的一定要考虑性能指标, 考虑是否会打垮数据库,是否会击穿缓存

异: 异常处理是程序员最基本的素质,不要处处捕获异常,对于捕获了只写日志,没有任何处理的 catch 要问一问自己,这样吃掉异常,是否合理

下面是一个反例, 在导出文件的controller方法中做了两层的try...catch, 在catch块中记录日志后什么都没做, 这样用户看不到真正想要的内容, 研发也只有看日志才能发现错误, 而“看日志”, 通常只有业务方反馈问题时才会看, 就会导致研发人员发现错误会比现场人员还会晚。

  1. @RequestMapping(value = "/export"
  2. public void export(CityRelationDomain condition, HttpServletResponse response) { 
  3.    ZipOutputStream zos = null
  4.    BufferedWriter bufferedWriter = null
  5.    try { 
  6.       condition.setStart(0); 
  7.       condition.setSize(MAX_EXPORT_LINES); 
  8.       List<CityRelationDomain> list = cityRelationService.getOrdersByCondition(condition); 
  9.       response.setCharacterEncoding("GBK"); 
  10.       response.setContentType("multipart/form-data"); 
  11.       response.setHeader("Content-Disposition", "attachment;fileName=export.zip"); 
  12.       zos = new ZipOutputStream(response.getOutputStream()); 
  13.       bufferedWriter = new BufferedWriter(new OutputStreamWriter(zos, "GBK")); 
  14.       bufferedWriter.write("订单类型编码,始发城市-省,始发城市-市,目的城市-省,目的城市-市"); 
  15.       ZipEntry zipEntry = new ZipEntry("export.csv"); 
  16.       zos.putNextEntry(zipEntry); 
  17.       for (CityRelationDomain domain : list) { 
  18.          try { 
  19.             bufferedWriter.newLine(); 
  20.             bufferedWriter.write(CSVExportUtil.trans2CSV(domain.getOrderCode())); 
  21.             bufferedWriter.write(','); 
  22.             bufferedWriter.write(CSVExportUtil.trans2CSV(domain.getProvinceNameFrom())); 
  23.             bufferedWriter.write(','); 
  24.             bufferedWriter.write(CSVExportUtil.trans2CSV(domain.getCityNameFrom())); 
  25.             bufferedWriter.write(','); 
  26.             bufferedWriter.write(CSVExportUtil.trans2CSV(domain.getProvinceNameTo())); 
  27.             bufferedWriter.write(','); 
  28.             bufferedWriter.write(CSVExportUtil.trans2CSV(domain.getCityNameTo())); 
  29.          } catch (Exception e) { 
  30.             e.printStackTrace(); 
  31.          } 
  32.       } 
  33.       bufferedWriter.newLine(); 
  34.            bufferedWriter.flush(); 
  35.            zos.closeEntry(); 
  36.            bufferedWriter.close(); 
  37.    } catch (Exception e) { 
  38.       e.printStackTrace(); 
  39.       logger.error("导出CSV文件异常"); 
  40.    } finally { 
  41.       try { 
  42.          if (zos != null) { 
  43.             zos.close(); 
  44.          } 
  45.          if (bufferedWriter != null) { 
  46.             bufferedWriter.close(); 
  47.          } 
  48.       } catch (IOException e) { 
  49.          e.printStackTrace(); 
  50.       } 
  51.    } 

长: 如果一行代码过长,要分解开来;如果一个方法过长,要重构方法;如果一个类过长要考虑拆分类

依轮线日简 - 依伦先日贱

依: 如果调用了外部依赖, 一定要搞清楚这个外部依赖可以提供的性能指标,***约定 SLA

轮: 不要重复造轮子,如果已经有成熟类库实现了类似功能,要优先使用成熟类库的方法,这是因为成熟类库中的方法都经过很多人的测试验证,通常情况下我们自己实现的质量***等同于成熟类库的质量。

线: 要注意我们的 jsf 服务,web 应用,消费消息的 worker 都是多线程环境,要注意线程安全问题,最典型的 HashMap,SimpleDateFormat ,ArrayList 是非线程安全的,另外如果使用 Spring 自动扫描服务,那么这个服务默认是单例,其内部成员是多个线程共享的,如果直接用成员变量是有线程不安全的。

两个典型的错误代码片段:

  • 无视 SimpleDateFormat 非线程安全
    1. @Service 
    2. public class AService { 
    3.     private static final SimpleDateFormat FORMAT = new SimpleDateFormat("yyyy-MM-dd"); 
    4.   
    5.     public void doSomething() { 
    6.         //use FORMAT 
    7.     } 
  • 使用 Service 成员变量
    1. @Service 
    2. public class BService { 
    3.     private Pojo b; 
    4.   
    5.     public void doB() { 
    6.          b = getB(); 
    7.          process(b); 
    8.     } 

日: 打印日志和设定合理的日志级别,如有必要要添加 if 条件限定是否打印日志,在日志中使用 JSON 序列化,生成长字符串的 toString() 都要做 if 限定打印,否则配置的日志级别没达到,也会做大量字符串拼接,占用很多 gc 年轻代内存. 另外一定要通过log4j打印日志而不是直接把日志打印到控制台。

典型错误示例:

  1. @Service 
  2. public class FooService { 
  3.     private static final Logger LOGGER = LoggerFactory.getLogger(FooService.class); 
  4.   
  5.     public void doFooThing(Foo foo) { 
  6.         LOGGER.debug("get parameter foo {}", JSONObject.toString(foo)); 
  7.         try {/*do something*/} catch (Exception ex) {ex.printStackTrace();} 
  8.     } 

简: 尽可能保持整体设计的简洁,方法实现的简洁,要根据情况使用内存缓存,redis 缓存,jmq 异步处理。这里的简需要把握好分寸。

接偶正分壮 - 洁偶正粉妆

接: 接口是用来隔离变化的,如果一个业务有几种不同的形态,但都有相同的处理,那么可以定义接口来隔离业务形态的不同,在服务调用处,通过业务类型字段来获得不同的服务类。而不要实现一个类,然后在类的各个方法中都根据业务类型做 if else 或更复杂的各种判断。

典型示例:

  • 做法 1 :
    1. public interface BarService {    void doBarThing(Bar b); 
    2.       
    3.     void doBarFatherThing(Bar b); 
    4. public class BarServiceImpl  implement BarService{ 
    5.     public void doBarThing(Bar b) { 
    6.         if (b.getType() == BarType.A) { 
    7.             //do some logic 
    8.         } else (b.getType() == BarType.B) { 
    9.             //do some B type logic 
    10.         } 
    11.         //do other doBarThing logic 
    12.     } 
    13.       
    14.     public void doBarFatherThing(Bar b) { 
    15.         if (b.getType() == BarType.A) { 
    16.             //do some logic 
    17.         } else (b.getType() == BarType.B) { 
    18.             //do some B type logic 
    19.         } 
    20.         //do other doBarFatherThing logic 
    21.     } 
  • 做法 2 :
    1. public interface BarService { 
    2.     void doBarThing(Bar b); 
    3.       
    4.     void doBarFatherThing(Bar b); 
    5. public class BarServiceFactory { 
    6.     public BarService getBarService(BarType type) { 
    7.         // get bar service logic 
    8.     } 
    9. //如果有公共逻辑就定义, 没有就不定义 
    10. public class BaseBarService implement BarService { 
    11.     public void doBarThing(Bar b) { 
    12.         //do other doBarThing logic 
    13.     } 
    14.       
    15.     public void doBarFatherThing(Bar b) { 
    16.         //do other doBarFatherThing logic 
    17.     } 
    18.       
    19. public class TypeABarService extends BaseBarService  implement BarService { 
    20.     public void doBarThing(Bar b) { 
    21.         // doATypeThing 
    22.         super.doBarThing(b); 
    23.     } 
    24.       
    25.     public void doBarFatherThing(Bar b) { 
    26.         // do bar type A service 
    27. super.doBarFatherThing(b); //如果需要就调用, 不需要就不调用父类 
    28.     } 
    29.       

做法 2 的好处是将不同类型的逻辑解耦,各自发展,不会相互影响,如果添加类型也不必影响现有类型逻辑。

偶: 认识系统之间的耦合关系,通过同步数据来做两个系统之间的交互是一种很强的耦合关系,会使数据接收方依赖于数据发送方的数据库定义,如果发送方想改数据结构,必须要求下游接收方一起修改;通过接口调用是一种常见的系统耦合关系,接口的提供方要保证接口的可用性,接口的调用方要考虑接口不可用时的应对方案; mq 消息是一种解耦的方法,两个系统不存在实时的耦合关系。但是 mq 解耦的方式不能滥用,在同一系统内不宜过多使用 mq 消息来做异步,要尽可能保证接口的性

能, 而不是通过 mq 防止出问题后重新消费。

正: 模块之间依赖关系要正向依赖,不能让底层模块依赖于上层模块;不能让数据层依赖于服务层也不能让服务层依赖于 UI 层; 也不能在模块之间形成循环依赖关系。

分: 分而治之,复杂的问题要分解成几个相对简单的问题来解决,首先要分析出核心问题, 然后分析出核心的入参是什么,结果是什么,入参通过几步变化可以得出结果。

壮: 时刻注意程序的健壮性,从两个方面实践提升健壮性:

  • 契约,在设计接口时定义好协议参数,并在实现时***时间校验参数,如果参数有问题,直接返回给调用方; 如果出现异常情况, 也按异常情况约定应对策略
  • 考虑各种边界条件的输出,比如运单号查询服务, 要考虑用户输入错误运单时怎么返回,有边界的查询条件,如果用户查询条件超过边界了, 应该返回什么
  • 为失败做设计,如果出问题了有降级应对方案。

作者:赵玉开,十年以上互联网研发经验,2013年加入京东,在运营研发部任架构师,期间先后主持了物流系统自动化运维平台、青龙数据监控系统和物流开放平台的研发工作,具有丰富的物流系统业务和架构经验。在此之前在和讯网负责股票基金行情系统的研发工作,具备高并发、高可用互联网应用研发经验。

【本文来自51CTO专栏作者张开涛的微信公众号(开涛的博客),公众号id: kaitao-1234567】

 

 戳这里,看该作者更多好文

责任编辑:赵宁宁 来源: 51CTO专栏
相关推荐

2018-07-03 15:46:24

Java架构师源码

2018-02-05 09:30:23

高性能高并发服务

2015-12-09 15:16:03

架构师京东架构

2012-11-01 15:08:10

IBM资深架构师

2016-04-20 17:18:29

分布式数据库京东WOT

2013-10-17 15:54:46

红帽

2015-04-10 17:35:26

WOT2015谷歌资深架构师李聪

2013-10-17 15:45:24

红帽

2021-06-07 09:35:11

架构运维技术

2019-10-21 09:32:48

缓存架构分层

2013-11-14 10:06:11

红帽redhat

2009-02-19 16:19:48

SaaS开发SaaS安全SaaS

2014-04-09 18:01:42

京东

2012-12-17 17:38:37

System CentWindows SerHyper-V

2013-01-28 10:23:12

软件架构师架构师程序员

2018-09-17 05:00:59

架构系统练级

2017-11-17 15:57:09

Java多线程并发模型

2018-07-04 13:41:17

架构系统结构数据库

2016-08-29 11:33:23

京东云云计算云安全

2017-12-15 20:30:03

开发码农架构师
点赞
收藏

51CTO技术栈公众号