Published on

Idea代码格式化Code Style及代码检查CheckStyle配置

Authors
  • avatar
    Name
    Pumpkinor

目标

  1. 多台设备不同Idea版本，统一代码风格格式
  2. 团队成员统一代码风格格式
  3. 检查可能出现的代码问题

方案

  1. 配置Idea内置的Code Style
  2. 配置CheckStyle代码检查
  3. 配置Save Actions Tool 保存代码时的自动格式化代码
  4. 配置Idea的Git提交代码检查（会用到Git Commit Template Check 但该插件无需配置）

Idea 插件安装

1. 安装 CheckStyle 插件

File -> Settings -> Plugins -> Marketplace -> 搜索CheckStyle-IDEA

CheckStyle-IDEA_install

2. 安装 Save Actions Tool 插件

File -> Settings -> Plugins -> Marketplace -> 搜索Save Actions Tool

Save_Actions_Tool_install

3. 安装 Git Commit Template Check 插件

File -> Settings -> Plugins -> Marketplace -> 搜索Git Commit Template Check

Git_Commit_Template_install

4. 重启 Idea

安装完插件后请务必重启 idea

否则可能导致后续步骤无法进行

Idea 配置

1. 下载 CheckStyle 配置文件

下面的两个配置文件可以任选其一

alibaba-checks.xml 是阿里的代码规范

google_checks.xml 配置文件是谷歌的代码规范

也可以作为参考 自行制定CheckStyle配置

后续操作以 aliaba-checks.xml 为例

alibaba-checks.xml

google_checks.xml

2. 配置 Code Style

File -> Settings 搜索 Code Style Code Style -> Scheme -> Import Scheme -> Checkstyle configuration

Code_Style_configuration

选择 1 中下载的CheckStyle配置文件（alibaba-checks.xml）

Code_Style_configuration_chosefile.png

点击OK完成配置

3. 配置 CheckStyle

File -> Settings

搜索 CheckStyle

点击加号，输入配置文件的名字（Description），点击Brower

CheckStyle_configuration.png

选择 1 中下载的CheckStyle配置文件（alibaba-checks.xml）

CheckStyle_configuration_chosefile.png

点击OK -> Finish -> OK完成配置

4. 配置 Save Action Tool

File -> Settings

搜索 Save Actions

勾选General 勾选Formatting Actions

Save_Action_Tool_configuration.png

点击OK完成配置

5. 配置 Idea 的 Git 提交代码检查

Git -> Commit -> 右下角齿轮图标进入设置

Commit_Checks_configuration.png

勾选Commit Checks

Commit_Checks_configuration_choseoption.png

使用

1. 保存代码时自动格式化代码

2. 提交代代码时填写必要信息生成 Commit Message

Git -> Commit -> 左上方Amend右侧图标进入Commit Template

open_Commit_Template.png

填写Commit相关信息

fill_Commit_Template.png

点击OK后，Commit Message会自动生成

auto_generate_Commit_Template.png

结束

此时，在保存代码时，会自动格式化代码，提交代码时，会检查代码是否符合规范，并且自动生成Commit Message