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

01

前言

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

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

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

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

02

功能介绍

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

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

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

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

03

安装

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

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

安装:

重启 就可以了!

04

使用介绍

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,会如图弹框提示,开发者可继续提交,或者取消去修改代码。

原文发布于微信公众号 - Android机动车(JsAndroidClub)

原文发表时间:2017-10-18

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏FreeBuf

新痛点:APT组织PawnStorm 0Day如何绕过Java点击播放保护

几个月以前,趋势科技发现了APT组织Pawn Storm利用之前未经披露的Java漏洞(CVE-2015-2590)进行攻击。在那之后,我们注意到一个被用于染过...

20560
来自专栏杨建荣的学习笔记

了解一下CPU 第一篇(r4笔记第30天)

CPU可能对于我们来说是熟悉又陌生的,每天的工作基本都离不开CPU,CPU的消耗是系统负载的一个重要指标,每天都会不定时的来看看CPU的使用情况,但是对于它了解...

35240
来自专栏aCloudDeveloper

UNIX环境高级编程笔记之文件I/O

一、总结   在写之前,先唠几句,《UNIX环境高级编程》,简称APUE,这本书简直是本神书,像我这种小白,基本上每看完一章都是“哇”这种很吃惊的表情。其实大概...

242100
来自专栏IT笔记

记一次JavaWeb网站技术架构总结

题记 工作也有几多年了,无论是身边遇到的还是耳间闻到的,多多少少也积攒了自己的一些经验和思考,当然,博主并没有太多接触高大上的分布式架构实践,相对比较零碎,随时...

483110
来自专栏云计算教程系列

如何在Debian上安装MutliCraft

PS:本文撰写前已查询相关法律,本文内容不违反《互联网文化管理暂行规定》,遵守EULA协议,请勿举报。

20530
来自专栏王亚昌的专栏

iostat命令使用

天刚上线了一台server,观察了一下,发现io比较高,想到了iostat命令,观察了一下(每隔一秒打印一次),发现有一个守护进程每隔几秒就写一次IO,再top...

8720
来自专栏程序猿DD

自建API网关「架构设计篇」

阅读对象 传统企业正在做微服务架构转型的开发人员或者架构师,希望本文对您能起到一定的引导作用。 API网关介绍 网关一词较早出现在网络设备里面,比如两个相互独立...

1.5K70
来自专栏圣杰的专栏

使用Bitbucket Pipeline进行.Net Core项目的自动构建、测试和部署

1. 引言 首先,Bitbucket提供支持Mercurial和Git版本控制系统的网络托管服务。简单来说,它类似于GitHub,不同之处在于它支持个人免费创建...

32290
来自专栏FreeBuf

打开文件夹就运行?COM劫持利用新姿势

*本文原创作者:菠菜,本文属FreeBuf原创奖励计划,未经许可禁止转载 打开文件夹就能运行指定的程序?这不是天方夜谭,而是在现实世界中确实存在的。利用本文探讨...

26480
来自专栏企鹅号快讯

TRITON恶意软件攻击工业安全系统

简介 FireEye的Mandiant调查部最近响应了一个关于关键设施企业的应急事件,事件中攻击者用恶意软件来控制工业安全系统(industrial safet...

371100

扫码关注云+社区

领取腾讯云代金券