「springcloud 2021 系列」openfeign结合nacos进行声明式服务调用

源码地址：https://github.com/langyastudio/langya-tech/tree/master/spring-cloud

从 SpringCloud 2020 版本开始 ribbon 默认被 移除，替代品为 spring-cloud-loadbalancer

工作流程

openFeign 服务调用（spring cloud 2020 开始使用 spring-cloud-loadbalancer 作为负载均衡组件）

如何接入

通过修改官方示例 nacos-discovery-consumer-example 来演示服务发现的功能

使用 FeignClient 作为服务调用方的客户端

引入依赖

<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-loadbalancer</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

openFeign

FeignClient 已经默认集成了 Ribbon 或者 spring-cloud-loadbalancer（spring cloud 2020），此处演示如何配置一个 FeignClient

Ribbon（老版本）：openfeign 中 ribbon 默认负载算法为轮询、默认重试机制为当前请求实例 重试1次

@FeignClient(name = "nacos-discovery-provider")
public interface EchoService
{
    @GetMapping("/echo/{str}")
    String echo(@PathVariable("str") String str);

    @GetMapping("/divide")
    String divide(@RequestParam("a") Integer a, @RequestParam("b") Integer b);
}

• 使用 @FeignClient 注解将 EchoService 这个接口包装成一个 FeignClient
  • name 与 value 相同，name 属性会作为微服务的名称，用于服务发现。属性 name 对应服务名 nacos-discovery-provider
  • url: 一般用于调试，可以手动指定 @FeignClient 调用的地址
  • fallback: 定义容错的处理类，当调用远程接口失败或超时时，会调用对应接口的容错逻辑，fallback 指定的类必须实现 @FeignClient 标记的接口
  • configuration: Feign 配置类，可以自定义 Feign 的 Encoder、Decoder、LogLevel、Contract
  • fallbackFactory: 工厂类，用于生成 fallback 类示例，通过这个属性我们可以实现每个接口通用的容错逻辑，减少重复的代码
• echo 方法上的 @RequestMapping 注解将 echo 方法与 URL “/echo/{str}” 相对应，@PathVariable 注解将 URL 路径中的 {str} 对应成 echo 方法的参数 str

测试代码

完成以上配置后，将两者自动注入到 TestController 中

 @RestController
 public class TestController { 
     @Autowired
     private EchoService echoService; 

     @GetMapping(value = "/echo-feign/{str}")
     public String feign(@PathVariable String str) {
         return echoService.echo(str);
     }
 }

再配置 nacos 与端口即可

服务启动

启动应用，支持 IDE 直接启动和编译打包后启动。

多次调用接口： http://127.0.0.1:18091/echo-feign/12345 可以看到浏览器显示 nacos-discovery-provider 返回的消息 “hello Nacos Discovery 1234”，证明服务发现生效

可以发现两个 nacos-discovery-provider 的控制台交替打印如下信息（负载均衡生效）：

2022-01-04 19:26:08.643  INFO 16516 --- [io-18082-exec-4] c.l.c.c.EchoController                   : 1234

异常处理

当 feign 调用结果为非 200 的响应码时就触发了 Feign 的异常解析，Feign 的异常解析器会将其包装成 FeignException，即在我们业务异常的基础上再包装一次。

很显然，这个包装后的异常我们并不需要，我们应该直接将捕获到的生产者的业务异常直接抛给前端，只需要重写 Feign的异常解析器，重新实现 decode 逻辑，返回正常的 Exception 即可，而后全局异常拦截器又会捕获 Exception

重写 Feign 异常解析器

@Log4j2
public class OpenFeignErrorDecoder implements ErrorDecoder
{
    /**
     * Feign 异常解析
     */
    @Override
    public Exception decode(String methodKey, Response response)
    {
        log.error("feign client error,response is {}:", response);
        try
        {
            //获取数据
            String body = Util.toString(response.body().asReader(Charset.defaultCharset()));

            ResultInfo<?> resultData = JSON.parseObject(body, ResultInfo.class);
            if (!resultData.isSuccess())
            {
                return new MyException(resultData.getStatus(), resultData.getMessage());
            }

        }
        catch (IOException e)
        {
            e.printStackTrace();
        }

        return new MyException("Feign client 调用异常");
    }
}

在 Feign 配置文件中注入自定义的异常解码器

@ConditionalOnClass(Feign.class)
@Configuration
public class OpenFeignConfig {  
    /**
      * 自定义异常解码器
      */
    @Bean
    public ErrorDecoder errorDecoder()
    {
        return new OpenFeignErrorDecoder();
    }
}

参考

Nacos 官方文档

spring-cloud-feign 官方文档

nacos-example/nacos-discovery-example

Openfeign与Ribbon

使用Feign的一些问题以及如何解决

Feign传递Access_Token