架构实战营第 4 期 -- 模块三作业
前言
本文是外包学生管理系统详细架构设计文档,用于指导外包学生管理系统后续的开发、测试和运维。
词汇表
Nginx:一个高性能 HTTP 和反向代理 web 服务器,同时提供了 IMAP/POP3/SMTP 服务。
SpringBoot : 约定大于配置的 spring 新生代软件框架,便于快速开发。
SpringCloud:基于 springboot 的较为成熟的开源微服务解决方案框架。
MyBatis : 较为流行数据持久层框架。
MySQL:一个流行的关系型数据库管理系统。
1. 业务背景
随着学校的规模的不断扩大,学生数量的增加,需要处理的信息也日趋增大,由此带来了几个明显的问题:
管理成本高:需要花费大量的教师资源;
处理效率低下:学生信息管理数据信息量大修改不方便,对一系列数据进行分析时花费时间长;
信息准确度:学生管理数据量大,大量手工式的处理很容易产生数据错误,对正常管理带来干扰;
基于以上背景,为提高学生管理的管理水平,优化资源,学校需要引入学生信息管理系统,实现学生信息关系的系统化、规范化、自动化,其主要任务是统计学生各类信息进行日常管理,如查询、修改、增加、删除、以及学生选课、成绩的查询等功能设计的管理系统。
2. 约束和限制
在机器宕机的时候允许丢失当时请求的数据,但是不允许丢失已经存储的数据;
不同用户的权限不同;
学校的学生数量不会发生大变化。
3. 总体架构
[必选,描述经过备选架构决策后定下来的架构方案,这一章主要是描述架构的 3R:Rank、Role、Relation]
[技巧:1. 系统边界白盒图描述系统内的角色与外界的交互(Rank + Role + 外部 Relation);2. 系统架构图来描述内部的 Role + 内部 Relation]
[注意:不建议一张图同时描述系统架构的 3R 以及与外界的交互,因为图太复杂,画系统边界白盒图的时候,系统内部的 Relation 可以不画]
3.1 架构分析
[可选,这部分主要是架构复杂度的分析,基本上从备选架构文档中提炼关键内容过来即可]
[样例:
3.1.1 高可用
对于微博子系统来说,如果消息丢了,导致没有审核,然后触犯了国家法律法规,则是非常严重的事情;对于等级子系统来说,如果用户达到相应等级后,系统没有给他奖品和专属服务,则 VIP 用户会很不满意,导致用户流失从而损失收入,虽然也比较关键,但没有审核子系统丢消息那么严重。
综合来看,消息队列需要高可用性,包括消息写入、消息存储、消息读取都需要保证高可用性。
]
[技巧:常见的复杂度都要覆盖到,即使分析后不涉及也要描述,避免评审的时候被人认为遗漏了关键点]
3.2 总体架构
[必选,描述总体架构设计]
[样例:此处省略架构图,文字描述样例:
1)采用数据分散集群的架构,集群中的服务器进行分组,每个分组存储一部分消息数据。
2)每个分组包含一台主 MySQL 和一台备 MySQL,分组内主备数据复制,分组间数据不同步。
3)正常情况下,分组内的主服务器对外提供消息写入和消息读取服务,备服务器不对外提供服务;主服务 4)器宕机的情况下,备服务器对外提供消息读取的服务。
5)客户端采取轮询的策略写入和读取消息。
]
[技巧:
1.用系统架构图来描述架构,如果是前端或者客户端,用前端架构图或客户端架构图来描述架构
2.基于架构图中的内容,使用文字描述 Role、Relation 的基本内容,文档目录可以自由调整
]
4. 详细设计
[必选,描述核心场景或者流程的实现机制]
4.1 核心功能
[必选,描述核心场景或者流程的实现机制,对应 4R 架构中的 Rule,每个核心场景一个小节]
[样例:
4.1.1 消息发送流程
4.1.2 消息消费流程
]
[技巧:使用系统序列图来描述 Rule,跟项目开发中写设计文档一样的写法]
4.2 关键设计
[必选,描述系统的一些关键设计点是如何实现和取舍的]
[样例(如果你有兴趣,可以对比一下 kafka 的文档:Kafka design):
1)消息发送可靠性
业务服务器中嵌入消息队列系统提供的 SDK,SDK 支持轮询发送消息,当某个分组的主服务器无法发送消息时,SDK 挑选下一个分组主服务器重发消息,依次尝试所有主服务器直到发送成功;如果全部主服务器都无法发送,SDK 可以缓存消息,也可以直接丢弃消息,具体策略可以在启动 SDK 的时候通过配置指定。
如果 SDK 缓存了一些消息未发送,此时恰好业务服务器又重启,则所有缓存的消息将永久丢失,这种情况 SDK 不做处理,业务方需要针对某些非常关键的消息自己实现永久存储的功能。
2)消息存储可靠性
消息存储在 MySQL 中,每个分组有一主一备两台 MySQL 服务器,MySQL 服务器之间复制消息以保证消息存储高可用。如果主备间出现复制延迟,恰好此时 MySQL 主服务器宕机导致数据无法恢复,则部分消息会永久丢失,这种情况不做针对性设计,DBA 需要对主备间的复制延迟进行监控,当复制延迟超过 30 秒的时候需要及时告警并进行处理。
3)消息如何存储
每个消息队列对应一个 MySQL 表,消息队列名就是表名,表结构设计为……(此处请自行补充)
]
[技巧:常见的关键设计点包括高性能、高可用、可扩展、安全等]
4.3 设计规范
[必选,描述 Role 和 Relation 相关的开发框架、连接协议、数据包格式等]
[样例:
1)消息队列服务器使用 Spring Boot + Netty 开发
2)MySQL 使用 Innodb 存储引擎
3)TCP 包的结构设计……(此处省略,请自行补充)
]
[技巧:如果某个规范涉及内容比较多,请独立章节描述,例如数据包格式定义]
5. 质量设计
[必选,描述和质量相关的设计,包括:可测试性、可维护性、可观测性、成本等设计]
[样例:
5.1 消息队列管理后台
5.2 成本
]
[技巧:如果某个维度不涉及,也请在文档中说明,避免评审的时候被认为考虑不周全]
6. 演进规划
[必选,可以是演进规划,也可以是项目计划,需要描述每个里程碑或者版本具体要实现的能力]
[样例:
6.1 消息队列一期
6.2 消息队列二期
]
[技巧:开发阶段快速迭代,小步快跑,但要基本完善后才能正式推出给其他人用]
评论