后端的技术设计文档

一、 背景

1.简介

2.业务规划(非必需)

3.工作项拆解

拆解成多个工作项,每个工作项,需要多少人力。

4.资源评估(非必需)

有没有新的服务

二、架构设计

1.架构图(非必需,新服务比较需要)

2.技术选型

SpringCloud、Redis、Mysql、Mybatis

3.幂等设计(非必需)

4.数据迁移方案(历史数据的处理)

业务涉及数据迁移,数据批量变更等场景需要填写此项。

5.性能评估(非必需)

对于并发量和数据量较大的业务场景,需要考虑性能瓶颈。

三、时序流程图

**1.时序图 **

可以是系统维度,也可以是后台服务维度。

2.业务流程图(如果有时序图,也可以不用业务流程图)

业务流程图,偏向展示整体业务走向;设计时需要标明相较于上个版本的改动点,方便测试同学进行回归测试,避免遗漏。

3.状态机

展示状态机的流转。设计时需要标明相较于上个版本的改动点。

四、接口设计

1.接口清单及描述

五、数据存储设计

1.数据库表关联图

ER关系图,实体对象关系图。

2.表设计(存在变更时必填)

Mysql表结构设计,索引设计,SQL语句等;

如果预期表数据会超过2000w以上的要考虑分表方案。

3.缓存设计

对复杂的缓存设计,或者涉及内存缓存的,需要标明。

六、配置信息

当程序配置有新增点或者改动点时需要填写。

1.程序配置(存在配置变更时必填)

2.动态配置(存在配置变更时必填)

3.监控告警(核心业务最好有监控告警)

通过监控街区,先于用户发现问题,减少线上故障。

七、关联方信息

1.第三方设计文档

填写第三方设计文档地址,方便后续回溯。

八、灰度方案(非必需)

1.灰度方案

灰度方案和进行灰度测试时需要的数据

2.灰度配置

进行灰度测试时需要做哪些配置,配置流程

九、检查项(必填)

判断是否存在以下检查项

检查项检查内容
方案评审是否需要进行方案评审,大版本需要进行方案评审
敏感数据检查是否涉及用户敏感数据
SQL注入检查是否存在SQL注入漏洞
越权漏洞检查是否有越权安全漏洞
依赖检查发布前是否依赖第三方发布顺序,若有需在检查项表下标明依赖方
服务配置是否有生产环境配置项需要配置,如有请在配置信息一项标明
环境配置是否有新接入redis、mongodb、mysql、es等环境配置项
定时任务检查是否需要新建定时任务
数据库检查是否需要创建库和表,是否需要执行SQL语句
灰度是否需要进行灰度测试
接口压测是否有接口需要压测
白名单配置是否有第三方IP需要开白
编码检查是否需要进行codereview、编码规约

十、其它文档

1.产品需求文档

2.测试用例

填写自测文档、贴测试用例链接。

3.开发压测方案(非必需)

开发提供压测方案,方便测试压测使用。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/673879.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

SSL与TLS--一起学习技术干货之网络协议

一、定义 1、SSL协议(Secure Sockets Layer Protocol):是一种安全协议,用于对网络通信提供安全保障。它最初由网景公司开发,现在由IETF维护标准。通过在应用层和传输层之间建立安全连接,SSL协议保护了数据…

优化 IT 支出和消除浪费的 8 种主要方法

不懈追求最佳 IT 支出对于任何组织的长期可持续发展和成功都至关重要。在这个技术快速进步的时代,您必须做出明智的决策,消除浪费,同时最大限度地提高技术投资的价值。 从进行 IT 成本分析到采用敏捷预算和技术标准化,这些策略对…

双非本科准备秋招(19.1)—— Synchronized优化

轻量级锁 流程 一个对象虽然有多线程加锁,但是加锁时间是错开的,那么可以用轻量级锁优化。 语法还是synchronized,只是对使用者是透明的。 static final Object obj new Object(); public static void method1() {synchronized( obj ) {//…

代码随想录算法训练营第二十五天|216.组合总和III、17.电话号码的字母组合

回溯算法之组合问题&#xff1a; 216.组合总和III class Solution { public:vector<vector<int>> result;vector<int> path;void backtracking(int k,int n,int t,int sum){if(path.size()k){if(sumn)result.push_back(path);return;}for(int it;i<9;i)…

(力扣)1314.矩阵区域和

给你一个 m x n 的矩阵 mat 和一个整数 k &#xff0c;请你返回一个矩阵 answer &#xff0c;其中每个 answer[i][j] 是所有满足下述条件的元素 mat[r][c] 的和&#xff1a; i - k < r < i k, j - k < c < j k 且(r, c) 在矩阵内。 示例 1&#xff1a; 输入&a…

【Godot4.2】文件系统自定义控件 - FileSystemTree

FileSystemTree B站【Godot4.2】文件系统自定义节点 - FileSystemTree 概述 在Godot设计编辑器插件或应用程序时&#xff0c;可能需要涉及文件系统的显示&#xff0c;比如文件夹或文件的树形列表。 我们可以用Godot的Tree控件快速书写相应的功能&#xff0c;但是为了复用到…

深入理解拓扑排序:从基础到应用

深入理解拓扑排序&#xff1a;从基础到应用 I. 引言 A. 拓扑排序的定义与背景 拓扑排序是图论中一项重要的算法&#xff0c;主要用于处理有向图中节点之间的依赖关系。这个概念源于日常生活中的任务排序需求&#xff0c;例如在工程项目中&#xff0c;不同任务之间存在先后顺…

Wireshark不显示Thrift协议

使用Wireshark对thrift协议进行抓包&#xff0c;但是只显示了传输层的tcp协议&#xff1a; "右键" -> "Decode As" 选择thrift的tcp端口 将“当前”修改为Thrift&#xff0c;然后点击“确定” 设置后&#xff0c;可以发现Wireshark里面显示的协议从Tcp变…

H12-821_74

74.在某路由器上查看LSP&#xff0c;看到如下结果&#xff1a; A.发送目标地址为3.3.3.3的数据包时&#xff0c;打上标签1026&#xff0c;然后发送。 B.发送目标地址为4.4.4.4的数据包时&#xff0c;不打标签直接发送。 C.当路由器收到标签为1024的数据包&#xff0c;将把标签…

低代码平台项目化私有化部署问题总结

现阶段&#xff0c;低代码平台基本上是两个方向&#xff0c;一个是在原有的SaaS平台的基础上&#xff0c;抽象出来一个aPaaS&#xff08;比如&#xff0c;销售易、北森&#xff09;&#xff0c;另一个方向是纯低代码平台&#xff0c;没有业务&#xff08;比如&#xff0c;奥哲、…

gorm day2

gorm day2 连接到数据库创建记录 连接到数据库 gorm官方支持的数据库类型有&#xff1a;MySQL&#xff0c;postgresql&#xff0c;Sqlite&#xff0c;sql server Mysql import ("gorm.io/driver/mysql""gorm.io/gorm" )func main() {// 参考 https://g…

波纹扩散效果

<!DOCTYPE html> <html lang"en"><head><meta charset"UTF-8" /><meta name"viewport" content"widthdevice-width, initial-scale1.0" /><title>波纹扩散</title><style>body {disp…

『运维备忘录』之 Kubernetes(K8S) 常用命令速查

一、简介 kubernetes&#xff0c;简称K8s&#xff0c;是用8代替名字中间的8个字符“ubernete”而成的缩写&#xff0c;是一个开源的&#xff0c;用于管理云平台中多个主机上的容器化的应用。kubernetes是基于容器技术的分布式架构解决方案&#xff0c;具有完备的集群管理能力&a…

HTTP状态码知道哪些

100 Continue 继续&#xff0c;一般在发送post请求时&#xff0c;已发送了http header之后服务端将返回此信息&#xff0c;表示确认&#xff0c;之后发送具体参数信息 200 OK 正常返回信息 201 Created 请求成功并且服务器创建了新的资源 202 Accepted 服务器已接受请求&#x…

51单片机基础(C语言):定时器时钟

1.使用定时器 1 和LCD1602设计一个简易数字时钟。 main.c #include <REGX52.H> #include "Delay.h" #include "LCD1602.h" #include "Timer0.h"unsigned char Sec55,Min59,Hour23;void main() {LCD_Init();Timer0Init();LCD_ShowString(…

mysql入门到精通005-基础篇-约束

1、概述 1.1 概念 约束是作用于表中字段上的规则&#xff0c;用于限制储存在表中的数据。 1.2 目的 保证数据库中数据的正确性、有效性和完整性。 1.3 常见的约束分类 一旦谈到外键&#xff0c;则至少涉及2张表约束是作用于表中字段上的&#xff0c;可以在创建表/修改表的…

CTFshow web(命令执行29-36)

?ceval($_GET[shy]);&shypassthru(cat flag.php); #逃逸过滤 ?cinclude%09$_GET[shy]?>&shyphp://filter/readconvert.base64-encode/resourceflag.php #文件包含 ?cinclude%0a$_GET[cmd]?>&cmdphp://filter/readconvert.base64-encode/…

2. Maven 继承与聚合

目录 2. 2.1 继承 2.2继承关系 2.2.1 思路分析 2.2.2 实现 2.1.2 版本锁定 2.1.2.1 场景 2.1.2.2 介绍 2.1.2.3 实现 2.1.2.4 属性配置 2.2 聚合 2.2.1 介绍 2.2.2 实现 2.3 继承与聚合对比 maven1&#xff1a;分模块设计开发 2. 在项目分模块开发之后啊&#x…

Lua迭代器以及各种源函数的实现

范型for 范型for的格式如下所示&#xff1a; for <var-list> in <exp-list> do<body> end var-list指变量名列表&#xff0c;可以为多个&#xff0c;exp-list指表达式列表&#xff0c;通常情况下只有一个值。可以更具体地写为另一种形式&#xff1a; fo…

TCP和UDP相关问题(重点)(3)——3.HTTP基于TCP还是UDP?

HTTP/3.0 之前是基于 TCP 协议的&#xff0c;而 HTTP/3.0 将弃用 TCP&#xff0c;改用 基于 UDP 的 QUIC 协议 。具体见HTTP相关问题-CSDN博客