checkstyle 使用

程序员文章站 2024-01-18 08:39:28

...

下载： checkstyle 规范（包含 codeformatter codetemplates checkstyle 文件）

http://download.csdn.net/download/knight_black_bob/9640991

下载 checkstyle 插件

http://download.csdn.net/download/knight_black_bob/9643244

一、配置 Code Templates

设置 Eclipse 代码模版

打开 Eclipse 设置面板，选择 Java -> Code Style -> Code Templates，

如图：

checkstyle 使用

博客分类： checkstyle checkstyle规范

点击右边的 Import…按钮，选择 codetemplates.xml 文件，确定即

可。

二、配置使用 4 个空格代替 tab 键

tab键在不同的IDE、编辑器（例如EditPlus、UltraEdit等）中使用

的空格数不同，因此为了统一，开发人员统一使用4个空格代替tab

键。

打开 Eclipse 设置面板，选择 General -> Editors -> Text Editors，

如图：

checkstyle 使用

博客分类： checkstyle checkstyle规范

勾选 Insert spaces for tabs，并设置 Displayed tab width 为 4。

三、配置 Code Formatter

3.1 设置 Eclipse 的代码格式化模版

打开 Eclipse 设置面板，选择 Java -> Code Style -> Formatter，如图：

checkstyle 使用

博客分类： checkstyle checkstyle规范

点击右边的 Import…按钮，选择 codeformatter.xml 文件，确定即

可。

3.2 格式化使用说明

若要对某个文件进行格式化，可使用如下几种方法：

1.打开文件后，在代码区域采用“CTRL + SHIFT + F”快捷键；

2.打开文件后，在代码区域点击右键选择 Source -> Format 功

能。

【说明】建议采用 CTRL + Shift + F 快捷

四、配置 Checkstyle

4.1 与 ant 集成

要在 ant 工程中使用 Checkstyle，需要先安装 checkstyle 的 jar 包，以

checkstyle-6.15-all.jar 为例，这个包中包含了运行 Checkstyle 需要的类文件。

接下来就是在 build.xml 文件中添加 taskdef 的声明：

<taskdef resource="com/puppycrawl/tools/checkstyle/ant/checkstyle-ant-task.properties"          classpath="/path/to/checkstyle-6.15-all.jar"/> 然后添加一个 checkstyle 的 target。
<target name="checkstyle" >
  <checkstyle config="checkstyle.xml" failureProperty="checkstyle.failure"
failOnViolation="false">
  <formatter type="xml" tofile="${result.xml}/checkstyle_report.xml"/>
    <fileset dir="/home/jenkins/workspace/JAVA_checkstyle_ANT"
includes="**/*.java"/>
  </checkstyle>
  <style in="${result.xml}/checkstyle_report.xml" 
out="${result.html}/checkstyle_report.html"  style="${basedir}/checkstyle.xsl" /> 
  <fail if="checkstyle.failure">
          Checkstyle failed.
        </fail>
</target>

可以运行 ant checkstyle 进行扫描。详细结果信息被存放在

${result.xml}/checkstyle_report.xml 中。

4.2 与 MAVEN 集成

在 maven 中一个名为 maven-checkstyle-plugin 的插件，用于执行

CheckStyle task。下面是一个简单的配置。

<reporting> 

     <plugins> 

      <plugin> 

        <groupId>org.apache.maven.plugins</groupId> 

        <artifactId>maven-checkstyle-plugin</artifactId> 

        <version>2.9.1</version> 

<configuration> 

           <configLocation> config/maven_checks.xml</configLocation> 

<includes> 

            **\/package\/**.java,**\/otherpackage\/**.java 

             </includes> 

            </configuration> 

    </plugin> 

        <plugin> 

            <groupId>org.apache.maven.plugins</groupId> 

            <artifactId>maven-jxr-plugin</artifactId> 

            <version>2.3</version> 

         </plugin> 

        </plugins> 

</reporting>

可以运行 mvn checkstyle:checkstyle 进行扫描。checkstye 的详细结果信息被

存放在 target/checkstyle-result.xml 中。

4.3 跳过对指定文件的某些检查

如果对于指定文件的某些行检查出了一些问题，但是你想忽略它，则可以使用 suppression。方法是建立一个 checkstyle-suppressions.xml 文件。其中加入下述内容

<?xml version="1.0"?> 
<!DOCTYPE suppressions PUBLIC       
  "-//Puppy Crawl//DTD Suppressions 1.0//EN"        
 "http://www.puppycrawl.com/dtds/suppressions_1_0.dtd"> 
 
<suppressions>     
<suppress checks="MagicNumberCheck"              
 files="SessionMessageSource.java"               
lines="221,250-295"/>

 </suppressions>

然后配置 maven-checkstyel-plugin，在<configuration>……</configuration>

中添加下列两句： <suppressionsLocation>path/to/checkstylesuppressions.xml</suppressionsLocation> <suppressionsFileExpression>checkstyle.suppressions.file</suppressionsFileExp ression>

4.4 Jenkins 输出报告

在运行完 checkstyle 之后，可以使用 Publish Checkstyle analysis results 插

件，它可以解析生成的 xml 结果文件。

图 1 Checkstyle 报告输出插件

checkstyle 使用

博客分类： checkstyle checkstyle规范