阿里巴巴Java开发手册

在进入正题介绍这款插件之前,首先来谈一下《阿里巴巴Java开发手册》,2017年年初,首次公开的阿里官方Java代码规范标准手册可以说是引起了全民(IT界)代码规范的热潮,相信这个手册很多行业内的朋友都比较熟悉,毕竟有"大厂光环",想低调都难,这个手册的愿景是:

"统一规范标准将有助于提高行业编码规范化水平,帮助行业人员提高开发质量和效率、大大降低代码维护成本"

至今为止已更迭了三个版本,2017年9月25日,《阿里巴巴Java开发手册(终极版)》正式发布,也是阿里官方对外发布的最后一个PDF版本。最新版下载地址在这里

插件介绍

《阿里巴巴Java开发手册》自从第一个版本起,倍受业界关注,相信很多人对其中的规则也有了一定的了解,很多人甚至希望能尽快在自己的团队推行起来,这样大家有了一套共同的开发准则。但是,如何更好的去遵守规则并且按照手册去开发我们的系统确变得不那么容易,为了让开发者更加方便、快速的将规范推动并实行起来,阿里巴巴基于手册内容,研发了一套自动化的IDE检测插件(IDEA、Eclipse), 该插件在扫描代码后,将不符合《手册》的代码按Blocker/Critical/Major三个等级显示在下方,甚至在IDEA上,还基于Inspection机制提供了实时检测功能,编写代码的同时也能快速发现问题所在。对于历史代码,部分规则实现了批量一键修复的功能,提升代码质量,提高团队研发效能。

代码已经开源,GitHub:https://github.com/alibaba/p3c

我们来体验一下吧!

插件使用简易教程(基于IDEA)

搜索插件

打开IDEA,选择Preferences - Plugins - Browse repositories后,在输入框中输入"alibaba",可以看到返回结果中有"Alibaba Java Coding Guidelines"。

在一周前开始构思这篇文章时,已经有16340的下载量了,现在应该更多了,赞一下。

安装插件

点击插件详情中的"install"按钮,按照其提示即可完成安装,安装完成后需重启IDEA。

功能体验

安装后完成后,需要重启IDEA,重启后就可以在菜单栏中看到它的功能按钮,有三种方式可以扫描代码:

  • 在项目目录上右键点击也会出现这两个功能按钮,点击绿色的按钮即可开始扫描代码,或者在工程目录上右键也会出现检测的功能按钮。
  • 如果不想全部扫描,只扫描当前编辑的文件的话,在当前文件面板中点击右键也会出现此功能按钮。
  • 前面说的两种方式是手动检测,插件也提供了实时监测的功能,此功能默认开启,一旦开启则会在你编写代码时就会实时监测,一旦有不符合规范的语句就会出现错误提示。

    由于大括号不规范的问题,if下方有错误红线的提示。

    idea中有quick fix快捷键:option/alt+enter,点击后则可以自动添加大括号。

扫描代码后,不符合规约的代码会按Blocker/Critical/Major三个等级显示在下方面板中,如图:

左边是扫描出的不符合规范的代码,依次点进去可以看到是代码的多少行出现了规约问题以及哪一个规约问题,右边则是规约的详细描述及实例代码。

不仅如此,右侧还有quick fix的按钮,点击后直接可以改正代码,但是并不是所有的问题都有此按钮,有些问题还是需要手动修改。

支持版本

IDEA官方仓库:最低支持版本14.1.7,JDK1.7+
Eclipse版插件:支持4.2(Juno,JDK1.8+)及以上版本

检测更新

可以通过 Help >> Check for Udates 进行插件新版检测

插件卸载

在插件面板点击"uninstall"即可。

使用感受

并没有在插件刚出来的时候整理这篇文章,而是使用了一段时间后才决定写这篇文章,目前已经使用了一个多星期,整体的感觉还算满意,可能是一开始的要求和期待有点高了,使用后觉得也就那样,100分的话给80分吧(个人意见,不用太在意),其中10分是因为中文的原因,哈哈哈哈。

先整理一下比较明显的优点:

  • 中文提示,且按照《阿里巴巴Java开发手册》给出详细的提示和解释,看起来真的很舒服。
  • 能够检测出一些平时不在意的问题,可以提高开发编码过程中对于细枝末节的注意。
  • quick fix,检测出问题后点击一下按钮即可完成代码的修改。
  • 基本满足代码规范检测的需求。

缺点嘛,也存在:

  • 只支持IDEA和Eclipse,且对版本有要求。
  • 有错别字(小问题)。
  • 有bug。

目前此插件还处于第一个公开版本,所以肯定还有一些小问题或者小bug,以后应该会慢慢修复的,但是已经基本满足代码审查的需求了,用起来也比较满意。不过,一些容易产生空指针异常的语句和问题,好像并不能检查出来,只是满足基本的代码质量检测,如果要求较严格的话,还是需要使用SonarQube这种较专业的工具来进行代码质量检测和分析,相比较而言,p3c较为基础,SonarQube较为齐全一些,不过这种比较也是不对称比较,目前来看,两者根本不是一个量级的工具。

多说几句,此插件所使用的规范为阿里公布的那套规范,肯定与其他规范有少许的出入和不同,记得在阿里这份规范公布时,有人甚至在评论区用"八股文"来形容它,我感觉没这么恐怖吧,规范嘛,你遵守了就是规范,你不遵守它算个什么东西啊,各家有各家的规范,也不可能完全统一,选择适合自己的就好,没必要上纲上线,言尽于此,不找骂了。

总结

是不是使用了这个插件之后就能够让我们的代码中少一些Bug?是不是我们就能少踩一些坑?答案肯定不是,插件只有检测和提示作用,真正的编码者依然是自己,所以不要本末倒置,这只是一个工具而已,这种想法一定不能存在,真正要写出健壮代码最重要的还在于编码者自己。

首发于我的个人博客,2017年10月22日。

阿里巴巴Java开发规约插件p3c详细教程及使用感受的更多相关文章

  1. 阿里巴巴Java开发规约插件p3c详细教程及使用感受 - 转

    http://www.cnblogs.com/han-1034683568/p/7682594.html

  2. 【Z】扩展阿里巴巴Java开发规约插件

    https://blog.csdn.net/u014513883/article/details/79186893 1.前言 工作中难免会遇到维护别人代码的情况,那么首先就得看懂别人写的代码.如果对方 ...

  3. 扩展阿里巴巴Java开发规约插件(转)

    转自:https://blog.csdn.net/u014513883/article/details/79186893 1.前言 工作中难免会遇到维护别人代码的情况,那么首先就得看懂别人写的代码.如 ...

  4. 阿里巴巴Java开发规约插件-体验

    插件有哪些功能? 阿里技术公众号于今年的2月9日首次公布<阿里巴巴Java开发规约>,瞬间引起全民代码规范的热潮,上月底又发布了PDF的终极版,大家踊跃留言,期待配套的静态扫描工具开放出来 ...

  5. 阿里巴巴 Java 开发规约插件初体验

    阿里巴巴 Java 开发手册 又一次来谈<阿里巴巴 Java 开发手册>,经过这大半年的版本迭代,这本阿里工程师们总结出来避免写出那么多 Bug 的规范,对于 Java 开发者简直就是必备 ...

  6. 阿里巴巴Java开发规约插件安装使用指南

    编码规范插件安装使用指南 阿里技术公众号于今年的2月9日首次公布<阿里巴巴Java开发规约>,瞬间引起全民代码规范的热潮,后又发布了PDF的终极版,大家踊跃留言,期待配套的静态扫描工具开放 ...

  7. IDEA阿里巴巴Java开发规约插件使用

    前言 2017年2月9日,首次公布<阿里巴巴Java开发手册>; 2017年9月25日,阿里巴巴集团发布了<阿里巴巴Java开发手册>PDF终极版; 2017年10月14日,在 ...

  8. 阿里巴巴Java开发规约插件

    就在今天 10月14日上午9:00 阿里巴巴于在杭州云栖大会<研发效能峰会>上,正式发布<阿里巴巴Java开发手册>扫描插件,该插件在扫描代码后,将不符合<手册>的 ...

  9. 阿里巴巴Java开发规约插件全球首发!(转)

    https://mp.weixin.qq.com/s?__biz=MzI0NTE4NjA0OQ==&mid=2658355901&idx=1&sn=3169172bfc6819 ...

随机推荐

  1. 201521123067 《Java程序设计》第14周学习总结

    201521123067 <Java程序设计>第14周学习总结 1. 本周学习总结 1.1 以你喜欢的方式(思维导图或其他)归纳总结多数据库相关内容. 2. 书面作业 Q1. MySQL数 ...

  2. Java程序设计——学生基本信息管理系统

    1.团队课程设计博客链接 http://www.cnblogs.com/handsome321/p/7067121.html 2.个人负责模块说明 本组课题:学生信息管理系统 本人任务:插入.删除学生 ...

  3. 【干货】教你如何利用fullPage.js以及move.js插件打造高端大气的网站效果!

    前言: 如今我们经常能见到全屏网站,尤其是国外网站.这些网站用几幅很大的图片或色块做背景,再添加一些简单的内容,显得格外的高端大气上档次. 在学习过jQuery插件之后,才发现之前的很多网站特效完全可 ...

  4. postman: 用于网页调试和发送Http请求的chrome插件

    一 简介 Postman 是一款功能超级强大的用于发送 HTTP 请求的 Chrome插件 .做web页面开发和测试的人员应该是无人不晓无人不用!其主要特点 特点: 创建 + 测试:创建和发送任何的H ...

  5. springmvc05-Spring+Springmvc+Hibernate实现简单的用户管理系统

    1, 导入\spring-framework-3.2.4.RELEASE\libs\disk下所有包; hibernate-distribution-3.6.7.Final\lib\required下 ...

  6. CSS 基本样式

    1.CSS 背景: css 允许应用纯色作为背景,也允许使用背景图像创建相当复杂的效果 属性 描述 background-attachment 背景图像是否固定或者随着页面的其余部分滚动 backgr ...

  7. Java 使用Axis实现WebService实例

    在上一篇WebService实例中,基于jdk1.6以上的javax.jws 发布webservice接口.这篇博文则主要用eclipse/myeclipse 使用axis插件进行发布和调用WebSe ...

  8. 初学者一些常用的SQL语句(一)

    一.数据库的创建create database 数据库名create database bbb二.表的创建 ***[]:可选项*** null:空值 not null 不为空***只有字符型能指定长度 ...

  9. PyTorch教程之Tensors

    Tensors类似于numpy的ndarrays,但是可以在GPU上使用来加速计算. 一.Tensors的构建 from __future__ import print_function import ...

  10. css常见布局方式

    CSS常见布局方式 以下总结一下CSS中常见的布局方式.本人才疏学浅,如有错误,请留言指出. 如需转载,请注明出处:CSS常见布局方式 目录: 使用BFC隐藏属性 float + margin abs ...