系统概要设计说明书V10.docx

系统概要设计说明书V10.docx

《系统概要设计说明书V10.docx》由会员分享，可在线阅读，更多相关《系统概要设计说明书V10.docx（14页珍藏版）》请在冰豆网上搜索。

系统概要设计说明书V10

概要设计说明书（HLD）

版本【V1.0】

拟制

日期

审核

日期

批准

日期

修订历史记录

版本

日期

AMD

修订者

说明

V1.0

8.11

初步概要设计

（A-添加，M-修改，D-删除）

目录

1.文档介绍4

1.1.编写目的4

1.2.文档读者4

1.3.术语与缩略词5

1.4.参考文档5

2.系统上下文5

3.设计约束5

4.架构设计5

4.1.功能架构5

4.2.系统架构6

4.3.技术架构7

4.4.工程架构7

5.接口设计7

5.1.数据库接口7

5.1.1.描述7

5.1.2.实现技术7

5.1.3.输入7

5.1.4.处理8

5.1.5.输出8

5.2.…8

6.组件设计8

6.1.修改提示组件8

6.1.1.描述8

6.1.2.技术实现8

6.1.3.输入8

6.1.4.处理8

6.1.5.输出8

6.1.6.出错处理8

6.2.删除提示组件8

6.2.1.描述8

6.2.2.技术实现8

6.2.3.输入8

6.2.4.处理9

6.2.5.输出9

6.2.6.出错处理9

6.3.身份认证组件9

6.3.1.描述9

6.3.2.实现技术9

6.3.3.输入9

6.3.4.处理9

6.3.5.输出9

6.3.6.出错处理9

6.4.输入框空白提示组件9

6.4.1.描述9

6.4.2.技术实现9

6.4.3.输入10

6.4.4.处理10

6.4.5.输出10

6.4.6.出错处理10

6.5.经纬度转换组件10

6.5.1.描述10

6.5.2.技术实现10

6.5.3.输入10

6.5.4.处理10

6.5.5.输出10

6.5.6.出错处理10

6.6.界面等待组件10

6.6.1.描述10

6.6.2.技术实现10

6.6.3.输入10

6.6.4.处理10

6.6.5.输出11

6.6.6.出错处理11

7.模块设计11

7.1.模块111

7.1.1.概念模型11

7.1.2.数据流图12

7.1.3.状态图（可选）13

7.1.4.关键设计点14

7.1.5.出错处理14

7.2.模块214

7.3.……14

8.关键设计点14

1.文档介绍

1.1.编写目的

本文档通过详细阐述系统总体架构设计、内外部接口设计、系统公共组件设计、系统关键点设计等方面，试图达到以下目的：

1）作为详细设计人员进行详细设计的输入源，框定详细设计人员必须遵守的方向和原则，保障详细设计的一致性和整体性，从而保障详细设计质量；

2）作为设计评审人员进行概要设计评审的依据；

3）作为项目经理、代码编写人员，以及所有系统干系人员，了解概要设计的依据；

4）作为项目组内部工作交接而进行知识传递的主要材料。

1.2.文档读者

在阅读和使用本文档之前，建议读者先阅读项目对应的《系统需求规格说明书》，本文档的预期读者如下：

1）项目经理；

2）详细设计人员；

3）代码编写人员；

4）设计评审人员；

5）客户方技术负责人员。

1.3.术语与缩略词

【编写指引：

本文档阐述概要设计时，可能会涉及到业务和技术相关的术语和缩略词，考虑到文档读者范围的多样性和广泛性，有必要对这些术语和缩略词进行解释，以便读者更好的阅读和理解文档所阐述的内容】

术语、缩写词

解释

1.4.参考文档

文档名称

提供方

版本号

备注

《系统需求规格说明书》

项目组

v00.00.02

2.系统上下文

3.设计约束

设计约束

设计时应该考虑

用户通过影响数据库记录的相关界面对数据库表进行恶意操作。

采取数据操作与页面分离的编码手段（或者可以用LINQ等其他技术实现），防止用户的恶意注入。

系统数据库储存的数据记录量较大。

通过建立索引提高数据查找效率，从而减少系统由于储存数据量较大而引起的系统性能降低（例如：

反应时间较慢）的问题。

4.架构设计

4.1.功能架构

首先按照划分，可以把系统划分为站点管理、门匙管理、用户管理和登陆几个功能块。

接着分析这几个功能块的需求的共性：

需求分析需要所有的应用系统错误都应记录到系统日志文件中，每个功能块都需要有对应的日志记录，因此可以提供一个日志记录的公共模块。

4.2.系统架构

系统架构采用三层架构，分别为数据访问层、业务逻辑层和表示层。

并作为之后组件和模块设计的架构依据。

表示层主要显示UI界面，业务逻辑层主要存放与UI分离的业务数据操作。

因为需求中需要应用系统中所有数据统一保存到SQLServer数据库中，所以数据访问层必须使用SQL连接语句。

4.3.技术架构

表现层也即客户端层，使用Web浏览器。

表现层与业务逻辑层通过HTTPSOAP和HTTPHTML进行交互。

业务逻辑层即应用服务器层，使用C#、ASP.NET、HTML、CSS等技术和框架；ASP.NET通过ADO.NET与SQLServer数据库交互。

数据源层使用SQLServer数据库，并且根据用途和职责的不同，分为平台数据库和应用数据库。

4.4.工程架构

【编写指引：

功能架构和系统架构中，已经明确了业务组件、系统组件、功能模块或子系统的划分，那么系统工程结构则可以依据功能用途和职责区分，而划分为不同的工程来支撑。

各个工程各司其职，也便于后续的开发管理和部署管理。

】

例如：

5.接口设计

5.1.数据库接口

5.1.1.描述

用于业务操作与数据库之间的数据交互。

5.1.2.实现技术

数据库接口基于ADO.NET类库和C#面向对象的封装技术。

5.1.3.输入

序号

输入项

输入来源

描述

1

操作条件

应用系统

1．数据操作的数值范围。

（查询）

2．选择数据项目。

（删除、修改）

3．直接点击添加功能按钮。

（新增）

5.1.4.处理

采用ADO.NET中的SqlConnetion类和Command类实现与数据库的交互连接。

在接口中内嵌SQL语句实现数据库操作。

5.1.5.输出

用户的浏览器显示返回所选择操作的结果。

5.2.…

6.组件设计

6.1.修改提示组件

6.1.1.描述

修改提示为用户提供修改的缓冲提供接口，可以让用户确认是否修改操作。

6.1.2.技术实现

基于C#技术进行封装，以供外部使用。

6.1.3.输入

点击修改按钮。

6.1.4.处理

让用户选择是否修改，经确认后执行修改，否则返回。

6.1.5.输出

用户的浏览器显示修改成功提示信息或返回到更改后界面。

6.1.6.出错处理

略。

6.2.删除提示组件

6.2.1.描述

删除提示为防止用户误操作的缓冲提供接口，可以让用户确认是否删除操作。

6.2.2.技术实现

基于C#技术进行封装，以供外部使用。

6.2.3.输入

点击删除按钮。

6.2.4.处理

让用户选择是否删除，经确认后执行删除，否则返回。

6.2.5.输出

用户的浏览器显示删除成功提示信息或返回到操作前界面。

6.2.6.出错处理

略。

6.3.身份认证组件

6.3.1.描述

身份认证服务提供了让应用系统验证用户身份信息的服务接口，应用系统可以通过此服务完成用户身份认证过程，从而实现单点登录。

6.3.2.实现技术

身份认证服务使用基于FormPost请求实现用户身份信息验证。

应用系统通过FormPost的方式把需要验证身份的用户信息传递给IAS，IAS验证通过后通过URL的方式跳转回应用系统指定的地址。

6.3.3.输入

序号

输入项

输入来源

描述

1

用户身份信息

应用系统

2

认证参数信息

应用系统

包括认证成功后需要跳转的URL等参数

6.3.4.处理

IAS根据请求传递的帐号类型选择不同的用户身份信息验证技术：

本地帐号：

在安全信息数据库中验证用户帐号密码是否有效

Portal帐号：

依据广东省移动Portal提供的技术规范进行验证，详细请看相关规范文档

6.3.5.输出

用户的浏览器跳转到应用系统指定的URL。

6.3.6.出错处理

略。

6.4.输入框空白提示组件

6.4.1.描述

输入框空白提示为防止用户信息输入框留白提供接口，可以让用户确认是否漏填信息。

6.4.2.技术实现

基于C#技术进行封装，以供外部使用。

6.4.3.输入

空值。

6.4.4.处理

在用户输入的同时，检测用户是否漏填信息。

6.4.5.输出

当用户漏填信息，用户的浏览器显示输入框空白提示信息。

6.4.6.出错处理

略。

6.5.经纬度转换组件

6.5.1.描述

经纬度转换为用户提供转换经纬度录入方式的接口。

应用系统可以通过此服务完成经纬度录入方式的转换。

分别是度分秒方式和浮点数方式。

6.5.2.技术实现

基于C#技术进行封装，以供外部使用。

6.5.3.输入

输入项：

用户录入的站点经纬度。

6.5.4.处理

在用户录入后，系统换算出指定表示方式。

6.5.5.输出

用户浏览器输出指定方式。

6.5.6.出错处理

略。

6.6.界面等待组件

6.6.1.描述

通过loading友好表现形式反映用户请求已被接受并正在响应。

6.6.2.技术实现

6.6.3.输入

页面跳转请求

6.6.4.处理

响应请求并显示等待信息。

6.6.5.输出

弹出新的页面，出错处理

如网络不通或意外情况发生则显示出错信息，告知用户意外情况的发生，并作进一步处理。

6.6.6.出错处理

略。

7.模块设计

模块之间的总体关系

7.1.站点管理模块

7.1.1.概念模型

7.1.2.状态图（可选）

7.1.3.关键设计点

【编写指引：

对于模块具有全局影响的设计点，需要单独进行描述。

】

7.1.4.出错处理

【编写指引：

对于模块异常情况下，系统如何响应，处理机制如何，需要详细阐述。

】

7.2.门匙管理模块

7.2.1.概念模型

7.2.2.状态图（可选）

7.2.3.关键设计点

【编写指引：

对于模块具有全局影响的设计点，需要单独进行描述。

】

7.2.4.出错处理

【编写指引：

对于模块异常情况下，系统如何响应，处理机制如何，需要详细阐述。

】

7.3.用户管理模块

7.3.1.概念模型

7.3.2.状态图（可选）

7.3.3.关键设计点

【编写指引：

对于模块具有全局影响的设计点，需要单独进行描述。

】

7.3.4.出错处理

【编写指引：

对于模块异常情况下，系统如何响应，处理机制如何，需要详细阐述。

】

8.关键设计点

【编写指引：

关键设计点阐述对具有全局意义的功能性和非功能性需求设计。

根据关键点的不同，阐述的方式也会有所不同。

】