246379.md 16 KB

95 | 项目实战二:设计实现一个通用的接口幂等框架(实现)

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

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

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

话不多说,让我们正式开始今天的学习吧!

V1版本功能需求

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

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

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

我们先来看,如何生成幂等号。

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

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

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

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

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

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

我们再来看,如何实现幂等号的存储、查询和删除。

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

在幂等判重逻辑中,我们需要先检查幂等号是否存在。如果没有存在,再将幂等号存储进Redis。多个线程(同一个业务实例的多个线程)或者多进程(多个业务实例)同时执行刚刚的“检查-设置”逻辑时,就会存在竞争关系(竞态,race condition)。比如,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.valueOf(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是否可以传递进null呢?
  public 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.valueOf(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.xzg.cd.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;289.13.2.12:8978
   * @param config should not be null
   */
  public RedisIdempotenceStorage(String redisClusterAddress, GenericObjectPoolConfig config) {
    Set<HostAndPort> redisNodes = parseHostAndPorts(redisClusterAddress);
    this.jedisCluster = new JedisCluster(redisNodes, config);
  }

  public RedisIdempotenceStorage(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 return false
   */
  public boolean saveIfAbsent(String idempotenceId) {
    Long success = jedisCluster.setnx(idempotenceId, "1");
    return success == 1;
  }

  public void delete(String idempotenceId) {
    jedisCluster.del(idempotenceId);
  }

  @VisibleForTesting
  protected 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.valueOf(hostAndPort[1])));
    }
    return redisNodes;
  }
}

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

在代码可读性方面,我们对构造函数、saveIfAbsense()函数的参数和返回值做了注释,并且将genId()函数改为全拼generateId()。不过,对于这个函数来说,缩写实际上问题也不大。

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

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

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

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

重点回顾

好了,今天的内容到此就讲完了。我们一块来总结回顾一下,你需要重点掌握的内容。

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

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

课堂讨论

  1. 针对MVP代码,我有两个问题留给你思考。其中一个问题是,delete()是应该返回void值还是boolean值?如果删除出错,应该如何处理?另一个问题是,需不需要给幂等号生成算法抽象出一个接口呢?为什么?
  2. 在后续的版本规划中,你觉得幂等框架还可以继续扩展哪些功能?或者做哪些优化?如果让你规划第二个版本,你会做哪些东西?

欢迎留言和我分享你的想法。如果有收获,也欢迎你把这篇文章分享给你的朋友。