openfeign技术分享

简介: Feign是Netflix开发的声明式,模板化的HTTP客户端,其灵感来自Retrofit,JAXRS-2.0以及WebSocket.Feign可帮助我们更加便捷,优雅的调用HTTP API。 在SpringCloud中,使用Feign非常简单——创建一个接口,并在接口上添加一些注解,代码就完成了。Feign支持多种注解,例如Feign自带的注解或者JAX-RS注解等。SpringCloud对Feign进行了增强,使Feign支持了SpringMVC注解,并整合了Ribbon和Eureka,从而让Feign的使用更加方便。

一、feign概述



前面我们使用的RestTemplate实现REST API调用,代码大致如下:


@GetMapping("/buy/{id}")
public Product order() {
    Product product = restTemplate.getForObject("http://shop-serviceproduct/product/1", Product.class);
    return product; }


由代码可知,我们是使用拼接字符串的方式构造URL的,该URL只有一个参数。但是,在现实中,URL中往往含有多个参数。这时候我们如果还用这种方式构造URL,那么就会非常痛苦。


1.1 Feign简介


Feign是Netflix开发的声明式,模板化的HTTP客户端,其灵感来自Retrofit,JAXRS-2.0以及WebSocket.


Feign可帮助我们更加便捷,优雅的调用HTTP API。 在SpringCloud中,使用Feign非常简单——创建一个接口,并在接口上添加一些注解,代码就完成了。


Feign支持多种注解,例如Feign自带的注解或者JAX-RS注解等。


SpringCloud对Feign进行了增强,使Feign支持了SpringMVC注解,并整合了Ribbon和Eureka,

从而让Feign的使用更加方便。


1.2 基于Feign的服务调用


(1)引入依赖


在服务消费者 shop_service_order 添加Fegin依赖


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


(2)启动类添加Feign的支持

@SpringBootApplication(scanBasePackages="cn.itcast.order")
@EntityScan("cn.itcast.entity")
@EnableFeignClients
public class OrderApplication {
public static void main(String[] args) {
SpringApplication.run(OrderApplication.class, args);
 }
}


通过@EnableFeignClients注解开启Spring Cloud Feign的支持功能


(3)启动类激活FeignClient


创建一个Feign接口,此接口是在Feign中调用微服务的核心接口


在服务消费者 shop_service_order 添加一个 ProductFeginClient 接口


//指定需要调用的微服务名称 
@FeignClient(name="shop-service-product") 
public interface ProductFeginClient { 
  //调用的请求路径 
  @RequestMapping(value = "/product/{id}",method = RequestMethod.GET) 
  public Product findById(@PathVariable("id") Long id); 
}


  • 定义各参数绑定时,@PathVariable、@RequestParam、@RequestHeader等可以指定参数属性,在Feign中绑定参数必须通过value属性来指明具体的参数名,不然会抛出异常
  • @FeignClient:注解通过name指定需要调用的微服务的名称,用于创建Ribbon的负载均衡器。所以Ribbon会把 shop-service-product 解析为注册中心的服务。


(4)配置请求提供者的调用接口


修改 OrderController ,添加ProductFeginClient的自动注入,并在order方法中使用ProductFeginClient 完成微服务调用


@RestController 
@RequestMapping("/order") 
public class OrderController { 
  @Autowired 
  private ProductFeginClient productFeginClient; 
  @GetMapping("/buy/{id}") 
  public Product order(@PathVariable Long id) { 
    return productFeginClient.findById(id); 
  } 
} 


(5)测试效果


  成功调用~不放截图了,电脑太卡了


1.3 Feign和Ribbon的联系


Ribbon是一个基于 HTTP 和 TCP 客户端 的负载均衡的工具。它可以 在客户端 配置


RibbonServerList(服务端列表),使用 HttpClient 或 RestTemplate 模拟http请求,步骤相当繁琐。

Feign 是在 Ribbon的基础上进行了一次改进,是一个使用起来更加方便的 HTTP 客户端。采用接口的方式, 只需要创建一个接口,然后在上面添加注解即可 ,将需要调用的其他服务的方法定义成抽象方法即可, 不需要自己构建http请求。然后就像是调用自身工程的方法调用,而感觉不到是调用远程方法,使得编写客户端变得非常容易


1.4 负载均衡


Feign中本身已经集成了Ribbon依赖和自动配置,因此我们不需要额外引入依赖,也不需要再注册

RestTemplate 对象。另外,我们可以像上节课中讲的那样去配置Ribbon,可以通过 ribbon.xx 来进

行全局配置。也可以通过 服务名.ribbon.xx 来对指定服务配置:


feign:
  client:
    config:
      ##定义FeginClient的名称
      service-product:
        #相当于Request.Options
        connect-timeout: 5000
        #相当于Request.Options
        readTimeout: 5000
        #配置Feign的日志级别,相当于代码配置方式中的Logger
        loggerLevel: full
        #Feign的错误解码器,相当于代码配置方式中的ErrorDecoder
        errorDecoder: com.example.SimpleErrorDecoder
        #配置重试,相当于代码配置方式中的Retryer
        retryer: com.example.SimpleRetryer
        #配置拦截器,相当于代码配置方式中的RequestInterceptor
        requestInterceptors:
          -com.example.FooRequestInterceptor
          -com.example.BarRequestInterceptor
        decode404: false


启动两个 shop_service_product ,重新测试可以发现使用Ribbon的轮询策略进行负载均衡。


二、Feign进阶


2.1Feign的配置


从SpringCloudEdgware开始,Feign支持使用属性自定义Feign。对于一个指定名称的Feign Client(例如该FeignClient的名称为feignName),Feign支持如下配置项:


feign:
  client:
    config:
      service-product:
        #相当于Request.Options
        connect-timeout: 5000
        #相当于Request.Options
        readTimeout: 5000
        #配置Feign的日志级别,相当于代码配置方式中的Logger
        loggerLevel: full
        #Feign的错误解码器,相当于代码配置方式中的ErrorDecoder
        errorDecoder: com.example.SimpleErrorDecoder
        #配置重试,相当于代码配置方式中的Retryer
        retryer: com.example.SimpleRetryer
        #配置拦截器,相当于代码配置方式中的RequestInterceptor
        requestInterceptors:
          -com.example.FooRequestInterceptor
          -com.example.BarRequestInterceptor
        decode404: false


  • feignName:FeginClient的名称
  • connectTimeout:建立链接的超时时长readTimeout:读取超时时长
  • loggerLevel:Fegin的日志级别
  • errorDecoder:Feign的错误解码器
  • retryer:配置重试
  • requestInterceptors:添加请求拦截器decode404:配置熔断不处理404异常


2.2请求压缩


SpringCloudFeign支持对请求和响应进行GZIP压缩,以减少通信过程中的性能损耗。通过下面的参数即可开启请求与响应的压缩功能:


feign:
  compression:
    request:
      # 开启请求压缩
      enabled: true
    response:
      # 开启响应压缩
      enabled: true


同时,我们也可以对请求的数据类型,以及触发压缩的大小下限进行设置:


feign:
  compression:
    request:
      # 开启请求压缩
      enabled: true
      #设置压缩的数据类型
      mime-types: text/html,application/xml,application/json
      #设置触发压缩的大小下限
      min-request-size: 2048


注:上面的数据类型、压缩大小下限均为默认值。


2.3日志级别


在开发或者运行阶段往往希望看到Feign请求过程的日志记录,默认情况下Feign的日志是没有开启的。要想用属性配置方式来达到日志效果,只需在application.yml中添加如下内容即可:


feign:
  client:
    config:
      service-product:
        # 相当于Request.Options
        connect-timeout: 5000
        # 相当于Request.Options
        readTimeout: 5000
        # 配置Feign的日志级别,相当于代码配置方式中的Logger
        loggerLevel: full
logging:
  level:
    # Feign日志只会对日志级别为debug的做出响应
    cn.itcast.order.fegin.ProductFeginClient: debug


feign.client.config.shop-service-product.loggerLevel:配置Feign的日志Feign有四种日志级别:


  • NONE【性能最佳,适用于生产】:不记录任何日志(默认值)
  • BASIC【适用于生产环境追踪问题】:仅记录请求方法、URL、响应状态代码以及执行时间
  • HEADERS:记录BASIC级别的基础上,记录请求和响应的header。
  • FULL【比较适用于开发及测试环境定位问题】:记录请求和响应的header、body和元数据。
相关实践学习
部署高可用架构
本场景主要介绍如何使用云服务器ECS、负载均衡SLB、云数据库RDS和数据传输服务产品来部署多可用区高可用架构。
负载均衡入门与产品使用指南
负载均衡(Server Load Balancer)是对多台云服务器进行流量分发的负载均衡服务,可以通过流量分发扩展应用系统对外的服务能力,通过消除单点故障提升应用系统的可用性。 本课程主要介绍负载均衡的相关技术以及阿里云负载均衡产品的使用方法。
相关文章
|
7月前
|
Kubernetes Cloud Native Java
重磅!程序员都在学的Spring实战(第6版),你竟然还没有掌握?
不知不觉已经年底了,可能很多程序员还在迷茫阶段,不知道该如何学习进步。 也因为疫情的缘故,都阳了!也可能因为被裁了,在家里面待着,除了刷剧就是看视频、玩游戏,也就都默默躺平了..... 殊不知,你该起来学习了,在躺平下去就真的废了,没有经济来源,没有工作,也就赶不上明年金三银四招聘旺季。
|
12月前
|
负载均衡 监控 算法
探秘SpringCloud系列《序篇:SpringCloud江湖简介》
探秘SpringCloud系列《序篇:SpringCloud江湖简介》
64 0
|
运维 监控 前端开发
竟然开源,万人围观,spring-cloud详细解说
竟然开源,万人围观,spring-cloud详细解说
153 0
|
消息中间件 Cloud Native Java
RocketMQ-Spring 毕业两周年,为什么能成为 Spring 生态中最受欢迎的 messaging 实现?
2019 年 1 月,孵化 6 个月的 RocketMQ-Spring 作为 Apache RocketMQ 的子项目正式毕业,发布了第一个 Release 版本 2.0.1。该项目是把 RocketMQ 的客户端使用 Spring Boot 的方式进行了封装,可以让用户通过简单的 annotation 和标准的 Spring Messaging API 编写代码来进行消息的发送和消费。当时 RocketMQ 社区同学请 Spring 社区的同学对 RocketMQ-Spring 代码进行 review,引出一段罗美琪(RocketMQ)和春波特(Spring Boot)的故事。
161 0
 RocketMQ-Spring 毕业两周年,为什么能成为 Spring 生态中最受欢迎的 messaging 实现?
|
负载均衡 Java 微服务
Feign讲解与应用(文末送书)
Feign讲解与应用(文末送书)
133 0
Feign讲解与应用(文末送书)
|
缓存 Java API
SpringCloud升级之路2020.0.x版-25.OpenFeign简介与使用
SpringCloud升级之路2020.0.x版-25.OpenFeign简介与使用
SpringCloud升级之路2020.0.x版-25.OpenFeign简介与使用
|
负载均衡 算法 网络协议
ribbon技术分享
Ribbon是 Netflixfa 发布的一个负载均衡器,有助于控制 HTTP 和 TCP客户端行为。在 SpringCloud 中,Eureka一般配合Ribbon进行使用,Ribbon提供了客户端负载均衡的功能,Ribbon利用从Eureka中读取到的服务信息,在调用服务节点提供的服务时,会合理的进行负载。 在SpringCloud中可以将注册中心和Ribbon配合使用,Ribbon自动的从注册中心中获取服务提供者的列表信息,并基于内置的负载均衡算法,请求服务。
123 0
|
设计模式 监控 Java
Hystrix技术分享
在微服务架构中,一个请求需要调用多个服务是非常常见的。如客户端访问A服务,而A服务需要调用B服务,B服务需要调用C服务,由于网络原因或者自身的原因,如果B服务或者C服务不能及时响应,A服务将处于阻塞状态,直到B服务C服务响应。此时若有大量的请求涌入,容器的线程资源会被消耗完毕,导致服务瘫痪。服务与服务之间的依赖性,故障会传播,造成连锁反应,会对整个微服务系统造成灾难性的严重后果,这就是服务故障的“雪崩”效应。
160 0
Hystrix技术分享
|
监控 负载均衡 Dubbo
Dubbo技术分享
Dubbo是Alibaba开源的分布式服务框架,它最大的特点是按照分层的方式来架构,使用这种方式可以使各个层之间解耦合(或者最大限度地松耦合)。从服务模型的角度来看,Dubbo采用的是一种非常简单的模型,要么是提供方提供服务,要么是消费方消费服务,所以基于这一点可以抽象出服务提供方(Provider)和服务消费方(Consumer)两个角色。关于注册中心、协议支持、服务监控等内容,详见后面描述。
197 0
Dubbo技术分享
|
消息中间件 存储 负载均衡
我的新书《Spring Cloud实战》预告
我的新书《Spring Cloud实战》预告
115 0