将checkstyle设置为java项目构建过程的一部分

时间:2012-12-28 14:12:03

标签: java netbeans ant jenkins checkstyle

我正在努力将checkstyle添加到java项目的构建过程中。 checkstyle的结果稍后将显示在jenkins上。我正在使用java7& netbeans 7.2.1

对于大多数工作,我按照此页面上的说明操作:http://checkstyle.sourceforge.net/anttask.html

但是,我是java(& jenkins)的初学者,有些指令对我没有意义:

1-文档说:“要在构建文件中使用该任务,您将需要以下taskdef声明:”。 问题:这是要添加到build.xml文件中吗?或者在哪里?

2-然后,doc继续描述一组参数并提供一些示例。这些是否也被添加到build.xml中?或?

3- Checkstyle使用配置文件。我将使用标准的sun_checks.xml。应该放在哪里?

如果有人能指出我整个过程的分步教程,我将非常感激。 提前回答所有答案

我在build.xml中使用以下内容:

<taskdef resource="checkstyletask.properties"
     classpath="libs/checkstyle-5.6-all.jar"/>

<target name="checkstyle"
        description="Generates a report of code convention violations.">

    <checkstyle config="sun_checks.xml"
                  failureProperty="checkstyle.failure"
                  failOnViolation="false">
        <fileset dir="src" includes="**/*.java"/>
        <formatter type="xml" toFile="checkstyle-results.xml"/>
    </checkstyle>

    <style in="checkstyle-results.xml" out="checkstyle_report.html" style="checkstyle.xsl"/>

</target>

2 个答案:

答案 0 :(得分:1)

  1. 是的,您必须将它添加到build.xml

  2. 这些属性和元素是<checkstyle> ant任务的属性和元素,您可以在构建文件中使用它,这要归功于您在第1点添加的taskdef。是的,这个{{1必须在build.xml中使用任务。

  3. 您可以将它放在任何地方。您只需使用其<checkstyle>属性提供<checkstyle>任务的路径。

答案 1 :(得分:0)

我不确定您正在使用的构建管理。如果您使用的是Gradle,则可以使用gradle-estilo-plugin。它直接从gradle配置块设置您需要的整个checkstyle配置。

以下是您需要开始使用的内容:

buildscript {
  repositories {
    mavenCentral()
  }

  dependencies {
    classpath 'net.anshulverma.gradle:gradle-estilo-plugin:0.4.8'
  }
}

apply plugin: 'net.anshulverma.gradle.estilo'

estilo {
  source 'sun'
}