用代码“读懂”代码:衡量开发交付质量(微服务度量之一)

回顾软件开发的流程,从前期的业务需求分析,到产品设计,再到架构设计,通过层层迭代,让所有关于业务及系统的思考、意图和策略最终都通过开发人员的代码表述出来。 代码成了这些活动的最终产出物。

可以说,一个系统的源代码就是一本,读懂这本,我们就知道这个系统的前世今生。当然, 深入(自动化)分析源代码也可以衡量服务的开发和设计质量

在实际的开发工作中,大都采用面向对象的编程方式。我们把真实世界的业务实体映射成软件中的对象,实体间的关系就演变成了对象间的继承、实现和引用关系。因此通过对源代码的分析,可以知道软件系统的一系列关系逻辑,包括系统的调用入口在哪,以及系统API的实现和继承关系、类方法之间的引用关系等。如图2. 11 所示,如果将图左边的 代码关系 用图形化的方式呈现出来,就可以获得图右边的 调用链路关系 图。这类关系图对我们快速梳理和理解系统的逻辑非常有帮助,在此基础上也可以对微服务的调用质量进行优化。

源码是一个宝库,包含了很多的内容。假如有个超人能够记住所有的源码并理解透彻,那么很多治理的难题都能迎刃而解。问题一出来,超人就能快速地定位问题所在。奈何现实中没有超人,全盘读懂源码既是脑力活也是体力活,将成千上万个核心类的调用关系梳理出来并画出关系图,没有核心程序员好几周的辛苦努力是搞不定的。

用代码“读懂”代码:衡量开发交付质量(微服务度量之一)

图2.11 代码逻辑关系的梳理

人力有穷时,最好的办法是通过某种自动化手段,自动提取源码中的元素,自动梳理这些元素之间的关系,简言之就是通过代码去理解代码

所幸,现在已经有一些能够对源码进行解析的工具和组件,JDT就是其中的典型代表。JDT的全称是Java Development Tools,是Eclipse的核心组件,主要用于Java程序的组织编译调试和运行等。在Java源码解析上,JDT提供了一个AST组件(Abstract Syntax Tree, 抽象语法树 )来做Java程序分析。通过AST,编译器会把代码转化成一棵抽象语法树,树上的每个节点代表一个代码元素(变量、方法、逻辑块等),同时针对节点的类型和属性解析提供完整的能力。

利用JDT-AST解析 Java源码的基本能力展示 如下所示。

01.         //获取Java源码

02.           String content =  read (javaFilePath)

03.         //创建语法解析器

04.           ASTParser parsert = ASTParser. newParser (AST. JLS4 );

05.         //设定解析器的源代码字符

06.           parsert. setSource (content. toCharArray ());

07. //使用解析器进行解析并返回AST上下文结果(CompilationUnit为根节点)  

08.           Comp ilationUnit result = (CompilationUnit) parsert. createAST ( null );

09.         //获取类型

10.           List types = result. types ();

11.           //取得类型声明( 可能有多个类定义 )

12.           TypeDeclaration typeDec = (TypeDeclaration) types. get (0);

13.         //取得包名

14.           PackageDeclaration packetDec = result. getPackage ();

15.         //取得类名

16.           String className = typeDec. getName (). toString ();

17.           //取得函数(Method) 声明列表

18.           MethodDeclaration methodDec[] = typeDec. getMethods ();

19.           //取得函数(Field) 声明列表

20.           FieldDeclaration fieldDec[] = typeDec. getFields ();

21.         //继承的类或者实现的接口

22.           for  (Object obj :typeDec. superInterfaceTypes ()){

23.               System. out . println ("interface:" + obj);

24.         }

25.           System. out . println ("extends:" + typeDec. getSuperclassType ());

26.         //输出包名

27.           System. out . println ("包名:" + packetDec. getName ());

28.         //输出类名

29.           System. out . println ("类名:" + className);

30.         //输出引用import

31.           System. out . println ("引用import:");

32.           for  (Object obj :result. imports ()) {

33. ImportDeclaration importDec = (ImportDeclaration) obj;

34.               System. out . println ("     " + importDec. getName ());

35.         }

36.

37.         //循环输出变量

38.           for  (FieldDeclaration fieldDecEle :fieldDec) {

39.               for  (Object obj :fieldDecEle. fragments ()) {

40.                   System. out . println ("类变量:"+fieldDecEle. getType ()+"     " +                          ((VariableDeclarationFragment) obj). getName ());

41.             }

42.         }

43.           for  (MethodDeclaration method :methodDec) {

44.               System. out . println ("方法:" + method. getName ());

45.             //遍历方法内变量

46.             List

mParams = method.
parameters ();

47.               if  (mParams !=  null ) {

48.                   for  ( int  i = 0;i < mParams. size () ;i++ ) {

49.                       SingleVariableDeclaration sVar = mParams. get (i);

50.                       System. out . println ("     方法变量:" + sVar. getType ().                              toString () + " " + sVar. getName (). toString ());

51.                 }

52.             }

53.             //遍历方法内逻辑块

54.               Block body = method. getBody ();

55.               if  (body ==  null ) {

56.                   continue ;

57.             }

58.               List statements = body. statements ()

59.               Iterator iter = statements. iterator ();

60.               while  (iter. hasNext ()) {

61.                   Statement stmt = (Statement) iter. next ();

62.                   System. out . println ("       逻辑块类型:" + stmt. getClass ().                           getSimpleName ());

63.             }

64.         }

通过JDT-AST可以解析出某个类所有引用的其他类(import)列表、类变量列表、类函数列表、函数内变量列表和函数内逻辑块。有了这些基础信息之后,再遍历每个方法中的每一行,通过正则表达式可以获取此代码行所调用的变量及其方法。比如,针对下面的代码:

params.put "isAdded", remind.getIsAdded());

通过正则表达式:

[a-zA-Z0-9_//$]+[ |/r|/n]*/.[ |/r|/n]*[a-zA-Z0-9_//$]+/

可以识别出如下两个子串:

1 params.put(

2 remind.getIsAdded(

对上面的结果稍加处理,可知上述代码分别调用了变量params的put方法和变量remind的getIsAdded方法。基于这个结论,再根据类变量列表及函数内变量列表匹配到对应的类上,即可获得某个类方法调用其他类方法的情况。微服务本身即以类方法(或接口)的形式存在,因此,通过这种方式可以获得微服务之间的调用关系,具体解析过程如图2. 12 所示。

用代码“读懂”代码:衡量开发交付质量(微服务度量之一)

图2.12 通过JDT-AST解析Java文件获取方法间的调用关系

有了这些信息,就可以逐个遍历方法,扫描方法的每一行代码,通过前面识别出的类变量及方法变量,找出这些变量的对外调用,从而构建出某个类方法对其他类方法的调用关系。如果把源码库中所有微服务工程的源码都进行扫描,可以获得一个 Map<string,list></string,list 对象集合,Map的key是某个类方法,Value是其调用的其他类方法的集合(为了程序处理方便,可能还需要构建一个类似的 被调用 关系集合Map)。在此基础上对这个Map进行递归遍历,就可以找出所有这些类方法的调用链路关系,如图2.1 3 所示。图中的 F#Func1 K#Func1 是微服务的调用入口,一般都作为调用契约以接口的形式存在。在进行代码扫描时,要注意将其与实现类做关联(接口和实现类的关联关系可以通过AST获得。

用代码“读懂”代码:衡量开发交付质量(微服务度量之一)

图2.13 微服务内部及微服务间的方法级别的调用链路关系

把如图2.1 3 所示的这些调用链路关系合并,可以构建一个如图2. 11 右边所示的完整的方法级别的调用矩阵,微服务间的调用是这个调用矩阵的一个子集。

图2.1 4 是一个真实静态调用链的示例,以一个类方法为起点,找到它调用的所有其他方法,逐层遍历后,就能得到图中所显示的调用层级关系。图2.1 4-① 是这种调用关系的文本描述,从图中可以清晰地看到方法间调用的先后和层级关系。

要注意的是类的实现和继承关系。接口类方法或者抽象类方法是没有具体实现逻辑的,所以在程序扫描时,还需维护类直接的继承和实现关系。接口方法往往用具体的实现类方法来代替,这样就能顺利地找到它的下一层引用关系。

如果引入诸如mxGraph这类图形化展示组件,可以将图2.1 4-① 中类方法间的调用关系用一棵从上至下、从左至右的调用树图来展示,如图2.1 4- ②所示。调用树上每一个节点就是一个类方法,节点间的箭头连线就是一个调用关系。通过JDT能够识别出方法注释,还可以将方法注释在每一个类方法节点的右边列出。如果系统注释完整,那么通过一张图就可以基本读清楚一个微服务入口方法的完整实现细节。

如果一个方法类的结构比较复杂,例如它有IF …ELSE关系或者FOR循环等嵌套调用关系,也可以用JDT识别,将这种关系在调用线条上列出。这样就能清楚 地知道这是一种分支调用关系还是一种循环调用关系。

用代码“读懂”代码:衡量开发交付质量(微服务度量之一)

图2.14 静态调用链的文本展示形式和图形展示形式的对照

由于扫描的是所有相关工程的代码,一张图上就包含了所有层级的服务或系统之间的RPC调用关系。通过包名来对不同的业务层级(前台、中台、后台)进行识别,并为不同包名的图形单元赋予不同的颜色,通过颜色的区分可以清楚地知道一个方法的调用究竟涉及多少个系统,在每个系统中的入口是什么、出口又是什么等。

这里存在一个问题,就是如何将源码扫描获取到的类方法(微服务的API)与需求/开发任务管理系统中的UserStory和Task关联上?可以强制要求在微服务API入口方法(或者微服务类声明)的注解(例如JavaDoc)上标注UserStory和Task的ID,扫描源码时通过对注解的解析即可将方法和需求或任务进行关联。不用担心开发人员不标注或者忘了标注,因为我们可以通过比对需求列表和源码的映射关系来监控开发人员是否贯彻了注解标注规范,如果有需求没有找到对应的方法或API入口,即可自动通知相应的开发人员及时修改。

有了以上信息,通过对最终构建出来的大调用矩阵不同维度的分析,可以获得很多微服务的开发及设计质量方面的度量信息,包括请求的调用链深度、服务间的依赖程度、服务的粒度等。这些度量信息将会作为微服务治理的度量及判定依据。

小贴士

笔者另外准备了一个更完整的JDT-AST源码解析示例,能够详细展示如何通过对一个Java类文件的解析来获得类的相关调用关系,限于篇幅,就不在本书中贴出其详细源码了,请读者自行从本书的GitHub源码下载站点中下载并运行,体验解析过程。

参与相关讨论,请在公众号回复关键词:读者群。

参与相关讨论,请在公众号回复关键词:读者群。 

往期推荐

  • 数据治理系列:一个数据质量监控系统的自我修养

  • 小团队也能做中台

  • 重启大法好!线上常见问题排查手册

  • 技术人员的耐心和包容心

  • 重温FinTech发展规划,分布式数据库计算、大数据、AI…

技术琐话 

以分布式设计、架构、体系思想为基础,兼论研发相关的点点滴滴,不限于代码、质量体系和研发管理。本号由坐馆老司机技术团队维护。

用代码“读懂”代码:衡量开发交付质量(微服务度量之一)

原文 

http://mp.weixin.qq.com/s?__biz=MzIxMzEzMjM5NQ==&mid=2651038166&idx=2&sn=b39a7a203cf1066a12a34f8814df2cbb

本站部分文章源于互联网,本着传播知识、有益学习和研究的目的进行的转载,为网友免费提供。如有著作权人或出版方提出异议,本站将立即删除。如果您对文章转载有任何疑问请告之我们,以便我们及时纠正。

PS:推荐一个微信公众号: askHarries 或者qq群:474807195,里面会分享一些资深架构师录制的视频录像:有Spring,MyBatis,Netty源码分析,高并发、高性能、分布式、微服务架构的原理,JVM性能优化这些成为架构师必备的知识体系。还能领取免费的学习资源,目前受益良多

转载请注明原文出处:Harries Blog™ » 用代码“读懂”代码:衡量开发交付质量(微服务度量之一)

赞 (0)
分享到:更多 ()

评论 0

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址