1. 背景
在编写ABAP代码时,我们可以通过Pretty Printer (Shift + F1)去完成代码的美化,但Pretty Printer所能提供的仅仅是关键字大小写的设置、以及行首留空格的控制,如下图所示。
也就是说,Pretty Printer所能提供的仅仅是代码格式上的微调,并不能让我们的代码更加的clean。
“Clean”是什么意思呢?这个就要说一说Clean Code的概念了,它从命名规范、格式、常量、变量以及类的使用的方方面面给出了相应的编程原则,核心就是让我的代码变得更加规范、整洁、干净。
这也意味着,如果想让自己的代码更clean些,光靠Pretty Printer去美化下格式是远远不够的,还需要手动去更改代码,去向这些clean的原则靠拢。有关clean design在ABAP中的应用,可以查看Clean ABAP的概念。
今天介绍的ABAP Cleaner是ABAP的ADT编程环境下的一款小插件,可以辅助我们实现clean code的目标。
2. ABAP Cleaner
2.1 简介
ABAP Cleaner是一款可以配置的小工具,旨在帮我我们尽可能多的完成ABAP编程中,可以自动化Clean的部分。
目前,ABAP Cleaner的V0.12版本中内置了60多种可配置的规则,来辅助我们的ABAP编程。
它可以帮助我们完成:清除未使用的变量,转换方法的调用模式(函数式调用),规范条件表达式的写法,使用新语法替代老语法,规范代码格式等工作。
如下图所示,安装完ABAP Cleaner插件后,针对目标代码。通过快捷键Ctrl + 4便可以一键完成自动clean的动作。
2.2 安装
第一步,安装ADT或Eclipse的ADT兼容版,如果你的电脑上已经安装的ADT,则可以直接跳过这一步。
第二步,启动ADT,选择Help >> Install New Software...,然后复制这个链接https://sap.github.io/abap-cleaner/updatesite到 Work with: 字段,点击Enter,然后确认安装。
第三步,安装完成后,重启ADT。在 source code的菜单下,你会发现两个新的功能和其对应的快捷键( Ctrl + 4 or Ctrl + Shift + 4)。
2.3 使用
使用abap cleaner的方法十分简单,通过下面两个快捷方式即可
- Ctrl + Shift + 4:在clean up前,预览结果;并可以完成clean up规则的设定
- Ctrl + 4:基于设定的规则,直接完成clean up。无预览步骤。
使用Ctrl + Shift + 4,可以打开预览界面,在这个页面可以完成对于abap cleaner的设置。
点击Edit Profie and Rules,可以看到当前ABAP Cleaner所支持的规则,你可以选择激活特定的规则,并可以对规则进行相关参数的配置。
配置完规则后,可以直接通过Ctrl + 4,对于ABAP代码进行clean up。
若仅想clearn up部分代码,则可以通过选中代码块,然后在使用Ctrl + 4或 Ctrl + Shift + 4的方式。也就是说,ABAP Cleaner支持框选的模式。
3. 小结
本文介绍的ABAP Cleaner的安装和使用方法,希望各位小伙伴借助这个工具,可以写出更加优雅的ABAP代码。