Android Studio安装Alibaba Java Coding Guidelines插件(检查代码规范)

时间:2024-04-11 20:25:06

Android Studio安装Alibaba Java Coding Guidelines插件(检查代码规范)

版权声明:本文为HaiyuKing原创文章,转载请注明出处!

前言

该插件主要是对今年发布的《阿里巴巴 Java 开发规约》的一个延伸,它以一个 IDE 的插件存在,可以自动对手册中的 Java 不规范的问题进行提示。现在主要支持(IDEA、Eclipse),Android Studio 是基于 IDEA 的,所以也是支持 Android 开发人员的。

该插件在扫描代码后,会将不符合规约的代码按照 Blocker/Critical/Major 三个等级显示在下方,甚至在 IDEA 上,还可以基于 Inspection 机制提供了实时检测的功能,编写代码的同时也能快速发现不规范的代码。而对于历史代码,部分规则实现了批量一键修复的功能,为首次在成熟项目上,使用插件,做了非常友善的支持。

安装步骤

File——Setting——Plugins——Browse repositories...

Android Studio安装Alibaba Java Coding Guidelines插件(检查代码规范)

搜索关键字『alibaba』,并在结果中,找到 Alibaba Java Coding Guidelines 并安装。

Android Studio安装Alibaba Java Coding Guidelines插件(检查代码规范)

Android Studio安装Alibaba Java Coding Guidelines插件(检查代码规范)

Android Studio安装Alibaba Java Coding Guidelines插件(检查代码规范)

安装完成之后,会有提示需要重启 Android Studio,我们点击 restart 按钮就可以帮我们自动重启,当然我们手动重启也行。

Android Studio安装Alibaba Java Coding Guidelines插件(检查代码规范)

Android Studio安装Alibaba Java Coding Guidelines插件(检查代码规范)

使用方法

切换语言(一般不需要)

阿里规约插件的使用非常的简单,并且本身插件就是国人开发完成,所以对中文的支持非常的好。

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

Tools——阿里编码规约——切换语言至英文

Android Studio安装Alibaba Java Coding Guidelines插件(检查代码规范)

Inspections 支持

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

Android Studio安装Alibaba Java Coding Guidelines插件(检查代码规范)

所有的规范,都可以在 Inspections 中查看到。

File——Settings——Editor——Inspections——Ali-Check

 Android Studio安装Alibaba Java Coding Guidelines插件(检查代码规范)

代码静态分析

可以理解为手动扫描分析。

Tools——阿里编码规约——编码规约扫描

Android Studio安装Alibaba Java Coding Guidelines插件(检查代码规范)

它分析的结果,会以 Blocker/Critical/Major 三个级别进行区分。最终检测出来的效果也非常的直观,如果你是当前插件语言是中文,基本上一眼就看出来哪里有问题,并给出了修复建议。

Android Studio安装Alibaba Java Coding Guidelines插件(检查代码规范)

参考资料

《阿里巴巴Java开发规约》插件使用详细指南

Android studio 插件:阿里发布的java规约插件

p3c/idea-plugin/