目录
一、 alibaba代码规范插件
二、安装
2.1 在线安装
2.2 离线安装
2.3 安装成功验证
三、代码规范使用
3.1 扫描
3.2 扫描结果说明
一、 alibaba代码规范插件
为了让开发更加方便、更为规范,阿里巴巴基于手册内容,研发了一套自动化的代码规范检测插件Alibaba Java Coding Guidelines 。该插件在扫描代码后,将不符合规约的代码按Blocker/Critical/Major三个等级显示在下方,甚至在IDEA上,我们还基于Inspection机制提供了实时检测功能,编写代码的同时也能快速发现问题所在。
二、安装
安装方式有如下两种:在线安装和离线安装:
2.1 在线安装
打开IDEA,File-> Settings->Plugins->Markerplae搜索栏搜索alibaba,然后安装,安装后重启,安装后点击"apply":
2.2 离线安装
官网地址:Alibaba Java Coding Guidelines - IntelliJ IDEs Plugin | Marketplace (jetbrains.com)https://plugins.jetbrains.com/plugin/10046-alibaba-java-coding-guidelines进入网页后选择合适的版本下载📥:将下载后的zip包放在英文且无空格目录路径(只有满足条件的路径才能文件才能被正确识别到🈲【📁拒绝中文空格📁】🈲)下:
接下来打开IDEA:
File-> Settings->Plugins->点击设置图标,🗜️然后选择install Plugin from Disk:
接下来找到刚刚下载的插件zip包📁:(我放的路径如下);选择路径后点击"ok":
2.3 安装成功验证
✅ 如下图所示:打开IDEA-->工具--->阿里编码规约(看到这里就证明安装成功了)
三、代码规范使用
3.1 扫描
如果是扫描某个目录(或某个文件或某段代码)的使用为:鼠标左键(选中目录/文件/代码),然后右键,鼠标下滑滚动,找到“编码规约扫描”并点击就可以了:
若为整个项目的代码规约扫描操作步骤如下:
继续点开折叠的检查结果,发现会有违反的具体规约说明,"双击”最后一层,就会自动定位到具体的问题行,如下图所示:
3.2 扫描结果说明
该插件在扫描代码后,将不符合规约的代码按Blocker/Critical/Major三个等级显示在下方:
- Blocker:阻塞剂,🔥🔥立即改🔥🔥。
- Critical:关键,🔥🔥立即改🔥🔥。
- Major:重大,🐌🐌稍后改🐌🐌。
一般前两个都是必须要改的。
详细的开发规约官方说明,可以点击如下链接了解一下:
阿里巴巴Java开发手册详尽编码规范与工程实践-开发者社区-阿里云https://developer.aliyun.com/article/1589859
如果本文帮到你,记得点个👍 + 关注,我们下篇见!