阿里发布的规约插件使用指南

一、前言

10月14日,阿里巴巴在杭州云栖大会上,正式发布了由阿里巴巴 P3C 项目组,经过 247 天的持续研发,正式发布众所期待的 《阿里巴巴 Java 开发规约》的扫描插件!

把《阿里巴巴 Java 开发规约》强制条目转化自动插件,并实现部分的自动编码。

该插件已经在 Github 上开源,有兴趣的可以直接去看看。

github.com/alibaba/p3c
或者在Github直接搜索p3c

二、功能介绍

该插件主要是对《阿里巴巴 Java 开发规约》的一个规约,它是一个 IDE 的插件,可以自动对手册中的 Java 不规范的问题进行提示。现在主要支持(IDEA、Eclipse)。

Android Studio 是基于 IDEA 的,所以也是支持 Android 开发人员的。

该插件在扫描代码后,会将不符合规约的代码按照 BlockerCriticalMajor 三个等级显示在下方,甚至在 IDEA 上。

还可以基于 Inspection 机制提供了实时检测的功能,编写代码的同时也能快速发现不规范的代码。而对于历史代码,部分规则实现了批量一键修复的功能。

三、安装

在Android Studio中,和普通插件一样:

File->Setting->Plugins,搜索alibaba,找到Alibaba Java Coding Guidelines ,第一条就是,如图:

这里写图片描述

安装:

这里写图片描述

重启 就可以了!

四、使用

1、语言切换

因为该插件是阿里团队开发,那当然是支持中文的啦。同时也支持英文。

你可以在Tools->Alibaba Coding Guidelines->Switch language to XXX 进行切换

这里写图片描述

切换之后,需要重启才能生效。

2、实时监测

Inspections 大家应该都不陌生,会自动在编码阶段,进行快速灵活的静态代码分析,自动检测编译器和运行时错误,并提示开发人员。

所有的规范,可以在Setting->Inspections中看到:

这里写图片描述

举个例子:

这里写图片描述

可以看到,这里提示ZQWebViewActivity类没有严格按照大驼峰命名法进行命名,也没用注明作者。

可以点击more查看完整提示:

这里写图片描述

3、静态分析代码

该插件除了支持实时监测,也可以静态全局分析代码:

通过Tools->阿里编码规约->编码规约扫描,进行代码扫描,监测代码规范。当然也可以使用快捷键:Ctrl+Alt+Shift+J 。

这里写图片描述

执行完成后,会按照Blocker、Critical、Major(极严重、严重、警告)三个等级来显示不规范的地方:

这里写图片描述

因为当前插件是中文版,所以对于我们来说非常友好!

4、VCS前监测

我们在团队开发时一定会用到版本控制,无非两种:Git和SVN。而此规约插件是同时支持两种版本控制工具的:

这里写图片描述

在代码提交界面,勾选Alibaba Code Guidelines,点击Commit,会如图弹框提示,开发者可继续提交,或者取消去修改代码。

最后

规约插件的介绍大概就是这样,大家可以关注我的微信公众号——安卓干货营,获取更多精彩内容!


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

推荐阅读更多精彩内容