Feign 增强包 V2.0 升级版

撸了一个 Feign 增强包，当时准备是利用构建应用，这个库可以类似于那样结合使用声明式接口来达到服务间通讯的目的。

但后期由于技术栈发生变化（改为 Go），导致该项目只实现了基本需求后就搁置了。

巧合的时最近内部有部分项目又计划采用开发，于是便着手继续维护；现已经内部迭代了几个版本比较稳定了，也增加了一些实用功能，在此分享给大家。

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

首先是新增了一些 :

更加统一的 API。
统一的请求、响应、异常日志记录。
自定义拦截器。
Metric 支持。
异常传递。

示例

结合上面提到的一些特性做一些简单介绍，统一的 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);
}

其中的等注解都是使用 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);
}

熟悉的味道，基本都是自带的注解，这样在使用上学习成本更低，同时与项目中原本的接口写法保持一致。

@SpringQueryMap(top.crossoverjie.feign.plus.contract.SpringQueryMap) 是由 feign-plus 提供，其实就是从 SpringCloud 中 copy 过来的。

：作为服务消费者依赖模块，根据其中声明的接口进行远程调用。
配置文件：

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

日志记录

从上图中可以看出会用 debug 记录请求/响应结果，如果需要打印出来时需要将该包下的日志级别调整为 debug：

logging:
  level:
    top:
      crossoverjie: debug

由于内置了拦截器，也可以自己继承来实现自己的日志拦截记录，或者其他业务逻辑。

@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");
    }
}

监控 metric

会自行记录每个接口之间的调用耗时、异常等情况。
访问会看到相关埋点信息，通过的 key 可以自行在配置相关面板，类似于下图：

异常传递

（远程调用）要使用起来真的类似于本地调用，异常传递必不可少。

// 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);
        }

比如中抛出了一个自定义的异常，在中可以通过捕获到该异常。

为了在 feign-plus 中实现该功能需要几个步骤：

自定义一个通用异常。
服务提供方需要实现一个全局拦截器，当发生异常时统一对外响应数据。
服务消费方需要自定义一个异常解码器的 bean。

通常这个类应该定义在公司内部的通用包中，这里为了演示方便。

接着定义了一个的类用于统一对外响应。

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

这个也应该放在通用包中。

到这一步又会出现一个引战话题：HTTP 接口返回到底是全部返回 200 然后通过 code 来来判断，还是参考 http_code 进行返回?

“一把梭：REST API 全用 POST”

默认采用的 http_code !=200 才会认为发生了异常。

而这里的 http_status 也是参考了 Google 的 api 设计：
具体可以参考这个链接：
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());
        };
    }
}

通常这块代码也是放在基础包中。

实现原理

实现原理其实也比较简单，了解原理的话应该会知道，服务提供者返回的异常调用方是不可能接收到的，这和是否由一种语言实现也没关系。

毕竟两个进程之间的栈是完全不同的，不在一台服务器上，甚至都不在一个地区。

所以抛出异常后，消费者只能拿到一串报文，我们只能根据这段报文解析出其中的异常信息，然后再重新创建一个内部自定义的异常（比如这里的），也就是我们自定义异常解析器所干的事情。

code message 模式

由于 feign-plus 默认是采用的方式来抛出异常的，所以采用的方式响应数据将不会传递异常，依然会任务是一次正常调用。

不过基于该模式传递异常也是可以实现的，但没法做到统一，比如有些团队习惯表示异常，甚至字段都不是 code；再或者异常信息有些是放在 message 或 msg 字段中。

每个团队、个人习惯都不相同，所以没法抽象出一个标准，因此也就没做相关适配。

这也印证了使用国际标准所带来的好处。

限于篇幅，如果有相关需求的朋友也可以在评论区沟通，实现上会比现在稍微复杂一点点

编程笔记 » Feign 增强包 V2.0 升级版