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

1、FH/QR/DESIGN/002Subversion代码统计及取源代码工具设计方案文件编号：FH/GYSJ/XX/XXXX-XXX文件版本：0.0.1 拟 制：何永刚 2010年1月22日审 核： 年 月 日批 准： 年 月 日FH/QR/DESIGN/002修改记录序号版本号生效日期变更理由/变更内容变更人备注12345目 录目 录31.术语与缩写解释42.系统概述42.1背景42.2功能目标43.系统总体结构43.1模块划分结构图44.数据流程说明64.1数据流程图64.2数据处理流程：74.3主要数据说明：105.模块设计126.参考资料错误！未定义书签。1. 术语与缩写解释缩写、术语解

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

3、改前的源码文件）两个文件夹存放3. 系统总体结构3.1模块划分结构图图3.1.1用户数据输入，任务制定、读取模块 TaskDefine该模块重用自VManager的TaskDefineDlg，存储和读取查询任务信息：查询用户名AuthorName，时间段、版本库路径REPOS_PATH等。Subversion数据库连接、数据掘取模块；DBReader该模块连接Subversion数据库，由用户界面调用，以用户界面从任务读取模块获取的查询任务信息为参数, 获取对应查询用户（作者）的源代码文件信息：版本，日期，获取对应源代码文件内容等。中间数据处理、统计模块。DataAnalyze该模块分析处理从

4、Subversion数据掘取模块获取的查询用户信息，进行查询结果统计：源代码文件，代码量。文件、统计结果存储模块 SaveResult该模块重用自VManager的Display模块，存储数据处理模块的输出信息：需存储源代码内容、存放路径。（有取代码需求时存储），代码量统计结果。用户操作界面用户界面，用户可通过界面操作进行任务制定、执行，并监视查询任务的执行状态4.数据流程说明4.1数据流程图图4.1.1流程图中灰色部分是基本流程模块， 黄色部分和绿色部分为二选一模块；黄色模块使用Subversion自带的文件比较工具进行代码修改量统计，绿色模块使用VManager代码统计工具中的文件比较模块

5、进行代码修改量的统计，两种方式的执行效率及精确程度需要完成后比较。4.2数据处理流程：1、 History从Subversion库（REPOS_PATH）获取该库的版本历史信息，将其保存为一个版本列表 ReversionList：如图4.2.1所示图4.2.12、 Info根据版本号_reversion获取该版本的信息：作者、时间、提交日志； 由此可以得出 <Author, ReversionNo> 数据对。图4.2.23、 Chaged根据版本号_reversion获取该版本的修改信息（针对版本目录的），由此获得版本号、修改文件列表：如下图示，由此得出<ReversionN

6、o, FileList>数据对图4.2.34、 代码统计方法之一：Diff 根据版本号_reversion获取版本目录下该版本所有修改文件的修改内容（见图4.2.4）：分析该文件可获取代码修改量，代码修改内容，差异文件版本号：<FileName, AuthorName, Reversion, PreReversion, FileChanged>。根据前面History、Info、Change获取的文件信息<FileName, Reversion, AuthorName>, 判定差异版本是否属于同一作者，如果非同一作者，代码量计入结果；同一作者则不计。取源代码文件到

7、本地时, 取Rversion版本到New文件夹，PreReversion版本到Old文件夹。Reversion为1时，取文件到Create文件夹。 图4.2.45、 代码统计方法之二：根据History、Info、Changed获取的数据：<Repos_path, ReversionList>< Reversion, AuthorName, Date><Reversion, FileList >处理后可获得: <AuthorName, Date，FileName, ReversionNo>, 已满足代码量统计的基本条件，以文件名为关键字，遍历文件

8、的各个版本获取信息：<作者名，作者版本，前一版本> （前一版本为最近的不属于该作者的版本；版本由作者创建且一直维护则前一版本为0）<AuthorName, Reversion, PreReversion>通过Cat命令获取对应版本号的文件内容：<Reversion，FileContent>调用VManager的文件比较模块CmpMngr，比较两个版本的差异，进行代码量统计。存储Reversion文件于New文件夹，存储PreReversion文件于Old文件夹。PreReversion为0的，存Reversion于Create文件夹。图4.2.5：3.1 系

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

10、程，执行svnlook程序，参数：option History | info | changed | diff -r repos_pathoptioncat r repos_path filePath_inRepos（2） 通过创建管道Pipe，从cmd子进程读取svnlook程序的执行结果。（3） 简单分析svnlook返回数据，主要数据说明见下文。（4） 提供取文件接口给外部使用主要数据说明：以数据处理顺序说明从subversion数据库取出处理的信息：ReposInfo：（目录历史信息）<Repos_path, ReversionList>Repository_pathver

11、sionsn.321ReversionInfo: (目录版本信息)<Reversion, Author, FileList >ReversionAuthorNameDateTimeFileListFile1File2File3UserInfo：(作者信息)<AuthorName, FileList> , <AuthorName，ReversionNo，DateTime>FileInfo: （文件信息）<FileName, Reversion, AuthorName>：FileNamern_author*_dateTime._r3_author*_

12、dateTime_r2_authou*_dateTime_r1_author*_dateTimeFileChangeInfo：（文件修改信息）统计方法 一<AuthorName, Files, <Reversion, PreReversion, LinesCanged>>FileNameReversion1Preversion1LinesChanged1Reversion2Preversion2LinesChanged2.Reversion_nPreversion_nLinesChanged_n主要流程：接口设计对外接口， ReadFileFromDB(Repos_Pa

13、th, FilePathInRepos，Reversion);参数：指定的版本库路径Repos_Path, 文件在版本库中的绝对路径FilePathInRepos，版本号Reversion。根据参数调用cmd子进程，运行svnlook程序，参数cat r Reversion Repos_path FilePathInRepos获取到指定文件指定版本的文件内容。5.3 数据分析处理模块功能：（1） 接收svn数据库读取模块返回的数据结构，ReversionInfo、FileInfo; FileChangedIfo.（2） 对接收的数据信息进行分析：统计方法一： 分析FileChangedInfo数据结构， 统计指定用户的总代码修改量；根据<Reversion, PreReversion>，调用SVN数据库读取模块提供的取文件接口，获取对应版本的文件内容，调用存储模块存储到本地；统计方法二： 分析ReversionInfo、FileInfo数据结构，获取统计所需信息：<FileName, Reversoin, DateTime, AuthorName>，用Vmanager相同统计逻辑遍历文