您的位置:蚂蚁网 > 条据书信 > 说明书 > 详细设计说明书 正文

详细设计说明书

2016-12-25 12:17:52 来源网站:蚂蚁网

篇一:详细设计说明书 真正例子

详细设计说明书

1.引言

1.1编写目的

本详细设计说明书是针对网络信息体系结构的课程作业而编写。目的是对该项目进行详细设计,在概要设计的基础上进一步明确系统结构,详细地介绍系统的各个模块,为进行后面的实现和测试作准备。本详细设计说明书的预期读者为本项目小组的成员以及对该系统感兴趣,在以后想对系统进行扩展和维护的人员。

2. 系统的结构

? ui:系统界面部分,负责接受用户输入,显示系统输出,负责其他模块功能的协调调用,

并含有站内搜索功能,即在用户指定的已打开的ftp站点中搜索用户需要的资源。ui部分调用common部分的功能读取xml文件中保存的界面元素属性信息,用户最近访问过的10个ftp信息,用户选择的下载的ftp内容列表及其他需要通过xml文件保存的信息。

? client:实现ftp客户端的功能,ftp连接,ftp上传及下载:上传或下载用户指定的

资源,并返回相应的信息。

? search:资源实时检索部分,根据用户输入的资源名称关键字,资源类型和选择的检索

方式检索用户需要的资源,并验证资源的可用性,返回可用资源及其大小,速度等相关信息。

? preview:资源预览部分,显示用户选择的资源的部分内容,以使用户决定是否需要该

资源。preview部分调用common部分读取属性文件的内容亦显示预览资源内容的显示格式。

3.模块1(ui)设计说明

3.1模块描述

实现用户界面的包,含有11个文件51个类,是本系统中最复杂的代码。

3.2功能

负责接受用户输入,显示系统输出,其他模块功能的协调调用,并含有站内搜索功能,即在用户指定的已打开的ftp站点中搜索用户需要的资源。

3.3交互的模块

client,search,preview,common。

3.4 模块设计

该模块中的主要文件,文件中包含的主要类及其功能和与其它包的交互如下:

? MainFrame.java:MainFrame是含有主函数的类,也是lyra客户端开始执行的类,它先后进行资源的初始化,显示主界面等工作,根据屏幕大小设置界面大小,设置界面的观感。

? FtpFrame_AboutBox.java:显示关于窗口的类,当用户点击帮助菜单中的关于菜单

项时会弹出关于对话框。

? Tools.java:FileTools是文件操作辅助类,可以实现文件的递归删除等。

? XMLController.java: JDOMTes是操作xml文件的类,用JDOM来操作xml文件,

实现的功能有:

(1)保存ftp服务器的文件列表(站内搜索时使用),递归的从ftp服务器读取列表,并存入一个xml文件中(文件的命名方法是:ip+用户名.xml);以目录树的形式保存。

(2)根据文件名在文件中查找文件,站内搜索时使用。

(3)保存ftp服务器的信息:ip,端口(默认端口21不保存),用户名(默认anonymous不保存),密码,最多存10个;存在resource\settings\ serversinfor.xml文件中。

(4)读取已存储的ftp服务器信息。

(5)从type.xml读取搜索的类型。

? Constants.java:放置系统运行时使用的一些常量,initcontent()函数对所有常量进行

初始化,这个函数在MainFrame中被调用一次。iconHashMap是hash表,用于存放文件的系统图标。

? CustomizedController.java:包含自定义的控件类,java中的控件可能不能满足需求,

需要自己定义某些属性。这些控件会在创建界面时使用。其中含有的类有:

(1)CustomizedJTable 是表格类,设置表格的某些属性,如字体等。

(2)CustomizedTableCellRenderer是表格单元格绘制器类,主要用于显示文件的系统图标,和文件名。

(3)LeftPanel类的父类是JTabbedPane,用户显示主窗口左边的面板。

(4)RightPanel类的父类是JPanel,用户显示右边的主题部分,包括右上边的搜索及服务

器选项,和中间的显示服务器文件的TabbedPane。.

(5)BottomPanel类是右下放显示下载和服务器信息的JTabbedPane。

(6)CustomizedJButton 是定义按钮类,更改了按钮的字体,java本身默认的字体不好看。

(7)CustomizedTableModel是表格类,实现单元格的不可编辑。

(8)CustomizedTableCellRenderer_Remote类是表格绘制器,在远程文件浏览器RemoteFilesPanel使用,用于显示文件名和文件图标。

(9)FontTableCellRenderer类是表格单元格绘制器,主要功能是设置字体。

(10)FontListCellRenderer类是下拉列表框单元格绘制器,主要用于设置字体。

(11)CustomizedJLabel类是自定义标签类,重新设置了标签的字体。

(12)CustomizedJTextField类是自定义文本框类,主要用于设置文本框的显示属性。

(13)CustomizedJMenu类是自定义菜单类,重新设置了菜单的字体。

(14)CustomizedJMenuItem类是自定义菜单项类,重新设置了菜单的字体。

(15)CustomizedListCellRenderer类是JComboBox即组合框单元格绘制器,用于在本地路径选择的下拉列表中显示磁盘图标。

? SearchResultReceiver.java, SearchResultReceiver是一个接口,主要用于返回搜索结果。

搜索完成后调用接口中的函数通知调用者。其中主要有两个函数:

(1)OnSearchFinished(String[] keywords,ArrayList[] resultset);result是一个10维的数组表result[10],result[i]是由类型为i的资源组成的数组。i:0-9,和类型列表框中的顺序一致。

(2)OnSearchFinished(String[] keywords,ArrayList resultset);不分类型,将所有资源放在一个数组表中。

? FtpFrame.java:FtpFrame是程序主窗口类,类型为JFrame,是由三个分割窗口JSplitPane

构成的。

jSplitPane_Left是左边的分割窗口,水平分割条上边显示本地文件框,下边是预览框; jSplitPane_Right是右边的分割窗口,水平分割条上边是服务器选项和ftp服务器文件显示的窗口,下边是下载和服务器信息显示窗口;

jSplitPane_Whole是整体的分割窗口,垂直分割条,左边是jSplitPane_Lef,右边是jSplitPane_Right。

FtpFrame把LeftPanel,RightPanel,BottomPanel,PreviewWrapperPanel这几部分安装在相应的分割窗格中;LeftPanel,RightPanel,BottomPanel是在CustomizedController.Java中定义的,PreviewWrapperPanel是在Preview包中定义的。

? LeftPanelCtrl.java: LocalFilesPanel是本地文件面板,用表格来显示本地文件的信

息。上边是组合框,显示了磁盘分区通过这里可以改变根目录。表格中显示了文件的信息,包括文件名,文件的系统图标,大小,最近修改日期,属性等。选中一个文件后可以执行上载和删除操作。文件夹会递归的删除。GetCurrentPath()函数返回当前的路径。DisplayPathFiles()函数在列表中显示指定目录下的文件。

? RightPanlCtrl.java:定义右上边的控件。含有的类有:

(1)FtpServerOptionPanel类是服务器连接选项面板,包含服务器地址,端口,用户名,密码等,还包括最上端的搜索选项。openRemoteFilesPanel()函数在下面的TabbedPane中打开一个新的服务器面板,连接服务器。

(2)RemoteFilesPanel类的主要功能是连接Ftp服务器并显示文件。这里会进行文件的上载,下载及预览等操作。RemoteFilesPanel 的内部类TransferController负责调用FtpClient类提供的功能与服务器进行交互,完成用户指定的文件操作。TransferController还有三个内部类:ConnThread类是负责连接服务器的线程(新开一个线程,目的是避免连接时阻塞),DownloadFileThread类是下载文件的线程,UploadFileThread类是上载文件的线程。

(3)SearchResultPanel类是显示搜索结果的类,它有两个子类SearchResultPanelWithinSearchEngine类的功能是在搜索引擎中搜索,SearchResultPanelWithinServer类的功能是站内搜索。搜索引擎的搜索会调用search包中的程序,搜索引擎搜索完成后search包通过OnSearchFinished()来通知SearchResultPanelWithinSearchEngine类,然后显示搜索结果。

(4)RightTabbedPane是显示ftp服务器文件表格的TabbedPane类。

? BottomPanelCtrl.java:实现主窗口下部面板及控件,显示下载情况,服务器连接信息。

包含的主要类有:

(1)RemoteMessPanel类是显示服务器连接信息的面板。需要显示ftp服务器传回的信息,并在显示前进行编码转换,还需要显示本地的相关信息。

(2)DownloadingMessPanel类是显示资源下载信息的面板,显示下载资源的大小,下载速度,已用时间,剩余时间等信息。

3.5流程逻辑

总体流程:

4.模块2(client)设计说明

4.1模块描述

实现ftp客户端FtpClient,有两个文件FtpClient.java和FtpLoginException.java,前者具体实现了ftp协议,后者是为登录时可能抛出的异常而定义的类。

4.2功能

实现ftp客户端FtpClient,实现了ftp协议,用于和ftp服务器通讯和数据传输。

4.3交互的模块

ui

4.4 模块设计

该模块中的主要文件,文件中包含的主要类及其功能和与其它包的交互如下:

? FtpClient.java:含有类FtpClient,,该类会被ui包中的界面类调用,完成ftp功能。

其中要功能的实现有:

在构造函数中根据ip和port建立与服务器的连接;

篇二:软件详细设计说明书实例

软件详细设计说明书实例

2013年5月

目录

1 引言 ..................................................................................................................................................................2

1.1

1.2

1.3

1.4

2 编写目的...............................................................................................................................................2 项目背景...............................................................................................................................................2 定义 .......................................................................................................................................................2 参考资料...............................................................................................................................................3 总体设计 .........................................................................................................................................................3

2.1

2.2 需求概述...............................................................................................................................................3 软件结构...............................................................................................................................................4

3 程序描述 .........................................................................................................................................................6

3.1

3.2

3.3

3.4

3.5

3.6

3.7

3.8

3.9

3.10 01登陆模块 .........................................................................................................................................6 02管理模块 ................................................................................................... 错误!未定义书签。 031图书信息查询模块 ............................................................................... 错误!未定义书签。 032学生信息查询模块 ............................................................................... 错误!未定义书签。 021入库管理模块 ........................................................................................ 错误!未定义书签。 022学生借书模块 ........................................................................................ 错误!未定义书签。 023学生还书模块 ........................................................................................ 错误!未定义书签。 024图书注销模块 ........................................................................................ 错误!未定义书签。 接口设计......................................................................................................... 错误!未定义书签。 测试要点 .......................................................................................................................................43

文档名称: 详细设计规格说明书

项目名称: 图书馆管理系统

项目负责人:陈新光

编写 TEST_____年_____月_____日

校对 所有小组成员_____年_____月_____日

审核 所有小组成员_____年_____月_____日

批准XXX_____年_____月_____日

开发单位__________________________________________

组员:TEST1 TEST2TEST3

1 引言

1.1 编写目的

图书管理系统详细设计是设计的第二个阶段,这个阶段的主要任务是在图书管理系统概要设计书基础上,对概要设计中产生的功能模块进行过程描述,设计功能模块的内部细节,包括算法和详细数据结构,为编写源代码提供必要的说明。

概要设计解决了软件系统总体结构设计的问题,包括整个软件系统的结构、模块划分、模块功能和模块间的联系等。详细设计则要解决如何实现各个模块的内部功能,即模块设计。具体的说,模块设计就是要为已经产生的图书管理各子系统设计详细的算法。但这并不等同于系统实现阶段用具体的语言编码,它只是对实现细节作精确的描述,这样编码阶段就可以将详细设计中对功能实现的描述,直接翻译、转化为用某种程序设计语言书写的程序。

1.2 项目背景

根据XX学校希望能够充分利用现代科技来提高图书管理的效率,在原有的办公系统基础上进行扩展,将一些可以用计算机来管理的都进行计算机化,使得图书馆管理人员工作更加方便,工作效率也更加的高。

1.3 定义

?Mysql:数据库管理软件

?DBMS:数据库管理系统

?Windows 2000/2003/XP:运行环境

?JSP :软件开发语言

?Myeclipse :开发工具

1.4 参考资料

《软件工程导论——第5版》 张海藩编著 清华大学出版社

《实用软件工程》Leszek A.Maciaszek Bruc Lee Liong著 机械工业出版社

2 总体设计

2.1 需求概述

按照需求分析文档中的规格要求,使用条形码扫描器进书、借书、还书,使得信息传递准确、流畅。同时,系统最大限度地实现易安装,易维护性,易操作性,运行稳定,安全可靠。

篇三:详细设计说明书(仅供参考)

南阳市地方税务局直属局网站管理系统

详细设计说明书

郑州仟佰网络技术有限公司

地址: 郑州市东风路与文化路交叉处小南国对面

电话: 0371-6013286860132869

传真: 0371-60132869

邮箱: appcom@vip.163.com

网址: http://

目 录

一、引言 .................................................................................................................................................. 3

1.1编写目的 ........................................................................................................................................ 3

1.2背景 ................................................................................................................................................ 3

1.3定义 ................................................................................................................................................ 3

1.4参考文献 ........................................................................................................................................ 4

二、系统框架结构 .................................................................................................................................. 4

三、系统的结构 ...................................................................................................................................... 6

四、本软件各模块的设计说明 .............................................................................................................. 7

4.1安全管理模块 ................................................................................................................................ 7

4.1.1用户管理 ................................................................................................................................. 8

4.1.2模块管理 ................................................................................................................................. 9

4.1.3权限管理 ............................................................................................................................... 10

4.1.4数据库备份 ........................................................................................................................... 11

4.1.5网站浏览量统计 ................................................................................................................... 12

4.1.6信息采用量统计 ................................................................................................................... 12

4.2在线考试模块 .............................................................................................................................. 13

4.3网上签到模块 .............................................................................................................................. 14

4.4下载管理模块 .............................................................................................................................. 15

4.4.1网上图书馆 ........................................................................................................................... 16

4.4.2下载中心 ............................................................................................................................... 17

4.5专题管理模块 .............................................................................................................................. 17

4.5.1热点专栏 ............................................................................................................................... 17

4.5.2科室动态 ............................................................................................................................... 19

4.5.3征纳互动 ............................................................................................................................... 20

4.5.4休闲驿站 ............................................................................................................................... 21

4.5.5信息发布 ............................................................................................................................... 22

4.6菜单管理模块 .............................................................................................................................. 23

4.6.1本局简介 ............................................................................................................................... 23

4.6.2政策法规 ............................................................................................................................... 24

4.6.3办税指南 ............................................................................................................................... 25

4.6.4教育培训 ............................................................................................................................... 26

4.6.5廉政建设 ............................................................................................................................... 27

4.6.6资讯中心 ............................................................................................................................... 28

4.7系统结构管理模块 ...................................................................................................................... 29

4.7.1页眉管理 ............................................................................................................................... 29

4.7.2页脚管理 ............................................................................................................................... 30

4.7.3菜单项管理 ........................................................................................................................... 31

五、外部接口 ........................................................................................................................................ 31

一、引言

1.1编写目的

为开发人员提供一份针对本系统实现的具体设计方案和实现方法,也让系统用户对开发的功能有个大致了解。

1.2背景

软件名称:南阳市地方税务局直属局网站管理系统

委托单位:南阳市地方税务局直属税务分局

承办单位:郑州仟佰网络技术有限公司

1.3定义

类 图:类图(Class diagram)是显示了模型的静态结构,特别是模型中存在的类、类的内部结构以及它们与其他类的关系等,用于描述系统的结构化设计。

对象图:对象图(Object Diagram) 是显示了一组对象和他们之间的关系的图示,一个对象图可看成一个类图的特殊用例,

状态图:状态图(State Diagram)是描述一个实体基于事件反应的动态行为,显示了该实体如何根据当前所处的状态对不同的时间做出反应的,用于显示状态机(它指定对象所在的状态序列)、使对象达到这些状态的事件和条件、以及达到这些状态时所发生的操作。

1.4参考文献

《中华人民共和国国家标准计算机软件产品开发文件编写指南》中华人民共和国电子工业部

《中华人民共和国国家标准信息处理-数据流程图、程序流程图、系统流程图、程序网络图和系统资源图的文件编制符号及约定》中华人民共和国机械电子工业部

《中华人民共和国国家标准计算机软件产品开发文件编写指南》中华人民共和国电子工业部

《中华人民共和国国家标准信息处理-数据流程图、程序流程图、系统流程图、程序网络图和系统资源图的文件编制符号及约定》中华人民共和国机械电子工业部

GB8566-88计算机软件开发规范

GB9385-88计算机软件需求说明编制指南

GB9386-88计算机软件测试文件编制规范

BG/T12504-90计算机软件质量保证计划规范

GB/T12505-90计算机软件配臵管理计划规范

二、系统框架结构

本系统采用三层架构设计,三层架构就是将整个业务应用划分为:表现层(UI)、业务逻辑层(BLL)、数据访问层(DAL)。区分层次的目的即为了“高内聚,低耦合”的思想。

1、表现层(UI):通俗讲就是展现给用户的界面,即用户在使用一个系统的时候他的所见所得。

2、业务逻辑层(BLL):针对具体问题的操作,也可以说是对数据层的操作,对数据业务逻辑处理。

3、数据访问层(DAL):该层所做事务直接操作数据库,针对数据的增添、删除、修改、更新、查找等。

3个层次中,系统主要功能和业务逻辑都在业务逻辑层进行处理。三层体系将业务规则、数据访问及合法性校验等工作放在中间层处理。客户端不直接与数据库交互,而是通过组件与中间层建立连接,再由中间层与数据库交互。中间层采用的是流行的Spring + Hibernate+Struts,为了将控制层与业务逻辑层分离,又细分为以下几种。 Web层:就是MVC模式里面的“C”(controller),负责控制业务逻辑层与表现层的交互,调用业务逻辑层,并将业务数据返回给表现层作组织表现,该系统的MVC框架采用Struts。

Service层(就是业务逻辑层):负责实现业务逻辑。业务逻辑层以DAO层为基础,通过对DAO组件的正面模式包装,完成系统所要求的业务逻辑。

DAO层:负责与持久化对象交互。该层封装了数据的增、删、查、改的操作。

  • 详细设计说明书

    详细设计说明书真正例子详细设计说明书1 引言1 1编写目的本详细设计说明书是针对网络信息体系结构的课程作业而编写。目的是对该项目进行详细设计,在概要设计的基础上进一步明确...




本文标题:详细设计说明书
本文地址:http://www.csmayi.cn/show/130296.html
声明:该文章系网友上传分享,此内容仅代表网友个人经验或观点,不代表本网站立场和观点;若未进行 原创声明,则表明该文章系转载自互联网;若该文章内容涉嫌侵权,请及时向蚂蚁网投诉!

推荐专题

热点推荐

相关推荐