ideajava阿里巴巴_AS阿里巴巴Java开发规约CheckStyleIDEA

Alibaba Java Coding Guidelines 简介

Alibaba Java Coding Guidelines 是阿里巴巴发布的基于 IDEA 的 Java 开发规约扫描插件。

经过247天的持续研发&＃xff0c;阿里巴巴于10月14日在杭州云栖大会上&＃xff0c;正式发布众所期待的《阿里巴巴Java开发规约》扫描插件&＃xff01;该插件由阿里巴巴P3C项目组研发。P3C是世界知名的反潜机&＃xff0c;专门对付水下潜水艇&＃xff0c;项目组使用此名称寓意是扫描出所有潜在的代码隐患。这个项目组是阿里巴巴开发爱好者自发组织形成的虚拟项目组&＃xff0c;把《阿里巴巴Java开发规约》强制条目转化成自动化插件&＃xff0c;并实现部分的自动编程。

阿里技术公众号于今年的2月9日首次公布《阿里巴巴Java开发规约》&＃xff0c;瞬间引起全民代码规范的热潮&＃xff0c;上月底又发布了PDF的终极版&＃xff0c;大家踊跃留言&＃xff0c;期待配套的静态扫描工具开放出来。为了让开发者更加方便、快速将规范推动并实行起来&＃xff0c;阿里巴巴基于手册内容&＃xff0c;研发了一套自动化的IDE检测插件(IDEA、Eclipse)。

该插件在扫描代码后&＃xff0c;将不符合规约的代码按Blocker/Critical/Major三个等级显示在下方&＃xff0c;甚至在IDEA上&＃xff0c;我们还基于Inspection机制提供了实时检测功能&＃xff0c;编写代码的同时也能快速发现问题所在。而对于历史代码&＃xff0c;部分规则实现了批量一键修复的功能&＃xff0c;为首次在成熟项目上使用插件&＃xff0c;做了非常友善的支持。如此爽心悦目的功能是不是很值得拥有&＃xff1f;提升代码质量&＃xff0c;提高团队研发效能&＃xff0c;插件将会一路同行。

目前插件实现了开发手册中的的53条规则&＃xff0c;大部分基于PMD实现&＃xff0c;其中有4条规则基于IDEA实现&＃xff0c;并且基于IDEA Inspection实现了实时检测功能。部分规则实现了Quick Fix功能&＃xff0c;对于可以提供Quick Fix但没有提供的&＃xff0c;我们会尽快实现&＃xff0c;也欢迎有兴趣的同学加入进来一起努力。

使用文档

基本使用

在AS的 Setting >> Plugins >> Browse repositories &＃xff0c;搜索关键字『alibaba』&＃xff0c;在结果中找到 Alibaba Java Coding Guidelines 并安装即可。

因为插件zip包托管在Jetbrains官方CDN上&＃xff0c;所以是从国外的服务器进行下载&＃xff0c;可能会出现超时的情况&＃xff0c;如果安装不了&＃xff0c;可以通过手动下载安装包进行安装。插件地址

下载后&＃xff0c;在AS的Settings >> Plugins >> Install plugin from disk...

安装之后&＃xff0c;它会默认使用你当前设备选择的语言环境进行配置语言&＃xff0c;当然你也可以自行切换语言&＃xff0c;暂时仅支持 中文 和 英语。

你可以在 Tools >> Alibaba Coding Guidelines >> Switch language to Xxx 进行切换&＃xff1a;

中文乱码解决方法&＃xff1a;Appearance&Behavior -> Appearance -> UI Options -> Name 里面设置成中文字体&＃xff0c;如微软雅黑。

实时检测(Inspections支持)

IDEA的Inspections 相信大家应该都不陌生&＃xff0c;它会自动在我们编码的阶段&＃xff0c;进行快速灵活的静态代码分析&＃xff0c;自动检测编译器和运行时错误&＃xff0c;并提示开发人员再编译之前就进行有效的改正和改进。

实时检测功能会在开发过程中对当前文件进行检测&＃xff0c;并以高亮的形式提示出来&＃xff0c;同时也可以支持Quick Fix&＃xff0c;该功能默认开启。

检测结果会高亮提示&＃xff0c;鼠标放上去会弹出提示信息&＃xff0c;按Alt&＃43;Enter键可呼出Intention菜单&＃xff0c;如&＃xff1a;

在某些情况下&＃xff0c;我们不希望对代码提示违规信息&＃xff0c;比如我们在阅读Github开源项目代码的时候&＃xff0c;如果界面出现一堆红色、黄色的提示&＃xff0c;此时心里肯定是飘过一万只草泥马。这个时候我们可以通过Inspection的设置关闭实时检测功能。

关闭方式&＃xff1a;

通过右键快速关闭(打开)所有规则的实时检测功能

通过 Tools >> Alibaba Coding Guidelines 同样可以关闭(打开)所有规则的实时检测功能

通过 Settings >> Editor >> Inspections 进行手动设置&＃xff0c;在这里&＃xff0c;我们也可以关闭某条规则的实时检测功能或者修改提示级别。

PS&＃xff1a;我觉得里面最恶心的一条规则是&＃xff1a;不能在行尾添加注释&＃xff01;

提示内容&＃xff1a;方法内部单行注释&＃xff0c;在被注释语句上方另起一行&＃xff0c;使用//注释。方法内部多行注释使用/* */注释。注意与代码对齐。

PS&＃xff1a;我觉得里面最恶心的一条规则是&＃xff1a;不能在行尾添加注释&＃xff01;

提示内容&＃xff1a;方法内部单行注释&＃xff0c;在被注释语句上方另起一行&＃xff0c;使用//注释。方法内部多行注释使用/* */注释。注意与代码对齐。

注意&＃xff1a;修改或关闭某一条约束后可能不会及时生效&＃xff0c;可以重启AS或关闭检测然后再打开检测就可以了。

代码扫描(静态分析&＃xff0c;Analyze)

阿里规约插件&＃xff0c;除了支持 Inspections 之外&＃xff0c;还可以对现有项目进行静态代码分析。

可以通过右键菜单、Toolbar按钮、快捷键三种方式手动触发代码检测。

在当前编辑的文件中点击右键&＃xff0c;可以在弹出的菜单中触发对该文件的检测

在左侧的Project目录树中点击右键&＃xff0c;可以触发对整个工程或者选择的某个目录、文件进行检测

使用快捷键(Ctrl&＃43;Shift&＃43;Alt&＃43;J)触发弹出窗口时&＃xff0c;可以选择检测范围

它分析的结果&＃xff0c;会以 Blocker/Critical/Major 三个级别进行区分。默认按等级分组&＃xff0c;方便统计每个级别错误的数量&＃xff1a;

三个级别的意义&＃xff1a;

Blocker(崩溃)&＃xff1a;阻碍开发或测试工作的问题

Critical(严重)&＃xff1a;系统主要功能部分丧失、数据库保存调用错误、用户数据丢失

Major(一般)&＃xff1a;功能没有完全实现但是不影响使用&＃xff0c;功能菜单存在缺陷但不会影响系统稳定性

x

三个级别的意义&＃xff1a;

Blocker(崩溃)&＃xff1a;阻碍开发或测试工作的问题

Critical(严重)&＃xff1a;系统主要功能部分丧失、数据库保存调用错误、用户数据丢失

Major(一般)&＃xff1a;功能没有完全实现但是不影响使用&＃xff0c;功能菜单存在缺陷但不会影响系统稳定性

默认情况&＃xff0c;我们在结果面板需要双击具体违规项才能打开对应的源文件&＃xff0c;点击面板中的图标

 开启Autoscroll To Source选项后&＃xff0c;单击面板中的文件名、或者是具体的违规项的时候IDEA会自动打开对应的源文件。

对于实现Quick Fix的规则&＃xff0c;在结果面板中可以直接一键修复(我还没有发现有支持的规则)。

增强的代码扫描(Inspect Code)

以上方式只会检测此插件中定义的规范&＃xff0c;而不会检测 IDEA 中 Inspections 中定义的其他规范&＃xff0c;通过下面方式可以达到这个目的&＃xff1a;

Analyze菜单 >> 点击Inspect Code >> 在弹框中设置检验范围和使用的检验规则&＃xff0c;确认即可

代码提交时检测

在提交代码框勾选Alibaba Code Guidelines选项

如果有违反手册的地方会提示是否继续提交&＃xff0c;选择取消后会自动对修改的代码进行扫描

这也是一个检查代码风格的插件&＃xff0c;可以对比如命名约定&＃xff0c;类设计等方面进行代码规范和风格的检查。

PS&＃xff1a;建议使用阿里出的Java代码规范【Alibaba Java Coding Guidelines】插件&＃xff0c;80K下载&＃xff0c;大小7.8 M

配置&＃xff1a;Other Settings -->CheckStyle--> 添加规范文件&＃xff0c;或勾选推荐的规范文件

文档&＃xff1a;

This plugin provides both real-time andon-demandscanning of Java files with CheckStyle from within IDEA.

这个插件可以在IDEA中使用提供的CheckStyle实时和按需扫描Java文件。

Once installed, a newinspectionwill be available in the group ‘CheckStyle‘. The ‘Inspections‘ item in the preferences panel will allow you to turn this on and to configure it.

安装完成后&＃xff0c;一个新的 inspection 将出现在“CheckStyle”组中。首选项面板中的“Inspections”项目将允许您打开并配置它。

Projectexceptionsare treated a littleoddly. Because CheckStyle demands these to be on the current classpath errors will appear if these have not as yet been compiled. Further, because we cache the real-time checkers for performance reasons, real-time scans may continue to show the errors after a compilation. A static scan will force a reload of the Checker and should resolve this.

项目例外有点奇怪。因为CheckStyle要求它们在当前类路径上&＃xff0c;所以如果它们还没有被编译的话&＃xff0c;错误将会出现。此外&＃xff0c;由于出于性能原因而缓存实时检查器&＃xff0c;实时扫描可能在编译后继续显示错误。静态扫描将强制重新加载检查器&＃xff0c;并应解决此问题。

2017-12-14