vlambda博客
学习文章列表

开发工具安装代码规范检测插件

前言

编码也是创造,并且经常需要团队协作进行创造,对于产出更是需要持续进行维护和扩展。团队遵守统一的编码规范,有利于产出可读性、扩展性良好的代码。一时之间编写出翔一样的代码不可怕,可怕的是习惯性的把翔拿在手里天天把玩,更过分的是,还塞给别人。


背景介绍

Alibaba Java Coding Guidelines 是阿里巴巴基于《阿里巴巴Java开发规约》手册内容,研发出的一款自动化的IDE检测插件(IDEA、Eclipse)。目的是让开发者更加方便、快速规范代码格式该插件在扫描代码后,将不符合规约的代码按Blocker/Critical/Major三个等级显示在下方。在编码过程中,使用JavaCoding Guidelines 插件可更方便的统一编码风格,养成良好的编码习惯。在IDEA上,基于Inspection机制提供了实时检测功能,编写代码的同时也能快速发现问题。

https://github.com/alibaba/p3c


IntelliJ IDEA安装

1、在线安装

开发工具安装代码规范检测插件


2、离线安装

先在官网下载JavaCoding Guidelines 插件包,然后在IDEA中使用离线安装:

开发工具安装代码规范检测插件


https://plugins.jetbrains.com/plugin/10046-alibaba-java-coding-guidelines/versions


Eclipse安装

开发工具安装代码规范检测插件

Java Coding Guidelines: https://p3c.alibaba.com/plugin/eclipse/update


IDEA使用示例

1、在类中右键可发现菜单中出现检查功能

开发工具安装代码规范检测插件

2、检查结果

1)工程全部文件或单个文件扫描


2)编码实时动态扫描


3、检查结果说明

1)  Blocker:表示可能存在隐患,可能会造成系统异常、阅读歧义或计算错误;

2)  Critical:表示可能存在缺陷,但不会影响系统稳定性;

3)  Major:表示可能存在优化项,可能存在性能或兼容性问题;


总结

Alibaba Java Coding Guidelines主要对编码规范进行检查,可结合另外一个插件 :FindBugs 一起使用。FindBugs 插件可帮助查找代码中隐藏的bug,插件安装类似上述步骤。