Beta——技术规格说明书

Beta——技术规格说明书

项目	内容
这个作业属于那个课程	2021春季学期软件工程（罗杰、任健）
这个作业的要求在哪里	团队项目-Beta阶段计划
更新日期	2021年5月21日
描述	接口及数据库的定义更新
更新人	LQ
版本号	1.1

一、技术栈

1.1 前端使用的编程语言及框架

前端所使用的编程语言为HTML, CSS和JavaScript语言。

前端框架使用Vue框架。

Vue框架的优点：

• 官方文档清晰，易于上手
• Vue.js通过简单的API提供高效的数据绑定和灵活的组件系统
• 数据双向绑定，即当数据发生变化的时候，视图也就发生变化，当视图发生变化的时候，数据也会跟着同步变化。尤其是在进行表单处理时，Vue的双向数据绑定非常方便

1.2 后端使用的编程语言及框架

后端所使用的编程语言为Python（主要因为有爬取数据的核心需求），开发环境为Python3.8。

后端框架使用flask框架。flask是基于Werkzeug工具箱编写的轻量级web开发框架，它主要面向需求简单，项目周期短的小应用。和Django不同，Flask轻巧、简洁，通过定制第三方扩展来实现具体功能，且支持noSQL等新型数据库。

1.3 数据库

数据库首选MySQL，版本为MySQL8.0.21

1.4 Web引擎

使用Nginx作为Web引擎

二、软件的总体架构

2.1 包含的子系统

• 前端

  • 主要功能包含
    • 向用户展示从后端获取的疫情感染以及疫苗接种数据。
    • 与用户进行交互，向用户动态提供其他信息。

• 后端

  • 主要功能包含
    • 向前端提供用户所需数据信息。
    • 与服务器端进行数据交换。

• 服务器端

  • 主要功能包含
    • 建立数据库，存储数据获取段所爬取的特定时间数据。
    • 与后端进行数据交换。

• 数据获取端

  • 主要功能包含
    • 应用爬虫，在特定时间爬取数据源网站公布的疫情感染及疫苗接种数据。

• UML图如下
  

2.2 各个子系统内部

• 前端：
  • 接收数据模块：负责接收后端发出的数据
  • 展示数据模块：向用户展示用户要查询的数据
  • 交互模块：对用户操作进行响应的模块。
• 后端：
  • 接收数据模块：接收来自数据库的数据
  • 处理数据模块：根据前端需要处理相应的数据
  • 发送数据模块：向前端发送其想要的数据
• 服务器端：
  • 数据库模块：数据库所在，存储信息
  • 发送数据模块：向后端发送数据
  • 接收数据模块：接收后端的需要存储的数据
• 数据获取端：
  • 爬虫模块：爬取自己想要的数据
  • 发送数据模块：向服务器端发送自己爬取的数据

• UML图如下

三、数据库和API接口设计

3.1 数据库设计

• 各国家/地区感染人数/感染率表（总览）

属性	类型	描述
time	DATE()	日期
areaName	VARCHAR(size)	国家/地区名称
currentNum	BIGINT(size)	现存确诊人数
totalNum	BIGINT(size)	累计确诊人数
addNum	INT(size)	新增确诊人数
cured	BIGINT(size)	累计治愈人数
totalDead	INT(size)	累计死亡人数
addDead	INT(size)	新增死亡人数
infRate	FLOAT(size,d)	感染率

• 各国家/地区接种人数/接种率表（总览）

属性	类型	描述
time	DATE()	日期
areaName	VARCHAR(size)	国家/地区名称
totalNum	BIGINT(size)	累计接种人数
addNum	INT(size)	新增接种人数
vacRate	FLOAT(size,d)	接种率

• 各国家/地区感染人数/感染率表（实时）：属性同上
• 各国家/地区接种人数/接种率表（实时）：属性同上
• 中国各地区感染情况（总览）
• 意见表

属性	类型	描述
time	DATE()	意见接受时间
text	String(800)	意见内容
point	INT	评分

• 地区关系映射表

属性	类型	描述
parentArea	String(100)	父区域姓名
childArea	String(100)	子区域姓名
population	BIGINT	子区域总人数

\(\beta\)阶段新增

• 疫情新闻咨询表

属性	类型	描述
time	String(20)	新闻时间
title	String(60)	新闻标题
urls	String(200)	新闻链接
source	String(50)	来源
abstracts	String(200)	新闻摘要
picUrls	String(200)	图片链接

• 疫苗新闻咨询表：属性同上

• 接种机构

属性	类型	描述
city	String(20)	城市名
name	String(100)	接种机构姓名
addr	String(100)	地址
tel	String(20)	联系电话

• 中高风险地区表

属性	类型	描述
province	String(20)	省份名
city	String(20)	城市名
childArea	String(20)	子区域名
level	Integer	风险等级，中风险为1，高风险为2
abstract	String(100)	具体街道等信息

3.2 接口设计

前端：

请求方法	请求路径	用途
GET	/news	请求新闻资讯列表
GET	/search/<region>/regionInfectDataMsg	请求某地区的搜索结果
GET	/search/<region>/regionVaccineDataMsg	请求某地区的接种机构列表
POST	/travelAdvice	请求某地区的出行建议

后端：

文件	名称	返回值	用途
newsDao.py	getInfNews(number)	List<InfNews>	用于返回感染情况相关的新闻资讯，并通过number参数控制返回的新闻条数
newsDao.py	getVacNews(number)	List<VacNews>	用于返回疫苗情况相关的新闻资讯，并通过number参数控制返回的新闻条数
vacInstitutions.py	getVacInstitutions(city)	List<vacInstitutions>	用于返回city对应的接种机构
travelAdvice.py	getRiskArea(*areas)	List<area>	用于返回area对应的中高风险地区
travelAdvice.py	getIfAddInf(region)	Lis<int>	用于返回region对应地区的近十四日新增的情况
travelAdvice.py	getPolicyIndex(region)	double	用于返回region对应地区的政策严格性指数

四、系统开发目标

4.1 需要完成哪些代码编写？

• 编写爬虫程序，爬取数据并处理
• 数据库设计的编码：根据爬取的数据设计数据库，建表并存储数据
• 后端编码：利用Flask框架搭建后台，根据展示条件和可视化要求查询数据、处理数据、转换数据格式、传输数据到前端。
• 前端web编码：设计平台web界面
• 前端可视化编码
• 云服务器部署编码

4.2 需要完成哪些单元测试？

对于编写的代码，均需要完成单元测试，一般是以函数或类为单位，尤其是对接口进行单元测试，具体可见接口设计部分

4.3 需要完成哪些系统压力测试？具体压力指标是多少？

目前认为需要对以下几个方面针对性做压力测试：

前端渲染速度、页面大小、数据库设计及访存速度、网站的最大并发量、响应时间、吞吐量等

模拟并发用户数，测试峰值并发数；

响应时间：90%用户的响应时间小于0.5秒

并发用户数（同时发出请求的用户数）：2000个用户

4.4 需要完成那些真实测试？具体测试细节是怎样的？

大量用户同时访问网站

短时间内存在大量请求

4.5 需要完成哪些系统文档的编写？需要详细到什么程度？

• 需求文档：详细明确的需求文档。对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的，也是实施开发工作的基础。该说明书应给出数据逻辑和数据采集的各项要求，为生成和维护系统数据文件做好准备。

• 概要设计文档：概要设计文档包括数据库概要设计文档和软件概要设计文档，粒度较粗，可以作为软工项目的中间产物。

• 详细设计文档：

  • 数据库设计文档： 本文档主要描述本系统包含多少个表，每个表的字段定义，表之间的约束关系。
  • 系统详细设计文档：本文档描述本系统包含那几个功能模块，每个模块包含哪几个类，类对象之间的调用关系，每个类的属性和方法定义。

• 部署文档：部署到服务器，运行环境等的详细文档

• 用户手册：本手册详细描述软件的功能、性能和用户界面，使用户对如何使用该软件得到具体的了解,为操作人员提供该软件各种运行情况的有关知识，特别是操作方法的具体细节。

• 测试分析报告：测试工作完成以后，应提交测试计划执行情况的说明，对测试结果加以分析，并提出测试的结论意见。

• 软件维护手册：主要包括软件系统说明、程序模块说明、操作环境、支持软件的说明、维护过程的说明，便于软件的维护。

• 软件问题报告：指出软件问题的登记情况，如日期、发现人、状态、问题所属模块等，为软件修改提供准备文档。

• 软件修改报告：软件产品投入运行以后，发现了需对其进行修正、更改等问题，应将存在的问题、修改的考虑以及修改的影响作出详细的描述，提交审批。