Spring: alibaba代码规范校验工具checkstyle

一、idea配置checkstyle插件

下载 Intellij IDEA Checkstyle 插件：File -> setting -> plugin通过关键字CheckStyle-IDEA搜索并安装。

安裝完成后重启idea

二、激活CheckStyle

接下就是在idea中激活checkstyle，需要进行如下配置：file -> setting -> Tool -> Checkstyle中找到 Checkstyle，并完成如下配置：

三、配置自动格式化功能

上面的步骤已经完成了checkstyle的基本配置，当代码或者文件不符合配置的风格时就会在checkstyle中显示。下面我们就配置下checkstyle的自动格式化功能，配置完成后我们可以使用快捷键的方式格式化我们的项目然后在进行git提交。配置方式file -> setting -> editor -> code style -> java

四、使用代码格式化

window用户可以使用快捷键ctrl + alt + l。也可以使用如下操作，鼠标放到项目上右击选中如下的选项：

此操作有如下选项：

• Optimize imports: 删除代码中未使用的import
• Rearrange entries: 重新排序源代码条目
• only changes uncommitted to VSC:
• Cleanup code: 清除无用import、多余注释规、规范代码缩进、规范注释等。一般选用此选项。