idea2023.1插件：Alibaba开发规范

太过爱你忘了你带给我的痛 2023-09-27 20:27 113阅读 0赞

**目录**

一、使用原因

二、下载

三、安装

四、扫描解释

五、小言

六、链接失效或版本不匹配

6.1.链接失效

6.2. 版本不匹配

--------------------

## 一、使用原因 ##

2018年5月17日，作为唯一中国代表，阿里巴巴获邀加入Java全球管理组织Java Community Process （JCP）的最高执行委员会JCP-EC。此次获得执行委员会席位，让中国企业首次加入到Java全球标准的制定中，更多“中国标准”有望成为全球规范。该席位将于5月24日生效。

JCP于1998年成立，是一个开放性的国际技术标准组织，职责是发展和更新Java技术规范。由24个成员组成的执行委员会JCP-EC则是该组织的最高决策机构，负责规划Java的技术演进方向。EC的成员由JCP成员投票选出。

阿里面向全球发布的《阿里巴巴Java开发规约》，这一规约集合了众多中国工程师的智慧与经验，能帮助全球开发者实现更为高效、更加容错、更有协作性的Java开发。

简单来说，就是使你代码更规范，提高开发效率，同时方便他人后续开发或维护。

## 二、下载 ##

idea下载 从下面图三阅读，直接下载插件就行

GitHub下载 戳》》》[2022P3C黄山版][2022P3C]

离线下载 戳》》》[阿里代码规范插件][Link 1]

## 三、安装 ##

![ed25c525612e49deb8c4b947b16ff04d.png][]

点开链接后，网页如图所示

![1e4c1dcf236f48cb8846c4828ace02a5.png][] 点击 download 后弹出安装步骤

![f7a38d7a197945b389a61642a96b6e48.png][]

按步骤操作后，重启![f66dbd9d52c14021830b2f2f80e70e50.png][]

重启后发现已经安装完毕

![be1dcd9d7e524714aea334ae53d041a1.png][]

使用

## 四、扫描解释 ##

如果点击当前的项目，则扫描当前项目下的所有不合规范的；如果点击某一个类，然后再点击编码规约扫描，则扫描的是当前类的不合规范的。该插件在扫描代码后，将不符合规约的代码按Blocker/Critical/Major三个等级显示在下方。  
Blocker：阻塞剂，立即改。  
Critical：关键，马上改。  
Major：重大，稍晚一点改。

如果存在[中文乱码][Link 2]问题：可以 Appearance&Behavior -> Appearance -> UI Options -> Name 里面设置成微软雅黑（microsoft yahei light）或者自己喜欢的其他字体。

如果想自定义扫描的：可以 File->Settings->Editor->inspections，可以根据自己要求进行选择约束。

## 五、小言 ##

本插件适用场景：个人想代码更规范或公司要求规范开发，是规范自己自己的开发习惯，同时方便其他人阅读你的代码。

非必要性使用，例如我上面就出现Major报错，要求我接口添加注释，但我就没添加，因为我的项目只有我自己开发和维护，不涉及其他人。不过，如果某天其他人接手，很有可能出现看不懂我方法写的作用是什么。

**建议还是自己平时规范一下开发习惯，而不是让插件提醒，毕竟插件也是需要人来开发和维护的，如果更新不及时，可能就不会发现开发中的问题，生产就有可能会返炉了。**

下面展示一下规范接口开发

![ad14637bba79459389ca2905a29399ff.png][]

这样能快速看出方法的作用及开发人员 ，方便其他人阅读和当项目报错时快速找出责任人。

## 六、链接失效或版本不匹配 ##

### 6.1.链接失效 ###

Idea的插件链接失效时，可以在[Idea官网 ][Idea_]搜索 Alibaba Java Coding，即可出现插件，自己选择下载就行。

![f5d155cc569b431296c71a84b57214ed.png][]

### 6.2. 版本不匹配 ###

我使用的这个插件，出现有23.1的版本不匹配问题，可以换个插件。例如下面的

![cc2b3b237d4d421b8c83a41e4e8d709b.png][]

[2022P3C]: https://github.com/alibaba/p3c
[Link 1]: https://plugins.jetbrains.com/plugin/10046-alibaba-java-coding-guidelines/versions.
[ed25c525612e49deb8c4b947b16ff04d.png]: https://img-blog.csdnimg.cn/ed25c525612e49deb8c4b947b16ff04d.png
[1e4c1dcf236f48cb8846c4828ace02a5.png]: https://img-blog.csdnimg.cn/1e4c1dcf236f48cb8846c4828ace02a5.png
[f7a38d7a197945b389a61642a96b6e48.png]: https://img-blog.csdnimg.cn/f7a38d7a197945b389a61642a96b6e48.png
[f66dbd9d52c14021830b2f2f80e70e50.png]: https://img-blog.csdnimg.cn/f66dbd9d52c14021830b2f2f80e70e50.png
[be1dcd9d7e524714aea334ae53d041a1.png]: https://img-blog.csdnimg.cn/be1dcd9d7e524714aea334ae53d041a1.png
[Link 2]: https://so.csdn.net/so/search?q=%E4%B8%AD%E6%96%87%E4%B9%B1%E7%A0%81&spm=1001.2101.3001.7020
[ad14637bba79459389ca2905a29399ff.png]: https://img-blog.csdnimg.cn/ad14637bba79459389ca2905a29399ff.png
[Idea_]: https://plugins.jetbrains.com/
[f5d155cc569b431296c71a84b57214ed.png]: https://img-blog.csdnimg.cn/f5d155cc569b431296c71a84b57214ed.png
[cc2b3b237d4d421b8c83a41e4e8d709b.png]: https://img-blog.csdnimg.cn/cc2b3b237d4d421b8c83a41e4e8d709b.png