目的:
checkstyle是apache项目组提供的一款代码规范检测工具,使用checkstyle,可以帮助开发人员快速找到不符合规范要求的代码,本文将要介绍的是如何在ant中配置checkstyle,以生成代码质量检测报告。
版本:
checkstyle5.3,ant1.7.1及以上
ant配置文件内容:
<?xml version="1.0" encoding="UTF-8"?>
<project name="Checkstyle" default="xml2html" basedir=".">
<property file="build.properties" />
<!--前面省略项目中的其他target -->
<!-- 定义lib存放目录 -->
<property name="lib.dir" value="${basedir}/lib/checkstyle5.3" />
<!-- 定义输出结果目录 -->
<property name="result.dir" value="${basedir}/result" />
<!-- 定义输出结果目录 -->
<property name="result.html" value="${basedir}/result/html" />
<!-- 定义源码目录 配置该文件时请确认此目录 -->
<property name="src.dir" value="${basedir}/../src" />
<!-- 初始化输出结果目录 -->
<target name="init">
<delete dir="${result.dir}" />
<mkdir dir="${result.dir}" />
<!--<mkdir dir="${result.html}" />-->
</target>
<!-- 引入ant的<checkstyle>命令 checkstyletask.properties文件在jar包中 -->
<taskdef resource="checkstyletask.properties" classpath="${basedir}/lib/checkstyle-5.3-all.jar" />
<!-- 定义checkstyle执行计划 -->
<target name="cs" description="Generates a report of code convention violations." depends="init">
<!-- 指定检查规范为GS_java_check.xml fileset指的要检查的文件;formatter type指结果返回格式 -->
<checkstyle failonviolation="false" config="${lib.dir}/my_java_check.xml">
<fileset dir="${basedir}/../src" includes="**/*.java" />
<formatter type="plain" />
<formatter type="xml" toFile="${result.dir}/checkstyle_report.xml" />
</checkstyle>
</target>
<target name="xml2html" depends="cs">
<!-- 将生产结果根据扩展样式表文件checkstyle-frames.xsl生成html页面,输出到html -->
<xslt basedir="${result.dir}" destdir="${result.html}" extension=".html" style="${lib.dir}/checkstyle-frames.xsl">
<param name="output.dir" expression="${result.html}" />
</xslt>
</target>
</project>
其中my_java_check.xm为checkstyle代码规范配置文件,可以在改文件中设置代码检测条件,
如:每个方法代码行数限制、java类的总长度、try/catch嵌套次数等等;
checkstyle-frames.xs是样式配置文件,l在xml转化htm时需要用到,该文件可以在checkstyle-5.3-all.jar包中找到;
ant文件包含了3个任务:
1)初始化输出目录,包含checkstyle生成文件目录,以及转换生成html格式文件目录
2)checkstyle检测代码,并见检测结果输出到checkstyle_report.xml文件
3)根据checkstyle-noframes.xs样式表,将checkstyle_report.xm转换为html格式文件
注意点:
在init target中,需要将<mkdir dir="${result.html}" />去掉,否则在执行xml转换时,会提示如下错误:
[xslt] : Error! The element type "META" must be terminated by the matching end-tag "</META>".
[xslt] : Error! com.sun.org.apache.xml.internal.utils.WrappedRuntimeException: The element type "META" must be terminated by the matching end-tag "</META>".
[xslt] Failed to process null
BUILD FAILED
D:\workspace\workspace_study\test\bulid\build-cs.xml:40: javax.xml.transform.TransformerException: javax.xml.transform.TransformerException: com.sun.org.apache.xml.internal.utils.WrappedRuntimeException: The element type "META" must be terminated by the matching end-tag "</META>".
分享到:
相关推荐
本指南将详细介绍如何在环境中安装配置Sonar,同时使用MySQL作为数据存储,并通过Ant构建工具调用Sonar任务。以下是详细的步骤: 1、安装Sonar 3.1.1 首先,下载Sonar的版本3.1.1(sonar-3.1.1.zip),将其解压缩至...
本篇将详细介绍如何在Ant工程中配置和使用Checkstyle进行代码检测。 首先,我们需要理解Ant的基本概念。Apache Ant是一个基于Java的任务驱动构建系统,它允许开发者通过XML配置文件定义任务来构建、测试和部署项目...
在实际项目中,为了更好地集成和自动化,可能还会配置持续集成服务器(如Jenkins、Travis CI等)来定期运行Ant的CheckStyle任务,并将检查结果展示在构建报告中,以便于及时发现并修复问题。 通过使用Ant和...
总的来说,CheckStyle 是一款强大的 Java 代码质量检查工具,通过安装、配置和使用 CheckStyle,开发团队可以遵循一致的编码规范,提升项目的整体质量。对于大型项目或多人协作的项目,引入 CheckStyle 更是必不可少...
5. **在Ant中使用Checkstyle**:Ant是Java项目常用的构建工具,Checkstyle可以通过Ant任务进行集成。配置包括定义Checkstyle任务,指定配置文件,然后运行任务检查代码。 6. **在Eclipse中使用Checkstyle**:...
在"Ant+checkstyle 实现代码检查"文档中,可能详细介绍了如何配置和运行上述Ant任务,包括错误处理和报告生成。 Checkstyle的规则覆盖了多个方面,包括命名规范(类名、变量名等)、导入语句、注释、空格和缩进、...
CheckStyle是一款功能强大且操作简单的代码检查工具,它可以与Ant结合使用,并且是Open Source的,这意味着用户不需要担心收到律师函。CheckStyle的主要功能是检查Java代码的格式和风格,以确保代码的可读性和维护性...
1. **配置 Checkstyle**: 首先,你需要在 Ant 脚本中定义 Checkstyle 相关的属性,包括配置文件路径(checkstyle.config),报告样式文件(checkstyle.report.style),结果 XML 文件(checkstyle.result)以及 ...
成员聊天:checkstyle,checkstyle是一个开发工具,可以帮助程序员编写遵循编码标准的java代码。默认情况下,它支持google java风格指南和sun代码约定,但高度可配置。它可以通过ant任务和命令行程序调用。.zip
### CruiseControl及Ant配置知识点详解 #### 一、CruiseControl简介 **CruiseControl**是一种持续集成(Continuous Integration, CI)工具,主要用于自动化软件构建过程。它支持多种构建工具和版本控制系统,能够...
1. **打开配置界面**:通过Eclipse菜单`Window -> Preferences`进入CheckStyle的配置项。 2. **创建新的检查标准**: - 点击“NEW”按钮弹出对话框,并选择导入外部配置文件。 - 浏览并选择部门的`style`配置...
- **集成构建工具**:如Maven和Ant,可以通过构建脚本运行CheckStyle检查,确保代码在构建过程中遵循规定。 - **扩展和定制**:通过创建自定义检查器,可以进一步扩展CheckStyle的功能,满足更具体的需求。 总之,...
7. **Maven和Ant集成**:对于使用Maven或Ant构建系统的项目,可以通过添加相应的插件将Checkstyle集成到构建流程中,确保每次构建时都会执行代码检查。 8. **自定义规则**:除了内置的检查,用户还可以通过实现`...
6. **命令行工具**:除了IDE插件,Checkstyle 还提供了一个命令行工具,方便在构建脚本(如Ant、Maven)中集成,实现自动化检查。 7. **社区活跃**:由于 Checkstyle 社区活跃,不断有新的检查项被添加,问题和bug...
<taskdef resource="com/puppycrawl/tools/checkstyle/ant/checkstyle-ant-task.properties"> <pathelement location="lib/checkstyle-8.x.jar"/> <checkstyle config="checkstyle.xml"> ${src.dir}"/> ...
此外,Checkstyle支持通过Ant、Maven和Gradle等构建工具进行命令行检查,使得在持续集成环境中也能保证代码质量。 在提供的压缩包文件中,`p2.index`和`content.jar`可能包含了Eclipse插件的元数据和核心功能实现,...
安装完成后,需要在 Eclipse 的首选项设置中配置 CheckStyle,指定使用的配置文件,这可以是 CheckStyle 提供的默认配置,也可以是团队自定义的编码规范。 配置文件是 CheckStyle 的核心,它定义了各种代码规则,...
5. **Ant任务**:对于使用Ant构建的项目,Checkstyle提供了Ant任务,方便集成到构建过程中。 在解压后的"checkstyle-5.5"目录中,你可能找到以下组件: 1. **checkstyle.jar**:主程序包,包含了Checkstyle的所有...