alibaba p3c代码规约：eclipse和idea集成p3c插件及导入代码格式化样式

「爱情、让人受尽委屈。」 2023-10-15 18:14 9阅读 0赞

### 一、说明 ###

代码规范检查插件p3c，是根据《阿里巴巴Java开发手册》转化而成的自动化插件。

（高级黑：P-3C“Orion”，反潜巡逻机，阿里大概取p3c先进，监测，发现潜在问题的意思）

![img][]

### 二、源码地址 ###

[https://github.com/alibaba/p3c][https_github.com_alibaba_p3c]

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

## 阿里巴巴Java开发手册 ##

### 一、说明 ###

《阿里巴巴Java开发手册》旨在码出高效，码出质量。

### 二、目的 ###

标准化，正规化，高效协同。

### 三、下载 ###

[阿里巴巴Java开发手册（详尽版）.pdf][Java_.pdf]

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

## 阿里代码规范设置 ##

### 一、eclipse ###

https://www.eclipse.org/downloads/

### 二、eclipse代码规范 ###

### 1. 下载 ###

【p3c-formatter】：[https://github.com/alibaba/p3c/tree/master/p3c-formatter][https_github.com_alibaba_p3c_tree_master_p3c-formatter]

![img][img 1]

### 2. 导入代码格式化样式 ###

![img][img 2]

### 3. 导入代码格式文件 ###

![img][img 3]

### 三、eclipse插件 ###

### 1. 下载 ###

【p3c-eclipse-plugin】：[https://p3c.alibaba.com/plugin/eclipse/update][https_p3c.alibaba.com_plugin_eclipse_update]

![img][img 4]

### 2. 将【features】及【plugins】复制到eclipse目录，重启eclipse ###

### 3. 编写测试文件 ###

/**
     * @author lsysy
     * @date 2018/11/13
     */
    public class Test {
        
        public static void main(String[] args) {
        
            String Ba = "Ba";
            if ("Ba" == Ba) {
        
                System.out.println(Ba);
            }
        }
    }

### 4. 点击![img][img 5]进行阿里编码规约扫描（如果不可用，点击![img][img 6]切换语言，再切换回来，重启即可） ###

![img][img 7]

### 5. 可选（设置eclipse保存时自动格式化） ###

![img][img 8]

### 四、idea ###

【[https://blog.csdn.net/mashuai720/article/details/79389314][https_blog.csdn.net_mashuai720_article_details_79389314]】

### 五、idea插件 ###

### 1. 下载 ###

【p3c-idea-plugin】：【[https://plugins.jetbrains.com/plugin/10046-alibaba-java-coding-guidelines][https_plugins.jetbrains.com_plugin_10046-alibaba-java-coding-guidelines]】

![img][img 9]

【eclipse-code-formatter】：【[https://plugins.jetbrains.com/plugin/6546-eclipse-code-formatter][https_plugins.jetbrains.com_plugin_6546-eclipse-code-formatter]】

![img][img 10]

【save-actions-plugin】：【[https://plugins.jetbrains.com/plugin/7642-save-actions][https_plugins.jetbrains.com_plugin_7642-save-actions]】

![img][img 11]

### 2. 安装 ###

![img][img 12]

### 3. 使用 ###

![img][img 13]

### 六、idea代码规范 ###

### 1. 准备 ###

/**
     * @author ${USER}
     * @date ${DATE}
     */

### 2. 写入文件头注释 ###

![img][img 14]

### 3. 导入代码格式化样式（导入eclipse-codestyle.xml） ###

![img][img 15]

### 4. 可选（设置idea保存时自动格式化） ###

![img][img 16]

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

links:

[https://www.cnblogs.com/lsysy/p/9954785.html][https_www.cnblogs.com_lsysy_p_9954785.html]

[img]: https://img-blog.csdnimg.cn/img_convert/9aece482c10ee37b6a1e598e4cea52fb.png
[https_github.com_alibaba_p3c]: https://github.com/alibaba/p3c
[Java_.pdf]: https://raw.githubusercontent.com/alibaba/p3c/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%E8%AF%A6%E5%B0%BD%E7%89%88%EF%BC%89.pdf
[https_github.com_alibaba_p3c_tree_master_p3c-formatter]: https://github.com/alibaba/p3c/tree/master/p3c-formatter
[img 1]: https://img-blog.csdnimg.cn/img_convert/d308b57ace20b655c25903312525a7c5.png
[img 2]: https://img-blog.csdnimg.cn/img_convert/25afe37b6e902658a68da6399b164969.png
[img 3]: https://img-blog.csdnimg.cn/img_convert/2559f6fa20b90c2641ae89dd1ba995cf.png
[https_p3c.alibaba.com_plugin_eclipse_update]: https://p3c.alibaba.com/plugin/eclipse/update
[img 4]: https://img-blog.csdnimg.cn/img_convert/df3ed73715f4f61771ec18307eda03da.png
[img 5]: https://img-blog.csdnimg.cn/img_convert/c74fae68209a8d0b4a97dc4be3caf861.png
[img 6]: https://img-blog.csdnimg.cn/img_convert/18b9fc6be82c12d09f041dba6ea7a395.png
[img 7]: https://img-blog.csdnimg.cn/img_convert/37cb543594945b77302274c75a8b922e.png
[img 8]: https://img-blog.csdnimg.cn/img_convert/35fa35bac7ff776747143def6e33f569.png
[https_blog.csdn.net_mashuai720_article_details_79389314]: https://blog.csdn.net/mashuai720/article/details/79389314
[https_plugins.jetbrains.com_plugin_10046-alibaba-java-coding-guidelines]: https://plugins.jetbrains.com/plugin/10046-alibaba-java-coding-guidelines
[img 9]: https://img-blog.csdnimg.cn/img_convert/86b20f68ae9a289d738a67960f1a929d.png
[https_plugins.jetbrains.com_plugin_6546-eclipse-code-formatter]: https://plugins.jetbrains.com/plugin/6546-eclipse-code-formatter
[img 10]: https://img-blog.csdnimg.cn/img_convert/f76dee92c956c5ff3ef664319d2d28eb.png
[https_plugins.jetbrains.com_plugin_7642-save-actions]: https://plugins.jetbrains.com/plugin/7642-save-actions
[img 11]: https://img-blog.csdnimg.cn/img_convert/58cdbde7898b5ad3c6ad3443c210f96c.png
[img 12]: https://img-blog.csdnimg.cn/img_convert/7df880e606aaf7495653c1c7ef60d390.png
[img 13]: https://img-blog.csdnimg.cn/img_convert/322b8d558aa833f08f7b526af7c5c5e0.png
[img 14]: https://img-blog.csdnimg.cn/img_convert/b47e431be0811dc027042bc946656ced.png
[img 15]: https://img-blog.csdnimg.cn/img_convert/ddd53245758c7ba08d7ec82ac011c1c6.png
[img 16]: https://img-blog.csdnimg.cn/img_convert/c0f9874e73dabd046100fa080349f4a3.png
[https_www.cnblogs.com_lsysy_p_9954785.html]: https://www.cnblogs.com/lsysy/p/9954785.html