科技信息化管理系统详细说明书.docx

1、科技信息化管理系统详细说明书科技信息化管理系统详细设计说明书编写：0502java第五组日期：2012-5-31审核：王刘娣日期：2012-5-31批准：日期：受控状态：是 发布版次：1.1日期：2012-5-31编号：1 引言1.1 编写目的本说明书目的在于明确说明系统各功能的实现方式，指导开发员进行编码。本说明书的预期读者为：代码开发员等。1.2 背景待开发软件系统的名称：科技信息化管理系统此软件系统任务提出者：中软国际公司此软件系统任务开发者：中软国际-飞蚁队 此软件系统任务用户：中软国际公司员工1.3 基线科技信息化管理系统需求规格说明书v1.61.4 定义为统一概念，避免混淆，本技术

2、文档对客户端内容管理系统的基本概念和术语进行了分类和解释。编号术语描述01系统管理员可以登录本系统进行系统管理的用户02科技项目管理员进行科技项目管理03待办项目申请事项审批系统中的概念。对于某一个角色的审批人来说，某一个项目申请轮到该审批人审批了，这个事项叫做待办项目申请。04办结项目事项审批系统中的概念。对于某一个角色的审批人来说，某一个项目申请已经被该审批人审批了，这个事项叫做办结项目。05Session（会话）Session（会话）表示用户从向服务器发送请求开始，直到用户关闭浏览器这段时间内的服务器可以识别出用户的一个状态。06科技人才公司内部业绩突出的员工07事项立项、实施、验收、成

3、果、奖励的申请和审批事件08科技项目签订合同后开始实施的项目，包括正在实施的项目和已经完成的项目09科技成果达到一定水平，有一定意义的成功项目10实施管理项目开始实施后的中期阶段汇报2编码规范2.1命名规范1. 包名：采用统一的com.chinasoft.*.*的方式进行命名，*为小写字母组成的英文单词描述。2. 类名：采用完整的英文描述，其中包含的每个单词都应紧靠在一起，每个单词首字母都应该大写。3. 方法名：采用完整的英文描述，其中应包含生动的动词，包含的每个单词都应该紧靠在一起，第一个单词首字母小写，其他单词首字母大写。4. 变量名：同方法名。5. 常量名：采用完整的英文描述，全部采用大

4、写字母，相邻的字母之间使用下划线隔开。6. JSP 文件名：采用完整的英文描述，其中包含的每个单词都应该紧靠在一起，第一个单词首字母小写，其他单词首字母大写。例如：包名：com.chinasoft.action 类名：ThisIsClassName 方法名：thisIsMethodName 常量名：MAX_SIZE注：1.循环变量使用I,j,k 或counter。2.命名中用到information 时一律使用info。2.2注释规则注释包括文件注释、类注释、方法注释、行间注释。1.文件注释：写在文件开头，标明作者、版本、最后更新时间、以及版权，如下所示，/* 作者：刘成* 版本：V 1.0*

5、 最后更新时间：2010-7-19 14:23* 中软国际版权所有*/2.类注释：写在类的声明之前，标明类的用途、作者、版本，如下所示，/* TODO将文本文件读取成StringBuffer的一个类* version v1.0* author aimicheng*/3.方法注释：写在方法定义之前，标明方法的用途、参数、返回值以及抛出的异常，如下所示，/* TODO:读取文本文件内容到一个StringBuffer中* param file 要读取的文本文件的文件系统中的路径* return 返回一个包含文本文件中的文本内容的StringBuffer对象* throws IOException*/

6、4.行间注释：对于关键的部分进行注释。写在要注释的行之上，标明该行语句的用途，如下所示，/创建一个文本文件内容的BufferedReaderBufferedReader fileIn = new BufferedReader(new FileReader(file);2.3缩进排版1. 行长度尽量避免一行的长度超过80 个字符。2. 换行当一个表达式无法容纳在一行内时，可以依据以下规则进行换行：-在一个逗号后面断开；-在一个操作符前面断开；-新的一行应该与上一行同一级别的表达式的开头处对齐。-如果以上规则导致你的代码混乱或者使你的代码都堆积在右边，则代之以缩进8 个空格3 模块汇总3.1模块汇

7、总表公共模块模块名称功能简述登录模块用户用自己的用户名和密码登录到属于自己的界面个人信息查询用户在自己的界面可以查看个人信息个修改信息。子功能模块模块名称功能简述申请模块申请人进入申请界面进行项目有关申请审批模块审批人进入审批界面对提交的项目进行审批项目管理模块项目管理员进入项目管理模块，对所有项目进行条件查询系统管理模块系统管理员进入管理界面，可以对公司部门文档和角色进行管理。3.2 模块关系图3.3包层次结构软件包层次结构图和webRoot层次结构图说明：1. 包层次com.chinasofti.action.apply 申请模块的actioncom.chinasofti.action.a

8、pprove 审批模块的actioncom.chinasofti.action.project 项目管理模块的actioncom.chinasofti.action.sysmaanger 系统管理模块的actioncom.chinasofti.dao.apply dao层的申请模块接口包com.chinasofti.dao.approve dao层的审批模块的接口包com.chinasofti.dao.project dao层的项目管理模块的接口包com.chinasofti.dao.sysmanager dao层系统管理模块的接口包com.chinasofti.dao.impl.apply

9、dao层的申请模块实现包com.chinasofti.dao.impl.approve dao层的审批模块实现包com.chinasofti.dao.impl.project dao层项目管理模块实现包com.chinasofti.dao.impl.sysmanager dao层系统管理模块实现包com.chinasofti.service.apply service层的申请模块接口包com.chinasofti.service.approve service层审批模块的接口包com.chinasofti.service project service层的项目管理模块的接口包com.china

10、softi. service.sysmanager service层的系统管理模块的接口包com.chinasofti.service.impl.apply service层的申请模块实现包com.chinasofti.service.impl.approve service层的审批模块实现包com.chinasofti.service.impl.project service层的项目管理模块实现包com.chinasofti.service.impl.sysmanager service层的系统管理模块实现包com.chinasofti. domain 实体类及系统映射包com.chinas

11、ofti.util hibernate 相关的包（登录）com.chinasofti.interceptor 拦截器有关的包 2 WebRoot层次 / 只存放登录页面login.jsp和index.Jsp主界面/sysmanager 存放系统管理模块的jsp 文件/apply 存放事项申请模块的jsp 文件/approve 存放事项审批模块的jsp 文件/project 存放项目管理模块的jsp 文件/css/ 存放jsp 页面中引用到的全局的css 文件/images/ 存放jsp 页面中引用到的全局的图片文件/js/ 存放jsp 页面中引用到的全局的JavaScript 文件/WEB-I

12、NF/ 存放web.xml,struts-config.xml,applicationContext.xml 等重要的配置文件/WEB-INF/lib/ 存放项目中用到的库文件4子系统模块设计4.1功能模块4.1.1 申请模块模块汇总：科技项目申请系统模块名称功能简述立项申请项目申请人填写项目立项信息，提交进行立项申请实施管理申请项目申请人填写实施管理申请信息，提交进行实施管理申请验收申请项目申请人填写验收申请信息，提交进行验收申请成果鉴定申请项目申请人填写成果鉴定申请信息，提交进行成果鉴定申请奖励申请项目申请人填写奖励申请信息，提交进行奖励申请待办及办结项目浏览查询项目申请人点击查询按钮，进

13、行项目查询科技项目申请系统类图【图1】申请模块类图类的说明:ApplyFormApplyForm包含变量中文说明ApplyForm类名称变量名类型说明立项申请ApplyFormProapply FormproNameString项目名称apcontentString申请内容proposerString申请人applyTimeDatetime申请时间proIdInt项目编号typeIdInt项目类型fundsDouble经费affixList上传的文档Action-Service对应说明Action对应ActionForm调用service对应service方法Action功能说明Proappl

14、yActionProapplyFormApplyManagementserviceproapplyProject添加立项申请ManageapplyActionManageapplyFormApplyManagementserviceManageapplyProject添加实施管理申请CheckapplyActionCheckapplyFormApplyManagementserviceCheckapplyProject添加验收申请IndentifyApplyActionIndentifyApplyFormApplyManagementserviceIndentifyApplyProject添加

15、成果鉴定申请AwardApplyActionAwardApplyFromApplyManagementserviceAwardApplyProject添加奖励申请DetailInfo ActionDetailInfoFormApplyManagementserviceDetailInfoProject添加项目详细信息方法名参数调用Dao调用Dao方法名称类型ProapplyActionprojectProjectProjectDaoaddProjectManageapplyActionprojectProjectProjectDaoaddProjectCheckapplyActionproje

16、ctProjectProjectDaoaddProjectIndentifyApplyActionprojectProjectProjectDaoaddProjectAwardApplyActionprojectProjectProjectDaoaddProjectDetailInfoActionprojectProjectProjectDaoaddProject功能时序图及详细设计如下:1 立项申请 功能名称立项申请功能编号功能描述申请人向系统提交信息操作流程：1. 申请人进入申请页面2. 申请人填写申请信息提交3. 系统显示信息3.1 若操作成功显示项目成功信息3.2 若操作失败显示失败信

17、息4. 返回前台主页面业务流程：1. 申请人选择申请页面2. 系统跳转至申请页面3. 申请人填写各项信息并提交4. 系统检查各项信息的合法性若各项信息合法，连接数据库添加立项申请结果(默认未生效)立项申请条提示成功信息；若否，提示失败信息5. 系统跳转至前台主页面流程图：页面输入申请人必须输入：项目名、类别、申请人、经费、申请内容、申请时间、页面输出成功、失败提示对应类ProApply Action对应方法ProApply Form方法输入proName,apcontent,proposer,applyTime, funds方法输出Boolean：true：操作成功false：操作失败查询条件

18、applyID方法描述跟据申请号查询数据库，并在功能接口设计申请增加数据库表申请表表字段proname typename proposer funds apcontent applyTime对表操作根据申请编号修改申请表列外说明必须输入的信息没有输入，系统提示错误信息；修改不成功。如下：【图2】立项申请时序图2项目实施管理申请功能名称实施管理申请功能编号功能描述申请人向系统提交信息操作流程：1、 申请人进入申请页面2、 申请人填写申请信息提交3、 系统显示信息a) 若操作成功显示项目成功信息b) 若操作失败显示失败信息4、 返回前台主页面业务流程：1、 申请人选择申请页面2、 系统跳转至申请页

19、面3、 申请人填写各项信息并提交4、 系统检查各项信息的合法性若各项信息合法，连接数据库添加立项申请结果(默认未生效)立项申请条提示成功信息；若否，提示失败信息5、 系统跳转至前台主页面流程图：页面输入申请人必须输入：项目名、类别、申请人、经费、申请内容、申请时间、页面输出成功、失败提示对应类ManageApply Action对应方法ManageApply Form方法输入proname,organizer,co-organizer,starttime,finishtime,partyAprincipal,partyBprincipal,proInvestment,pay condition

20、方法输出Boolean：true：操作成功false：操作失败查询条件applyID方法描述跟据申请号查询数据库，并在功能接口设计申请增加 数据库表申请表表字段proname typename proposer funds apcontent applyTime对表操作根据申请编号修改申请表列外说明必须输入的信息没有输入，系统提示错误信息；修改不成功。实施管理时序图如下：【图3】实施管理时序图3项目验收申请功能名称验收申请功能编号功能描述申请人向系统提交信息操作流程：1、 申请人进入申请页面2、 申请人填写申请信息提交3、 系统显示信息a) 若操作成功显示项目成功信息b) 若操作失败显示失败信

21、息4、 返回前台主页面业务流程：1、 申请人选择申请页面2、 系统跳转至申请页面3、 申请人填写各项信息并提交4、 系统检查各项信息的合法性若各项信息合法，连接数据库添加立项申请结果(默认未生效)立项申请条提示成功信息；若否，提示失败信息5、 系统跳转至前台主页面流程图：页面输入申请人必须输入：项目名、类别、申请人、经费、申请内容、申请时间、页面输出成功、失败提示对应类CheckApply Action对应方法CheckApply Form方法输入proName, proSchedule, proLeader方法输出Boolean：true：操作成功false：操作失败查询条件applyID方

22、法描述跟据申请号查询数据库，并在功能接口设计申请增加 数据库表申请表表字段proname typename proposer funds apcontent applyTime对表操作根据申请编号修改申请表列外说明必须输入的信息没有输入，系统提示错误信息；修改不成功。验收申请时序图如下：【图4】验收申请时序图4 项目成果鉴定申请功能名称成果鉴定申请功能编号功能描述申请人向系统提交信息操作流程：1、 申请人进入申请页面2、 申请人填写申请信息提交3、 系统显示信息a) 若操作成功显示项目成功信息b) 若操作失败显示失败信息4、 返回前台主页面业务流程：1、 申请人选择申请页面2、 系统跳转至申请

23、页面3、 申请人填写各项信息并提交4、 系统检查各项信息的合法性若各项信息合法，连接数据库添加立项申请结果(默认未生效)立项申请条提示成功信息；若否，提示失败信息5、 系统跳转至前台主页面流程图：页面输入申请人必须输入：项目名、类别、申请人、经费、申请内容、申请时间、页面输出成功、失败提示对应类IndentifyApply Action对应方法IndentifyApply Form方法输入proName,partyAPrincipal,partyBPrincipal,contractTime,totalInvestment,proId,contentIntro方法输出Boolean：true：

24、操作成功false：操作失败查询条件applyID方法描述跟据申请号查询数据库，并在功能接口设计申请增加 数据库表申请表表字段proname typename proposer funds apcontent applyTime对表操作根据申请编号修改申请表列外说明必须输入的信息没有输入，系统提示错误信息；修改不成功。成果鉴定申请时序图如下：【图5】成果鉴定申请时序图5 项目奖励申请功能名称奖励申请功能编号功能描述申请人向系统提交信息操作流程：1、 申请人进入申请页面2、 申请人填写申请信息提交3、 系统显示信息a) 若操作成功显示项目成功信息b) 若操作失败显示失败信息4、 返回前台主页面业

25、务流程：1、 申请人选择申请页面2、 系统跳转至申请页面3、 申请人填写各项信息并提交4、 系统检查各项信息的合法性若各项信息合法，连接数据库添加立项申请结果(默认未生效)立项申请条提示成功信息；若否，提示失败信息5、 系统跳转至前台主页面流程图：页面输入申请人必须输入：项目名、类别、申请人、经费、申请内容、申请时间、页面输出成功、失败提示对应类AwardApply Action对应方法AwardApply Form方法输入proname,organizer,co-organizer,finishMen方法输出Boolean：true：操作成功false：操作失败查询条件applyID方法描述

26、跟据申请号查询数据库，并在功能接口设计申请增加 数据库表申请表表字段proname typename proposer funds apcontent applyTime对表操作根据申请编号修改申请表列外说明必须输入的信息没有输入，系统提示错误信息；修改不成功。奖励申请时序图如下：【图5】奖励申请时序图6查看项目详细信息功能名称待办及办结项目查询功能编号功能描述用户查询项目详细信息操作流程：1. 用户进入主界面2. 用户点击查询按钮3. 系统显示信息：a) 若操作成功，系统用户要查询的信息b) 若操作失败，显示失败信息4. 返回前台主页 业务流程：1. 用户点击在办、办结项目浏览查看下拉按钮，

27、显示待办项目、办结项目、项目查询三项链接2. 点击待办项目链接，显示部门待办项目浏览界面，显示立项申请、实施管理申请、验收申请、成果鉴定申请、奖励申请等五个选项卡3. 点击需查询的信息选项卡，显示待办列表界面4. 点击查看详情按钮，弹出项目详细信息界面5. 点击关闭按钮，返回部门待办项目浏览界面流程图：页面输入申请人必须输入： 页面输出成功、失败提示对应类DetailInfo Action对应方法DetailInfo Form方法输入方法输出Boolean：true：操作成功false：操作失败查询条件applyID方法描述跟据申请号查询数据库，并在功能接口设计申请增加 数据库表申请表表字段p

28、roname typename proposer funds apcontent applyTime对表操作根据申请编号修改申请表列外说明必须输入的信息没有输入，系统提示错误信息；修改不成功。待办及办结项目时序图如下：【图7】待办及办结项目时序图4.1.2 审批模块模块汇总科技项目申请系统模块名称功能简述立项审批审批人给申请的项目进行审批实施管理审批审批人给申请的项目进行审批验收审批审批人给申请的项目进行审批成果审批审批人给申请的项目进行审批奖励审批审批人给申请的项目进行审批项目信息查询审批人根据查询条件进行项目查询个人信息个人信息查看修改科技审批项目类图【图8】审批功能类图说明：审批功能底层主要是对审批表进行添加以及对项目表和申请表的信息查询，Apply类中主要是申请的基本信息，project中主要是项目的基本信息，approve是审批的基本信息，三