CheckStyle 使用简介

CheckStyle 使用简介

CheckStyle简介

CheckStyle 是一款Java代码静态检查的工具。想了解更多的同学可以去 http://checkstyle.sourceforge.net/ 深入学习。

在maven中使用CheckStyle

首先建立一个maven项目checkstyle-test，pom.xml配置如下：

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>    

  <groupId>com.check</groupId>
  <artifactId>checkstyle-test</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <packaging>jar</packaging>    

  <name>CheckStyleTest</name>
  <url>http://maven.apache.org</url>    

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties> 

  <build>
    <pluginManagement>
      <plugins>
        <plugin>
          <groupId>org.apache.maven.plugins</groupId>
          <artifactId>maven-project-info-reports-plugin</artifactId>
          <version>2.4</version>
        </plugin>
        <plugin>
          <groupId>org.apache.maven.plugins</groupId>
          <artifactId>maven-site-plugin</artifactId>
          <version>3.4</version>
        </plugin>
        <plugin>
          <groupId>org.apache.maven.plugins</groupId>
          <artifactId>maven-checkstyle-plugin</artifactId>
          <version>2.9.1</version>
          <configuration>
            <configLocation>mycheckstyle.xml</configLocation>
          </configuration>
          <dependencies>
            <dependency>
              <groupId>com.puppycrawl.tools</groupId>
              <artifactId>checkstyle</artifactId>
              <version>6.6</version>
            </dependency>
          </dependencies>
        </plugin>
      </plugins>
    </pluginManagement>
  </build>

   <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-jxr-plugin</artifactId>
        <version>2.5</version>
      </plugin>
    </plugins>
  </reporting>  

  <dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>3.8.1</version>
      <scope>test</scope>
    </dependency>
  </dependencies>
</project>

mycheckstyle.xml 是自定义的checkstyle检测规则，放在项目根目录下。
maven-project-info-reports-plugin maven-site-plugin maven-jxr-plugin 都是用于生成checkstyle报告用的。
完成后，运行 mvn clean site checkstyle:checkstyle 后，会生成检测报告 ./target/site/checkstyle.html。
大家可以检出 https://github.com/QlDoors/checkstyle_test.git 试一下。

在jenkins中使用CheckStyle

如果想在 jenkins 上使用 CheckStyle,首先需要在 jenkins 上安装 Checkstyle Plug-in 和 Static Analysis Utilities 两个插件。
在项目中做如下配置：

配置完成后，运行 立即构建，checkstyle如果不过，jenkins就会被干红了。

在Eclipse中使用CheckStyle

CheckStyle插件的安装：

可能需要翻墙
* 在 Eclipse 中打开: Help -> Install New Software…
* 点击 Add… 添加 Location: http://eclipse-cs.sf.net/update
* 选择需要安装的插件，建议都选
* 完成安装

CheckStyle规则的配置：

• 在 Eclipse 中打开: Eclipse -> Preference…

• 打开 Checkstyle, 在这里可以看到三个默认的代码检测规则，分别是：

  1. Google Checks
  2. Sun Checks
  3. Sun Checks(Eclipse)

  大家可以根据实际情况在相应的检测规则上进行修改。

CheckStyle的使用：

使用比较简单，在相应的“项目”或者“文件”中点击右键 Checkstyle -> Check Code With Checkstyle 就可以对代码进行检查了。
如果想清除检查结果，在相应的“项目”或者“文件”中点击右键 Checkstyle -> Clear Checkstyle violations 。

最后

对于 Checkstyle 规则的配置我还不是特别熟悉，自定义规则的编写也没有搞明白，有明白的同学欢迎分享。