乐趣区

关于spring-cloud:SpringCloud升级之路20200x版37-实现异步的客户端封装配置管理的意义与设计

jiezi

本系列代码地址：https://github.com/JoJoTec/sp…

为何须要封装异步 HTTP 客户端 WebClient

对于同步的申请，咱们应用 spring-cloud-openfeign 封装的 FeignClient，并做了额定的定制。对于异步的申请，应用的是异步 Http 客户端即 WebClient。WebClient 应用也比较简单，举一个简略的例子即：

// 应用 WebClient 的 Builder 创立 WebClient
WebClient client = WebClient.builder()
  // 指定基址
  .baseUrl("http://httpbin.org")
  // 能够指定一些默认的参数，例如默认 Cookie，默认 HttpHeader 等等
  .defaultCookie("cookieKey", "cookieValue")
  .defaultHeader(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON_VALUE) 
  .build();

创立好 WebClient 后即能够应用这个 WebClient 进行调用：

// GET 申请 /anything 并将 body 转化为 String
Mono<String> stringMono = client.get().uri("/anything").retrieve().bodyToMono(String.class);
// 这里为了测试，采纳阻塞获取
String block = stringMono.block();

返回的后果如下所示（申请 http://httporg.bin/anything 会将申请中的所有内容一成不变返回，从这里咱们能够看出下面测试的 Header 还有 cokkie 都被返回了）：

{"args": {}, 
  "data": "","files": {},"form": {},"headers": {"Accept":"*/*","Accept-Encoding":"gzip","Cookie":"TestCookie=TestCookieValue,getAnythingCookie=getAnythingCookieValue","Getanythingheader":"getAnythingHeaderValue","Host":"httpbin.org","Testheader":"TestHeaderValue","User-Agent":"ReactorNetty/1.0.7"},"json": null,"method":"GET","origin":"12.12.12.12","url":"http://httpbin.org/anything"
}

咱们也能够退出负载平衡的性能，让 WebClient 利用咱们外部的 LoadBalancer，负载平衡调用其余微服务，首先注入负载平衡 Filter：

@Autowired
ReactorLoadBalancerExchangeFilterFunction lbFunction;

创立 WebClient 的时候，将这个 Filter 退出：

// 应用 WebClient 的 Builder 创立 WebClient
WebClient client = WebClient.builder()
  // 指定基址微服务
  .baseUrl("http:// 微服务名称")
  // 能够指定一些默认的参数，例如默认 Cookie，默认 HttpHeader 等等
  .defaultCookie("cookieKey", "cookieValue")
  .defaultHeader(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON_VALUE) 
  // 负载均衡器，改写 url
  .filter(lbFunction)
  .build();

这样，这个 WebClient 就能调用微服务了。

然而，这样还不能满足咱们的需要：

  1. 须要在 WebClient 退出像 Feignclient 外面加的相似的重试与断路机制，线程隔离就不须要了，因为都是异步申请不会阻塞工作线程。
  2. 须要针对不同的微服务配置不同的连贯超时以及响应超时来适应不同微服务。
  3. 这些配置都减少了代码的复杂度，咱们须要缩小这些代码对于业务的侵入性，最好能通过纯配置实现这些 WebClient 的初始化。

要实现的配置设计以及应用举例

首先，咱们要实现的 WebClient，其 Filter 蕴含三个：

  1. 重试 Filter：重试的 Filter 要在负载平衡 Filter 之前，因为重试的时候，咱们会从负载均衡器获取另一个实例进行重试，而 不是在同一个实例上重试屡次。
  2. 负载平衡 Filter，其实就是内置的 ReactorLoadBalancerExchangeFilterFunction
  3. 断路器 Filter：断路器须要在负载平衡之后，因为只有负载平衡之后能力拿到具体本地调用的服务实例，这样咱们能力 实现基于微服务实例办法级别的断路器。

须要重试的场景：

  1. 非 2xx 的响应码返回，并且办法是能够重试的办法。如何定义方法是能够重试的，首先 GET 办法是能够重试的，对于其余办法，依据配置中的是否配置了这个 URL 能够重试决定。

  2. 异样重试：

    1. 连贯异样：例如连贯超时，连贯中断等等，所有申请的连贯异样都能够重试，因为申请并没有收回去。
    2. 断路器异样：该服务实例办法级别的断路器关上了，须要间接重试其余实例，因为申请并没有收回去。
    3. 响应超时异样：这个重试逻辑和非 2xx 的响应码返回一样。

咱们须要实现的配置形式是，通过这样配置 application.yml：

webclient:
  configs:
    // 微服务名称
    testService1:
      // 申请基址，第一级域名作为微服务名称
      baseUrl: http://testService1
      // 最多的 http 连贯数量
      maxConnection: 50
      // 连贯超时
      connectTimeout: 500ms
      // 响应超时
      responseTimeout: 60s
      // 除了 GET 办法外，哪些门路还能重试
      retryablePaths:
        - /retryable/**
        - /user/orders

退出这些配置，咱们就能获取载对应微服务的 WebClient 的 Bean，例如：

// 主动装载 咱们自定义的 WebClient 的 NamedContextFactory，这个是咱们前面要实现的
@Autowired
private WebClientNamedContextFactory webClientNamedContextFactory;


// 通过微服务名称，获取对应的微服务调用的 WebClient
webClientNamedContextFactory.getWebClient("testService1");

接下来，咱们会实现这些。

微信搜寻“我的编程喵”关注公众号，每日一刷，轻松晋升技术，斩获各种 offer：

退出移动版