擼了一個 Feign 增強(qiáng)包 V2.0 升級版

作者：crossoverJie 2022-05-07 13:52:22

巧合的時最近內(nèi)部有部分項(xiàng)目又計劃采用 SpringBoot + K8s 開發(fā)，于是便著手繼續(xù)維護(hù);現(xiàn)已經(jīng)內(nèi)部迭代了幾個版本比較穩(wěn)定了，也增加了一些實(shí)用功能，在此分享給大家。

前言

大概在兩年前我寫過一篇擼了一個 Feign 增強(qiáng)包，當(dāng)時準(zhǔn)備是利用 SpringBoot + K8s 構(gòu)建應(yīng)用，這個庫可以類似于 SpringCloud 那樣結(jié)合 SpringBoot 使用聲明式接口來達(dá)到服務(wù)間通訊的目的。

但后期由于技術(shù)棧發(fā)生變化(改為 Go)，導(dǎo)致該項(xiàng)目只實(shí)現(xiàn)了基本需求后就擱置了。

??https://github.com/crossoverJie/feign-plus。??

首先是新增了一些 features:

更加統(tǒng)一的 API。
統(tǒng)一的請求、響應(yīng)、異常日志記錄。
自定義攔截器。
Metric 支持。
異常傳遞。

示例

結(jié)合上面提到的一些特性做一些簡單介紹，統(tǒng)一的 API 主要是在使用層面：

在上一個版本中聲明接口如下：

@FeignPlusClient(name = "github", url = "${github.url}")
public interface Github {
    @RequestLine("GET /repos/{owner}/{repo}/contributors")
    List<GitHubRes> contributors(@Param("owner") String owner, @Param("repo") String repo);
}

其中的 @RequestLine 等注解都是使用 feign 包所提供的。

這次更新后改為如下方式：

@RequestMapping("/v1/demo")
@FeignPlusClient(name = "demo", url = "${feign.demo.url}", port = "${feign.demo.port}")
public interface DemoApi {
    @GetMapping("/id")
    String sayHello(@RequestParam(value = "id") Long id);

    @GetMapping("/id/{id}")
    String id(@PathVariable(value = "id") Long id);

    @PostMapping("/create")
    Order create(@RequestBody OrderCreateReq req);

    @GetMapping("/query")
    Order query(@SpringQueryMap OrderQueryDTO dto);
}

熟悉的味道，基本都是 Spring 自帶的注解，這樣在使用上學(xué)習(xí)成本更低，同時與項(xiàng)目中原本的接口寫法保持一致。

@SpringQueryMap(top.crossoverjie.feign.plus.contract.SpringQueryMap) 是由 feign-plus 提供，其實(shí)就是從 SpringCloud 中 copy 過來的。

我這里寫了兩個 demo 來模擬調(diào)用：

provider：作為服務(wù)提供者提供了一系列接口供消費(fèi)方調(diào)用，并對外提供了一個 api 模塊。

demo：作為服務(wù)消費(fèi)者依賴 provider-api 模塊，根據(jù)其中聲明的接口進(jìn)行遠(yuǎn)程調(diào)用。

配置文件：

server:
  port: 8181

feign:
  demo:
    url : http://127.0.0.1
    port: 8080
logging:
  level:
    top:
      crossoverjie: debug
management:
  endpoints:
    web:
      base-path: /actuator
      exposure:
        include: '*'
  metrics:
    distribution:
      percentiles:
        all: 0.5,0.75,0.95,0.99
    export:
      prometheus:
        enabled: true
        step: 1m
spring:
  application:
    name: demo

當(dāng)我們訪問 http://127.0.0.1:8181/hello/2 接口時從控制臺可以看到調(diào)用結(jié)果：

日志記錄

從上圖中可以看出 feign-plus 會用 debug 記錄請求/響應(yīng)結(jié)果，如果需要打印出來時需要將該包下的日志級別調(diào)整為 debug：

logging:
  level:
    top:
      crossoverjie: debug

由于內(nèi)置了攔截器，也可以自己繼承 top.crossoverjie.feign.plus.log.DefaultLogInterceptor 來實(shí)現(xiàn)自己的日志攔截記錄，或者其他業(yè)務(wù)邏輯。

@Component
@Slf4j
public class CustomFeignInterceptor extends DefaultLogInterceptor {
    @Override
    public void request(String target, String url, String body) {
        super.request(target, url, body);
        log.info("request");
    }

    @Override
    public void exception(String target, String url, FeignException feignException) {
        super.exception(target, url, feignException);
    }
    @Override
    public void response(String target, String url, Object response) {
        super.response(target, url, response);
        log.info("response");
    }
}

監(jiān)控 metric

feign-plus 會自行記錄每個接口之間的調(diào)用耗時、異常等情況。

訪問 http://127.0.0.1:8181/actuator/prometheus 會看到相關(guān)埋點(diǎn)信息，通過 feign_call* 的 key 可以自行在 Grafana 配置相關(guān)面板，類似于下圖：

異常傳遞

rpc(遠(yuǎn)程調(diào)用)要使用起來真的類似于本地調(diào)用，異常傳遞必不可少。

// provider
 public Order query(OrderQueryDTO dto) {
  log.info("dto = {}", dto);
  if (dto.getId().equals("1")) {
   throw new DemoException("provider test exception");
  }
  return new Order(dto.getId());
 }

// consumer
        try {
            demoApi.query(new OrderQueryDTO(id, "zhangsan"));
        } catch (DemoException e) {
            log.error("feignCall:{}, sourceApp:[{}], sourceStackTrace:{}", e.getMessage(), e.getAppName(), e.getDebugStackTrace(), e);
        }

比如 provider 中拋出了一個自定義的異常，在 consumer 中可以通過 try/catch 捕獲到該異常。

為了在 feign-plus 中實(shí)現(xiàn)該功能需要幾個步驟：

自定義一個通用異常。
服務(wù)提供方需要實(shí)現(xiàn)一個全局?jǐn)r截器，當(dāng)發(fā)生異常時統(tǒng)一對外響應(yīng)數(shù)據(jù)。
服務(wù)消費(fèi)方需要自定義一個異常解碼器的 bean。

這里我在 provider 中自定義了一個 DemoException：

通常這個類應(yīng)該定義在公司內(nèi)部的通用包中，這里為了演示方便。

接著定義了一個 HttpStatus 的類用于統(tǒng)一對外響應(yīng)。

@Data
@AllArgsConstructor
@NoArgsConstructor
public class HttpStatus {
    private String appName;
    private int code;
    private String message;
    private String debugStackTrace;
}

這個也應(yīng)該放在通用包中。

然后在 provider 中定義全局異常處理：

當(dāng)出現(xiàn)異常時便會返回一個 http_code=500 的數(shù)據(jù)：

到這一步又會出現(xiàn)一個引戰(zhàn)話題：HTTP 接口返回到底是全部返回 200 然后通過 code 來來判斷，還是參考 http_code 進(jìn)行返回?

這里不做過多討論，具體可以參考耗子叔的文章： “一把梭：REST API 全用 POST”

feign-plus 默認(rèn)采用的 http_code !=200 才會認(rèn)為發(fā)生了異常。

而這里的 http_status 也是參考了 Google 的 api 設(shè)計：

具體可以參考這個鏈接： https://cloud.google.com/apis/design/errors#propagating_errors。

然后定義一個異常解析器：

@Configuration
public class FeignExceptionConfig {
    @Bean
    public FeignErrorDecoder feignExceptionDecoder() {
        return (methodName, response, e) -> {
            HttpStatus status = JSONUtil.toBean(response, HttpStatus.class);
            return new DemoException(status.getAppName(), status.getCode(), status.getMessage(), status.getDebugStackTrace());
        };
    }
}