阿里巴巴Java开发手册及Java代码规约扫描eclipse和IDEA插件

r囧r小猫 2022-05-21 23:20 227阅读 0赞

> 《阿里巴巴Java开发手册》是阿里巴巴技术团队的集体智慧结晶和经验总结，经历了大规模的实战不断完善，主要由编码规约、异常日志、单元测试、安全规约、工程结构、MySQL数据库六部分组成。俗话说得好无规矩不成方圆，无规范不能协作，相信大家在编程时都不喜欢维护别人写的代码，代码过度个性化使得维护起来非常费力，该手册让Java开发者能够提升协作效率。该规范也并非必须的，可以给我们一个参考作用。

《阿里巴巴Java开发手册》：

https://github.com/alibaba/p3c/blob/master/%E9%98%BF%E9%87%8C%E5%B7%B4%E5%B7%B4Java%E5%BC%80%E5%8F%91%E6%89%8B%E5%86%8C%EF%BC%88%E7%BB%88%E6%9E%81%E7%89%88%EF%BC%89.pdf

![阿里巴巴Java开发手册及Java代码规约扫描eclipse和IDEA插件][Java_Java_eclipse_IDEA]

下面主要来介绍一下如何安装、使用eclipse和idea插件。

一、eclipse插件

①准备

>  *  Eclipse Juno+
>  *  JDK 1.7+

②安装

安装插件Help >> Install New Software，打开安装插件界面，点击add（添加），在（URL）位置项中输入以下链接

https://p3c.alibaba.com/plugin/eclipse/update

![阿里巴巴Java开发手册及Java代码规约扫描eclipse和IDEA插件][Java_Java_eclipse_IDEA 1]

点击\[确定\]按钮，插件列表读取完成后，点击\[全部选中\]，然后点击\[下一步\]。

![阿里巴巴Java开发手册及Java代码规约扫描eclipse和IDEA插件][Java_Java_eclipse_IDEA 2]

选择\[我接受许可协议中的条款\]，点击\[完成\]，等待插件安装完成，完成后重启eclipse即可。

![阿里巴巴Java开发手册及Java代码规约扫描eclipse和IDEA插件][Java_Java_eclipse_IDEA 3]

③使用

在java文件或者项目上点击右键，选择\[阿里编码规约扫描\]即可；快捷键Ctrl+Alt+Shift+J。

![阿里巴巴Java开发手册及Java代码规约扫描eclipse和IDEA插件][Java_Java_eclipse_IDEA 4]

或者点击工具栏中的下图所示按钮。

![阿里巴巴Java开发手册及Java代码规约扫描eclipse和IDEA插件][Java_Java_eclipse_IDEA 5]

在P3C Results视图中查看编码规约扫描结果。

![阿里巴巴Java开发手册及Java代码规约扫描eclipse和IDEA插件][Java_Java_eclipse_IDEA 6]

选中任意一个可以查看正确规范示例。

![阿里巴巴Java开发手册及Java代码规约扫描eclipse和IDEA插件][Java_Java_eclipse_IDEA 7]

![阿里巴巴Java开发手册及Java代码规约扫描eclipse和IDEA插件][Java_Java_eclipse_IDEA 8]

![阿里巴巴Java开发手册及Java代码规约扫描eclipse和IDEA插件][Java_Java_eclipse_IDEA 9]

![阿里巴巴Java开发手册及Java代码规约扫描eclipse和IDEA插件][Java_Java_eclipse_IDEA 10]

阿里巴巴编码分析

二、IDEA插件

①准备

>  *  Project JDK: 1.7+

②安装

打开插件安装界面Settings >> Plugins >> Browse repositories...。

![阿里巴巴Java开发手册及Java代码规约扫描eclipse和IDEA插件][Java_Java_eclipse_IDEA 11]

通过关键字搜索“alibaba”，然后选择“Alibaba Java Coding Guidelines”安装。

![阿里巴巴Java开发手册及Java代码规约扫描eclipse和IDEA插件][Java_Java_eclipse_IDEA 12]

③使用

使用与eclipse类似，就不做描述了，大家可以自行查看。

![阿里巴巴Java开发手册及Java代码规约扫描eclipse和IDEA插件][Java_Java_eclipse_IDEA 13]

![阿里巴巴Java开发手册及Java代码规约扫描eclipse和IDEA插件][Java_Java_eclipse_IDEA 14]

![阿里巴巴Java开发手册及Java代码规约扫描eclipse和IDEA插件][Java_Java_eclipse_IDEA 15]

[Java_Java_eclipse_IDEA]: /images/20220522/aeda1c0faed7447bb9fd1fb51ac6e8c5.png
[Java_Java_eclipse_IDEA 1]: http://p3.pstatp.com/large/4009000210f71c64d81a
[Java_Java_eclipse_IDEA 2]: http://p3.pstatp.com/large/40060001fd76c0f5a4a5
[Java_Java_eclipse_IDEA 3]: http://p3.pstatp.com/large/40080002128cc90149e0
[Java_Java_eclipse_IDEA 4]: /images/20220522/3f67efc6c728438fa4a61febb8add73d.png
[Java_Java_eclipse_IDEA 5]: http://p9.pstatp.com/large/400900021ab914d78b50
[Java_Java_eclipse_IDEA 6]: http://p3.pstatp.com/large/400b000200b2c5627d99
[Java_Java_eclipse_IDEA 7]: /images/20220522/87405eeb86374f11aa24a03eedb1c154.png
[Java_Java_eclipse_IDEA 8]: http://p3.pstatp.com/large/400d00004564f50b3d63
[Java_Java_eclipse_IDEA 9]: http://p3.pstatp.com/large/400600021398ba6afbfb
[Java_Java_eclipse_IDEA 10]: http://p3.pstatp.com/large/400900022734c83433ca
[Java_Java_eclipse_IDEA 11]: http://p3.pstatp.com/large/400c0000bf5df160236c
[Java_Java_eclipse_IDEA 12]: http://p9.pstatp.com/large/4008000253a62569e18c
[Java_Java_eclipse_IDEA 13]: http://p3.pstatp.com/large/400a00024f2e9034856c
[Java_Java_eclipse_IDEA 14]: /images/20220522/cb476009c8d04242923bf8cea569d511.png
[Java_Java_eclipse_IDEA 15]: /images/20220522/6a707478aac4418c9aa08dffca78da01.png