SpringCloud H版 OpenFeign客户端讲解

Posted 2022-01-07 小毕超

一、OpenFeign客户端

Feign是一个声明式客户端调用。它的使用方法是定义一个服务接口然后在上面添加SpringMVC的注解即可。Feign也支持可拔插式的编码器和解码器。Spring Cloud对Feign进行了封装，使其支持了Spring MVC标准注解和HttpMessageConverters。Feign可以与Eureka和Ribbon组合使用以支持负载均衡

上篇文章中，我们讲解了ribbon的使用及如何修改负载算法，在前面的章节中，客户端调用都是基于RestTemplate来实现的，每次都要使用RestTemplate的Api进行调用，当服务增多时，势必不利于我们对服务调用的管理，那本篇就来介绍下OpenFeign的使用，OpenFeign是封装的feign，让我们可以类似于声明接口的方式来声明远程服务，极大便于客户端对服务的声明和管理。

上篇博客地址：https://blog.csdn.net/qq_43692950/article/details/121991392

并且在Feign的实现下，我们只需创建一个接口并使用注解的方式来配置它(以前是Dao接口上面标注Mapper注解,现在是一个微服务接口上面标注一个Feign注解即可)，即可完成对服务提供方的接口绑定，简化了使用Spring cloud Ribbon时，自动封装服务调用客户端的开发量。

并且利用Ribbon维护了Payment的服务列表信息，并且通过轮询实现了客户端的负载均衡。而与Ribbon不同的是，通过feign只需要定义服务绑定接口且以声明式的方法，优雅而简单的实现了服务调用

二、OpenFeign的使用

在前面的文章中，我们已经搭建了服务提供者provider，现在我们在服务消费者端使用OpenFeign来调用相关服务，先来看下provider 所提供的服务：

@RestController
public class ProviderController 

    @Value("$server.port")
    private String port;

    @GetMapping("/getData")
    public ResponseTemplate providerData() 

        return ResSuccessTemplate.builder().data("come from : " + port).build();
    

    @GetMapping("/getTimeData")
    public ResponseTemplate getTimeData() throws InterruptedException 
        TimeUnit.SECONDS.sleep(5);
        return ResSuccessTemplate.builder().data("come from : " + port).build();
    

下面在服务消费者端我们先来进行OpenFeign的整合：

在pom中添加依赖：

<!--openfeign-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

主启动类中开启FeignClients

如果不添加@EnableFeignClients注解，声明出的feign接口将注入失败。

@SpringBootApplication
@EnableDiscoveryClient
@EnableFeignClients
public class ConsulConsumerApplication 
    public static void main(String[] args) 
        SpringApplication.run(ConsulConsumerApplication.class, args);
    

编写provider 的feign声明：

@Component
@FeignClient(value = "provider")
public interface ProviderFeignService 
    @GetMapping("/getData")
    public ResSuccessTemplate providerData();

    @GetMapping("/getTimeData")
    public ResSuccessTemplate getTimeData();

这里的注解正好对应上面提供者所使用的注解。

编写测试接口，测试feign

@RestController
@RequestMapping("/feign/consumer")
public class FeignController 
    @Autowired
    ProviderFeignService providerFeignService;

    @GetMapping("/getData")
    public ResponseTemplate getData() 
        ResponseTemplate responseTemplate = providerFeignService.providerData();
        return responseTemplate;
    

    @GetMapping("/getTimeData")
    public ResponseTemplate getTimeData() 
        ResponseTemplate responseTemplate = providerFeignService.getTimeData();
        return responseTemplate;
    

下面在浏览器端输入 http://localhost:8080/feign/consumer/getData 我的服务消费者端口为8080：

我提供者端启动了两个服务，端口为8091和8092，从上面就看出了已经和前面文章演示的结果相同了，但是在声明服务上借助feign已经让调用服务更简化。

三、OpenFeign的默认超时时间

上面我们已经使用OpenFeign调用到了提供者所提供的服务，从上面我们写的接口可以看出，还有一个接口没有调用，那就是 getTimeData 这个接口，这个接口在服务提供者端做了5秒的延时，用来模式耗时的接口，下面我们在浏览器调用下消费者端的 getTimeData 接口。
调用http://localhost:8080/feign/consumer/getTimeData

可以看到服务500报错了，看下日志错误原因：

是接口请求超时，这里其实OpenFeign的默认等待时间为1秒的时长，可能我们有些服务处理时间要大于1秒，或者并发请求量大时，等待时间也可能超过1秒的时间，这样就会造成服务明明正常，客户端确得到了错误的反馈，因此在使用OpenFeign时，一定要设置OpenFeign的等待时长：

配置文件中添加：

ribbon:
  #指的是建立连接所用的时间，适用于网络状况正常的情况下,两端连接所用的时间
  ReadTimeout: 6000
  #指的是建立连接后从服务器读取到可用资源所用的时间
  ConnectTimeout: 6000

再次请求上面的接口：

已经拿到返回了。

四、OpenFeign的服务降级

从上面这个问题我们应该能看出一些问题，服务调用失败直接返回500给客户端肯定不合适的，在任何情况下，我们都不能确保每次的服务调用都肯定都能正确连接到提供端，有可能因为网络震荡造成调用失败，哪这种情况我们就报错给客户吗，是不是应该有备选方案来解决，当当用失败，就走备选的返回，那就事服务降级了，服务降级这快我们后面会在讲hystrix的时候详细讲解，但现在也要理解什么事服务降级，就可以理解为服务的备选方案。

OpenFeign的服务降级也已经很简单了，只需实现Feign的声明接口，并在@FeignClient的注解中指定fallback为实现类即可：

• 先在配置文件中开启 feign 的服务保护功能

feign:
  hystrix:
    enabled: true

新增 ProviderFeignServiceFallBack 实现 ProviderFeignService

@Component
public class ProviderFeignServiceFallBack implements ProviderFeignService 
    @Override
    public ResSuccessTemplate providerData() 
        return ResSuccessTemplate.builder().code(400).message("服务降级处理").build();
    

    @Override
    public ResSuccessTemplate getTimeData() 
        return ResSuccessTemplate.builder().code(400).message("服务降级处理").build();
    

修改 ProviderFeignService：

@Component
@FeignClient(value= "provider",  fallback = ProviderFeignServiceFallBack.class)
public interface ProviderFeignService 
    @GetMapping("/getData")
    public ResSuccessTemplate providerData();

    @GetMapping("/getTimeData")
    public ResSuccessTemplate getTimeData();

把上面的服务超时配置，我们修改为1秒，故意让接口超时报错，看下接口的返回，浏览器调用http://localhost:8080/feign/consumer/getTimeData

这样就不会出现一个500给人一个不好的感觉了。关于服务保护的内容会在hystrix的文章中详细介绍。

五、OpenFeign的日志打印

上面我们演示了OpenFeign的使用，但是我们应该也发现了一个问题，控制台没有任何打印信息，我们想知道接口中具体怎么调用的怎么看呢，这里就可以开启openfeign 的日志打印功能了。

• 添加配置类

@Configuration
public class FeignConfig 
    @Bean
    Logger.Level feignLoggerLevel() 
        return Logger.Level.FULL;
    

可选有：

NONE：默认的，不显示任何日志；

BASIC：仅记录请求方法、URL、响应状态码及执行时间；

HEADERS：除了 BASIC 中定义的信息之外，还有请求和响应的头信息；

FULL：除了 HEADERS 中定义的信息之外，还有请求和响应的正文及元数据。

• 配置文件中添加

logging:
  level:
    # feign日志以什么级别监控哪个接口
    com.bxc.consumer.controller.feignTemplateDemo.feignservice.*: debug

com.bxc.consumer.controller.feignTemplateDemo.feignservice 表示你的feign声明的接口包名路径

下面重启消费者，再次请求接口，查看控制台日志：


喜欢的小伙伴可以关注我的个人微信公众号，获取更多学习资料！