软件概要设计说明书范例

软件概要设计说明书范例XX概要设计说明书

拟制日期：某某某日期

审核日期：

批准日期：

文档修改记录：

修改日期。版本/状态。修改章节。修改描述2017-10-17.初版发布

填写说明：

1.系统结构的定义

本体系对整个软件系统按如下结构方式进行划分：

系统 -。子系统 -。模块/子模块

其中：

1）系统层次在本说明书中予以描述。

2）子系统层次在系统设计说明书中予以描述。

3）模块/子模块层次划分属于详细设计，在详细设计说明书中予以描述。

如果系统相对简单，可以省略“子系统”这一层次。

2.如果填写了系统设计说明书，则在本说明书中略过“系统划分”的相关内容（即第2章）。

3.如果系统相对简单，不需要做“系统子系统”划分，这种情况下，取消填写系统设计说明书，只须填写本说明书，直接

套用“系统模块”划分（即第3章）进行“系统模块”划分（把其中“子系统”一词替换为“系统”），并删除本说明书中“系统子系统”划分的相关内容（第2章）。

目录：

1.简介

1.1 背景和目的

1.2 范围

1.3 术语和缩略语

2.系统总体设计

2.1 任务概述

2.2 目标

2.3 需求概述

2.4 设计概述

2.5 总体约束

1.简介

1.1 背景和目的

本文档的目的是说明软件系统的设计考虑，包括基本处理流程、组织结构、模块划分、功能分配、接口设计、运行设计、数据结构设计和出错处理设计等，为软件的详细设计奠定基础。

1.2 范围

本文档适用于消息推送项目二期产品的服务端。

1.3 术语和缩略语

缩略语英文全名中文解释

XMPP XXX 可扩展通讯和表示协议

2.系统总体设计

本章节省略。

3.功能需求的实现方案

本节描述了系统的功能需求及其实现方案。详细内容请参见《消息推送系统需求规格说明书》。

4.非功能性需求的实现方案

本节描述了系统的非功能性需求及其实现方案。

4.1 性能的考虑

系统应能够支持每秒钟至少处理1000个并发请求。

4.2 兼容性的考虑

系统应当兼容主流的操作系统和浏览器。

4.3 安全的考虑

系统应当具有用户认证、权限控制、数据加密等安全机制。

4.4 可移植性的考虑

系统应当具有良好的可移植性，能够在不同的平台上运行。

4.5 集成与测试的考虑

系统应当具有良好的集成性和可测试性，能够与其他系统进行无缝集成和测试。

4.6 可扩展性的考虑

系统应当具有良好的可扩展性，能够方便地添加新的功能和模块。

4.7 可靠性的考虑

系统应当具有良好的可靠性，能够保证数据的完整性和系统的稳定性。

4.8 可维护性的考虑

系统应当具有良好的可维护性，能够方便地进行系统维护和升级。

5.难点及解决方案

本节描述了系统设计中的难点及其解决方案。

6.参考资料

本节列出了系统设计中所参考的资料。

7.附录

本节省略。

任务概述：

本文旨在设计一个即时通讯和消息推送的解决方案。具体来说，包括系统整体框架的逻辑结构和物理结构、子系统的划分和依赖关系定义、子系统之间的接口定义以及子系统功能定义。

2.1 目标和需求概述

本项目的目标是实现即时通讯和消息推送的功能。需求细节请参考“软件需求规格说明书”。

2.2 设计方案概述

我们的设计方案包括两个部分：

1.云端服务端系统：使用Spring、Mina和JGroups建立一

个分布式的服务端系统，以XMPP协议提供接口。

2.终端客户端：使用Smack建立一个XMPP协议的客户端，调用协议接口实现消息接收和终端展示。

2.3 系统架构设计

2.3.1 系统逻辑架构设计

我们将系统逻辑架构分为六层结构：负载均衡层、接入层、逻辑处理层、数据访问层、数据层和WEB层。

1.负载均衡层：TV终端通过域名访问云端，DNS智能解

析终端的IP地址让它连接就近的分发服务器，从分发服务器

获取接入服务器列表，然后断开XMPP连接。

2.接入层：TV终端和接入服务器建立XMPP长连接，创

建会话。

3.逻辑处理层：包括终端协议服务器、推送服务器（RS）和统计服务器。

a) 终端协议服务器：终端往接入服务器发送协议包，接入服务器转发给终端协议服务器处理。

b) 推送服务器：负责从MQ取出消息、解析消息（条件体和消息体）、终端在线和离线查询、按各接入服务器有哪些终端登录把消息包分发给接入服务器。

c) 统计服务器：运用Quartz执行定时任务，实现终端每天在线数、终端每小时在线数、终端每天激活数、终端登录次数、消息推送结果等统计功能。

4.数据访问层：提供数据访问组件，如MySQL JDBC接口、Jedis缓存接口。提供第三方推送接口，供第三方云端调用的API，提供单点推送（明消息/暗消息）、条件（区域+机型）推送、RegID推送。

5.数据层：Mongodb集群、MySQL数据库（主从+读写分离）、ActiveMQ消息队列、Redis缓存服务器。

6.WEB层：运营平台、第三方推送平台。

2.3.2 系统物理架构设计

需要整理。

2.4 子系统定义

2.4.1 子系统列表

子系统名称子系统编号（标识）功能描述开发方式

运营平台子系统 1 提供管理平台，用于管理系统用户和消息推送等功能。Web开发

第三方推送子系统 2 提供API，供第三方云端调用。Java 开发

终端客户端子系统 3 提供终端客户端，用于消息接收和终端展示。Android开发

统计子系统 4 提供统计功能，如终端每天在线数、终端每小时在线数、终端每天激活数、终端登录次数、消息推送结果等。Java开发

数据访问子系统 5 提供数据访问组件，如MySQL JDBC 接口、Jedis缓存接口。Java开发

推送服务器子系统 6 负责从MQ取出消息、解析消息（条件体和消息体）、终端在线和离线查询、按各接入服务器有哪些终端登录把消息包分发给接入服务器。Java开发

以上是我们的子系统列表，每个子系统都有不同的功能和开发方式。

Our system is designed for use by super administrators and operators。It is self-developed and provides third-party management。basic data management。message management。n and maintenance。statistics。system settings。and log query ns。We also offer APIs for third-party cloud services。including push ns (both visible and invisible)。nal and device-specific push ns。XXX。

XXX account and a third-party push platform system that allows for n management。message publishing。and message result querying。Our cloud-based logical server retrieves messages from MQ。parses them based on ns。and distributes them to access servers based on which terminals are online or offline。

Our system also features a background task subsystem。

which XXX such as daily online user counts。hourly online user counts。daily terminal ns。terminal login counts。and message push results。

For message box terminals。we provide cloud-based interfaces that use XMPP protocol to communicate with terminals。including distributing server lists。obtaining unique identifiers for TV terminals。identifying user IDs。logging in with user IDs。establishing ns and long ns。pushing messages。receiving feedback on message n and clicks。XXX。

XXX to build a cluster in the cloud to manage us logical servers。XXX members。feedback on member status。and maintenance of member lists。

Note: Development methods can be selected from procurement。outsourcing。self-development。and reuse。

Subsystem nships:

We clearly define the XXX subsystems。interfaces (messages。data structures) een subsystems。and the collaborative work een subsystems using structural diagrams。(interactive) n diagrams。message sequence diagrams。and ER diagrams。

Subsystem 1 Design:

We define the subsystem number and name in the title and divide it into modules。The purpose is to design the overall

framework of the subsystem。including its logical structure。module n and dependency ns。and module n ns。

XXX Overview:

We may include a n of the design goals and scope。as well as an overview of the requirements。

Design Overview:

XXX constraints。including development standards。if applicable.

1.编码约定规定了代码体系、模块之间的接口和命名规则。这个约定非常重要，因为它可以确保代码的一致性和可读性。如果没有一个良好的编码约定，代码会变得混乱且难以理解。

2.文件约定规定了子系统的所有配置、日志等文件命名方

式与格式。这个约定可以确保文件的一致性和易于管理。如果没有一个良好的文件约定，文件会变得混乱且难以维护。

3.目录约定规定了子系统的目录结构，包括运行目录、源

文件目录、配置目录、日志目录、数据目录等。这个约定可以确保目录的一致性和易于管理。如果没有一个良好的目录约定，目录会变得混乱且难以维护。

3.2.1.2.约束

这一部分列出了对软件设计有重要影响的系统内外部约束和限制，包括用户环境、内存或其它资源限制、数据存储和分发需求、安全和可靠性需求、性能需求、测试和可维护性需求。

3.2.2.子系统外部接口

这一部分描述了该软件子系统与外部实体的接口，包括用户界面、软件接口、硬件接口和通信接口。外部实体包括操作系统、驱动程序、硬件、中断、其它软件子系统等。详细描述子系统外部接口的参数，如接口名称、调用方式、传输的数据、频度、数据同步机制、平台无关性、遵循的标准、提供的功能、前置条件和后置条件等。

3.2.3.设计方案概述

这一部分描述了整个设计所采用的方法、采用的系统架构、使用的相应技术和工具、采用的框架技术的形式、使用的设计模式、资源/内存分配、Flash资源/文件分配以及哪些模块采用软件复用等。

3.3.子系统架构设计

这一部分定义了子系统的总体逻辑结构，定义模块划分以及模块之间的依赖关系。可以采用分层结构描述如何将子系统分解为模块。结构描述可以使用结构图、层次分解图、数据流图，并用文字说明相互间的关系。

3.4.模块定义

这一部分列出了模块列表。

模块名称（标识）：模块间关系

功能简述：明确模块之间的调用关系、模块间的接口（消息、数据结构）以及相关模块之间的协同工作，如模块间时序图，协作图，以及系统之间状态切换流程图。

模块描述：

模块1（编号1）

1）功能描述：该模块实现了什么基本功能以及每个功能

之间的相互关系。

2）性能描述：描述对模块的性能要求，包括精度、时间

特性和处理速度。

3）接口描述：描述与其它模块的接口，与其它系统或硬

件的接口。对于接口函数，需要明确输入项、输出项和返回值。

4）配置描述：可选，描述该模块所处的逻辑位置、物理

位置，如指明模块放在哪个应用服务器或客户端的哪个目录、哪个文件（库），或是在数据库内部建立的对象。

模块2（编号2）

非功能性需求的实现方案：

6.1.性能的考虑：为满足延时、吞吐量等性能，在既定硬

件环境约束下所采取的设计方案。

6.2.兼容性的考虑：对以前版本的兼容，以及平滑升级的

考虑。

6.3.安全的考虑：作为应用软件，在安全方面更多的是考

虑访问控制，包括使用什么样的权限管理、分配、验证方案。

6.4.可移植性的考虑：系统如果有跨平台的需求，要考虑

操作系统、中间件、应用服务器特性、数据库及第三方服务移植。描述如何在不同的平台移植，是否为可配置的。

6.5.集成与测试的考虑：描述如何进行模块的集成和测试。

本文旨在讨论软件产品概要设计报告的一些要点。

6.6 可扩展性的考虑

在设计软件系统时，不仅要考虑系统功能的扩展，还要考虑系统的性能扩展，即可伸缩性。在考虑可扩展性时，需要思考以下两个问题：

1.如何以最低成本添加新的功能？

2.如何以最低成本复制一个新系统，并且使新旧系统可以做成统一体？

6.7 可靠性的考虑

在设计软件系统时，需要考虑故障检测、故障隔离、故障恢复、容错、冗余和备份等方面的设计。这些都是提高系统可靠性的重要因素。

6.8 可维护性的考虑

在设计软件系统时，需要考虑以下几个方面：

1.系统模块是否可以装配？