Idea之阿里巴巴代码规范

Idea之阿里巴巴规范

阿里巴巴规范主要分为两部分，代码格式化和代码规范扫描

1. 代码格式化

Idea格式化插件主要有两个，google的格式化插件和阿里巴巴的格式化插件

1.1 google的格式化插件

1.1.1 google-java-format安装

通过File – settings – plugins – google-java-format 下载 安装 打开即可

1.1.2 Checkstyle-IDEA安装

Checkstyle-IDEA是一个Idea的代码扫描插件，可以结合google的规范，进行代码规范扫描

通过File – settings – plugins – Checkstyle-IDEA 下载 安装

可以通过CheckStyle窗口，对某个类，某个文件夹，或者整个项目进行代码规范扫描

1.1.3 不足

因为Google规范是国外广泛使用的规范，但是对于国内的开发习惯并不是太过兼容，比如缩进两个空格之类的（个人喜好4个空格）。所以国内还是推荐使用阿里巴巴的代码格式化，当然这依照个人习惯选择

2. 阿里巴巴代码格式化插件

阿里巴巴的代码格式化默认是只支持esclipse，Idea中没有对应插件实现。但是可以通过安装eslipse格式化工具，来完成Idea中阿里巴巴的代码格式化

2.1 Eclipse Code Formatter安装

Eclipse Code Formatter插件是为了帮助在Idea中使用eclipse的格式化准备的插件

通过File – settings – plugins – Eclipse Code Formatter 下载 安装

2.2 阿里模板下载

阿里格式模板：eclipse-codestyle.xml

点击链接即可去往github页面，进行下载

2.3 配置阿里格式化

通过File – settings – Other Settings – Eclipse Code Formatter 下载 安装

通过ctrl+alt+L即可完成格式化

2. Alibaba代码规约扫描

插件：Alibaba Java Coding Guidelines

Alibaba Java Coding Guidelines 专注于Java代码规范，目的是让开发者更加方便、快速规范代码格式。该插件在扫描代码后，将不符合规约的代码按 Blocker、Critical、Major 三个等级显示出来，并且大部分可以自动修复，它还基于 Inspection 机制提供了实时检测功能，编写代码的同时也能快速发现问题所在。

通过File – settings – Other Settings – Alibaba Java Coding Guidelines 下载 安装

可以通过 tools下的 阿里编码规约进行扫描，或者使用快捷键Ctrl+Shift+Alt+J进行扫描