喻轩Blog

菜单

YuXuan
发布于 2020-07-22 / 19 阅读
0

Feign远程调⽤组件

#Spring Cloud#Feign

之前用过服务消费者调⽤服务提供者的时候使⽤RestTemplate技术，存在几个不便之处：

  1. 拼接url
  2. restTemplate.getForObJect

这两处代码都⽐较模板化，能不能不写这种模板化的东⻄
另外来说，拼接url显得很low，拼接字符串，拼接参数，很low还容易出错

Feign简介

Feign是Netflix开发的⼀个轻量级RESTful的HTTP服务客户端（⽤它来发起请求，远程调⽤的），是以Java接⼝注解的⽅式调⽤Http请求，⽽不⽤像Java中通过封装HTTP请求报⽂的⽅式直接调⽤，Feign被⼴泛应⽤在Spring Cloud 的解决⽅案中。
类似于Dubbo，服务消费者拿到服务提供者的接⼝，然后像调⽤本地接⼝⽅法⼀样去调⽤，实际发出的是远程的请求。

  • Feign可帮助我们更加便捷，优雅的调⽤HTTP API（不需要我们去拼接url然后调⽤restTemplate的api），在SpringCloud中，使⽤Feign⾮常简单，创建⼀个接⼝（在消费者--服务调⽤⽅这⼀端），并在接⼝上添加⼀些注解，代码就完成了。
  • SpringCloud对Feign进⾏了增强，使Feign⽀持了SpringMVC注解（OpenFeign）

本质：封装了Http调⽤流程，更符合⾯向接⼝化的编程习惯，类似于Dubbo的服务调⽤（Dubbo的调⽤⽅式其实就是很好的⾯向接⼝编程）

Feign配置应⽤

在服务调⽤者⼯程（消费者）创建接⼝（添加注解）
效果：Feign = RestTemplate + Ribbon + Hystrix

  • 服务消费者⼯程中引⼊Feign依赖（或者⽗类⼯程）
<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
  • 服务消费者⼯程启动类使⽤注解@EnableFeignClients添加Feign⽀持
    注意： 此时去掉Hystrix熔断的⽀持注解@EnableCircuitBreaker以及引⼊的Hystrix依赖，因为Feign会⾃动引⼊
  • 创建Feign接⼝
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

// name：调⽤的服务名称，和服务提供者yml⽂件中spring.application.name保持⼀致
@FeignClient(name = "cloud-eureka-server")
public interface OrderFeignClient {
  // 调⽤的请求路径
  @RequestMapping(value = "/shop/order/{userId}", method = RequestMethod.GET)
  public Integer findOrder(@PathVariable(value = "userId") Long userId);
}

注意：

  1. @FeignClient注解的name属性⽤于指定要调⽤的服务提供者名称，和服务提供者yml⽂件中spring.application.name保持⼀致
  2. 接⼝中的接⼝⽅法，就好⽐是远程服务提供者Controller中的Hander⽅法（只不过如同本地调⽤了），那么在进⾏参数绑定的时，可以使⽤@PathVariable、@RequestParam、@RequestHeader等，这也是OpenFeign对SpringMVC注解的⽀持，但是需要注意value必须设置，否则会抛出异常
  • 使⽤接⼝中⽅法完成远程调⽤（注⼊接⼝即可，实际注⼊的是接⼝的实现）
@Autowired
private OrderFeignClient OrderFeignClient;

@Test
public void testFeignClient(){
  Integer order = OrderFeignClient.findOrder(1545132l);
  System.out.println("=======>>> order：" + order);
}

Feign对负载均衡的⽀持

Feign 本身已经集成了Ribbon依赖和⾃动配置，因此我们不需要额外引⼊依赖，可以通过 ribbon.xx 来进⾏全局配置,也可以通过 服务名.ribbon.xx 来对指定服务进⾏细节配置配置（参考之前，此处略）
Feign默认的请求处理超时时⻓1s，有时候业务确实执⾏的需要⼀定时间，那么这个时候，就需要调整请求处理超时时⻓，Feign⾃⼰有超时设置，如果配置Ribbon的超时，则会以Ribbon的为准

Ribbon设置

# 针对的被调⽤⽅微服务名称,不加就是全局⽣效
cloud-eureka-server:
  ribbon:
    # 请求连接超时时间
    ConnectTimeout: 2000
    # 请求处理超时时间
    ReadTimeout: 5000
    # 对所有操作都进⾏重试
    OkToRetryOnAllOperations: true
    # 根据如上配置，当访问到故障请求的时候，它会再尝试访问⼀次当前实例（次数由MaxAutoRetries配置），
    # 如果不⾏，就换⼀个实例进⾏访问，如果还不⾏，再换⼀次实例访问（更换次数由MaxAutoRetriesNextServer配置），
    # 如果依然不⾏，返回失败信息。

    # 对当前选中实例重试次数，不包括第⼀次调⽤
    MaxAutoRetries: 0 
    # 切换实例的重试次数
    MaxAutoRetriesNextServer: 0 
    # 负载策略调整
    NFLoadBalancerRuleClassName: com.netflix.loadbalancer.RoundRobinRule

这些配置对Feign生效，对RestTemplate是不生效的。

Feign对熔断器的⽀持

  1. 在Feign客户端（服务消费端）⼯程配置⽂件（application.yml）中开启Feign对熔断器的⽀持
# 开启Feign的熔断功能
feign:
  hystrix:
    enabled: true

Feign的超时时⻓设置，其实就上⾯Ribbon的超时时⻓设置
Hystrix超时设置（按照之前Hystrix设置的⽅式设置）
注意：

  1. 开启Hystrix之后，Feign中的⽅法都会被管理，⼀旦出现问题就进⼊对应的回退逻辑处理
    注意：针对超时这⼀点，当前有两个超时时间设置（Feign/hystrix），熔断的时候是根据这两个时间的最⼩值来进⾏的，即处理时⻓超过最短的那个超时时间，就熔断进⼊回退降级逻辑
hystrix:
  command:
    default:
      execution:
        isolation:
          thread:
            # Hystrix的超时时⻓设置
            timeoutInMilliseconds: 15000
  1. ⾃定义FallBack处理类（需要实现FeignClient接⼝）
package com.cloud.controller.service;

import org.springframework.stereotype.Component;

/*
 * 降级回退逻辑需要定义⼀个类，实现FeignClient接⼝，实现接⼝中的⽅法
 */
// 别忘了这个注解，还应该被扫描到
@Component
public class OrderFallback implements OrderFeignClient {
  @Override
  public Integer findOrder(Long userId) {
    return -6;
  }
}
  1. 在@FeignClient注解中关联第2步中⾃定义的处理类
// 使⽤fallback的时候，类上的@RequestMapping的url前缀限定，改成配置在@FeignClient的path属性中
@FeignClient(value = "cloud-eureka-server", fallback = OrderFallback.class, path = "/shop") 
//@RequestMapping("/shop")
public interface OrderFeignClient {

}

Feign对请求压缩和响应压缩的⽀持

Feign ⽀持对请求和响应进⾏GZIP压缩，以减少通信过程中的性能损耗，但是全部压缩会极度占用cpu资源。通过下⾯的参数，即可开启请求与响应的压缩功能：

feign:
  compression:
    request:
      # 开启请求压缩
      enabled: true 
      # 设置压缩的数据类型，此处也是默认值
      mime-types: text/html,application/xml,application/json 
      # 设置触发压缩的⼤⼩下限，此处也是默认值
      min-request-size: 2048 
    response:
      # 开启响应压缩
      enabled: true

Feign的⽇志级别配置

Feign是http请求客户端，类似于咱们的浏览器，它在请求和接收响应的时候，可以打印出⽐较详细的⼀些⽇志信息（响应头，状态码等等）。
如果我们想看到Feign请求时的⽇志，我们可以进⾏配置，默认情况下Feign的⽇志没有开启。

  1. 开启Feign⽇志功能及级别
// Feign的⽇志级别（Feign请求过程信息）
// NONE：默认的，不显示任何⽇志----性能最好
// BASIC：仅记录请求⽅法、URL、响应状态码以及执⾏时间----⽣产问题追踪
// HEADERS：在BASIC级别的基础上，记录请求和响应的header
// FULL：记录请求和响应的header、body和元数据----适⽤于开发及测试环境定位问题
@Configuration
public class FeignConfig {
  @Bean
  Logger.Level feignLevel() {
    return Logger.Level.FULL;
  }
}
  1. 配置log⽇志级别为debug
logging:
  level:
    # Feign⽇志只会对⽇志级别为debug的做出响应(FeignClient的全限定类名)
    com.cloud.controller.service.ResumeServiceFeignClient: debug

Feign核⼼源码剖析

只定义了接⼝，添加上@FeignClient，真的没有实现的话，是不能完成远程请求的，那么它很有可能是做了代理了。

  1. 先在findOrder方法内打个断点，发现OrderFeignClient确实是代理对象。并且它的增强是FeignInvocationHandler。
    image.png
    image.png
  2. 从@EnableFeignClients正向切⼊
    image.png
    image.png
    image.png
    image.png
    image.png
    接下来，我们主要追踪下另外⼀⾏主要的代码registerFeignClients(metadata, registry);
    image.png
    图片
    注册客户端，给每⼀个客户端⽣成代理对象
    image.png
    下⼀步，关注FeignClientFactoryBean这个⼯⼚Bean的getObject⽅法，这个⽅法会返回我们的代理对象（FeignClientFactoryBean.getObject）
    image.png
    image.png
    image.png
    org.springframework.cloud.openfeign.HystrixTargeter#target
    image.png
    图片
    image.png
  • 请求进来时候，是进⼊增强逻辑的，所以接下来我们要关注增强逻辑部分，FeignInvocationHandler
    image.png
    SynchronousMethodHandler#invoke
    image.png
    image.png
    image.png
    AbstractLoadBalancerAwareClient#executeWithLoadBalancer()
    image.png
    进⼊submit⽅法，我们进⼀步就会发现使⽤Ribbon在做负载均衡了
    image.png
    image.png
    image.png
    最终请求的发起使⽤的是HttpURLConnection
    image.png
GateWay⽹关组件
Hystrix熔断器