软件详细设计模板示例汇总.docx

项目案例名称：《软件系统》

项目案例文档：《软件系统概要设计说明书》

导言

目的

本文档的目的是描述《软件系统》项目的详细设计，其主要内容包括：

系统功能简介

系统详细设计简述

各个模块的三层划分

最小模块组件的伪代码

本文档的预期的读者是：

设计人员

开发人员

项目管理人员

测试人员

范围

该文档定义了系统的各个模块和模块接口，但未确定单元的具体实现，这部分内容将在实现中确定。

引用标准

《企业文档格式标准》V1.1北京长江软件有限公司

《软件详细设计报告格式标准》V1.1

北京长江软件有限公司软件工程过程化组织

参考资料

[1]《实战ｓｔｒｕｃｔ》〔美〕Ｔｅｄ Ｈｕｓｔｅｄ机械工业出版社

版本更新信息

修改编号000

修改编号

000

修改日期 修改后版本

2010-4-13 0.1

修改位置

全部

修改内容概述

初始发布版本

系统设计概述

根据《软件系统》的概要设计，系统分为用户登录管理、帐号管理、帐号组权限管理、角色管理、日志查询、统计报表、平台管理、业务信息系统维护、个人信息维护等模块，他

综合信息管理平台用户登录管理

综合信息管理平台

用户登录管理

业务信息系统管理

员Portal

平台管理员Portal

业

帐

号

管理

帐

号组管

理

异常

时间登录操作报表

务

信息系统管

理

当

前登录用

户

业

务

个

信

人

用

日

统

平

息

信

户

志

计

台

系

息

管

查

报

管

统

维

理

询

表

理

维

护

护

帐

号

权

角

角

限

色

色

管

管

变

理

理

更

报

表

图C-1：模块设计图

详细设计概述

由于本系统采用了基于Struts体系结构的设计，即采用MVC的三层设计模式，采用面向对象的JAVA语言以及JSP的脚本语言。所以，基本采用面向对象的设计方法。在整个的开发过程中，尽可能采用复用的原则，例如采用标签库，统一数据库的基本操作，统一结果显示等。

本文档的详细设计主要是按照Struts的MVC的三个层次分别描述视图层、控制层和模型层模块的伪代码。为下一步的编码提供基础。

４登录管理模块

登录管理模块负责用户的登录。系统框架可以分成三层结构，即视图层、控制层和模型层，具体如表C-2所示。

视图login.jspmain.jsp

表C-2：登录管理的三层模块

控制器 模型

LoginForm LoginAction DB.java

Constants.javaUser.java

视图层

界面登录界面

界面

登录界面

JSP

login.jsp

功能描述

登录的主页面

主页面

主页面

页面中部页面上端页面左端

页面下端

main.jsp

center.jsptop.jspleft.jsp

bottom.jsp

管理主页面

复用页面：页面中心部分复用页面：页面上部分复用页面：页面的左部分

复用页面：页面的下部分

login.jspmain.jsp根据界面流的设计可以确定各个界面的访问入口，以及界面之间切换关系，页面流程如图C-2

login.jsp

main.jsp

图C-2：登录管理的页面流程图

控制层

登录管理的控制层主要是设计用户的登录事件的流程控制（Action）。表C-4列出了每个Action的入口（即调用Action的组件）、传递Action的ActionForm，以及出口（即Action将请求转发到目标组件）。

表C-4：登录管理控制层设计

事件

事件

用户登录

Action

LoginAction

入口

login.jsp

ActionForm

LoginForm

出口

main.jsp

模型层

登录管理模型组件负责完成用户信息的数据库操作的业务逻辑模型，建立封装了用户信息的bean，这个bean主要完成验证用户相关信息是否存在，并判断其权限。模型组件如表C-5所示。

表C-5：登录管理的模型组件

模型组件

模型组件

DB.javaUserBean.java

描述

封装数据库操作的bean封装用户信息的bean

５帐号管理模块

帐号管理模块负责用户帐号的维护，可以分成三层结构，即视图层、控制层和模型层，具体如表C-6所示。

表C-6：帐号管理的三层模块

视图

视图

userlist.jsp

控制器

UserForm

UserAction

模型

DB.java

adduser.jspupdateuser.jspuserdetail.jspauthrole.jsp

RoleForm Constants.javaUser.javaRole.java

视图层

根据上述的功能介绍，总结出帐号管理功能的页面设计如表C-7所示。

表C-7：帐号管理模块的页面设计

界面

帐号管理首页新增帐号