安装插件
-
打开IDEA
-
File -> Settings (或者Ctrl+Alt+S) -> Plugins
-
在搜索框中输入CheckStyle-IDEA
-
找到后在右边栏中点击Install，安装结束后重启IDEA，安装结束
Plugins
配置CheckStyle插件
-
同样进入到Setting中 -> Checkstyle
-
在界面中可以配置版本号，扫描域
-
如果想要使用的CheckStyle版本号不在其中的话可以使用第三方的包进行扫描：
- 在Third-Party Checks栏中点击右边的"+"号按钮，选择要用到的第三方Jar包
- Jar包可以在CheckStyle官网下载，这里是传送门
-
CheckStyle自带Google和Sun的编码规范xml文件，如果需要用自己定制的：
- 在Configuration File栏中点击右边的"+"号按钮，选择要用到的定制的xml文件
- 官方自带的Google规范和Sun规范在此
- 如果上面链接过时，可到CheckStyle官网查找
Checkstyle
修改Google规范文件（可选，看自己项目规范）
因为项目组默认使用缩进格式是4个空格，而谷歌规范使用的是2个空格，因此在使用谷歌规则文件时，还需要做简单的修改：
-
打开google_checks.xml文件
-
找到Indentation模块，如图所示
-
将里面的值统统扩大到2倍:
- basicOffset value: 2->4
- caseIndent value: 2->4
- throwsIndent value: 4->8
- lineWrappingIndentation value: 4->8
- arrayInitIndent value: 2->4
Google规则文件
使用CheckStyle对文件进行检查
在要进行检查的文件中右键Check Current File就开始进行检查了，结果如图：
检查结果
附：使用命令行模式进行CheckStyle的检查
- 官网指令模式说明
- 如果不复杂的话可以直接使用该句，对指定目录下所有文件进行扫描检查
java -jar checkstyle-8.15-all.jar -c google_checks.xml CodeRepos/data-server/src/
- 检查结果：
开始检查……
[WARN] E:\CodeRepos\data-server\src\main\java\com\jiniutech\common\Page.java:40:5: 缺少 Javadoc 。 [JavadocMethod]
[WARN] E:\CodeRepos\data-server\src\main\java\com\jiniutech\common\Page.java:87:1: 行内含有制表符 tab 。 [FileTabCharacter]
[WARN] E:\CodeRepos\data-server\src\main\java\com\jiniutech\common\Page.java:88:1: 行内含有制表符 tab 。 [FileTabCharacter]
[WARN] E:\CodeRepos\data-server\src\main\java\com\jiniutech\common\Page.java:89:1: 行内含有制表符 tab 。 [FileTabCharacter]
[WARN] E:\CodeRepos\data-server\src\main\java\com\jiniutech\common\Page.java:90:1: 行内含有制表符 tab 。 [FileTabCharacter]
[WARN] E:\CodeRepos\data-server\src\main\java\com\jiniutech\common\Page.java:101:22: WhitespaceAround: '>' is not preceded with whitespace. [WhitespaceAround]
[WARN] E:\CodeRepos\data-server\src\main\java\com\jiniutech\common\Page.java:101:23: WhitespaceAround: '>' is not followed by whitespace. Empty blocks may only be represented as {} when not part of a multi-block statement (4.1.3) [WhitespaceAround]
检查完成。
网友评论