android:阿里编码规约初体验

一、阿里编码规约简介

阿里编码规约是由阿里巴巴 P3C 项目组开发的针对 Java 语言的代码检测插件。

能够在编码时给出编码建议,也能够在代码Review的时候扫描潜在的代码隐患。

该插件已经在 Github 上开源,地址为:https://github.com/alibaba/p3c

二、AndroidStudio集成阿里编码规约

(1)、集成步骤示意图

步骤1:打开通用设置界面
步骤2:切换到 Plugins 菜单并选择底部的 Browse Reposiories
步骤3:搜索并安装,底部进度条走完之后表示安装成功,此时直接重启即可。如果不确定是否已经安装上,可以直接右键左侧栏中插件名称,在弹出的邮件菜单中查看 DownloadAndInstall 是否为灰色不可点击状态,如果是表示安装完成,直接重启AS即可
步骤4:重启AS之后,在Tools 中能看到 阿里编码规约条目,表示安装成功

三、简单设置

在上面 步骤4 的图中,我们能看到 阿里编码规约 中共有三个子菜单,分别是:

图标 子菜单名称 含义/功能
编码规约扫描 检测代码中的隐藏问题,未选中module时,默认分析当前的文件;如果想分析module,则先在左侧选中,然后点击分析。具体参考四 基本使用中的动图。
是否开启实时检测 编码过程中是否开启实时检测并提醒,默认开启
切换语言 支持中文和英文模式,默认与根据当前设备的语言设置同步。切换语言之后需要重启AS才能生效

四、基本使用

(1)、问题分类

使用阿里编码规约扫描出来的问题分为三种:

种类 大致含义
Blocker Blocker 是较严重的,极易出问题的
Critical Critical是一般的,可能会出问题的;
Major Major 是一些规范和优化级别的

1)、Blocker示例:

Blocker示例

上图中,提示我们要用 ScheduledExecutorService 替代 Timer,并给出了原因:Timer运行多个TimeTask任务时,只要其中一个挂掉了,其他的TimeTask也不会执行,而ScheduledExecutorService则不会。

补充:ScheduledExecutorService 代码示例

ScheduledExecutorService executorService = new ScheduledThreadPoolExecutor(1, new BasicThreadFactory
                   .Builder().daemon(true).build());
executorService.schedule(new Runnable() {
      @Override
      public void run() {
           //do something
           handler.sendEmptyMessage(PlayAudioOver);
     }
}, 1000, TimeUnit.MILLISECONDS);

在上述代码中,创建一个 executorService , 1000毫秒之后发送handler空消息执行某个任务。这里在引入 BasicThreadFactory 的时候需要添加 dependencies: compile 'org.apache.commons:commons-lang3:3.5'。在上面的Blocker示例的图中,我们能看到除了提示信息之外,还有示例代码,示例代码的第一行给我们指出了 BasicThreadFactory 所处的包

2)、Critical示例:

Critical示例

上图中,Switch语句中没有default语句,就给出了提示,并指明了所在文件和文件中的位置

3)、major示例

major示例

上图中提示说不能出现魔法值,就是未经定义的数值常量或者字符串常量,要求我们在使用前先定义。

(2)、基本使用示例

1)、分析当前文件

分析当前文件:未选中左侧module时,默认分析当前文件。分析完成后,底部会多出一个 Inspection Results ,里面展示了具体的分析结果

2)、分析module

分析module:先在左侧点击module名称,然后Tools--阿里编码规约--编码规约扫描

3)、分析并修改

下面演示一个分析并修改的案例。

在下面的案例中我们没有选中左侧的module,而是直接点击的分析,那么就会分析当前正在打开的文件——MainActivity.java

另外,由于当前使用的LICEcap , 无法录制菜单栏,但,我们在二(1)集成步骤示意图 的 步骤四 中能够知道 阿里编码规约 的入口 是在 Tools 菜单中

分析并修改

在上面的动图中,共扫描出了 1个Blocker , 4 个 Critical,60 Majors 。

动图中以修改Critical为例,展开条目后,会提示问题位置的文件和行号,直接双击具体的行号条目会实现跳转,直接跳转到问题位置。如下图:

双击定位问题位置

将光标放置到上面后会以popup的形式提示你为什么要修改,如果提示过长后面还有一个超链接的 more 字样,点击more 可以查看完整提示信息。如下图:

查看完整提示信息

定位到问题位置后,可以手动 Shift + F6 按照提示批量修改,也可以直接 Alt+Enter 实现自动修复。(注意:此处的快捷键是 MAC 系统下 MAC OX 10.5+模板的快捷键,其他系统或者其他模板的快捷键会有不同)自动修复如下图:

Alt + Enter 的自动修复提示

修改完成之后,在末尾会有 No longer valid 字样,表示已经修改完毕了。如下图:

No longer valid

五、总结

阿里编码规约支持中文,扫描速度快,提示也是中文易于理解。

但是,个人认为扫描准确度和深度较 FindBugs等还有差距。

六、附录:

参考链接 https://juejin.im/post/59e2e0bd6fb9a0450d101de9

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

推荐阅读更多精彩内容