您的当前位置:首页正文

软件项目管理详细设计说明书

2021-10-22 来源:易榕旅网


详细设计说明书

1.导言

1.1 目的

本文档的目旨在推动软件工程的规范化,使设计人员遵循统一的代码书写规范,节省制作文档的时间,降低系统实现的风险,做到系统设计资料的规范性与全面性,以利于系统的实现、测试、维护等。

1.2 范围

本文档用于软件设计阶段的详细设计,它的上游是《概要设计说明书》,它的下游是源程序清单及单元测试计划,并为单元测试报告提供测试依据。范围应覆盖《概要设计说明书》中的功能时序图、性能点列表、接口列表。

软件详细设计的范围是:各子系统的公用模块实现设计、专用模块实现设计、存储过程实现设计、触发器实现设计、外部接口实现设计、角色授权设计、其他详细设计等。

按照3层结构(B/A/S)的布局,详细设计应从下面3个方面进行。数据库服务器上的面向数据的设计:数据字典物理设计、基本表物理设计、中间表物理设计(报表设计)、临时表物理设计、视图物理设计、存储过程物理设计、触发器物理设计。应用服务器上的面向业务逻辑的设计:接口数据设计、中间件设计、数据通信传输设计、可视构件设计、非可视构件设计、角色授权设计、功能点设计(功能点列表设计)。浏览器上的面向对象的设计:录入修改界面设计、浏览查询界面设计、登录注册界面设计、信息发布界面设计。

1.3 术语定义

术语定义,如表1所示。 序术语名称 术 语 定 义 号 在概要设计的基础上,对其功能模块或部件进行实1 详细设计 现设计,使编程人员据此能顺利书写出程序代码 存放在数据库服务器上的一段程序,它能被其他程2 存储过程 序调用,以完成对数据库表的某些规定操作 存放在数据库服务器上的一段程序,当触发条件满3 触发器 足时它就被执行,以完成对数据库表的某些规定操作

续前表

4 算法 详细设计中实现某项功能的数据处理方法及处理流程 表1 术语定义

1.4 参考资料

[1] 《概要设计说明书》 [2] 《需求分析说明书》 1.5 相关文档 [1] 源程序清单

[2] 单元测试计划及报告 [3] 《用户使用手册》

2.模块实现设计

包设计

图 1 整个系统的包图

2.1 类库设计

图2 类库图

2.1.1用户实体类,如图3

图 3 用户实体类

类:admin(管理员)

是否抽象:false 是否Leaf:false

继承:classLibrary.entityClass.expert 实现:Implements

描述:管理员

操作

操作名 可见性 返回类型 参数 抽象 deleteUser public addUser public 静态 Leaf 描述 Abstract false false 删除会员信息 Abstract false false 添加新会员信息

类:expert

是否抽象:false 是否Leaf:false

继承:classLibrary.entityClass.user 实现:Implements

描述:专家

类:user

是否抽象:false 是否Leaf:false 继承:

实现:Implements 描述:用户 字段

字段名 可见性 类型 默认值 静态 Leaf 描述 name pwd protected string protected string false false false false false false typeName protected string

操作 操作名 login scan 可见性 返回类型 参数 抽象 public public 静态 Leaf 描述 editUserInfo public Abstract false false Abstract false false Abstract false false 2.1.2控制类,如图4

图 4 控制类图

类:addNewPests

是否抽象:false 是否Leaf:false

继承:classLibrary.controllerClass.infoController 实现:Implements

描述:新害虫信息控制类

操作 操作名 可见返回类参数 性 型 void String introduce, userName 抽象 静态 Leaf 描述 submitEditInfo public string Abstract false false 类:echinococcosisInfoController

是否抽象:false 是否Leaf:false

继承:classLibrary.controllerClass.infoController 实现:Implements

描述:虫病信息控制类

操作 操作名 submitEditInfo 可见返回参数 性 类型 抽象 静Leaf 描态 述 public void Int id, String name, Int typeNo, Abstract false false String nomen, String feature, String locate, String rule, String harm, String prevent, String image submitEditKindName public void int typeNo, String typeName, Abstract false false String introduce, string prevent

操作 操作名 submitEditInfo 可见返回参数 性 类型 抽象 静Leaf 描态 述 public void Int id, String name, String Abstract false false nomen, String feature, String locate, String rule, String prevent, String image, Int typeNo, String typeName submitEditKindName public void int typeNo, String typeName, Abstract false false String introduce, string prevent

类:infoController

是否抽象:false 是否Leaf:false 继承:

实现:Implements 描述:信息控制类 操作 操作名 requestInfo showInfo showKindName showResult 可见性 返回类型 参数 public public public String string String string String id Int id Int id Int id 抽象 静态 Leaf 描述 Abstract false false Abstract false false Abstract false false Abstract false false requestKindName public protected String String showType Abstract false false 类:messageBox

是否抽象:false 是否Leaf:false 继承:

实现:Implements 描述:消息框类

操作 操作名 可见性 返回类型 参数 bool 抽象 静态 Leaf 描述 messageBox public string msgStr Abstract false false 类:pestsInfoController

是否抽象:false 是否Leaf:false

继承:classLibrary.controllerClass.infoController 实现:Implements

描述:害虫信息控制类

操作 操作名 可见返性 回类型 参数 抽象 静Leaf 描态 述 submitEditInfo public void Int id, String name, Int typeNo, Abstract false false String nomen, String feature, String locate, String rule, String condition, String harm, String prevent, String image submitEditKindName public void Int typeNo, String typeName, Abstract false false String introduce, String prevent, Int parent

类:userInfoController

是否抽象:false 是否Leaf:false 继承:

实现:Implements

描述:用户信息控制类

操作 操作名 addUser 可见返回类参数 性 型 public void 抽象 静Leaf 描态 述 string name, string pwd, string Abstract false false typeName string name string name, string pwd string name, string pwd string name string showType string name, string pwd Abstract false false Abstract false false Abstract false false Abstract false false Abstract false false Abstract false false Abstract false false deleteUser public void login register public void public void requestInfo public string requestInfo public string showResult private void submitEdit public void submitEdit public void string name, string pwd, string Abstract false false typeName 2.1.3 边界类,如图5

图 5 边界类图

类:boundaryInfoClass

是否抽象:false 是否Leaf:false 继承:

实现:Implements

描述:信息边界类

字段

字段名 可见性 类型 默认值 静态 Leaf 描述 feature protected string id image locate name protected int protected String protected string protected string false false false false false false false false false false false false false false false false false false nomen protected String prevent protected String rule protected string typeNO protected Int 操作

操作名 可见性 返回类型 参数 抽象 getInfo protected void sendInfo protected void

静态 Leaf 描述 Abstract false false Abstract false false 类:boundaryKindClass

是否抽象:false 是否Leaf:false 继承:

实现:Implements

描述:边界类型类

字段

字段名 可见性 类型 默认值 静态 Leaf 描述 typeNO protected Int false false false false typeName protected String 操作 操作名 可见性 返回类型 参数 抽象 静态 Leaf 描述 getKindName protected void sendKindName protected void Abstract false false Abstract false false

类:echinococcosisInfoBoundary

是否抽象:false 是否Leaf:false

继承:classLibrary.boundaryClass.boundaryInfoClass 实现:Implements

描述:虫病信息边界类

字段

字段名 可见性 类型 默认值 静态 Leaf 描述 harm private string false false 类:echinococcosisKindBoundary

是否抽象:false 是否Leaf:false

继承:classLibrary.boundaryClass.boundaryKindClass 实现:Implements

描述:虫病种类边界类

字段 字段名 typePrevent 可见性 类型 默认值 静态 Leaf 描述 false false false false private String typeIntroduce private String 类:enemyInfoBoundary

是否抽象:false 是否Leaf:false

继承:classLibrary.boundaryClass.boundaryInfoClass 实现:Implements

描述:天敌信息边界类

类:enemyKindBoundary

是否抽象:false 是否Leaf:false

继承:classLibrary.boundaryClass.boundaryKindClass

实现:Implements

描述:天敌种类边界类

类:pestsInfoBoundary

是否抽象:false 是否Leaf:false

继承:classLibrary.boundaryClass.boundaryInfoClass 实现:Implements

描述:害虫信息边界类

字段

字段名 可见性 类型 默认值 静态 Leaf 描述 condition private string harm private String false false false false 类:pestsKindBoundary

是否抽象:false 是否Leaf:false

继承:classLibrary.boundaryClass.boundaryKindClass 实现:Implements

描述:害虫种类边界类

字段 字段名 typePrevent 可见性 类型 默认值 静态 Leaf 描述 false false false false private String typeIntroduce private String 2.2 用户信息管理模块,如图6

图 6 用户信息管理模块图

类:userInfoController

是否抽象:false 是否Leaf:false

继承:classLibrary.controllerClass.userInfoController 实现:Implements

描述:用户信息控制者

接口:loginForm

是否抽象:false 是否Leaf:false 继承:

实现:Implements

描述:登录表单

操作 操作名 可见性 返回类型 参数 抽象 静态 Leaf 描述 submitLogin public Abstract false false

接口:registerForm

是否抽象:false 是否Leaf:false 继承:

实现:Implements

描述:注册表单

操作 操作名 可见性 返回类型 参数 抽象 静态 Leaf 描述 submitRegister public Abstract false false 接口:userInfoForm

是否抽象:false 是否Leaf:false 继承:

实现:Implements

描述:用户信息维护表单

操作 操作名 可见性 返回类型 参数 抽象 静态 Leaf 描述 requestUserInfo public showLoginResult public showSaveResult public showUserInfo submitEdit submitUserInfo public public public Abstract false false Abstract false false Abstract false false Abstract false false Abstract false false Abstract false false

2.3 害虫信息管理,如图7

图 7 害虫信息管理模块

类:pestsInfoController

是否抽象:false 是否Leaf:false

继承:classLibrary.controllerClass.pestsInfoController 实现:Implements

描述:害虫信息管理控制者

类:pestsInfoSystem

是否抽象:false 是否Leaf:false

继承:classLibrary.boundaryClass.pestsInfoBoundary 实现:Implements

描述:害虫信息管理系统

类:pestsKindSystem

是否抽象:false 是否Leaf:false

继承:classLibrary.boundaryClass.pestsKindBoundary 实现:Implements

描述:害虫种类管理系统

包:pestsInfo.editPests

接口:editPestsInfo

是否抽象:false 是否Leaf:false 继承:

实现:Implements

描述:害虫信息维护表单

操作 操作名 editPestsInfo showPestsInfo 可见性 返回类型 参数 抽象 public public 静态 Leaf 描述 Abstract false false Abstract false false Abstract false false Abstract false false requestPestsInfo public showSaveResult public 接口:editPestsKind

是否抽象:false 是否Leaf:false 继承:

实现:Implements

描述:害虫种类维护表单

操作

操作名 editKindName showKindName 可见性 返回类型 参数 抽象 public public 静态 Leaf 描述 Abstract false false Abstract false false Abstract false false Abstract false false requestKindName public showSaveResult public 包:pestsInfo.scanPestsInfo

接口:scanPestInfoForm

是否抽象:false 是否Leaf:false 继承:

实现:Implements

描述:害虫信息查看表单 操作 操作名 showPestsInfo 可见性 返回类型 参数 抽象 public 静态 Leaf 描述 requestPestsInfo public Abstract false false Abstract false false 接口:scanPestsKind

是否抽象:false 是否Leaf:false 继承:

实现:Implements

描述:害虫种类查看表单

操作 操作名 showKindName 可见性 返回类型 参数 抽象 public 静态 Leaf 描述 requestKindName public Abstract false false Abstract false false

2.4 虫病信息管理,如图8

图 8 虫病信息管理模块

类:echinococcosisInfoController

是否抽象:false 是否Leaf:false

继承:classLibrary.controllerClass.echinococcosisInfoController 实现:Implements

描述:虫病信息控制者

类:echinococcosisInfoSystem

是否抽象:false 是否Leaf:false

继承:classLibrary.boundaryClass.echinococcosisInfoBoundary 实现:Implements

描述:虫病信息管理系统

类:echinococcosisKindSystem

是否抽象:false 是否Leaf:false

继承:classLibrary.boundaryClass.echinococcosisKindBoundary 实现:Implements

描述:虫病种类管理系统

包:echinococcosisInfo.editEchinococcosis

接口:editEchinococcosisForm

是否抽象:false 是否Leaf:false 继承:

实现:Implements

描述:虫病信息维护表单

操作 操作名 editEchinococcosis showEchinococcosis showSaveResult 可见性 返回类型 参数 抽象 public public public 静态 Leaf 描述 Abstract false false Abstract false false Abstract false false Abstract false false requestEchinococcosisInfo public 接口:editKindForm

是否抽象:false 是否Leaf:false 继承:

实现:Implements

描述:虫病种类维护表单 操作 操作名 editKindName showKindName 可见性 返回类型 参数 抽象 public public 静态 Leaf 描述 Abstract false false Abstract false false Abstract false false Abstract false false requestKindName public showSaveResult public 包:echinococcosisInfo.scanEchinococcosis

接口:echinococcosisInfoForm

是否抽象:false

是否Leaf:false 继承:

实现:Implements

描述:虫病信息浏览表单 操作 操作名 showEchinococcosis 可见性 返回类型 参数 抽象 public 静态 Leaf 描述 requestEchinococcosisInfo public Abstract false false Abstract false false 接口:scanKindForm

是否抽象:false 是否Leaf:false 继承:

实现:Implements

描述:虫病种类浏览表单

操作 操作名 showKindName 可见性 返回类型 参数 抽象 public 静态 Leaf 描述 requestKindName public Abstract false false Abstract false false

2.5天敌信息管理,如图9

图 9 天敌信息管理模块

2.6 新发现害虫管理,如图10

图 10 新发现害虫管理模块

类:newPestsInfoController

是否抽象:false 是否Leaf:false

继承:classLibrary.controllerClass.pestsInfoController 实现:Implements

描述:新害虫添加控制者

类:newPestsSystem

是否抽象:false 是否Leaf:false 继承:

实现:Implements

描述:新害虫管理系统

字段

字段名 可见性 类型 默认值 静态 Leaf 描述 introduce private string userName private string false false false false 操作

操作名 可见性 返回类型 参数 抽象 getInfo public sendInfo public 静态 Leaf 描述 Abstract false false Abstract false false 包:newPestsInfo.addNewPests

接口:addNewPestsForm

是否抽象:false 是否Leaf:false 继承:

实现:Implements

描述:新害虫添加表单

操作 操作名 可见返回参数 性 类型 抽象 静态 Leaf 描述 requestNewPests public Abstract false false showNewPests public Abstract false false showSaveResult public Abstract false false submitNewPests public Abstract false false 包:newPestsInfo.scanNewPestsForm

接口:scanAddNewPests

是否抽象:false

是否Leaf:false 继承:

实现:Implements 描述:浏览新害虫 操作 操作名 showNewPests 可见性 返回类型 参数 抽象 public 静态 Leaf 描述 requestNewPests public Abstract false false Abstract false false 包:newPestsInfo.suerAddNewPests

接口:suerAddNewPestsForm

是否抽象:false 是否Leaf:false

继承:

实现:Implements 描述:确认添加表单 操作 操作名 showNewPests submitSure 可见性 返回类型 参数 抽象 public public 静态 Leaf 描述 requestNewPests public Abstract false false Abstract false false Abstract false false 类:enemyInfoController

是否抽象:false 是否Leaf:false

继承:classLibrary.controllerClass.enemyInfo 实现:Implements

描述:天敌信息管理者

类:enemyInfoSystem

是否抽象:false 是否Leaf:false

继承:classLibrary.boundaryClass.enemyInfoBoundary 实现:Implements

描述:天敌信息管理系统

类:enemyKindSystem

是否抽象:false 是否Leaf:false

继承:classLibrary.boundaryClass.enemyKindBoundary 实现:Implements

描述:天敌种类管理系统

包:enemyInfo.editEnemyInfo

接口:editEnemyInfoForm

是否抽象:false

是否Leaf:false 继承:

实现:Implements

描述:维护天敌信息表单 操作 操作名 editPestsInfo showPestsInfo 可见性 返回类型 参数 抽象 public public 静态 Leaf 描述 Abstract false false Abstract false false Abstract false false Abstract false false requestPestsInfo public showSaveResult public 接口:editEnemyKindForm

是否抽象:false 是否Leaf:false 继承:

实现:Implements

描述:维护天敌种类表单 操作 操作名 editKindName showKindName 可见性 返回类型 参数 抽象 public public 静态 Leaf 描述 Abstract false false Abstract false false Abstract false false Abstract false false requestKindName public showSaveResult public 包:enemyInfo.scanEnemyInfo

接口:scanEnemyInfoForm

是否抽象:false 是否Leaf:false 继承:

实现:Implements

描述:浏览天敌信息表单

操作 操作名 showPestsInfo 可见性 返回类型 参数 抽象 public 静态 Leaf 描述 requestPestsInfo public Abstract false false Abstract false false 接口:scanEnemyKind

是否抽象:false 是否Leaf:false 继承:

实现:Implements

描述:浏览天敌种类表单 操作 操作名 showKindName 可见性 返回类型 参数 抽象 public 静态 Leaf 描述 requestKindName public Abstract false false Abstract false false 2.7 留言管理,如图11

图 11 留言管理模块

类:messageSystem

是否抽象:false 是否Leaf:false 继承:

实现:Implements 描述:留言系统 字段

字段名 可见性 类型 默认值 静态 Leaf 描述 content parent title private string private string private string false false false false false false false false false false pubTime private string userName private string 操作 操作名 可见性 返回类型 参数 抽象 静态 Leaf 描述 getMessage public sendMessage public Abstract false false Abstract false false 类:pubMessageController

是否抽象:false 是否Leaf:false 继承:

实现:Implements

描述:留言管理控制者

操作 操作名 request requestDelete saveMessage 可见性 返回类型 参数 抽象 public public public 静态 Leaf 描述 Abstract false false Abstract false false Abstract false false Abstract false false showSaveResult private

包:pubMessage.managmentMessage

接口:messageManagementForm

是否抽象:false 是否Leaf:false 继承:

实现:Implements

描述:管理表单

操作 操作名 可见性 返回类型 参数 抽象 静态 Leaf 描述 deleteMessage public showMessage public Abstract false false Abstract false false 包:pubMessage.pubMessage

接口:PubMessageForm

是否抽象:false 是否Leaf:false 继承:

实现:Implements

描述:留言表单

操作 操作名 showMessage 可见性 返回类型 参数 抽象 public 静态 Leaf 描述 publishMessage public Abstract false false Abstract false false 包:pubMessage.responseMessage

接口:responseForm

是否抽象:false 是否Leaf:false 继承:

实现:Implements 描述:回复表单 操作 操作名 showMessage 可见性 返回类型 参数 抽象 public 静态 Leaf 描述 responseMessage public Abstract false false Abstract false false 2.8 诊断管理,如图12

图 12 诊断管理

类:diagnosisController

是否抽象:false 是否Leaf:false 继承:

实现:Implements

描述:诊断管理控制者 操作 操作名 requestChoices requestPestsInfo requestSearch showSaveResult 可见性 返回类型 参数 抽象 public public public 静态 Leaf 描述 Abstract false false Abstract false false Abstract false false Abstract false false Abstract false false requestEchinococcosisInfo public private 类:diagnosisForm

是否抽象:false 是否Leaf:false 继承:

实现:Implements

描述:诊断管理表单

操作 操作名 requestChoices requestPestsInfo requestSearch 可见性 返回类型 参数 抽象 public public public 静态 Leaf 描述 Abstract false false Abstract false false Abstract false false Abstract false false requestEchinococcosisInfo public

3.界面设计

本系统的界面分为网站管理员后台界面和普通用户的操作页面。其中管理员后台界面主要是对整个网站系统的管理、维护功能,对数据库的维护、备份和恢复。普通用户的操作界面主要是浏览相应的信息,发表、回复留言,添加用户发现的新害虫信息等。 3.1管理员后台界面,如图13

进入登录界面,只有管理员权限的用户可以通过验证,进入后台。界面如下图3。

图 13 后台登录界面

初始化时分配一个管理员账号,管理员输入自己的账号信息,验证无误后登录入后台管理首页页面,如下图14所示。

图14 后台管理页面

点击左边相应的图标,进入相应的功能管理界面。以下是信息浏览界面,用Repeater绑定数据来显示相应的信息,如图15所示。

图 15 信息浏览界面

修改信息页面,如图16所示。

图 16 修改用户信息页面

普通用户的前台操作页面显示设置界面,如图17所示。

图 17 前台普通用户操作首页显示内容设置界面

管理员有删除用户信息和其他信息的权限,删除之前弹出警告窗口,如下图18所示。

图 18 删除信息时弹出的警告

添加新的信息时或修改信息时弹出的添加成功或修改成功窗口,如图19所示。

图 19 修改信息成功提示

3.2 普通用户的前台界面 首页内容如图20所示。

图 20 普通用户的前台操作界面

用户发表留言界面,如图21所示。

图 21 用户发表留言界面

用户查看并回复留言界面,如图22所示。

图 22 用户查看并回复留言界面

用户浏览信息界面,如图23所示。

图 23 用户浏览信息界面

用户添加用户发现的新害虫信息页面,如图24所示。

图 24 用户添加新发现害虫描述

用户修改个人密码页面,如图25所示。

图 25 修改个人密码界面

因篇幅问题不能全部显示,请点此查看更多更全内容