Svn代码统计和取源代码工具设计方案.doc

FH/QR/DESIGN/002

Subversion代码统计及取源代码工具设计方案

文件编号：
FH/GYSJ/XX/XXXX-XXX
文件版本：
0.0.1
拟 制：
何永刚 2010年1月22日
审 核：
年 月 日
批 准：
年 月 日

FH/QR/DESIGN/002
修改记录

序号
版本号
生效日期
变更理由/变更内容
变更人
备注
1

2

3

4

5

目 录

目 录 3
1. 术语与缩写解释 4
2. 系统概述 4
2.1背景 4
2.2功能目标 4
3. 系统总体结构 4
3.1模块划分结构图 4
4.数据流程说明 6
4.1数据流程图 6
4.2数据处理流程： 7
4.3主要数据说明： 10
5.模块设计 12
6.参考资料 错误！未定义书签。

1. 术语与缩写解释

缩写、术语
解释
REPOS_PATH
Subversion Repository Path，Subversion 数据仓库路径

2. 系统概述
2.1背景
部门决定更换版本控制工具，从Visual SourceSafe更换至Subversion，版本控制工具相关外围工具也需要随之更换。版本控制器对外接口改变，原VSS代码统计工具VManager不能在Subversion中使用，因此需要针对Subversion提供的接口进行开发。
2.2功能目标
获取指定源代码文件提交时间端内，指定作者所属的代码修改量。
获取指定作者新建、维护的源代码，新建文件存放于Create文件夹，维护代码文件分
New（修改后的源码文件）和Old（修改前的源码文件）两个文件夹存放

3. 系统总体结构
3.1模块划分结构图

图3.1.1

用户数据输入，任务制定、读取模块 TaskDefine
该模块重用自VManager的TaskDefineDlg，存储和读取查询任务信息：查询用户名AuthorName，时间段、版本库路径REPOS_PATH等。

Subversion数据库连接、数据掘取模块；DBReader
该模块连接Subversion数据库，由用户界面调用，以用户界面从任务读取模块获取的查询任务信息为参数, 获取对应查询用户（作者）的源代码文件信息：版本，日期，获取对应源代码文件内容等。

中间数据处理、统计模块。DataAnalyze
该模块分析处理从Subversion数据掘取模块获取的查询用户信息，进行查询结果统计：源代码文件，代码量。

文件、统计结果存储模块 SaveResult
该模块重用自VManager的Display模块，存储数据处理模块的输出信息：需存储源代码内容、存放路径。（有取代码需求时存储），代码量统计结果。

用户操作界面
用户界面，用户可通过界面操作进行任务制定、执行，并监视查询任务的执行状态

4.数据流程说明
4.1数据流程图

图4.1.1

流程图中灰色部分是基本流程模块， 黄色部分和绿色部分为二选一模块；黄色模块使用Subversion自带的文件比较工具进行代码修改量统计，绿色模块使用VManager代码统计工具中的文件比较模块进行代码修改量的统计，两种方式的执行效率及精确程度需要完成后比较。

4.2数据处理流程：
1、 History从Subversion库（REPOS_PATH）获取该库的版本历史信息，将其保存为一个版本列表 ReversionList：如图4.2.1所示

图4.2.1
2、 Info根据版本号_reversion获取该版本的信息：作者、时间、提交日志； 由此可以得出 数据对。

图4.2.2

3、 Chaged根据版本号_reversion获取该版本的修改信息（针对版本目录的），由此获得版本号、修改文件列表：如下图示，由此得出数据对

图4.2.3

4、 代码统计方法之一：
Diff 根据版本号_reversion获取版本目录下该版本所有修改文件的修改内容（见图4.2.4）：分析该文件可获取代码修改量，代码修改内容，差异文件版本号：
。
根据前面History、Info、Change获取的文件信息, 判定差异版本是否属于同一作者，如果非同一作者，代码量计入结果；同一作者则不计。
取源代码文件到本地时, 取Rversion版本到New文件夹，PreReversion版本到Old文件夹。
Reversion为1时，取文件到Create文件夹。

图4.2.4

5、 代码统计方法之二：
根据History、Info、Changed获取的数据：

< Reversion, AuthorName, Date>
version, FileList >
处理后可获得: , 已满足代码量统计的基本条件，以文件名为关键字，遍历文件的各个版本获取信息：<作者名，作者版本，前一版本> （前一版本为最近的不属于该作者的版本；版本由作者创建且一直维护则前一版本为0）

通过Cat命令获取对应版本号的文件内容：
调用VManager的文件比较模块CmpMngr，比较两个版本的差异，进行代码量统计。
存储Reversion文件于New文件夹，存储PreReversion文件于Old文件夹。PreReversion为0的，存Reversion于Create文件夹。

图4.2.5：

3.1 系统处理流程

5.模块设计
5.1 界面模块
功能：
（1） 任务制定、读取入口：接收用户输入，调用任务制定模块；开始、停止选定任务。
（2） 显示当前任务列表：已执行任务、未执行任务。
（3） 显示当前任务处理进度。
（4） 提供配置选项如：统计文件类型选择、多线程处理等。
（5） 任务制定界面，任务要素输入：Author、DateTime、Repos_path, LoginUser, LoginPwd.。
（6） 提供结果显示界面，以TreeView形式显示版本库及各目录、子目录对应的代码文件行数。

界面示图：
类似于VManager的Frame-View示图

5.2 SVN数据读取模块
功能：
（1） 创建cmd子进程，执行svnlook程序，参数：
option [History | info | changed | diff] [-r] repos_path
option[cat] –r repos_path filePath_inRepos
（2） 通过创建管道Pipe，从cmd子进程读取svnlook程序的执行结果。
（3） 简单分析svnlook返回数据，主要数据说明见下文。
（4） 提供取文件接口给外部使用

主要数据说明：

以数据处理顺序说明从subversion数据库取出处理的信息：

ReposInfo：（目录历史信息）

Repository_path

versions
n
.
.
.
3
2
1

ReversionInfo: (目录版本信息)

Reversion
AuthorName
DateTime
FileList
File1
File2
File3

UserInfo：(作者信息)
,

FileInfo: （文件信息）
：
FileName
rn
_author*
_dateTime
.
.
.
.
.
.
_r3
_author*
_dateTime
_r2
_authou*
_dateTime
_r1
_author*
_dateTime

FileChangeInfo：（文件修改信息）统计方法 一
>

FileName
Reversion1
Preversion1
LinesChanged1
Reversion2
Preversion2
LinesChanged2
.
.
.
Reversion_n
Preversion_n
LinesChanged_n

主要流程：

接口设计
对外接口， ReadFileFromDB(Repos_Path, FilePathInRepos，Reversion);
参数：指定的版本库路径Repos_Path, 文件在版本库中的绝对路径FilePathInRepos，版本号Reversion。
根据参数调用cmd子进程，运行svnlook程序，参数
cat –r Reversion Repos_path FilePathInRepos
获取到指定文件指定版本的文件内容。

5.3 数据分析处理模块
功能：
（1） 接收svn数据库读取模块返回的数据结构，ReversionInfo、FileInfo; FileChangedIfo.
（2） 对接收的数据信息进行分析：
统计方法一： 分析FileChangedInfo数据结构， 统计指定用户的总代码修改量；根据，调用SVN数据库读取模块提供的取文件接口，获取对应版本的文件内容，调用存储模块存储到本地；
统计方法二： 分析ReversionInfo、FileInfo数据结构，获取统计所需信息：
，用Vmanager相同统计逻辑遍历文件的每个版本，获取信息；调用SVN数据库读取模块提供的取文件接口，获取对应版本文件内容，保存到本地； 然后调用CmpMngr模块进行文件比较（重用自Vmanager）。
主要流程：
统计方法一的流程图：

接口设计
5.4 任务制定，文件读写模块
重用VManager部分源代码，稍作修改。

17（17）
(R2.0.0-20060714) 2025-03-07