statsvn & cloc代码统计工具

StatSVN简单使用说明

[color=green]本文参考网上一些资料以及StatSVN官方手册编写[/color]

目录

StatSVN简单使用说明...1

1. 简介...1

2. 前置条件...2

3. 快速上手...2

4. 命令行选项...3

5. 设置统计的开始与结束时间...5

6. Ant任务...5

7. 不足之处...6

8. 使用心得...6

9. 更多参考...7


[b]1. 简介[/b]

StatSVN是一个Java写的开源统计程序，从StatCVS移值而来。StatSVN能够从Subversion版本库中取得信息，然后使用JFreeChart生成描述项目开发的各种表格和图表。比如：

Ø 代码行数的时间线

Ø 针对每个开发者的代码行数

Ø 开发者的活跃程度

Ø 开发者最近所提交的文件数量

Ø 平均文件大小

Ø 最大文件

Ø 哪个文件是修改最多次数的

Ø 目录大小

Ø 带有文件数量和代码行数的Repository tree

StatSVN当前版本能够生成一组包括表格与图表的静态HTML或XDOC文档。

StatSVN统计的文件数量包含：所有文件类型。

StatSVN统计的代码变动行数包含文件类型：所有编程文件类型（如.java、.cpp、.h），.xml，.properties、.txt等，jar包等不在统计之内。
[b]2. 前置条件[/b]

Ø Java version 1.4.x or above

Ø The Subversion command-line client*, version 1.3.0 or higher (The binaries need to be on your command-line path when executing StatSVN)*
[b]3. 快速上手[/b]

[b]3.1.安装Java运行环境[/b]
StatSVN运行需要Java的运行环境支持，所以需要安装Java的运行环境jdk 1.4.或更高版本。在命令行模式下运行java --version命令，可以查看到所安装java运行环境版本。
[b]3.2.安装SVN客户端命令[/b]
StatSVN在使用中需要使用SVN的客户端，因此需要确保机器上可以访问到SVN的客户端命令，也就是那个SVN.EXE文件，我们可以将它拷贝出来，比如我将它拷贝到了我客户端的版本库D:\bl_repos
[b]3.3.下载StatSVN[/b]
可以从http://www.statsvn.org/下载，下载完成后解压到一个目录，比如C:\statsvn，里面有一个statsvn.jar的文件，无需安装。
[b]3.4.从Subversion CheckOut一个模块[/b]
CheckOut一个最新的工作版本库比如e:\bl_repos
[b]3.5.生成LOG文件[/b]
使用以下命令生成LOG文件例如：

D:\bl_repos>svn log -r {2011-3-1}:{2011-4-1}-v --xml --username xxx      --password 123 e:\bl_repos > e:\bl_repos\logfile.log

详情可以参考svn log -?，这里的意思是生成e:\bl_repos工作目录的2011-3-1到2011-4-1的代码日志文件到e:\bl_repos\logfile.log下
[b]3.6.调用StatSVN进行统计[/b]

    C:\statsvn>java -jar statsvn.jar e:\bl_repos\logfile.log e:\bl_repos

该命令的格式是java -jar statsvn.jar [options] <logfile> ，其中参数为生成的log文件，e:\bl_repos为工作拷贝目录，注意两个参数都要列出正确的全路径，否则会提示错误如logfile.log找不到等等
[b]3.7.查看统计结果[/b]
回到C:\statsvn，会发现里面生成了很多网页，查看index.html，就可以看见统计结果了。

4. 命令行选项

statsvn必要参数是<logfile> <checked-out-module>：

java -jar statsvn.jar options<logfile> <checked-out-module>

但是statsvn还可以支持更多其它参数：

-output-dir <directory>

指定报告生成目录，如果目录不存在则自动创建此目录。

-include <include-pattern-list>
-exclude <exclude-pattern-list>

[b]设置过滤规则：[/b]

'?' 匹配单个字符

'*' 匹配0个或多个字符

'**' 匹配0级或多级目录
[b]
例1：src/*/.java-----[/b]

匹配src目录及子目录下所有java文件。*.java-----匹配根目录下的java文件，因为*不包含子目录。

[b]例2：-include "*/.c:*/.h" -exclude "legacy/**"[/b]

匹配目录下除legacy目录下所有.c和.h文件。

注意：Unix系统下注意在表达式上使用引号，否则shell将会与通配符相冲突。

-cache-dir <directory>

为从Subversion服务起收集信息指定缓存目录，

-username <subversion_username>

指定连接Subversion server的用户名.

-password <subversion_username>

指定连接Subversion server的密码.

-tags <tags-regularexpression>

添加Subversion tags信息到报告中。只有与正则表达式相匹配的tags才会被添加。例如：-tags '.*' 则会添加所有的tags。

[b]注意：[/b]这一功能会到你的存储目录的/tags目录下查找tags，所以为了能让这一功能运行正常，必须在你的存储根目录下生成log文件，这样才会将各个tags和trunk的信息都写入log文件，但tags目录没有必要都checked out下来。

[b]注意：[/b]Unix系统下注意在表达式上使用引号，否则shell将会与通配符相冲突。

-tags-dir <directory>

指定tags正则表达式去评估的根目录，默认值为/tags/

-no-developer <login-name>

在报告中排除某个或某几个开发者的代码提交信息。比如排除管理员的一些代码操作。

-verbose

输出中添加进程信息

-bugzilla< bugzilla_install_root>

指定Bugzilla的安装路径，报告中将以链接的形式代替'Bug ###'，这样方便直接链接至相应Bug。

-title <title>

指定报告的名称，默认以Subversion模块名作为标题。

-xdoc

将报告文档从默认的html文档改为Maven的XDoc文档。

-xml

将报告文档从默认的html文档改为xml文档。

-css <stylesheet>

为报告指定css样式，这里可以是http url或本地文件。

-notes <notes-file>

指定一个注释文件，该文件的内容将会添加至报告的index页面。文件内容应该包含一个有效的块级html片段。例如：

<p>
 These are development statistics for the<a href="http://www.statsvn.org" >StatSVN</a>
project, created by StatSVN itself.
</p>

<p>
<strong>Note:</strong>

 This report was generated by an unreleased development version of StatSVN. It might contain features not yet found in the official release.

</p>

其它更多参数请查阅其官方文档。
示例：

java -jar statsvn.jar -verbose -title jUCMNav  -exclude */src/urncore/;/src/grl/;/src/ucm/;/src/urn/;/src/seg/jUCMNav/model/ucm/* \  -output-dir ./stats c:\eclipse\workspace\seg.jUCMNav\svn.log c:\eclipse\workspace\seg.jUCMNav

[b]5. 设置统计的开始与结束时间[/b]


虽然StatSVN不提供指定报告统计的开始与结束时间，但是可以通过svn log命令来指定从而达到相同的效果。

svn  log  v  -xml  -r  {2007-02-19}:{2007-02-12}> log.xml

更多信息可以查看：

http://svnbook.red-bean.com/en/1.2/svn.tour.revs.html#svn.tour.revs.dates
http://jbrugge.com/blog/2007/02/27/using-date-ranges-with-statsvn/

[b]6. Ant任务[/b]

StatSVN可以与Apache Ant进行集成使用。

示例：

<?xml version="1.0"?>

<project name="StatSvnAnt" default="main" basedir=".">

  <taskdef name="statsvn" classname="net.sf.statsvn.ant.StatSvnTask" classpath="dist/statsvn.jar" />


  <target name="main">

    <statsvn

        path="d:/statsvn"

        log="d:/statsvn/logfile.log"

        outputDir="d:/statsvn/stats"

        title="StatSVN"

        include="*/.java"

        exclude="tests-src/**"

        notes="d:/statsvn/report-notes.txt"/>

  </target>

</project>其中path和log属性是必须指定的（path为源码所在目录），其它属性可选。statsvn.jar必须位于Ant的classpath下，或者像上面一样由taskdef属性来指定。

[b]7. 不足之处[/b]

StatSVN现在最新版才到0.7.0，属于一个新推出工具，还没有正式发布稳定版，所以还存在一些不足之处：

Ø 删除和移动文件：在删除和移动的文件上，代码统计行数可能不精确。当一个文件被删除或被移动，StatSVN现在还不能准确的统计出文件行数以及都由哪些人提交过（这是StatCVS的遗留问题，但是StatSVN在将来会解决这一遗留问题）。

Ø 分支（Branches）：StatSVN analyzes anything it is given. Because of the way Subversion treats branches, StatSVN is not limited to a repository's default branch, as StatCVS was. However, there are currently no special features that take into account the most common Subversion repository layout (with /branches and /trunk).

Ø Tags：这个参数当前还处于beta阶段，不够成熟，使用起来有些不便，详情可查看前面提到的tags参数使用部分。

[b]8. 使用心得[/b]

8.1.有时统计结果会有一点点偏差，如对原有文件进行格式化后，格式的变动也会算入代码变动行数之列，这个jsp偏差量比较大，所以建议每个代码提交者都养成提交代码时使用IDE格式化快捷键对文件进行一下格式化操作，这样能最小避免这种误差。

8.2.删除文件和移动文件统计上会有不准确。

所以使用此工具生成报告后，最好检查一下是否存在大量代码变动只是由于源文件排版格式的变动，以及是否存在有大量代码是引入了某些工具类（非jar包形式）或配置文件（如installanywhere使用的一个配置文件TWNS_hp.iap_xml 有几万行）。这些情况都是需要最后手动减除的。

[b]9. 更多参考[/b]

http://wiki.statsvn.org

http://statcvs.sourceforge.net/