设计模式学习笔记 - 项目实战二:设计实现一个通用的接口幂等框架(实现)

ops/2024/11/9 0:33:04/

概述

上篇文章,我们讲解了幂等框架的设计思路。在正常情况下,幂等框架的处理流程是比较简单的。调用方生成幂等号,传递给实现方,实现方记录幂等号或者用幂等号判重。但是,幂等框架要处理的异常情况很多,这也是设计的复杂之处和难点之处。比如,代码运行异常、业务系统宕机、幂等框架异常。

虽然幂等框架要处理的异常很多,但考虑开发成本以及简单易用性,我们对某些异常的处理在工程师做了妥协,交由业务系统或者人工介入处理。这样就打打简化了幂等框架开发的复杂度和难度。

本章,我们针对幂等框架的设计思路,讲解如何编码实现。跟限流框架一样,对于幂等框架,我们也会还原它的整个开发过程,从 V1 版本需求、最小原型代码将其,然后 review 代码发现问题、重构代码解决问题,最终得到一份易读、易扩展、灵活、可测试的高质量代码实现。


V1 版本功能需求

上篇文章给出的设计思路比较零散,重点还是在讲设计的缘由,为什么要这么设计。本章,我们在重新整理一下,经过上篇文章的分析梳理最终得到的设计思路。虽然上篇文章分析的很复杂、很烧脑,但思从深而行从简,最终得到的幂等框架的设计思路是很简单的,主要包括下面这样两个主要的功能开发点:

  • 实现生成幂等号功能
  • 实现存储、查询、删除幂等号功能。

因为功能非常简单,所以这里就不再进一步剪裁了。在 V1 版本中,我们会实现上面罗列的所有功能。针对这两个功能点,先来说下实现思路。

先看下,如何生成幂等号

幂等号用来标识两个接口请求是否是同一个业务,换句话说,两个接口请求是否是重试关系,而非独立的两个请求。接口调用方在发送接口请求时,将幂等号一块传递给接口实现方。那如何来生成幂等号呢?一般有两种方式。一种方式是集中生成并分派给调用方,另一种方式是直接由调用方生成。

对于第一种方式,我们要部署一套幂等号生成系统,并且提供相应的远程接口(RESTful 后者 RPC 接口),调用方通过远程接口来获取幂等号。这样做的好处是,对调用方完全隐藏了幂等号的实现细节。当我们需要改动幂等号的生成算法时,调用方不需要改动任何代码。

对于第二种生成方式,调用方按照跟接口实现方式预先商量好的算法,自己来生成幂等号。这种实现方式的好处在于,不用像第一种方式那样调用远程接口,所以执行效率高。但是,一旦需要修改幂等号的生成算法,就需要修改每个调用方的代码。

并且,每个调用方自己实现幂等号的生成算法也有问题。一方面,重复开发,违反 DRY 原则。另一方面,工程师的开发水平参差不齐,代码难免会由 bug。此外,对于复杂的幂等号生成算法,比如依赖外部系统 Redis 等,显然更加适合上一种实现方式,可以避免调用方为了使用幂等号引入新的外部系统。

权衡来讲,即考虑到生成幂等号的效率,又考虑到代码维护的成本,我们选择第二种实现方式,并且在此基础上做些改进,由幂等框架来统一提供幂等号生成算法的代码实现,并封装成开发类库,提供给各个调用方复用。此外,我们希望生成的幂等号的算法尽可能的简单,不依赖其他外部系统。

实际上,对于幂等号的唯一要求就是全局唯一。全局唯一的 ID 生成算法有很多。比如,简单点的有 UUID,复杂点的可以把应用名拼接在 UUID 上,方面做问题排查。总体上来讲,幂等号的生成算法并不难。

在看下,如何实现幂等号的存储、查询和删除

从现在的需求来看,幂等号只是为了判重。在数据库中,我们只需要存储一个幂等号就可以,不需要太复杂的数据结构,所以,我们不选择使用复杂的关系型数据库,而是选择使用更加简单的、读写更快速的兼职数据库,比如 Redis。

在幂等判重逻辑中,我们需要先检查幂等号是否存在。如果不存在,再将幂等号存储进 Redis。多个线程(同一个业务实例的多个线程)或或进程(多个业务实例)同时执行刚刚的 “检查 - 设置” 逻辑时,就会存在竞争关系。比如,A 现成检查幂等号不存在,在 A 现成讲幂等号存储进 Redis 之前,B 线程也检查幂等号不存在,这样就会导致业务被重复执行。为了避免这种情况发生,我们要给 “检查 - 设置” 操作加锁,让同时只有一个线程能执行。此外,为了避免多线程之间的竞争,普通线程还不起作用,我们需要分布式锁。

引入分布式锁会增加开发的难度和复杂度,而 Redis 本身就提供了把 “检查 - 设置” 操作作为原子操作执行的命令:setnx(key, value) 。它检查 key 是否存在,如果存在,则返回结果 0;如果不存在,则将 key 值存下来,并将值设置为 value,返回结果 1。因为 Redis 本身是单线程执行命令的,所以不存在刚刚讲到的并发问题。

最小原型代码实现

V1 版本要实现的功能和实现思路,现在已经很明确了。现在,我们来看下具体的代码实现。还是跟限流框架同样的实现方式,我们先不考虑设计和代码质量,怎么简单怎么来,先写出 MVP 代码,然后基于这个最简陋的版本做优化重构。

V1 版本的功能非常简单,我们用一个类就能搞定。代码如下所示。只用了不到 30 行代码,就搞定了一个框架。对于这段代码,你可以先思考下有哪些值得优化的地方。

public class Idempotence {private JedisCluster jedisCluster;public Idempotence(String redisClusterAddress, GenericObjectPoolConfig config) {String[] addressArray = redisClusterAddress.split(";");Set<HostAndPort> redisNodes = new HashSet<>();for (String address : addressArray) {String[] hostAndPort = address.split(":");redisNodes.add(new HostAndPort(hostAndPort[0], Integer.parseInt(hostAndPort[1])));}this.jedisCluster = new JedisCluster(redisNodes, config);}public String genId() {return UUID.randomUUID().toString();}public boolean saveIfAbsent(String idempotenceId) {Long success = jedisCluster.setnx(idempotenceId, "1");return success == 1;}public void delete(String idempotenceId) {jedisCluster.del(idempotenceId);}
}

Review 最小原型代码

尽管 MVP 代码很少,但仔细推敲,也有很多值得优化的地方。现在,我们就站在 Code Reviewer 的角度,分析一下这段代码。我把所有的意见都放到代码注释中了,你可以对照着代码一块看下。

public class Idempotence {// comment-1: 如果要替换存储方式,很麻烦private JedisCluster jedisCluster;// comment-2: 如果幂等框架要跟业务系统复用jedisCluster链接呢?// comment-3: 是不是应该注释说明下redisClusterAddress的格式,以及config是不是可以传递nullpublic Idempotence(String redisClusterAddress, GenericObjectPoolConfig config) {// comment-4: 这段逻辑放到构造函数里,不容易写单元测试String[] addressArray = redisClusterAddress.split(";");Set<HostAndPort> redisNodes = new HashSet<>();for (String address : addressArray) {String[] hostAndPort = address.split(":");redisNodes.add(new HostAndPort(hostAndPort[0], Integer.parseInt(hostAndPort[1])));}this.jedisCluster = new JedisCluster(redisNodes, config);}// comment-5: generateId() 的命名是不是比缩写要好一点?// comment-6: 根据接口隔离廁,这个函数跟其他函数的使用场景完全不同,这个函数主要用在调用方,其他函数在实现方,是不是应该分别放到两个类中?public String genId() {return UUID.randomUUID().toString();}// comment-7: 返回值的意义是不是应该注释说明一下public boolean saveIfAbsent(String idempotenceId) {Long success = jedisCluster.setnx(idempotenceId, "1");return success == 1;}public void delete(String idempotenceId) {jedisCluster.del(idempotenceId);}
}

总结一下,MVP 代码主要涉及下面这样几个问题:

  • 代码可读性问题:有些函数的参数和返回值的格式和意义不够明确,需要注释补充解释一下。genId() 函数使用了缩写,全拼 generateId() 可能更好一些。
  • 代码可扩展性问题:按照现在的代码实现方式,如果改变幂等号的存储方式和生成算法,代码改起来比较麻烦。此外,基于接口隔离原则,我们应该将 genId() 函数跟其他函数分离开来,放到两个类中。独立变化,隔离修改,更容易扩展。
  • 代码可测试问题:解析 Redis Cluster 地址的代码逻辑较为复杂,但因为放到了构造函数中,无法对它编写单元测试。
  • 代码灵活性问题:业务系统有可能希望幂等框架复用已经建立好的 jedisCluster,而不是单独给幂等框架创建一个 jedisCluster

重构最小原型代码

实际上,问题找到了,修改起来就容易多了。针对刚刚罗列的问题,我们对 MVP 代码进行重构,重构之后的代码如下所示。

// 代码目录结构
com.example.idempotence--Idempotence--IdempotenceIdGenerator (幂等号生成类)--IdempotenceStorage (接口: 用来读写幂等号)--RedisClusterIdempotenceStorage (IdempotenceStorage的实现类)// 每个代码的实现类
public class Idempotence {private IdempotenceStorage storage;public Idempotence(IdempotenceStorage storage) {this.storage = storage;}public boolean saveIfAbsent(String idempotenceId) {return storage.saveIfAbsent(idempotenceId);}public void delete(String idempotenceId) {storage.delete(idempotenceId);}
}public class IdempotenceIdGenerator {public String generateId() {return UUID.randomUUID().toString();}
}public interface IdempotenceStorage {boolean saveIfAbsent(String idempotenceId);void delete(String idempotenceId);
}public class RedisClusterIdempotenceStorage implements IdempotenceStorage {private JedisCluster jedisCluster;/*** Constructor* @param redisClusterAddress the format is 128.91.12.1:3455;128.91.12.2:3452;128.91.12.3:3453;...* @param config should not be null*/public RedisClusterIdempotenceStorage(String redisClusterAddress, GenericObjectPoolConfig config) {Set<HostAndPort> redisNodes = parseHostAndPorts(redisClusterAddress);this.jedisCluster = new JedisCluster(redisNodes, config);}public RedisClusterIdempotenceStorage(JedisCluster jedisCluster) {this.jedisCluster = jedisCluster;}/*** Save {@idempotenceId} into storage if it does not exist.* @param idempotenceId the idempotence ID* @return true if the {@idempotenceId} is saved, otherwise retyrn false*/@Overridepublic boolean saveIfAbsent(String idempotenceId) {Long success = jedisCluster.setnx(idempotenceId, "1");return success == 1;}@Overridepublic void delete(String idempotenceId) {jedisCluster.del(idempotenceId);}@VisibleForTestingprotected Set<HostAndPort> parseHostAndPorts(String redisClusterAddress) {String[] addressArray = redisClusterAddress.split(";");Set<HostAndPort> redisNodes = new HashSet<>();for (String address : addressArray) {String[] hostAndPort = address.split(":");redisNodes.add(new HostAndPort(hostAndPort[0], Integer.parseInt(hostAndPort[1])));}return redisNodes;}
}

接下来,我们再总结罗列一下,针对之前发现的问题,我们都做了哪些改动。主要有下面这样几点。

在代码可读性方面,我们对构造函数、saveIfAbsent() 函数的参数和返回值做了注释,并将 genId() 函数改为全拼的 generateId()

在扩展性方面,我们按照基于接口而非实现编程原则,将幂等号的读写独立出来,设计成 IdempotenceStorage 接口和 RedisClusterIdempotenceStorage 实现类。RedisClusterIdempotenceStorage 实现了基于 Redis Cluster 的幂等号读写。如果我们需要替换新的幂等号读写方式,比如基于单个 Redis 而非 Redis Cluster,我们就可以在定义一个实现了 IdempotenceStorage 接口的实现类:RedisIdempotenceStorage

此外,按照接口隔离原则,我们将生成幂等号的代码抽离出来,放到 IdempotenceIdGenerator 类中。这样,调用方只需要依赖这个类的代码就可以了。幂等号生成算法的修改,跟幂等号存储逻辑的修改,两者完全独立,一个修改并不会影响到另一个。

在代码可测试性方面,我们把原本放在构造函数中的逻辑抽离出来,放到了 parseHostAndPorts() 中。这个函数本应该是 private 访问权限的,但为了方便编写单元测试,我们把它设置成了 protected 访问权限,并通过注释 @VisibleForTesting 做了标明。

在代码灵活性方面,为了方便复用业务系统已经建立好的 jedisCluster,我们提供了一个新的构造函数,支持业务系统直接传递 jedisCluster 来创建 RedisClusterIdempotenceStorage 对象。

总结

前面花了两篇文章,用很大的篇幅在讲需求设计,特别是设计的缘由。而真正到了实现环节,只用了 30 行代码,就实现了幂等框架。这就很好地体现了 “思从深而行从简” 的道理,对于不到 30 行代码,很多人觉得不大可能有啥优化的空间了,但我们今天还是提出了 7 个优化建议,并且对代码结构做了比较大的调整。这说明,只要仔细推敲,再小的代码都有值得优化的地方。

大项目和小项目,在编码这个层面,实际上没有太大的区别。再宏达的工程、再庞大的项目,也是一行一行写出来的。那些上来就要看上万行代码,分析庞大项目的人,大部分都还没有理解编码的精髓。编码本身就是一个很细节的事情,牛不牛也都隐藏在一行一行的代码中。空谈架构、设计、大道理,实际上没有太大意义,对你帮助不大。能沉下心来把细节都做好那才是真的牛!


http://www.ppmy.cn/ops/24749.html

相关文章

CSS Grid 那些鲜为人知的内幕

❝ 叔本华&#xff1a;人生没有意义&#xff0c;人生就是一团欲望&#xff0c;欲望满足了就空虚&#xff0c;满足不了就痛苦&#xff0c;人生就像摆钟在空虚和痛苦中来回摇摆。 ❞ 大家好&#xff0c;我是「柒八九」。一个「专注于前端开发技术/Rust及AI应用知识分享」的Coder …

报错:图片验证码接口对接vue+springboot(下一个笔记会记录整个验证码的代码)

问题&#xff1a;空指针异常ai: 根据错误堆栈信息中提供的方法调用位置&#xff0c;看起来空指针异常是在 AuthCodeServiceImpl 类的 authUserCoded 方法的第 41 行发生的。 为了解决这个问题&#xff0c;你可以检查 AuthCodeServiceImpl 类中 authUserCoded 方法的第 41 行&am…

从零手写实现 apache Tomcat-01-入门介绍

创作缘由 平时使用 tomcat 等 web 服务器不可谓不多&#xff0c;但是一直一知半解。 于是想着自己实现一个简单版本&#xff0c;学习一下 tomcat 的精髓。 怎么实现一个 tomcat 呢&#xff1f; Tomcat就像是一个用Java语言搭起来的大舞台&#xff0c;专门用来演出那些用Jav…

基于ESP32—CAM物联网WIFI小车

一.功能概述 摄像头的画面可以实时的传输到,点灯科技APP的手机端,这样可以实时查看周围环境的状况,灯光不足,画面不清晰时可以打开灯光照明。手机端有左转、右转、前进、后退、停止的按钮。可以根据自己需要,来控制小车。手机APP端还设有模式切换的按钮,可以根据需要进行…

备考数通HCIE证书4点经验分享!

大家好&#xff0c;我是来自安阳工学院20级网络工程的刁同学&#xff0c;在2023年12月20日成功通过了华为Datacom HCIE认证&#xff0c;并且取得了笔试900多分&#xff0c;实验B的成绩。在此&#xff0c;我想把我的一些考证心得分享给正在备考的小伙伴们。 关于为什么考证 我…

C#面:ASP.NET 与 ASP 相比,主要有哪些进步

C# ASP.NET 相对于传统的ASP有以下几个主要的进步&#xff1a; 更强大的编程语言&#xff1a;C#是一种现代化的编程语言&#xff0c;相比于ASP使用的 VBScript 或 JScript&#xff0c;C#具有更强大的面向对象编程能力和更丰富的语法特性&#xff0c;使得开发人员可以更高效地编…

C++:初始C++

文章目录 C关键字命名空间命名空间定义命名空间的使用 C的输入&输出缺省参数缺省参数的概念缺省参数分类 函数重载函数重载的概念C支持函数重载的原理——名字修饰(name Mangling) 引用引用的概念引用特性常引用使用场景做参数做返回值 传值、传引用效率比较值和引用作为返…

Seata-server配置

首先先查看一下版本看看所用的版本是否都兼容 版本兼容查看 建立seata-server数据库 数据库DDL 给每个业务库建立undo.log表 undo.log 然后在虚拟机安装seata-server 创建文件路径&#xff0c;并创建docker-compose.yml文件 创建完成后先启动一下seata docker run -rm seata…