Maven CheckStyle Plugin集成

一直以来都想规范化自己写的代码，近期自己写项目的时候终于尝试集成CheckStyle对代码进行自动检测。

在项目的pom.xml文件中，添加CheckStyle的Maven插件配置：

......
  
    2.17
  

  
    
      
        org.apache.maven.plugins
        maven-checkstyle-plugin
        ${maven.checkstyle.version}
      
    
  
......

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

Maven CheckStyle插件提供两种预先定义的规则：sun_checks.xml和google_checks.xml(http://checkstyle.sourceforge.net/google_style.html)，默认提供的为sun_checks.xml。当然你也可以指定自定义的规则集。

google_checks.xml需要maven-checkstyle-plugin的version为2.17及以上

指定规则为google_checks.xml

  
    
      org.apache.maven.plugins
      maven-checkstyle-plugin
      ${maven.checkstyle.version}
      
        google_checks.xml
      
    
  

1
2
3
4
5
6
7
8
9
10
11
12

CheckStyle插件可执行任务：

mvn checkstyle:help 查看帮助
mvn checkstyle:check 查看工程是否满足检查。如果不满足，检查失败，可以通过target/checkstyle-result.xml来查看
mvn checkstyle:checkstyle 查看工程是否满足检查。如果不满足，不会失败，可以通过target/site/checkstyle.html查看检查信息
mvn checkstyle:checkstyle-aggregate 检查工程是否满足检查。如果不满足，不会失败，可以通过target/site/checkstyle.html查看
1
2
3
4

在用checkstyle命令检查之后，采用html的方式查看检查结果。结果中只会提示在哪一行，不能直接看代码。这时候可以添加Maven插件

  
    
      org.apache.maven.plugins
      maven-jxr-plugin
      ${maven.jxr.version}
    
  

1
2
3
4
5
6
7
8
9

执行mvn jxr:jxr之后，就可以查看对应的代码。