likes
comments
collection
share

ABAP Code Inspector 的一些高级功能分享

作者站长头像
站长
· 阅读数 33

ABAP Code Inspector 是每一位 ABAP 开发人员工具箱里必备的代码检测工具之一。使用 ABAP Code Inspector 自带的标准检查项,可以帮助开发人员快速检测 ABAP 代码中潜在的缺陷,提高代码质量,改善代码运行性能。

本文分享笔者从事 ABAP 应用程序开发十余年来在工作中积累的一些 ABAP Code Inspector 的使用经验。

我们可以在ABAP Code Inspector的检查变体(Check Variant)里,根据自己的需要灵活地选择对ABAP代码进行哪种类型的扫描动作。

ABAP Code Inspector 的一些高级功能分享

下图是一个例子,意思是对ABAP代码中所有对数据库表产生了读写访问之处,进行 Table Names from SELECT Statements 的扫描。该扫描的具体行为,可以点击蓝底白色的感叹号图片,以获得帮助文档。下图这个例子里勾取的选项,意思是检查被访问的数据库表,在SE11的ABAP字段里的Technical Settings是否正确被维护了,比如表的缓存类型是否设置正确。

ABAP Code Inspector 的一些高级功能分享

性能检查

Select-Statement can be transformed. X% of fields used - 检查内表字段的使用率

假设我们使用 SELECT * 从一张表里读取数据到ABAP内表,然后在后续代码中只使用到了A个字段,而读取的表在SE11里总共有B个字段,那么A除以B的结果越小,说明读出来的内表字段使用率越低。

ABAP Code Inspector 的一些高级功能分享

也就是说,你或许该考虑只SELECT真正需要的字段来替代SELECT *? 只需要在上图设置里维护一个最低阀值,当Code Inspector扫描代码时,一旦检测到使用率低于维护的阀值就会报错。上图的20意思是20%.

Search DB Operations in loops across modularization units

Jerry 2007年刚加入SAP开始学习ABAP编程时,前辈们就告诫过我,不要在LOOP里使用SELECT语句,这样会极大影响代码的性能。

ABAP Code Inspector 的一些高级功能分享

上图是通过Code Inspector扫描出来的一个例子,在双重LOOP循环里使用SELECT读取数据库表CRMD_DPP_HI_BLCK.

Nested Loops - 嵌套循环的检测

尽管当应用代码里嵌套循环的循环次数不大时,对代码运行的绝对时间没有太大影响——然而编写具有至少指数级时间复杂度的代码,在任何上下文里都不是一个好的编程习惯。

ABAP Code Inspector 的一些高级功能分享

这个设置能够帮助我们快速找到所有的嵌套循环。

Copy current table row for LOOP AT

ABAP Code Inspector 的一些高级功能分享

找出所有LOOP AT ... INTO之处,理论上这些地方都可以用LOOP AT ... REFERENCE INTO或者ASSIGNING <fs>替换。当内表的行结构体字段很多时,使用后两种方式可以获得一些性能的提升。

Low-Perform. Parameter Transfers - 检测所有参数传递使用"Pass by Value"之处

编程语言里参数传递的 传引用传值 这两种方式的辨析,至今仍然是很多互联网公司的面试题之一。

ABAP Code Inspector 的一些高级功能分享

这个选项可以让您指定针对何种类型的参数进行参数传递方式的扫描:

ABAP Code Inspector 的一些高级功能分享

在ABAP里理论上采用引用传递的方式进行参数传递,性能上总是优于值传递,具体性能会提高多少,依赖于具体传递的参数类型,无法一概而论。

Security Check – Dynamic and Client-Specific accesses in SELECT - 动态SQL语句的检测

符合下列范式的动态SQL会被扫描出来:

  • Dynamic table accesses: SELECT * FROM (dbtab) WHERE …
  • Dynamic WHERE conditions: SELECT * FROM dbtab WHERE (where_cond)
  • Accesses to certain tables: SELECT * FROM dbtab WHERE …
  • Client-specific accesses: SELECT * FROM dbtab FROM WA … CLIENT SPECIFIED …

这个选项并不是禁止您使用动态SQL语句——事实上SAP应用的持久层里有大量的动态SQL语句的使用例子——而是提醒您别忘记了进行SQL注入的预防措施:一旦扫描出来,如果有用户输入参与了这些动态SQL语句的拼接,那就别忘记看看上下文有没有使用CL_ABAP_DYN_PRG对用户输入进行处理。

Search for APPEND and INSERT … INDEX in SORTED Tables

检测所有在有序内表上施加了APPEND操作的地方。有了这个扫描选项,能够帮助您避免下图第13行这种类型的运行时错误。

ABAP Code Inspector 的一些高级功能分享

Check of SY-SUBRC Handing - ABAP关键字调用后系统变量sy-subrc的检测

Jerry至今仍清楚地记得,十多年前上研究生课程《UNIX环境高级编程》时,老师不断地强调在进行系统调用之后一定要检查返回值并进行相应的错误处理。在Jerry看来,错误检测和处理是每一位编程人员都应该具备的基本素养。

ABAP Code Inspector 的一些高级功能分享

对应到ABAP里,就意味着每次调用ABAP的关键字完成某项操作后,都必须检查sy-subrc的值来确认这次操作是否成功。

ABAP Code Inspector 的一些高级功能分享

当然也可以根据项目的实际情况,告诉Code Inspector只检查某些类型的ABAP关键字调用。比如上图意思就是只检查READ TABLE关键字调用后是否进行了sy-subrc的检查。

Missing table content check before calling SELECT … FOR ALL ENTRIES IN

在使用FOR ALL ENTRIES IN <itab>之前,必须先检查内表itab是否为空。这个选项能扫描出没有按照这个规范来编写的代码。

Programming Conventions - Naming conventions

在这个界面里为ABAP里不同类型的变量设置好您团队里达成一致的命名规范,然后Code Inspector就能把代码里所有违反了这些命名规范的地方扫描出来。

ABAP Code Inspector 的一些高级功能分享ABAP Code Inspector 的一些高级功能分享

Metrics and Statistics

这个检查类别下面的设置都是一些很有意思的统计信息。

ABAP Code Inspector 的一些高级功能分享

还是举例说明。下图红色区域的设置,意思是如果一个类的方法内的可执行语句行数超过150行,Code Inspector就报一条警告消息。这是为了避免大家写出一个过于冗长的方法。而蓝色区域的设置是如果每100行可执行代码的对应注释量小于10行,就报一条警告消息。这些阀值可以根据实际情况自行修改或关闭。

ABAP Code Inspector 的一些高级功能分享

FAN-OUT Structural Metrics - 统计一个方法的扇出值

方法的扇入值和扇出值在模块化编程的上下文会经常被提及,这对概念不是编程界首创的,而是源自半导体行业里的逻辑电路设计:

ABAP Code Inspector 的一些高级功能分享

逻辑门的扇出系数定义了该门能够驱动的数字信号输入的最大量,而一个代码模块的扇出值则代表了其直属下层的模块个数。

这个选项能够统计您方法的扇出系数。扇出系数太小,意味着该方法基本没有调用其他下层的函数,这有两种可能:

(1) 该方法的逻辑本身非常简单,只有两三行代码,比如类的setter/getter方法;(2) 这个方法的模块化没有做好,存在优化的空间,比如某些直接写在方法内的语句,可以提炼成下层函数并在方法内调用。

Comment Language Metrics

这个选项可以统计代码中出现的德文注释的函数。

ABAP Code Inspector 的一些高级功能分享

OO Size Metrics

这个选项也是为了防止您不经意间就创造出怪兽级的类(monster class)而生的:一旦您关注的类的属性超过设置的阀值,比如类的成员,类的公/私有方法等关注点超过选项里设置的值时,Code Inspector就会报警。

ABAP Code Inspector 的一些高级功能分享

Program Complexity Test – cyclomatic complexity - 代码环复杂度(圈复杂度)的测试利器

这又是一个能帮助您写出Clean ABAP code的强大工具。

什么是代码的环复杂度?

根据维基百科的定义,我们把一段代码的执行流画成一张有向无环图,然后环复杂度可以通过下面的公式计算出来:

https://en.wikipedia.org/wiki...

环复杂度 = 图的边数 - 图的节点数 + 2

ABAP Code Inspector 的一些高级功能分享

这其实就是我们研究生专业课《图论》里学的欧拉定理。看下面这个例子:

ABAP Code Inspector 的一些高级功能分享

上面这8行ABAP代码,环复杂度为3,怎么计算出来的?先把其对应的有向无环图画出来:

ABAP Code Inspector 的一些高级功能分享

这张图的边数为3,即图中黑色,红色和绿色三条粗线。

这张图的顶点数为2,如图中两个菱形的蓝色图例所示。

最后环复杂度为3 – 2 + 2 = 3.

统计表明,代码的高环复杂度和高故障率之间存在很强的正相关性,这不难理解,代码的环复杂度越高,意味着里面嵌套的IF-ELSE,SWITCH等逻辑越多,无论是代码原来的开发人员,还是后来接手的维护人员,读起来都会觉得头昏脑胀。

因此大家可以多用ABAP Code Inspector的这个扫描选项,随时监控您代码的环复杂度。

ABAP Code Inspector 的一些高级功能分享

Search DB Operations

把您关注的在代码中出现的SQL操作关键字全部罗列出来。

ABAP Code Inspector 的一些高级功能分享

Search ABAP Statement Patterns

这个选项也很有用,能根据您指定的正则表达式扫描ABAP代码。

ABAP Code Inspector 的一些高级功能分享

例如,您希望找出代码里所有出现了READ TABLE XXX WITH KEY X = X的地方,只需要在上图的输入框里填入对应的正则表达式,即用*代表任意字符串:

READ TABLE * WITH KEY * = *

然后ABAP Code Inspector就会按照我们期望的行为去扫描代码:

ABAP Code Inspector 的一些高级功能分享

ABAP报表RS_ABAP_SOURCE_SCAN也能实现完全一致的功能:

ABAP Code Inspector 的一些高级功能分享

总结

ABAP Code Inspector 是每一位 ABAP 开发人员工具箱里必备的代码检测工具之一。使用 ABAP Code Inspector 自带的标准检查项,可以帮助开发人员快速检测 ABAP 代码中潜在的缺陷,提高代码质量,改善代码运行性能。

本文分享了笔者工作多年使用 ABAP Code Inspector 的一些高级功能,从而满足了笔者所在团队对交付的产品代码各个维度的质量检测,监控和报表输出的功能,希望能够对大家的 ABAP 项目开发有所帮助。