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

news2024/11/28 10:54:32

文章目录

  • 一、背景
  • 二、技术方案重要性
  • 三、常见的技术方案有哪些内容
    • 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、系统风险点评估

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

四、总结

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

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

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

相关文章

计算机网络--应用层

计算机网络–计算机网络概念 计算机网络–物理层 计算机网络–数据链路层 计算机网络–网络层 计算机网络–传输层 计算机网络–应用层 1. 概述 因为不同的网络应用之间需要有一个确定的通信规则。 1.1 两种常用的网络应用模型 1.1.1 客户/服务器模型(Client/Se…

Java面试八股之什么是反射,实现原理是什么

Java中什么是反射,实现原理是什么 Java中的反射(Reflection)是一种强大的特性,它允许程序在运行时检查和操作类、接口、字段和方法的信息。简而言之,反射机制使得程序能够在运行时动态地了解和使用自身或其他程序集中…

python文件:py,ipynb, pyi, pyc, pyd, pyo都是什么文件?

1、Python文件类型介绍 📁 1.1 .py 文件:源代码基础 .py 文件是 Python 最基本的源代码文件格式,用于存储纯文本形式的 Python 代码。它是开发者编写程序的主要场所,包含函数、类、变量定义以及执行逻辑。Python 解释器直接读取…

【排序算法】总结篇

✨✨这些 排序算法都是指的 需要进行比较的排序算法 ✨✨下面都是略微讲解一下思路,如果需要详细了解哪一个排序,点击👉链接即可 ✨✨对于时间、空间复杂度、稳定性,希望你🧑‍🎓能够理解记忆🧑…

MyBatisPlus插件生成代码

文章目录 概要安装插件使用插件 概要 MyBatis-Plus 是 MyBatis 的增强工具,旨在简化 MyBatis 的开发。MyBatis-Plus 代码生成器插件可以自动生成项目中常见的代码,如实体类、Mapper 接口、Service 接口和实现类、Controller 等,从而减少手动…

python代码中参数的默认值

python中的函数,可以给形参指定默认值。 带有默认值的参数,可以在调用的时候不传参。 如上图所示,在给函数设定形参的时候可以给函数形参设定默认值,当然默认参数的形参应该在非默认形参的后面。 如果在调用函数的时候&#xff…

SpringBoot整合SpringSecurit(二)通过token进行访问

在文章:SpringBoot整合SpringSecurit(一)实现ajax的登录、退出、权限校验-CSDN博客 里面,使用的session的方式进行保存用户信息的,这一篇文章就是使用token的方式。 在其上进行的改造,可以先看SpringBoot…

ctfshow-web入门-命令执行(web41_exp与分析)

过滤不严,命令执行 preg_match(/[0-9]|[a-z]|\^|\|\~|\$|\[|\]|\{|\}|\&|\-/i, $c) 过滤掉了数字、字母以及一些符号,之前接触过的无字母 rce 是取反编码再取反,采用不可见字符去绕过正则,但是这里取反符号被过滤掉了&#x…

还在为线上BUG苦苦找寻?试试IntelliJ IDEA远程调试线上Java程序

😄 19年之后由于某些原因断更了三年,23年重新扬帆起航,推出更多优质博文,希望大家多多支持~ 🌷 古之立大事者,不惟有超世之才,亦必有坚忍不拔之志 🎐 个人CSND主页——Mi…

VMware导入小白分享的MacOS版本之后,无法开机的解决方案

前言 这段时间陆续有小伙伴找到小白,说:导入小白分享的MacOS版本之后,出现无法开机的问题。 遇到这个问题,并不是说明分享版本有问题,因为大部分小伙伴导入之后都没有出现类似的问题,都是导入之后开机&…

VBA经典应用69例应用5:使用VBA冻结窗格

《VBA经典应用69例》(版权10178981),是我推出的第九套教程,教程是专门针对初级、中级学员在学习VBA过程中可能遇到的案例展开,这套教程案例众多,紧贴“实战”,并做“战术总结”,以便…

PaddleSpeech MFA:阿米娅中文音色复刻计划

PaddleSpeech:阿米娅中文音色复刻计划 本篇项目是对iterhui大佬项目[PaddleSpeech 原神] 音色克隆之胡桃的复刻,使用的PaddleSpeech的版本较新,也针对新版本的PaddleSpeech做了许多配置之上的更新并加入了自己对语音的对齐、配置、训练其它任…

Buildroot和Debian文件系统修改方法

本文档主要介绍在没有编译环境的情况下,如何修改buildroot和debian文件系统方法,如在buildroot文件系统中添加文件、修改目录等文件操作,在debian文件系统中,安装软件库、工具、扩大文件系统空间等等操作。 1.Debian文件系统 …

Java | Leetcode Java题解之第137题只出现一次的数字II

题目: 题解: class Solution {public int singleNumber(int[] nums) {int a 0, b 0;for (int num : nums) {b ~a & (b ^ num);a ~b & (a ^ num);}return b;} }

AndroidStudio无法识别连接夜神模拟器

方法一(无法从根本上解决) ①进入夜神模拟器安装路径下的bin路径(安装路径可以带有中文路径) ②打开cmd窗口,输入以下代码(一定要打开模拟器) nox_adb.exe connect 127.0.0.1:62001 方法二(根本上解决) 原因:Android Studio的adb版本与夜神模拟器的adb版本不一致 ①打开And…

【Unity】 HTFramework框架(五十一)代码片段执行器

更新日期:2024年6月8日。 Github源码:[点我获取源码] Gitee源码:[点我获取源码] 索引 Code Snippet Executer 代码片段执行器使用 Code Snippet Executer打开 Code Snippet Executer动态执行(代码片段)静态执行&#x…

core dump核心转储

检查核心转储是否开启&#xff0c;否则无法生成core文件 ulimit -a 如果为0就需要修改 ulimit -c 10240 写一个会触发core命令的程序 以浮点数运算为例 #include <iostream>int main() {int i 1/0; } 在编译时使用-g选项 运行程序&#xff0c;生成core文件 gdb调试 g…

本地部署GLM-4-9B清华智谱开源大模型方法和对话效果体验

GLM-4-9B是清华大学和智谱AI推出的最新一代预训练模型GLM-4系列中的开源版本。在语义、数学、推理、代码和知识等多方面的数据集测评中&#xff0c;GLM-4-9B及其人类偏好对齐的版本GLM-4-9B-Chat均表现出较高的性能&#xff0c;其通用能力评测结果甚至超越了Llama-3-8B开源大模…

如何解锁植物大战僵尸杂交版v2.0.88所有植物

如何解锁植物大战僵尸杂交版v2.0.88所有植物 前言安装相关软件快速解锁方法修改冒险模式修改挑战模式 前言 经过探索植物大战僵尸杂交版植物解锁和关卡有关&#xff0c;所以通过所有关卡就可以解锁所有植物。 安装相关软件 1.安装植物大战僵尸 2.安装Hex Editor Neo 快速解…

pytorch 加权CE_loss实现(语义分割中的类不平衡使用)

加权CE_loss和BCE_loss稍有不同 1.标签为long类型&#xff0c;BCE标签为float类型 2.当reduction为mean时计算每个像素点的损失的平均&#xff0c;BCE除以像素数得到平均值&#xff0c;CE除以像素对应的权重之和得到平均值。 参数配置torch.nn.CrossEntropyLoss(weightNone,…