checkstyle代码检查工具安装配置

使用:SVN钩子 + CheckStyle + svnchecker

原理概述:

(1)CheckStyle定义了代码的规范;

(2)svnchecker可以调用CheckStyle定义的规范进行检查;

(3)使用svn的钩子程序可以在代码提交前执行svnchecker.

安装步骤:

1.下载并安装CheckStyle(使用版本:5.2)如下为checkstyle-5.2安装后的文件目录。其中checkstyle-5.2-all.jar为供svnchecker调用的jar文件,checkstyle_checks.xml是对java代码规范的定义(以后主要是对该文件的维护)。

注意:需要赋予checkstyle-5.2-all.jar可执行的权限

2.下载并安装svnchecker(使用版本:0.2.1)

如下为svnchecker-0.2.1安装后的文件目录。

 
注意:需要赋予Main.py和modules下所有文件可执行的权限。

3.定义文件svncheckerconfig.ini配置svnchecker

svncheckerconfig.ini文件是svnchecker的配置文件。但svnchecker中并未定义该文件,需要用户自己创建。 
其位置可以放在svnchecker根目录(全局配置)或者svn资源库的hooks目录下(当前项目配置)。配置如下:

[Default]
Main.PreCommitChecks=
Checkstyle.Java=/usr/local/jdk1.6/bin/java
Checkstyle.Classpath=/usr/local/svn/checkstyle-5.2/checkstyle-5.2-all.jar
Checkstyle.ConfigFile=/usr/local/svn/project/hooks/sun_checks23.xml
Checkstyle.FailureHandlers=Console

[WAPSERVICE]
Main.Regex=^svntest/src/com/soufun/wap/.*$
Main.PreCommitChecks=Checkstyle
[[email protected] hooks]#

默认是对svn工程下的所有目录都进行检测。如果需要只对指定目录进行检测,就需要用到Profiles功能添加新的profile,而且这个profile里要设定Main.Regex配置选项的值。 
如果只希望检测指定目录里的文件,其他的不进行检查,则默认[Default]里应设置Main.PostCommitChecks为空。

4.修改svn pre-commit脚本

资源库hooks目录文件如下:

将文件pre-commit.tmpl重命名为pre-commit。

在pre-commit添加代码(以实际路径为准):

/usr/local/svn/svnchecker-0.2.1/Main.py PreCommit $REPOS $TXN || exit 1

5.如上配置,若代码不符规范会在控制台提示信息。

6.部分代码bug

SVNChecker工程已停止维护,所以对于bug需要自己修改。 
(1)对于svn路径有空格会找不到文件的bug,修改svnchecker文件checks/checkstyle.py。

if len(files) == 0:
         return ("", 0)
    try:
        #Process.execute(command + " ".join(files))
        for file in files:
            command += ‘"‘ + file + ‘" ‘
        Process.execute(command)

(2)返回错误信息太多导致Network connection closed unexpectedly的问题,修改checks/checkstyle.py文件

except Process.ProcessException, e:
        msg = "Coding style errors found: "
        msg += e.output + " "
        if len(msg) > 6000:
            msg = msg[:6000]
            msg += " More information is omitted! "
        msg += "See Checkstyle documentation for a detailed description: http://checkstyle.sourceforge.net/"
        return (msg, 1)

7.注意事项

(1)赋予相关文件可执行权限; 
(2)svncheckerconfig.ini不允许有语法错误,否则会报文件无法找到的错误; 
(3)版本问题,svnchecker和checkstyle不是所有版本都可以对应。建议checkstyle使用5.4版本,svnchecker使用0.3版本。

时间: 2024-10-19 08:31:04

checkstyle代码检查工具安装配置的相关文章

PMD-Java 代码检查工具对 error 和 warning 的配置

PMD是一款优秀的Java程序代码检查工具.该它可以检查Java代码中是否含有未使用的变量.是否含有空的抓取块.是否含有不必要的对象等. 但在使用过程中,你会项目中发现存在大量的 PMD 插件报出的 error 和 warning,尽管 PMD 鼓励程序员去改进它们并写出干净的代码,但也产生了很多让人烦躁的感觉.更重要的是,你可能忽略了 Java 代码中真正的错误和问题.下面我们就通过在 Eclipse 中配置只有在选中的资源中才去对代码检查. 第一步,在 Eclipse 中选择Problems

静态代码检查工具 cppcheck 的使用(可分别集成到VS和QT Creator里)

CppCheck是一个C/C++代码缺陷静态检查工具.不同于C/C++编译器及其它分析工具,CppCheck只检查编译器检查不出来的bug,不检查语法错误.所谓静态代码检查就是使用一个工具检查我们写的代码是否安全和健壮,是否有隐藏的问题. 比如无意间写了这样的代码: [cpp] view plain copy int n = 10; char* buffer = new char[n]; buffer[n] = 0; 这完全是符合语法规范的,但是静态代码检查工具会提示此处会溢出.也就是说,它是一

代码检查工具jshint和csslint

前面的话 Douglas Crockford大神根据自己的理念用JavaScript写了一个JavaScript代码规范检查工具,这就是JSLint.后来非常流行,也的确帮助了广大的JavaScript程序员.但是,大神对于自己的代码规范不做丝毫的妥协,对开源社区的反馈的回应也不礼貌.于是,JSLint从一个帮助程序员规范代码,避免Bug的工具,变成了一个让代码像Crockford的工具.在最不信神的IT界,这当然不能忍了 2011年,一个叫Anton Kovalyov的前端程序员借助开源社区的

Android 代码检查工具SonarQube

http://blog.csdn.net/rain_butterfly/article/details/42170601 代码检查工具能帮我们检查一些隐藏的bug,代码检查工具中sonar是比较好的一个.官网 Sonar 概述 Sonar 是一个用于代码质量管理的开放平台.通过插件机制,Sonar 可以集成不同的测试工具,代码分析工具,以及持续集成工具.与持续集成工具(例如 Hudson/Jenkins 等)不同,Sonar 并不是简单地把不同的代码检查工具结果(例如 FindBugs,PMD

静态代码检查工具 cppcheck 的使用

CppCheck是一个C/C++代码缺陷静态检查工具.不同于C/C++编译器及其它分析工具,CppCheck只检查编译器检查不出来的bug,不检查语法错误.所谓静态代码检查就是使用一个工具检查我们写的代码是否安全和健壮,是否有隐藏的问题. 比如无意间写了这样的代码: [cpp] view plaincopy int n = 10; char* buffer = new char[n]; buffer[n] = 0; 这完全是符合语法规范的,但是静态代码检查工具会提示此处会溢出.也就是说,它是一个

CSS代码检查工具stylelint

前面的话 CSS不能算是严格意义的编程语言,但是在前端体系中却不能小觑. CSS 是以描述为主的样式表,如果描述得混乱.没有规则,对于其他开发者一定是一个定时炸弹,特别是有强迫症的人群.CSS 看似简单,想要写出漂亮的 CSS 还是相当困难.所以校验 CSS 规则的行动迫在眉睫.stylelint是一个强大的现代 CSS 检测器,可以让开发者在样式表中遵循一致的约定和避免错误.本文将详细介绍CSS代码检查工具stylelint 概述 stylelint拥有超过150条的规则,包括捕捉错误.最佳实

Oracle 客户端安装 + pl/sql工具安装配置

Oracle 客户端安装 +  pl/sql工具安装配置 下载oracle客户端,并在本地安装. 11g下载地址为: http://www.oracle.com/technetwork/database/enterprise-edition/downloads/index.html 10g下载地址为: http://www.oracle.com/technetwork/database/enterprise-edition/downloads/index.html 根据自己机器或者oracle服

推荐一款华为最新的自动化代码检查工具

作为一枚软件攻城狮,你是不是总觉得自己撸代码的能力还有待提高却又无从下手?你是不是看到过XX大神美轮美奂的代码,然后佩服的五(ren)体(yang)投(ma)地(fan),然后躲在暗房里哭.然后你下定决心要痛改前非,然后发现无处下手,然后--又回到了以前的不归路? 如果你没有以上症状,请你关上浏览器,悄悄离开,千万别回头! 如果你有以上症状,但觉得自己已经病入膏肓,无法医治,让我拍拍你的肩,对你说"下辈子重新来过吧!". 如果你觉得自己还有救,就留下来继续观看,我给你开导开导. 要想修

《Android Studio有用指南》7.1 AndroidStudio代码检查工具概述

本文节选自<Android Studio有用指南> 作者: 毕小朋 博客: http://blog.csdn.net/wirelessqa 眼下本书已上传到百度阅读, 在百度中搜索[Anroid Studio有用指南]便能够找到本书. Android Studio提供了功能强大.高速.灵活的代码检查工具, 它能够检測出编译器和执行时的错误,在你编译之前建议你修正和攺进. Android Studio代码检查不仅仅能检查出编译错误, 还会检查出一些效率低下的代码,它支持一些代码规范.编程指南.最