openfeign技术分享

本文涉及的产品
应用型负载均衡 ALB,每月750个小时 15LCU
传统型负载均衡 CLB,每月750个小时 15LCU
网络型负载均衡 NLB,每月750个小时 15LCU
简介: 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和元数据。
相关实践学习
小试牛刀,一键部署电商商城
SAE 仅需一键,极速部署一个微服务电商商城,体验 Serverless 带给您的全托管体验,一起来部署吧!
负载均衡入门与产品使用指南
负载均衡(Server Load Balancer)是对多台云服务器进行流量分发的负载均衡服务,可以通过流量分发扩展应用系统对外的服务能力,通过消除单点故障提升应用系统的可用性。 本课程主要介绍负载均衡的相关技术以及阿里云负载均衡产品的使用方法。
相关文章
|
Java Maven Docker
java 音频转为wav格式标准音频 | Java工具类
java 音频转为wav格式标准音频 | Java工具类
java 音频转为wav格式标准音频 | Java工具类
|
Kubernetes 关系型数据库 MySQL
seata启动问题之指针异常如何解决
Seata是一款开源的分布式事务解决方案,旨在提供高效且无缝的分布式事务服务;在集成和使用Seata过程中,开发者可能会遇到不同的异常问题,本合集针对Seata常见异常进行系统整理,为开发者提供详细的问题分析和解决方案,助力高效解决分布式事务中的难题。
543 79
|
8月前
|
存储 安全 Java
如何确保 CSRF 令牌的安全性
CSRF 令牌是保护网站免受跨站请求伪造攻击的重要机制。为确保其安全性,需采取措施如:使用Https协议、设置HttpOnly和Secure标志、采用同源策略、定期更新令牌等。
|
11月前
|
JSON API 开发者
淘宝商品销量数据接口:获取与利用全攻略
淘宝商品销量数据接口让开发者获取平台上商品的销量信息。首先,需在开放平台注册并创建应用;随后获取API密钥(appkey与appsecret),用于身份验证。参考官方文档了解接口详情,通过HTTP请求调用接口并设置参数如商品ID。接口返回JSON格式数据,需用编程语言解析提取销量数据。示例代码展示了如何使用Python和requests库调用接口及打印结果。使用时应遵守规定,避免违规行为,并关注接口更新。若无开发能力,可选用第三方服务但需谨慎评估。
|
12月前
|
SQL 监控 druid
MySQL连接池DataSource怎么使用?
**摘要:** 本文探讨了数据库连接池在高并发Web应用中的重要性,特别聚焦于阿里巴巴的DruidDataSource。DruidDataSource是一个高效的Java数据库连接池,包含监控、SQL防护和日志功能。文中通过示例展示了如何配置和使用DruidDataSource,包括在Java应用中的直接配置和在Spring Boot中的集成,并提到了启用SQL监控。此外,还分享了设置连接池参数的技巧,如合理设定初始、最大和最小连接数,并强调了定期监控和使用内置监控工具优化性能的重要性。
570 0
|
11月前
|
jenkins Java 测试技术
Jenkins 在持续集成/持续交付(CI/CD)管道中的应用
【8月更文第31天】 在现代软件开发过程中,持续集成(Continuous Integration, CI)和持续交付(Continuous Delivery, CD)已经成为提升开发效率和软件质量的重要实践。Jenkins 是一个广泛使用的开源工具,它能够帮助团队实现自动化构建、测试和部署,是 CI/CD 流水线的核心组件之一。本文将详细介绍 Jenkins 在 CI/CD 管道中的应用,并提供具体的代码示例。
417 0
|
机器学习/深度学习 自然语言处理 PyTorch
[ELMo]论文实现:Deep contextualized word representations
[ELMo]论文实现:Deep contextualized word representations
128 1
|
11月前
|
Kubernetes 监控 Shell
在K8S中,我们公司用户反应pod连接数非常多,希望看一下这些连接都是什么信息?什么状态?怎么排查?容器里面没有集成bash环境、网络工具,怎么处理?
在K8S中,我们公司用户反应pod连接数非常多,希望看一下这些连接都是什么信息?什么状态?怎么排查?容器里面没有集成bash环境、网络工具,怎么处理?
|
Go 数据安全/隐私保护 iOS开发
Mac系统重装指南(不抹盘):2023版保姆级教程,轻松解决macOS问题并保留数据和软件
Mac系统重装指南(不抹盘):2023版保姆级教程,轻松解决macOS问题并保留数据和软件
669 0
Xmind2022最新版破解与激活教程,操作简单
Xmind 是一款 全功能 的思维导图和头脑风暴软件。像大脑的瑞士军刀一般,助你理清思路,捕捉创意。
3917 0

热门文章

最新文章