科技信息化管理系统详细说明书.docx
《科技信息化管理系统详细说明书.docx》由会员分享，可在线阅读，更多相关《科技信息化管理系统详细说明书.docx（66页珍藏版）》请在冰豆网上搜索。
科技信息化管理系统详细说明书
科技信息化管理系统
详细设计说明书
编写：
0502java第五组
日期：
2012-5-31
审核：
王刘娣
日期：
2012-5-31
批准：
日期：
受控状态：
是
发布版次：
1.1
日期：
2012-5-31
编号：
1引言
1.1编写目的
本说明书目的在于明确说明系统各功能的实现方式，指导开发员进行编码。
本说明书的预期读者为：
代码开发员等。
1.2背景
待开发软件系统的名称：
科技信息化管理系统
此软件系统任务提出者：
中软国际公司
此软件系统任务开发者：
中软国际-飞蚁队
此软件系统任务用户：
中软国际公司员工
1.3基线
科技信息化管理系统需求规格说明书v1.6
1.4定义
为统一概念，避免混淆，本技术文档对客户端内容管理系统的基本概念和术语进行了分类和解释。
编号
术语
描述
01
系统管理员
可以登录本系统进行系统管理的用户
02
科技项目管理员
进行科技项目管理
03
待办项目申请
事项审批系统中的概念。
对于某一个角色的审批人来说，某一个项目申请轮到该审批人审批了，这个事项叫做待办项目申请。
04
办结项目
事项审批系统中的概念。
对于某一个角色的审批人来说，某一个项目申请已经被该审批人审批了，这个事项叫做办结项目。
05
Session（会话）
Session（会话）表示用户从向服务器发送请求开始，直到用户关闭浏览器这段时间内的服务器可以识别出用户的一个状态。
06
科技人才
公司内部业绩突出的员工
07
事项
立项、实施、验收、成果、奖励的申请和审批事件
08
科技项目
签订合同后开始实施的项目，包括正在实施的项目和已经完成的项目
09
科技成果
达到一定水平，有一定意义的成功项目
10
实施管理
项目开始实施后的中期阶段汇报
2编码规范
2.1命名规范
1.包名：
采用统一的com.chinasoft.**.**的方式进行命名，**为小写字母组成的英文单词
描述。
2.类名：
采用完整的英文描述，其中包含的每个单词都应紧靠在一起，每个单词首字母都
应该大写。
3.方法名：
采用完整的英文描述，其中应包含生动的动词，包含的每个单词都应该紧靠在
一起，第一个单词首字母小写，其他单词首字母大写。
4.变量名：
同方法名。
5.常量名：
采用完整的英文描述，全部采用大写字母，相邻的字母之间使用下划线隔开。
6.JSP文件名：
采用完整的英文描述，其中包含的每个单词都应该紧靠在一起，第一个单
词首字母小写，其他单词首字母大写。
例如：
包名：
com.chinasoft.action类名：
ThisIsClassName方法名：
thisIsMethodName
`常量名：
MAX_SIZE
注：
1.循环变量使用I,j,k或counter。
2.命名中用到information时一律使用info。
2.2注释规则
注释包括文件注释、类注释、方法注释、行间注释。
1.文件注释：
写在文件开头，标明作者、版本、最后更新时间、以及版权，如下所示，
/*
*作者：
刘成
*版本：
V1.0
*最后更新时间：
2010-7-1914:
23
*中软国际版权所有
*/
2.类注释：
写在类的声明之前，标明类的用途、作者、版本，如下所示，
/**
*TODO将文本文件读取成StringBuffer的一个类
*@versionv1.0
*@authoraimicheng
*/
3.方法注释：
写在方法定义之前，标明方法的用途、参数、返回值以及抛出的异常，如下所
示，
/**
*TODO:
读取文本文件内容到一个StringBuffer中
*@paramfile要读取的文本文件的文件系统中的路径
*@return返回一个包含文本文件中的文本内容的StringBuffer对象
*@throwsIOException
*/
4.行间注释：
对于关键的部分进行注释。
写在要注释的行之上，标明该行语句的用途，如下
所示，
//创建一个文本文件内容的BufferedReader
BufferedReaderfileIn=newBufferedReader（newFileReader（file））;
2.3缩进排版
1.行长度
尽量避免一行的长度超过80个字符。
2.换行
当一个表达式无法容纳在一行内时，可以依据以下规则进行换行：
-在一个逗号后面断开；
-在一个操作符前面断开；
-新的一行应该与上一行同一级别的表达式的开头处对齐。
-如果以上规则导致你的代码混乱或者使你的代码都堆积在右边，则代之以缩进8个空格
3模块汇总
3.1模块汇总表
公共模块
模块名称
功能简述
登录模块
用户用自己的用户名和密码登录到属于自己的界面
个人信息查询
用户在自己的界面可以查看个人信息个修改信息。
子功能模块
模块名称
功能简述
申请模块
申请人进入申请界面进行项目有关申请
审批模块
审批人进入审批界面对提交的项目进行审批
项目管理模块
项目管理员进入项目管理模块，对所有项目进行条件查询
系统管理模块
系统管理员进入管理界面，可以对公司部门文档和角色进行管理。
3.2模块关系图
3.3包层次结构
软件包层次结构图和webRoot层次结构图
说明：
1.包层次
com.chinasofti.action.apply申请模块的action
com.chinasofti.action.approve审批模块的action
com.chinasofti.action.project项目管理模块的action
com.chinasofti.action.sysmaanger系统管理模块的action
com.chinasofti.dao.applydao层的申请模块接口包
com.chinasofti.dao.approvedao层的审批模块的接口包
com.chinasofti.dao.projectdao层的项目管理模块的接口包
com.chinasofti.dao.sysmanagerdao层系统管理模块的接口包
com.chinasofti.dao.impl.applydao层的申请模块实现包
com.chinasofti.dao.impl.approvedao层的审批模块实现包
com.chinasofti.dao.impl.projectdao层项目管理模块实现包
com.chinasofti.dao.impl.sysmanagerdao层系统管理模块实现包
com.chinasofti.service.applyservice层的申请模块接口包
com.chinasofti.service.approveservice层审批模块的接口包
com.chinasofti.serviceprojectservice层的项目管理模块的接口包
com.chinasofti.service.sysmanagerservice层的系统管理模块的接口包
com.chinasofti.service.impl.applyservice层的申请模块实现包
com.chinasofti.service.impl.approveservice层的审批模块实现包
com.chinasofti.service.impl.projectservice层的项目管理模块实现包
com.chinasofti.service.impl.sysmanagerservice层的系统管理模块实现包
com.chinasofti.domain实体类及系统映射包
com.chinasofti.utilhibernate相关的包（登录）
com.chinasofti.interceptor拦截器有关的包
2WebRoot层次
/只存放登录页面login.jsp和index.Jsp主界面
/sysmanager存放系统管理模块的jsp文件
/apply存放事项申请模块的jsp文件
/approve存放事项审批模块的jsp文件
/project存放项目管理模块的jsp文件
/css/存放jsp页面中引用到的全局的css文件
/images/存放jsp页面中引用到的全局的图片文件
/js/存放jsp页面中引用到的全局的JavaScript文件
/WEB-INF/存放web.xml,struts-config.xml,applicationContext.xml等重要的配置文件
/WEB-INF/lib/存放项目中用到的库文件
4子系统模块设计
4.1功能模块
4.1.1申请模块
模块汇总：
科技项目申请系统
模块名称
功能简述
立项申请
项目申请人填写项目立项信息，提交进行立项申请
实施管理申请
项目申请人填写实施管理申请信息，提交进行实施管理申请
验收申请
项目申请人填写验收申请信息，提交进行验收申请
成果鉴定申请
项目申请人填写成果鉴定申请信息，提交进行成果鉴定申请
奖励申请
项目申请人填写奖励申请信息，提交进行奖励申请
待办及办结项目浏览查询
项目申请人点击查询按钮，进行项目查询
科技项目申请系统类图
【图1】申请模块类图
类的说明:
ApplyForm
ApplyForm
包含变量
中文说明
ApplyForm类名称
变量名
类型
说明
立项申请
ApplyForm
ProapplyForm
proName
String
项目名称
apcontent
String
申请内容
proposer
String
申请人
applyTime
Datetime
申请时间
proId
Int
项目编号
typeId
Int
项目类型
funds
Double
经费
affix
List
上传的文档
Action-Service对应说明
Action
对应ActionForm
调用service
对应service方法
Action功能说明
ProapplyAction
ProapplyForm
ApplyManagementservice
proapplyProject
添加立项申请
ManageapplyAction
ManageapplyForm
ApplyManagementservice
ManageapplyProject
添加实施管理申请
CheckapplyAction
CheckapplyForm
ApplyManagementservice
CheckapplyProject
添加验收申请
IndentifyApplyAction
IndentifyApplyForm
ApplyManagementservice
IndentifyApplyProject
添加成果鉴定申请
AwardApplyAction
AwardApplyFrom
ApplyManagementservice
AwardApplyProject
添加奖励申请
DetailInfoAction
DetailInfoForm
ApplyManagementservice
DetailInfoProject
添加项目详细信息
方法名
参数
调用Dao
调用Dao方法
名称
类型
ProapplyAction
project
Project
ProjectDao
addProject
ManageapplyAction
project
Project
ProjectDao
addProject
CheckapplyAction
project
Project
ProjectDao
addProject
IndentifyApplyAction
project
Project
ProjectDao
addProject
AwardApplyAction
project
Project
ProjectDao
addProject
DetailInfoAction
project
Project
ProjectDao
addProject
功能时序图及详细设计如下:
1立项申请
功能名称
立项申请
功能编号
功能描述
申请人向系统提交信息
操作流程：
1.申请人进入申请页面
2.申请人填写申请信息提交
3.系统显示信息
3.1若操作成功显示项目成功信息
3.2若操作失败显示失败信息
4.返回前台主页面
业务流程：
1.申请人选择申请页面
2.系统跳转至申请页面
3.申请人填写各项信息并提交
4.系统检查各项信息的合法性若各项信息合法，连接数据库添加立项申请结果（默认未生效）立项申请条提示成功信息；若否，提示失败信息
5.系统跳转至前台主页面
流程图：
页面输入
申请人必须输入：
项目名、类别、申请人、经费、申请内容、申请时间、
页面输出
成功、失败提示
对应类
ProApplyAction
对应方法
ProApplyForm
方法输入
proName,apcontent,proposer,applyTime,funds
方法输出
Boolean：
true：
操作成功false：
操作失败
查询条件
applyID
方法描述
跟据申请号查询数据库，并在功能
接口设计
申请增加
数据库表
申请表
表字段
pronametypenameproposerfundsapcontentapplyTime
对表操作
根据申请编号修改申请表
列外说明
必须输入的信息没有输入，系统提示错误信息；修改不成功。
如下：
【图2】立项申请时序图
2项目实施管理申请
功能名称
实施管理申请
功能编号
功能描述
申请人向系统提交信息
操作流程：
1、申请人进入申请页面
2、申请人填写申请信息提交
3、系统显示信息
a）若操作成功显示项目成功信息
b）若操作失败显示失败信息
4、返回前台主页面
业务流程：
1、申请人选择申请页面
2、系统跳转至申请页面
3、申请人填写各项信息并提交
4、系统检查各项信息的合法性若各项信息合法，连接数据库添加立项申请结果（默认未生效）立项申请条提示成功信息；若否，提示失败信息
5、系统跳转至前台主页面
流程图：
页面输入
申请人
必须输入：
项目名、类别、申请人、经费、申请内容、申请时间、
页面输出
成功、失败提示
对应类
ManageApplyAction
对应方法
ManageApplyForm
方法输入
proname,organizer,co-organizer,starttime,finishtime,partyAprincipal,partyBprincipal,proInvestment,paycondition
方法输出
Boolean：
true：
操作成功
false：
操作失败
查询条件
applyID
方法描述
跟据申请号查询数据库，并在功能
接口设计
申请增加
数据库表
申请表
表字段
pronametypenameproposerfundsapcontentapplyTime
对表操作
根据申请编号修改申请表
列外说明
必须输入的信息没有输入，系统提示错误信息；修改不成功。
实施管理时序图如下：
【图3】实施管理时序图
3项目验收申请
功能名称
验收申请
功能编号
功能描述
申请人向系统提交信息
操作流程：
1、申请人进入申请页面
2、申请人填写申请信息提交
3、系统显示信息
a）若操作成功显示项目成功信息
b）若操作失败显示失败信息
4、返回前台主页面
业务流程：
1、申请人选择申请页面
2、系统跳转至申请页面
3、申请人填写各项信息并提交
4、系统检查各项信息的合法性若各项信息合法，连接数据库添加立项申请结果（默认未生效）立项申请条提示成功信息；若否，提示失败信息
5、系统跳转至前台主页面
流程图：
页面输入
申请人
必须输入：
项目名、类别、申请人、经费、申请内容、申请时间、
页面输出
成功、失败提示
对应类
CheckApplyAction
对应方法
CheckApplyForm
方法输入
proName,proSchedule,proLeader
方法输出
Boolean：
true：
操作成功
false：
操作失败
查询条件
applyID
方法描述
跟据申请号查询数据库，并在功能
接口设计
申请增加
数据库表
申请表
表字段
pronametypenameproposerfundsapcontentapplyTime
对表操作
根据申请编号修改申请表
列外说明
必须输入的信息没有输入，系统提示错误信息；修改不成功。
验收申请时序图如下：
【图4】验收申请时序图
4项目成果鉴定申请
功能名称
成果鉴定申请
功能编号
功能描述
申请人向系统提交信息
操作流程：
1、申请人进入申请页面
2、申请人填写申请信息提交
3、系统显示信息
a）若操作成功显示项目成功信息
b）若操作失败显示失败信息
4、返回前台主页面
业务流程：
1、申请人选择申请页面
2、系统跳转至申请页面
3、申请人填写各项信息并提交
4、系统检查各项信息的合法性若各项信息合法，连接数据库添加立项申请结果（默认未生效）立项申请条提示成功信息；若否，提示失败信息
5、系统跳转至前台主页面
流程图：
页面输入
申请人
必须输入：
项目名、类别、申请人、经费、申请内容、申请时间、
页面输出
成功、失败提示
对应类
IndentifyApplyAction
对应方法
IndentifyApplyForm
方法输入
proName,partyAPrincipal,partyBPrincipal,contractTime,totalInvestment,proId,contentIntro
方法输出
Boolean：
true：
操作成功
false：
操作失败
查询条件
applyID
方法描述
跟据申请号查询数据库，并在功能
接口设计
申请增加
数据库表
申请表
表字段
pronametypenameproposerfundsapcontentapplyTime
对表操作
根据申请编号修改申请表
列外说明
必须输入的信息没有输入，系统提示错误信息；修改不成功。
成果鉴定申请时序图如下：
【图5】成果鉴定申请时序图
5项目奖励申请
功能名称
奖励申请
功能编号
功能描述
申请人向系统提交信息
操作流程：
1、申请人进入申请页面
2、申请人填写申请信息提交
3、系统显示信息
a）若操作成功显示项目成功信息
b）若操作失败显示失败信息
4、返回前台主页面
业务流程：
1、申请人选择申请页面
2、系统跳转至申请页面
3、申请人填写各项信息并提交
4、系统检查各项信息的合法性若各项信息合法，连接数据库添加立项申请结果（默认未生效）立项申请条提示成功信息；若否，提示失败信息
5、系统跳转至前台主页面
流程图：
页面输入
申请人
必须输入：
项目名、类别、申请人、经费、申请内容、申请时间、
页面输出
成功、失败提示
对应类
AwardApplyAction
对应方法
AwardApplyForm
方法输入
proname,organizer,co-organizer,finishMen
方法输出
Boolean：
true：
操作成功
false：
操作失败
查询条件
applyID
方法描述
跟据申请号查询数据库，并在功能
接口设计
申请增加
数据库表
申请表
表字段
pronametypenameproposerfundsapcontentapplyTime
对表操作
根据申请编号修改申请表
列外说明
必须输入的信息没有输入，系统提示错误信息；修改不成功。
奖励申请时序图如下：
【图5】奖励申请时序图
6查看项目详细信息
功能名称
待办及办结项目查询
功能编号
功能描述
用户查询项目详细信息
操作流程：
1.用户进入主界面
2.用户点击查询按钮
3.系统显示信息：
a）若操作成功，系统用户要查询的信息
b）若操作失败，显示失败信息
4.返回前台主页
业务流程：
1.用户点击在办、办结项目浏览查看下拉按钮，显示待办项目、办结项目、项目查询三项链接
2.点击待办项目链接，显示部门待办项目浏览界面，显示立项申请、实施管理申请、验收申请、成果鉴定申请、奖励申请等五个选项卡
3.点击需查询的信息选项卡，显示待办列表界面
4.点击查看详情按钮，弹出项目详细信息界面
5.点击关闭按钮，返回部门待办项目浏览界面
流程图：
页面输入
申请人
必须输入：
页面输出
成功、失败提示
对应类
DetailInfoAction
对应方法
DetailInfoForm
方法输入
方法输出
Boolean：
true：
操作成功
false：
操作失败
查询条件
applyID
方法描述
跟据申请号查询数据库，并在功能
接口设计
申请增加
数据库表
申请表
表字段
pronametypenameproposerfundsapcontentapplyTime
对表操作
根据申请编号修改申请表
列外说明
必须输入的信息没有输入，系统提示错误信息；修改不成功。
待办及办结项目时序图如下：
【图7】待办及办结项目时序图
4.1.2审批模块
模块汇总
科技项目申请系统
模块名称
功能简述
立项审批
审批人给申请的项目进行审批
实施管理审批
审批人给申请的项目进行审批
验收审批
审批人给申请的项目进行审批
成果审批
审批人给申请的项目进行审批
奖励审批
审批人给申请的项目进行审批
项目信息查询
审批人根据查询条件进行项目查询
个人信息
个人信息查看修改
科技审批项目类图
【图8】审批功能类图
说明：
审批功能底层主要是对审批表进行添加以及对项目表和申请表的信息查询，
Apply类中主要是申请的基本信息，project中主要是项目的基本信息，approve是审批的基本信息，三
升级会员 