架构文档之《系统设计说明书》

文件编码
文件状态
当前版本
拟定		时间
审核		时间
批准		时间

一、引言

1.1、编写目的

项目名称：基于互联网大数据的事件智能抓取和画像系统
项目成员：张三、李四、王五

对基于互联网大数据的事件智能抓取和画像系统进行算法描述和软件设计说明。

1.2、背景

项目背景：随着互联网大数据的发展，各种大数据的分析对各行业都产生了不同程度的影响。网站数据、社交媒体数据等是互联网大数据的重要组成部分。对于民航业领域，社会事件的发生，会很大程度影响旅客的出行需求变化，从而影响航空公司飞机运力投放、航班编排、票价策略调整等，对互联网事件的准确抓取和分析能够帮助航空公司更好的服务市场、服务旅客、提升收益。

行业背景：对于航空公司来说，能否预先判断旅客的出行需求，可用于航空公司及行业管理部门决定行业运力投放的合理性，从而提高旅客服务水平、提高航空公司航班收益水平，从互联网中获取大量的影响民航领域的信息能够帮助航空公司制定销售策略。

1.3、项目概要

开发团队：*******有限公司

项目开发平台说明：

操作系统：Windows11及以上版本

应用服务器：Ubuntu Server 16.04 LTS 64位

服务器配置：CUP： 8核 内存：16GB 公网带宽：2048Mbps 硬盘：500G

应用服务器：LINUX

服务器配置：CUP：8核 内存：16GB 公网带宽：2048Mbps 硬盘：1T

网络架构：完全支持TCP/IP协议

开发工具或技术体系：开发语言：Python 3.6，开发工具：Pycharm 2021

数据库： MongoDB 3.4.3、mysql

软件运行环境说明：为了什么实现最后要到达什么目的

1.4、术语与缩写解释

术语解释和简单缩写的定义说明

1.5、参考材料

二、概述

2.1、系统任务

2.1.1、系统目标

说明本系统要实现的目标

2.1.2、运行环境

说明本系统运行环境的规定，包含所需的硬件设备和支持的软件

2.1.3、与其他系统关系

当前系统是某一软件产品的一部分，或者与其他系统有密切关联时，说明相互间对的关系

2.2、需求规定

2.2.1、功能需求

说明功能中主要输出和输入以及功能要求

2.2.2、非功能性需求

2.2.3、约束与假定

描述系统设计中最主要的约束，这些是由客户强制要求并在需求说明说写明的。说明系统如何来适应这些约束的，另外如果本系统跟其他外部系统交互或者依赖其他外部系统提供一些功能辅助，那么系统可能还受到其他的约束。这种情况下，要求清楚地描述与本系统由交互的软件类型以及这样导致的约束   

三、总体设计

3.1、基本设计概念和处理流程

说明本系统的基本设计概念和处理流程，尽量使用图标的形式展示

3.2、软件系统结构

用一览表及框图的形式说明本系统的系统元素（各层模块、子程序、公用程序等）的划分，简要说明每个系统元素的标识符和功能，分层次地给出各元素之间的控制欲被控制关系

3.2.1、模块1

3.2.2、模块2

3.3、功能需求与系统模块的关系

	系统模块1	系统模块2	。。。。	系统模块N
功能需求1
功能需求2
.。。。
功能需求N

3.4、子程序与功能需求、系统模块间关系

程序标识	需求标识	模块标识
程序1
程序N

3.5、接口设计

3.5.1、用户接口

说明将向用户提供的命令和他们的语法结构，以及软件的回答信息

3.5.2、外部接口

说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持软件之间的接口关系

3.5.3、内部接口

说明本系统内的各个系统元素之间的接口的安排

3.6、数据结构设计

3.6.1、逻辑结构设计要点

本系统所使用的每个数据结构的名称、标识符以及它们之间每个数据项、记录、文卷和系的标识、定义、长度及他们之间的层次的或表格的相互关系。

3.6.2、物理结构设计要点

给出本系统内所使用的每个数据结构中的每个数据项的存储要求，访问方法、存取单位、存取的物理关系（索引、设备、存储区域）、设计考虑和保密条件

3.6.3、数据结构与程序的关系

说明各个数据与程序的关系，采用一下图像是进行说明

四、子程序设计

4.1、程序1设计说明

从这开始要逐个给出各个层次中的每个程序的设计考虑。一下诶出的提纲是针对一般情况的。对于一个具体的模块，尤其是层次比较低的模块子程序，其很多条目的内容往往与他所隶属的上一层没模块的对应条目相同

4.1.1、程序描述

给出程序简要描述，主要说明安排设计本程序的目的意义，说明本程序的特点

4.1.2、功能

说明给程序应具备的功能可采用IPO图（输入-处理-输入图）的形式

4.1.3、性能

活命对陈固的全部性能要求，包括对精度、灵活性和时间特性的要求

4.1.4、输入项

给出对每个输入项的特性、包括名称、标识、数据的类型、格式、数据的有效范围、输入的方式。数量的频度、输入媒体、输入数据的来源和安全保密条件等

4.1.5、输出项

给出对每个输出项的特性、包括名称、标识、数据的类型、格式、数据的有效范围、输入的方式。数量的频度、输入媒体、输入数据的来源和安全保密条件等

4.1.6、算法

详细说明本程序所选用的算法，写出具体的计算公式和计算步骤。

4.1.7、流程逻辑

用图标说明表示程序流程，如果涉及界面把界面画出来

4.1.8、接口

用图的形式说明程序所隶属的上一层模块及隶属于本程序的下一层模块、子程序，说明参数复制和调用方式，说明与本程序直接关联的数据结构

4.1.9、存储分配

根据需要，说明本程序的存储分配

4.1.10、注释设计

说明程序段落注释如加载模块收不的注释、加载各分支点处的注释，对各变量的功能、范围、缺省条件、对所使用的逻辑所加的注释等。

4.1.11、限制条件

说明本程序运行所受到的限制条件

4.1.12、尚未解决的问题

说明本程序在设计中尚未解决而设计者认为在软件完成之前应解决的问题。

4.2、程序2设计说明

如：4.1

五、运行设计

5.1、运行模块组合

说明对系统施加不同的外界运行控制时所引起的各种不同的运行模块组合，说明每种运行所经历的内部模块和支持软件。

5.2、运行控制

说明每一种外界的运行控制的方式方法和操作步骤

5.3、运行时间

说明每种运行模块组合将占用各种资源的时间

六、系统出错处理设计

6.1、错误日志记录

当系统遇到错误时，及时记录错误信息非常重要。这样可以帮助我们追踪错误的原因并分析出错的模式。在设计策略时，我们应该确保系统能够记录关键错误信息，例如错误代码、错误描述、时间戳、等。同时为了方便查询和分析，我们可以采用合理的日志管理工具并说明。

6.2、异常处理机制

系统中的异常是导致错误发生的一种常见情况，为了有效应对异常，我们可以设计异常处理机制，应遵循统一异常处理原则，及准确报告异常、适当处理异常和有效恢复系统运行。

6.3、故障转移

当系统遭遇严重的错误或故障时，我们需要能快速地惊醒故障转移，使系统能够继续运行。为了实现故障转移，我们可以使用备用服务器或其他冗余设备来接管主服务器的任务，同时需制定相应的监控机制，以便检测到主服务器是否发生故障并触发故障转移。

6.4、用户友好提示

定义错误信息的规范，应包含明确的信息，原因以及解决的方案

七、系统维护设计

7.1、硬件维护

硬件维护是对系统硬件组件进行检测、维修和更换的过程，一确保系统正常的运行。硬件维护包括对服务器、存储设备、网络设备、终端设备等硬件设备的维护，以及对电源、冷却、机房的维护

7.2、软件维护

软件维护是对系统软件进行更新、修改和完善的过程，以确保系统软件正常运行并满足业务需求。软件维护包括对操作系统、数据库、中间件、应用程序等软件的维护，以及对软件性能、安全性和稳定性的优化

7.3、数据备份

数据备份是对系统数据进行复制、存储和保护的过程，以防止数据丢失或损坏。数据备份包括对关键数据，业务数据和配置数据的备份，以及对备份数据的存储和管理。

7.4、安全防护

安全防护是对系统进行安全管理和防护的过程，以防止未经授权的访问、攻击和破坏。安全防护包括对网络入口、系统入口、数据传输等环节的监控和防御，以及对用户身份认证、访问权限和日志记录管理

7.5、用户支持