代码与文档同行评审管理系统的设计与实现

论文摘要

在软件开发过程中,为了提高软件质量,开发人员需要借助他人的眼睛,邀请不同背景的评审人员从不同的角度检查文档和代码,以便及时找出自己发现不了的错误和缺陷,从而避免更大的损失。因此,引入同行评审是一个很好的实践。同行评审系统是汤森路透进行评审代码和文档的工具,简称SPIRIT。这个系统的目标是为内部员工提供一个在线平台,通过这个平台员工可以提交和评审源代码以及文档,各个部门领导也可以通过这个平台查看相关的统计数据,及时掌握部门软件产品开发进度和质量以及评审效率等情况。这次开发,在实现所有功能的基础上,还十分重视页面的美观和易用性,另外对评审流程,业务逻辑做到了尽可能的简化,系统已经在2011年11月正式上线。这个工具是一个WEB系统,主要使用JavaEE相关技术。软件架构设计方面采用MVC模式。视图层,为了追求界面的美观和易用,系统使用ExtJs框架实现前端页面设计。控制层,使用Strutsl实现业务逻辑控制。开发人员自己实现了模型层的封装,将其分为LOGIC和DAO两部分,分别用于处理业务逻辑和与数据库交互。本文详细分析了这个同行评审工具的设计与实现,包括开发过程中使用的相关理论,系统的需求分析,总体设计,数据库设计和评审会话管理、评注管理这两个关键模块的详细设计与实现。

论文目录

• 摘要
• ABSTRACT
• 第一章 引言
• 1.1 课题背景
• 1.2 课题任务
• 1.2.1 课题内容
• 1.2.2 本人承担任务
• 1.3 预期目标
• 1.4 论文结构
• 第二章 系统相关理论介绍
• 2.1 同行评审系统（Peer Review System）
• 2.1.1 广义的评审
• 2.1.2 同行评审的概念
• 2.1.3 同行评审的主要活动
• 2.1.4 同行评审常见角色分类
• 2.1.5 可以借鉴的评审实践
• 2.2 ExtJs
• 2.2.1 什么是ExtJs
• 2.2.2 ExtJs框架的发展历史
• 2.2.3 ExtJs的优势
• 2.3 MVC模式及STRUTS1
• 2.3.1 MVC模式
• 2.3.2 Struts1
• 2.4 相关软件知识介绍
• 2.4.1 Maven
• 2.4.2 SubVersion
• 2.4.3 Java开发环境Eclipse
• 2.4.4 SyntaxHighlighter
• 2.4.5 google-diff-match-patch
• 2.4.6 Jacob
• 2.4.7 POI和HSSF
• 2.4.8 SAFE （Secure Access For Everyone）
• 2.4.9 SSL（Secure Socket Layer）证书
• 2.4.10 动态日录整合
• 2.5 本章小结
• 第三章 系统的需求分析
• 3.1 系统功能需求分析
• 3.1.1 登录系统
• 3.1.2 计划评审
• 3.1.3 执行评审
• 3.1.4 数据记录
• 3.2 系统非功能需求分析
• 3.2.1 界面设计需求
• 3.2.2 性能方面需求
• 3.2.3 维护性需求
• 3.3 本章小结
• 第四章 同行评审系统的总体设计
• 4.1 系统架构与软件环境
• 4.1.1 系统架构
• 4.1.2 软件环境
• 4.2 系统软件层次架构设计
• 4.3 系统功能模块设计
• 4.3.1 模块概览
• 4.3.2 用户登录管理模块
• 4.3.3 评审会话管理模块
• 4.3.4 评注管理模块
• 4.3.5 数据记录管理模块
• 4.4 系统数据库设计
• 4.4.1 数据概念模型的设计
• 4.4.2 数据库表的设计
• 4.5 系统关键问题设计
• 4.5.1 代码评审流程图设计
• 4.5.2 同行评审中的常见问题及如何避免
• 4.6 本章小结
• 第五章 系统主要功能模块的详细设计与实现
• 5.1 SPIRIT站点概览
• 5.2 评审会话管理模块详细设计与实现
• 5.2.1 我的同行评审列表
• 5.2.2 创建新的评审会话
• 5.2.3 维护评审会话
• 5.3 代码评注的详细设计与实现
• 5.3.1 源代码载入
• 5.3.2 源代码显示
• 5.3.3 评注管理
• 5.4 数据记录管理模块的设计与实现
• 5.4.1 评审数据记录
• 5.4.2 统计数据
• 5.5 本章小结
• 第六章 结束语
• 6.1 论文工作总结
• 6.2 尚未解决的问题以及系统的改进
• 6.3 展望
• 参考文献
• 致谢