1.背景
阿里巴巴java开发手册不断完善并出了很多版本到目前2023年1月截止,已经出了黄山版,在文章最后有参考资料可根据需要下载;
随着企业对项目质量的要求,对开发代码也有了更高的要求和规范,借助阿里巴巴编码规约插件,可让开发团队对编码规范进行统一认识并按照统一要求进行修复完善,以下内容介绍如何安装阿里巴巴编码规约插件并如何使用插件、提示分类和快捷修复操作等。
2.安装插件
以下三种安装方式都可以安装,任选其中一种即可。
2.1 第一种:idea客户端marketplace插件安装
File-->Settings-->Plugins
![](https://img-blog.csdnimg.cn/img_convert/2c5335e55b074923bb4b7a1c14b0529a.png)
首先在Plugins 选择Marketplace页签,输入关键字Alibaba Java Coding Guidelines进行搜索和安装
![](https://img-blog.csdnimg.cn/img_convert/0330d75c3d2e422a9437d797c0f0af33.png)
安装完后根据提示重启idea,在idea顶部出现tools-->阿里编程规约,表示安装成功。
2.2 第二种:在浏览器进行插件安装
在浏览器中输入网址:https://plugins.jetbrains.com/plugin/10046-alibaba-java-coding-guidelines
![](https://img-blog.csdnimg.cn/img_convert/f0215e7b7de44ac282bbe70a902c74c7.png)
假如浏览器右上角没有出现蓝色按钮:Install to IntelliJ IDEA 2021.2 而是出现的get则直接看2.3 第三种离线安装;
点击浏览器右上角按钮:Install to IntelliJ IDEA 2021.2 后,idea客户端界面提示如下:
![](https://img-blog.csdnimg.cn/img_convert/9f4fc2bdeea84ffa870d3ca80605018f.png)
点击OK即可;在idea顶部出现tools-->阿里编程规约,表示安装成功。
2.3 第三种:离线安装
在浏览器中输入网址:https://plugins.jetbrains.com/plugin/10046-alibaba-java-coding-guidelines
点击Versions选择相应的版本点击下载Download
![](https://img-blog.csdnimg.cn/img_convert/bfe3e4997d434c8c9a5a26dd30436838.png)
然后在idea客户端File-->Setting-->Plugins,选择小齿轮的Install Plugin from Disk
![](https://img-blog.csdnimg.cn/img_convert/1f4a48fc4e44493cbf873e40ccff852e.png)
![](https://img-blog.csdnimg.cn/img_convert/7f732badfb6647eab2f15d2be4a2771c.png)
安装完成后重启idea
![](https://img-blog.csdnimg.cn/img_convert/511067936e4748028804b717aabac145.png)
在idea顶部出现tools-->阿里编程规约,表示安装成功。
3.执行插件
刚开始安装完插件我们可以使用某个代码较少的目录或者单一java文件进行检查,如下所示:
![](https://img-blog.csdnimg.cn/img_convert/b84bd89e25554548a252b2d3bdf5a397.png)
提示如下:
![](https://img-blog.csdnimg.cn/img_convert/ebd9192a05d143d780a0d73322138007.png)
在idea的Problems窗口中展示检查内容,按照检查内容进行完善。
4.提示修复
在这提示的内容进行了分类:BLOCKER(崩溃)> CRITICAL(严重)> MAJOR(重要)
![](https://img-blog.csdnimg.cn/img_convert/e6f27ab1ecfd4410b105dfa2f49db2c0.png)
根据规约提示进行快捷修复或者手工修复。
![](https://img-blog.csdnimg.cn/img_convert/94804eda199147a7998ad908cb697479.png)
文件修复完点击保存后,提示行字体为淡黄色。继续选择同一目录或者文件执行阿里编码规约扫描,展示最新提示
5.参考资料
阿里Java开发手册(黄山版) 截止到2023年1月最新
链接:https://pan.baidu.com/s/1Tg8R3xT3kRvtdNMTU1aPww?pwd=pkwp
提取码:pkwp
阿里Java开发手册(嵩山版)
链接:https://pan.baidu.com/s/1QBhyX7wmuAMB9NoP1Zchcg?pwd=51n3
提取码:51n3
Java工程师成神之路
链接:https://pan.baidu.com/s/1oi9UbXbkdKQWS7lvzl130w?pwd=icz0
提取码:icz0