如何用工具检查 ABAP 代码是否符合 Clean ABAP 编码规范

本文在 ABAP 系统里的操作截图,来自 SAP 社区博客,地址如下:

笔者之前的文章,介绍了 Clean ABAP 的概念。

聊聊 Clean ABAP

简单的说,Clean ABAP 由四个“一”组成:一个由 SAP 主推的开源项目,一套通用的 Clean ABAP 编程规范,一套匹配该规范的代码扫描工具,加上一套对应的代码自动重构工具。

图中紫色的椭圆区域,包含的就是 Clean ABAP 编程规范,在笔者之前的文章有详细介绍:

SAP 官方 ABAP 编程规范(2023 版)

本文介绍下图粉色椭圆区域的内容:Code pal for ABAP,一个开源的 ABAP 代码扫描工具。

该工具基于 Clean ABAP 编码规范对 ABAP 代码进行扫描。

当然,工具不可能 100% 覆盖编码规范中定义的所有规则,因此图中 Code pal for ABAP 所占的区域,只是 Clean ABAP 编码规范的一个子集。

pal 在英语中有朋友,老兄,兄弟的意思。

Code pal for ABAP 是开源工具,Github 地址如下

使用 abapGit 将其源代码克隆到本地 ABAP 系统。

笔者之前的文章已经介绍过 abapGit 的使用:

使用 abapGit 在 ABAP On-Premises 系统和 SAP 云平台 ABAP 环境之间进行代码传输

从官网上将 abapGit 的完整源代码,拷贝到 ABAP 系统里新建的报表里,激活即可使用。

新建一个 Online Repository:

输入 Code pal for ABAP 的 Github 地址,点击 Create Online Repo:

点击 Pull,即可把远端 Github 网站的 ABAP 代码,全部拉取到本地 ABAP 系统里,自动生成对应的 ABAP 类和其他开发资源。

激活这些 ABAP 开发资源之后,使用事务码 SCI 进入 ABAP Code Inspector,开启 Code pal for ABAP 的扫描选项:

选中所有 Test Category 为 code pal for ABAP 的检查规则:

新建一个 Check Variant,包含刚才开启的检查规则:


单击每个 Checks 的 Attributes 按钮,可以对违反这个检查规则的 ABAP 代码的处理行为,进行自定义。

比如对于输入参数类型为布尔类型这条检查规则,可以定义违反规则后抛出消息的严重级别,以及是否允许通过 ABAP Pragma #EC BOOL_PARAM(一种特殊的注释) 来屏蔽掉。

配置完毕之后,就能在 ABAP Development Tool 的 ATC 工具里使用了:

选择刚才创建的包含了 Code pal for ABAP 检查的 Check Variant 即可:

完成代码扫描之后,选中每条检查结果,可以看到详细的错误说明和解决方案提示。

在 SAP BTP ABAP 云端编程环境里,可以使用 Code pal for ABAP 的云版本。

在 ABAP Development Tool 里打开 abapGit 仓库的视图:

把 Code pal for ABAP 对应的云端版本克隆下来即可:

https://github.com/SAP/code-pal-for-abap-cloud

之后就能够看到对应的检查规则了。后续的使用方法,同 ABAP Opportunities 环境里一致。

Code pal for ABAP 里的很多检查选项,能够给我们提供一些有意思的思考。

每个选项在 Github 上都有一个对应的文档,介绍了引入这个检查选项的初衷和背景,以及一些讨论。

比如一个方法的输入参数,选择布尔数据类型,有什么好处和弊端?

其对应的文档链接如下:

https://github.com/SAP/code-pal-for-abap/blob/master/docs/checks/boolean-input-parameter.md

为什么 Clean ABAP 编程规范里,不推荐在方法设计时,使用布尔类型的输入参数呢?

因为编程规范认为,这种设计有违反设计领域里单一职责 - Single Responsibility 的嫌疑。

比如下面这个方法:

METHODS update
  IMPORTING
    do_save TYPE abap_bool.

在 update 的实现体内,完成的逻辑是:如果传入的输入参数值为 abap_false, 那么只修改内表值,不进行 commit 操作。反之,调用另一个 Update Function Module 执行数据库层面的修改。

表面上看,用一个方法,处理了两种业务场景,节省了代码量。

但是 Clean ABAP 编程规范认为,这样的设计增加了 update 方法的测试复杂度,同时也降低了消费 update 方法的代码的可读性。

消费 update 方法的应用代码:

do_save(abap_false).
do_save(abap_true).

上面这种消费代码方式,并不是自描述的。

接手这段代码的维护人员,可能看了之后一头雾水:这里的 abap_true 和 abap_false, 是用来区分 save 操作是同步或者异步?是真实提交或者 simulation 即模拟方式提交?是保存时考虑或者忽略权限检查?

总之在阅读 do_save 方法实现源代码之前,维护人员只能瞎猜。

Clean ABAP 编程规范的建议就是:简单的将 do_save 拆分成两个方法:

METHODS update_without_saving.
METHODS update_and_commit.

虽然看起来可能有点笨拙,但提高了代码的可测试性和可读性。

总之,Clean ABAP 编码规范和其配套的工具,不但能从规则和技术上,确保 ABAP 代码符合 Clean 规范,而且通过阅读编码规范的文档,也能从中学到很多编码的最佳实践和准则。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,491评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,856评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,745评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,196评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,073评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,112评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,531评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,215评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,485评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,578评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,356评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,215评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,583评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,898评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,174评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,497评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,697评论 2 335

推荐阅读更多精彩内容