【 技术栈】技术方案到底怎么写?

文章目录

  • 一、背景
  • 二、技术方案重要性
  • 三、常见的技术方案有哪些内容
    • 1、系统用例
    • 2、功能整体链路
      • 2.1、核心业务流程
    • 3、数据库设计
    • 4、接口设计
    • 5、非功能设计
      • 5.1、性能与稳定性
      • 5.2、监控
    • 7、系统风险点评估
  • 四、总结

一、背景

工作中,有一些需求或者技术改造,老板总是会要我写出一个技术方案先和他对一对,作为程序员,我相信大家工作中也经常要出技术方案,技术方案有没有一些套路呢,根据多年来的经验,其实是有的,本文就把平时写技术方案的套路总结出来,有需要的同学可以花几分钟时间看下。

二、技术方案重要性

开发人员写代码前,系统设计是不可少的,特别是涉及到新功能或者比较大的系统变更,一般都需要技术方案,技术方案是整个项目相关人员都需要了解的,比如系统关联方,前端,测试,产品和其他维护人员,有时候我们的老板也希望能看到我们的技术方案,通过技术方案,更好体现工作量和系统涉及到风险点,还能给项目相关方都看看方案是否合理。还有我们做开发久了会发现,如果一个功能想清楚怎么做了再去落地写代码,写代码的效率会更高。

本文将结合作者多年工作实际经验和具体案例,对技术方案怎么写来做一次总结,如果你不知道怎么写技术方案,可以先收藏起来备用。大家可以在评论区分享如何写一份比较好的技术方案。

三、常见的技术方案有哪些内容

1、系统用例

这部分能最简单的反映系统的使用者和系统功能的交互,是系统功能的蓝图。
一般会涉及到用户端和管理端的用例,可以通过用例图反映,比如退款申请功能用例:
在这里插入图片描述

2、功能整体链路

这部分是将用例以及各个系统串连起来,有序的完成整个功能的交互,我们可以通过时序图来表示。
通过这部分,可以反映功能涉及到的上下游系统,可以明确到相关接口层面,或者消息等,能体现相关方的工作量和风险点。比如下方用户申请退款的时序图简图,作为交易服务,需要依赖支付服务。
在这里插入图片描述

2.1、核心业务流程

这部分相对于第1部分是更细节更详细的设计,是关于业务功能里比较核心的业务逻辑,是一个大功能里对业务起关键作用的流程,比如发起退款里面,对退款的状态变更是比较关键的流程,我们一般要把这种核心功能的流程体现出来,可以用时序图或者流程图,流程图表示可以更直观,对于有一些数据或者状态变更的操作可以给一些推演案例,这点一般测试人员会比较关注。

下面是退款流水表退款状态的推演记录:

在这里插入图片描述

第几次发起退款发起退款结果退款状态退款状态含义
第1次失败0初始化
第2次成功1发起退款中

3、数据库设计

这块内容是对数据库变更的体现,数据库是我们业务系统的最底层,数据库变更应该是需要重视的。我们需要考虑数据库设计的合理性。
是否有新表引入,以及是否有必要性,需要注意新表是否需要分片,考虑数据量增量大小,是否需要定期归档
旧表新字段引入,需要关注新字段是否引入慢查询,是否有大字段,是否有敏感字段,是否需要加索引等,有比较多的情况新功能导致慢sql。
我们可以把ddl语句在文档中体现出来,突出是新增还是更新。
退款流水记录表order_refund_record(新增)

CREATE TABLE 'order_refund_record`(
`id`bigint(50) unsigned NOT NULL AUTO INCREMENT COMMENT 'id', order id` varchar (50) NOT NULL COMMENT'订单id',
`refund_status` int(4) NOT NULL COMMENT'退款状态0初始化,1退款中,2退款成功,3退款失败',
'create_time’ datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT'创建时间'`update_time` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT'更新时间’
`is_delete` tinyint(3) unsigned NOT NULL DEFAULT 'O' COMMENT'是否已删除0-未删除1-已删除' 
PRIMARY KEY (`id`),
) ENGINE = InnoDB DEFAULT CHARSET =utf8mb4 COMMENT-'退款流水记录表';

4、接口设计

这部分是比较细节的设计了,一般是用于提供给前端或者上下游系统,通过接口设计可以让相关方了解满足需求。
这部分有rpc接口或者http接口,也可能是消息,需要把传输的数据结构定义明确出来,特别是业务关键字段,让相关方能够评估改动点,可以知道新接口或者新字段是否可以满足需求。工作中常用的接口文档有yapi和swagger。
除了定义接口数据格式,接口设计需要考虑性能,比如幂等设计,是否需要限流。

5、非功能设计

5.1、性能与稳定性

非功能设计里面性能和稳定性应该是需要比较看重的,我们做的功能最基础的要保障稳定可用。
比如新功能如果有新增配置表,我们可以考虑配置表是否放缓存,避免直接查询数据库,特别是配置表查询qps比较高的情况。
比如依赖多个下游服务,下游服务之间互不依赖,我们可以考虑使用多线程异步并行处理,提高接口吞吐量。

5.2、监控

这部分也是很重要的,我们做的功能上线后怎么知道有没正常运行呢?我们除了看数据库,查日志,比较好的方式就是系统自己有业务监控,业务打点,通过业务监控可以实时查看业务的实际情况。
比如抽奖活动发奖励的业务功能,我们可以把参与抽奖活动成功,失败,发放各类奖励的数据记录到监控平台,监控平台可视化展示业务监控。
##6、核对
这是对于一些核心业务功能必须要做的事情,通过核对对账可以确定我们做的功能有没有漏洞,避免公司损失。
核对一般有实时核对和离线核对,比如营销活动发优惠券奖励,我们需要核对营销活动发放规则和发放优惠券是否正确,避免出现超发,漏发,错发的情况。

7、系统风险点评估

这部分我们要思考新功能对系统有哪些风险,比如新功能引入对现有功能的影响点风险点,比如功能流量大对系统稳定性是否有冲击,再比如对依赖服务是否有影响。可能还需要考虑如下点:
数据库是否需要扩容
缓存是否需要扩容
新功能是否需要压测
新接口是否需要限流

四、总结

技术方案应该是相关方共同参与并且需要达成共识,技术方案需要考虑现有的资源成本,现有系统影响,以及合理性多方位来分析,通过技术文档可以让相关方理解整个功能的业务流转逻辑,对于后续工作推进也有一定作用。本文结合作者工作中写技术方案的经验做了总结,存在不足欢迎补充或者指正,欢迎大家在评论区分享下自己如何写技术方案。
关注我们一起学习技术吧,坚持相信有输入一定要有输出,希望我们的技术能力越来越强大。

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

如若内容造成侵权/违法违规/事实不符,请联系我们进行投诉反馈qq邮箱809451989@qq.com,一经查实,立即删除!

相关文章

前端开发高频面试题

好的,以下是对您提出的问题的详细回答: 说说vue动态权限绑定渲染列表(权限列表渲染) Vue中动态权限绑定渲染列表通常涉及以下步骤: 首先,通过API请求从服务器获取当前用户的权限数据。在Vue组件中&#xff…

uc/OS移植到stm32实现三个任务

文章目录 一、使用CubeMX创建工程二、uc/OS移植三、添加代码四、修改代码五、实践结果六、参考文章七、总结 实践内容 学习嵌入式实时操作系统(RTOS),以uc/OS为例,将其移植到stm32F103上,构建至少3个任务(task&#xf…

[pixi.js] 入门简单案例 简易时钟

老实说pixi虽然之前拿来做个几个简单的游戏,但是是好久前的了,又忘了,现在算是重新入门。 官网版本已经更新到v8去了,而react相关的pixi库pixi-react 虽然支持react18 但还是v6-v7的版本,既然已经看了v8的文档&#xf…

Web 版 | 开源数据库设计软件 | drawdb

文章目录 简介快速运行方式 1:本地运行方式 2:Docker 构建并运行方式 3:Docker 运行参考🚀 目标: 安装一个 Web 版本的 ER 图设计软件! 👉 GitHub: https://github.com/drawdb-io/drawdb 【11.7k ⭐】 简介 DrawDB:Free, simple, and intuitive database design …

【iOS】UI——关于UIAlertController类(警告对话框)

目录 前言关于UIAlertController具体操作及代码实现总结 前言 在UI的警告对话框的学习中,我们发现UIAlertView在iOS 9中已经被废弃,我们找到UIAlertController来代替UIAlertView实现弹出框的功能,从而有了这篇关于UIAlertController的学习笔记…

Idea解决堆栈溢出

废话不说了,这问题搞了我两天,最近在用内网办公,没用公网,所以博客暂时没更新

堆排序-调整算法

个人主页点这里!~ 1.堆 了解堆排序首先要了解一下堆这个数据结构 堆(Heap)是一种特殊的树形数据结构,它通常被表示为一个完全二叉树或近似完全二叉树,并且满足堆性质(Heap Property)。堆主要分为两种&…

wordpress主题导航主题v4.16.2哈哈版

1.下载授权接口源码onenav-auth-api-v2.zip ,在宝塔新建一个网站,域名为 auth.iotheme.cn,设置wordpress伪静态,申请ssl证书。将上面源码解压后上传到此网站根目录。 2. 在宝塔根目录etc下 hosts 中添加 127.0.0.1 auth.iotheme.…

Docker配置Redis集群以及主从扩容与缩容

基础镜像拉取 docker run -p 6379:6379 -d redis:6.0.8 配置文件以及数据卷挂载 # 开启密码验证(可选) requirepass 1234 # 允许redis外地连接,需要注释掉绑定的IP # bind 127.0.0.1 # 关闭保护模式(可选) protected-m…

13、SpringBoot 源码分析 - 自动配置深度分析六

SpringBoot 源码分析 - 自动配置深度分析六 refresh和自动配置大致流程AutoConfigurationImportSelector的fireAutoConfigurationImportEvents通知自动配置导入事件AutoConfigurationGroup的selectImports封装成Entry返回MyAutoConfiguration自动配置类创建META-INF文件夹和文件…

CST纳米光学 --- LSPR局部等离子激元共振,消光截面ECS,法诺共振

这期我们用自带的Drude散射粒子,计算消光截面。 查看模型,内核是Silica二氧化硅,正常的介质材料,半径是38纳米: 外围是Drude模型的金属材料包裹,半径48纳米,该材料的参数可由宏Materials->Cr…

多个p标签一行展示,溢出隐藏

一开始,我是让div包裹多个p标签,并让div“flex”布局,且单行溢出隐藏,可是发现当父元素或当前元素有flex时,text-overflow: ellipsis;是不生效的 大多数解决办法都是,不要flex,或者给div下的每个…

代码随想录算法训练营第四十九天 | 139.单词拆分、多重背包、背包问题总结

139.单词拆分 视频讲解: 动态规划之完全背包,你的背包如何装满?| LeetCode:139.单词拆分_哔哩哔哩_bilibili 代码随想录 解题思路 1.dp[i] 字符串的长度为i,dp[i]是否可以被组成 2.递推公式 if( [j,i] && d…

基于springboot开发的Java MES制造执行系统源码,全套源码,一款数字化管理平台源码 云MES系统源码

基于springboot开发的Java MES制造执行系统源码,全套源码,一款数字化管理平台源码 云MES系统源码 MES系统源码相关技术: ​技术架构:springboot vue-element-plus-admin 开发语言:Java 开发工具:idea 前…

【Unity3D小功能】Unity3D中UGUI-Text实现打字机效果

推荐阅读 CSDN主页GitHub开源地址Unity3D插件分享简书地址QQ群:398291828 大家好,我是佛系工程师☆恬静的小魔龙☆,不定时更新Unity开发技巧,觉得有用记得一键三连哦。 一、前言 需求要实现Text的打字机效果,一看居然…

【Linux】进程4——进程状态

1.进程状态 什么是状态? 每个人都有状态——颓废,阳光,积极向上。。。。 进程也有状态 在操作系统中,由于进程的数量是非常多的,而系统的资源又非常少,所以不可能每一个进程在每时每刻都会处于上处理机运…

Python语言读取图像

import cv2 import numpy as np width 640 # 图像宽度height 480 # 图像高度channels 3 # 颜色通道数imgEmpty np.empty((height, width, channels), np.uint8) # 创建空白数组imgBlack np.zeros((height, width, channels), np.uint8) # 创建黑色图像 RGB0imgWhite …

微型丝杆与滚珠丝杆性能差异与适用场景!

滚珠丝杆是工具机械和精密机械上最常使用的传动元件,其主要功能是将旋转运动转换成线性运动,或将扭矩转换成轴向反复作用力。同时兼具高精度、可逆性和高效率的特点。而微型丝杆是一种直径为0.5mm以下且线性误差在几微米以内,精度高、传动稳定…

开发uniapp 小程序时遇到的问题

1、【微信开发者工具报错】routeDone with a webviewId XXX that is not the current page 解决方案: 在app.json 中添加 “lazyCodeLoading”: “requiredComponents” uniapp的话加到manifest.json下的mp-weixin 外部链接文章:解决方案文章1 解决方案文章2 &qu…

LLM的基础模型2:Transformer的组成模块

Transformer是一种先进的语言模型,它在预测下一个单词或标记方面与传统的语言模型有所不同,但仍然遵循相同的基本原理。Transformer通过一系列复杂的步骤,将输入的标记序列转换为能够进行预测的丰富向量序列。 在Transformer中,输…