SpringCloud Alibaba - HTTP 客户端 OpenFeign 、自定义配置、优化、最佳实践

这篇具有很好参考价值的文章主要介绍了SpringCloud Alibaba - HTTP 客户端 OpenFeign 、自定义配置、优化、最佳实践。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

目录

一、OpenFeign 是什么,有什么用呢?

二、OpenFeign 客户端的使用

2.1、远程调用

1.引入依赖

2.在order-service(发起远程调用的微服务)的启动类添加注解开启Feign的功能

3.编写 OpenFeign 客户端

4.通过 OpenFeign 客户端发起远程调用

2.2、自定义 OpenFeign 配置

1.配置文件方式

2.java代码方式

2.3、Feign 的性能优化

1.引入依赖

2.配置连接池

2.4、Feign 的最佳实践

1.方式一:给消费者的FeignClient和提供者的controller定义统一的父接口作为标准。

2.方式二(推荐):将FeignClient抽取为独立模块,并且把接口有关的POJO(实体类)、默认的Feign配置都放到这个模块中,提供给所有消费者使用


一、OpenFeign 是什么,有什么用呢?


以往我们是通过 RestTemplate 发起远程调用,如下

feign客户端,SpringCloud & Alibaba,spring cloud,http,spring

存在问题如下:

  • 代码可读性差,编程体验不统一
  • 参数复杂URL难以维护

Feign  是一个声明式的 http 客户端,其作用就是用来把我们解决上述问题的~

二、OpenFeign 客户端的使用


2.1、远程调用

主要分为以下步骤:

1.引入依赖

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

注意:由于SpringCloud Feign高版本(例如 2020.1.0)不使用Ribbon而是使用spring-cloud-loadbalancer,所以需要引用spring-cloud-loadbalancer或者降版本

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

2.order-service(发起远程调用的微服务)的启动类添加注解开启Feign的功能

feign客户端,SpringCloud &amp; Alibaba,spring cloud,http,spring

3.编写 OpenFeign 客户端

主要是基于SpringMVC的注解来声明远程调用的信息,比如:

  • 服务名称:userservice
  • 请求方式:GET
  • 请求路径:/user/{id}
  • 请求参数:Long id
  • 返回值类型:User
import cn.itcast.order.pojo.User;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.stereotype.Component;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;

@Component
@FeignClient("userservice")
public interface UserClients {

    @GetMapping("/user/{id}")
    User findById(@PathVariable("id") Long id);

}

如果是高版本的 SpringCloud,那么就需要使用 SpringCloud LoadBalencer 做负载均衡(也比较建议).

具体的添加@LoadBalancerClient注解:在调用服务的Service类上添加@LoadBalancerClient注解,并指定服务名。这样,负载均衡器将根据配置的属性来选择合适的服务实例进行调用。例如:

如下:

@FeignClient(value = "service-name", configuration = LoadBalancerClientConfiguration.class) 
public interface MyService {  
    @LoadBalanced  //启用负载均衡
    @GetMapping("/endpoint")  
    String getEndpointData();  
}

4.通过 OpenFeign 客户端发起远程调用

feign客户端,SpringCloud &amp; Alibaba,spring cloud,http,spring

用 Feign 来代替 RestTemplate 是不是十分优雅~

2.2、自定义 OpenFeign 配置

2.2.1、超时时间

Ps:OpenFeign早期版本(例如 Hoxton.SR6 )要求服务提供方在1秒内处理业务逻辑并返回响应。如果超过1秒没有返回,OpenFeign会直接报错,不会等待服务执行。随着版本的更新,OpenFeign已经对此做出了调整或优化(例如 2021.0.1)。

超时报错如下:

feign客户端,SpringCloud &amp; Alibaba,spring cloud,http,spring

修改超时时间:

a)在远程调用方的 application.yml 中配置,指定某个服务提供方的调用超时时间

feign:
  client:
    config:
      product: # 服务名
        connect-timeout: 5000 # 配置指定服务连接超时时间
        read-timeout: 5000 # 配置指定服务等待超时时间

b)在远程调用方的 application.yml 中配置,指定所有服务提供方的调用超时时间

feign:
  client:
    config:
      default: # 所有服务
        connect-timeout: 5000 # 配置指定服务连接超时时间
        read-timeout: 5000 # 配置指定服务等待超时时间

2.2.2、日志使用

OpenFeign 为了更好的方便在开发过程中检测 openfeign 数据传递 和 响应处理,在设计时提供了日志功能.  默认 openfeign 日志功能需要手动开启的.

日志级别有以下 4 种:

  1. NONE:不记录任何日志.
  2. BASIC:仅仅记录请求方法、url、响应状态代码及执行时间.
  3. HEADERS:记录 Basic 级别的基础上,记录请求和响应的header.
  4. FULL:展示所有 HTTP 协议状态.

配置Feign日志有以下两种方式:

1.配置文件方式(推荐)

a)开启 openfeign 日志展示

#开启 openfeign 日志
logging:
  level:
    org: # 这里是 feign 客户端接口包路径
      example:
        feign: debug

b)全局生效

feign:
  client:
    config:
      default: # 所有服务生效
        logger-level: FULL

c)局部生效

feign:
  client:
    config: 
      user: # 如果是写服务名称,则是针对某个微服务的配置
        logger-level: FULL

d)FULL 级别日志展示如下

feign客户端,SpringCloud &amp; Alibaba,spring cloud,http,spring

2.java代码方式

首先需要声明一个 Bean,如下

public class FeignClientConfiguration {
    @Bean
    public Logger.Level feignLogLevel(){
        return Logger.Level.BASIC;  //一般使用 BASIC 级别,因为太多的日志信息影响效率
    }
}

情况一:如果是全局配置,则把它放到@EnableFeignClients这个注解中:

@EnableFeignClients(defaultConfiguration = FeignClientConfiguration.class) 

情况二:如果是局部配置,则把它放到@FeignClient这个注解中:

@FeignClient(value = "userservice", configuration = FeignClientConfiguration.class) 

2.3、Feign 的性能优化

Feign 的底层客户端实现:

  • URLConnection:默认实现,不支持连接池
  • Apache HttpClient :支持连接池
  • OKHttp:支持连接池

因此优化Feign的性能主要包括:

  1. 使用连接池代替默认的URLConnection
  2. 日志级别,最好用basic或none

因此使用 HttpClient 或 OKHttp 代替 URLConnection

1.引入依赖

<!--httpClient的依赖 -->
<dependency>
    <groupId>io.github.openfeign</groupId>
    <artifactId>feign-httpclient</artifactId>
</dependency>

2.配置连接池

feign:
  client:
    config:
      default: # default全局的配置
        loggerLevel: BASIC # 日志级别,BASIC就是基本的请求和响应信息 
  httpclient:
    enabled: true # 开启feign对HttpClient的支持
    max-connections: 200 # 最大的连接数
    max-connections-per-route: 50 # 每个路径的最大连接数

2.4、Feign 的最佳实践

1.方式一:给消费者的FeignClient和提供者的controller定义统一的父接口作为标准。

仔细观察我们可以发现, Feign 发起远程调用的接口和接收远程调用请求的 controller 层实现代码是一样的,因此,我们我可以把他们的共性提取出来,写成一个公开的接口,将来我们使用的时候只需要继承这个接口即可,如下图

 feign客户端,SpringCloud &amp; Alibaba,spring cloud,http,spring

 但这种方式存在一定的问题,以下是官方提出的问题:

feign客户端,SpringCloud &amp; Alibaba,spring cloud,http,spring

也就是说

  • 服务紧耦合
  • 不适用于 Spring MVC (父接口参数列表中的映射不会被继承

2.方式二(推荐):FeignClient抽取为独立模块,并且把接口有关的POJO(实体类)、默认的Feign配置都放到这个模块中,提供给所有消费者使用

feign客户端,SpringCloud &amp; Alibaba,spring cloud,http,spring

 具体步骤:

1.首先创建一个module,命名为feign-api,然后引入feign的starter依赖

feign客户端,SpringCloud &amp; Alibaba,spring cloud,http,spring

        <!--feign 客户端依赖-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>


2.将order-service中编写的UserClient、User、DefaultFeignConfiguration都复制到feign-api项目中

feign客户端,SpringCloud &amp; Alibaba,spring cloud,http,spring


3.在order-service中引入feign-api的依赖

feign客户端,SpringCloud &amp; Alibaba,spring cloud,http,spring

4.修改order-service中的所有与上述三个组件有关的import部分,改成导入feign-api中的包

5.重启测试

这个时候你重启项目,项目必然会报以下错误

feign客户端,SpringCloud &amp; Alibaba,spring cloud,http,spring

为什么 UserClients 没有对应的对象呢?

UserClients 之前有对象是因为扫描到 @FeignClient 注解注入了对象 ,而现在 order-service 扫描包的范围是启动类下的包,但由于我们刚刚把 UserClients 挪到了 feign-api 这个 Module 中,因此,扫描不到该注解,无法注入对象。

总而言之:当定义的FeignClient不在SpringBootApplication的扫描包范围时,这些FeignClient无法使用。

有以下两种解决方式:

方式一:指定FeignClient所在包

@EnableFeignClients(basePackages = "cn.itcast.feign.clients")

这种方式会将指定包下的所有东西都拿过来。

方式二(推荐):指定FeignClient字节码

@EnableFeignClients(clients = {UserClient.class})

这种方式是精准打击,只拿指定的类,效率上更推荐使用,用哪个,就指定哪个.

feign客户端,SpringCloud &amp; Alibaba,spring cloud,http,spring文章来源地址https://www.toymoban.com/news/detail-718565.html

到了这里,关于SpringCloud Alibaba - HTTP 客户端 OpenFeign 、自定义配置、优化、最佳实践的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • 微服务——http客户端Feign

    目录 Restemplate方式调用存在的问题 Feign的介绍 基于Feign远程调用 Feign自定义配置 修改日志方式一(基于配置文件) 修改日志方式二(基于java代码) Feign的性能优化 连接池使用方法  Feign_最佳实践分析   方式一: 方式二  实现Feign最佳实践(方式二)  两种解决方案 就像早期的事务

    2024年02月15日
    浏览(39)
  • 【WebClient】客户端HTTP 超时配置

    提示:文章写完后,目录可以自动生成,如何生成可参考右边的帮助文档 1、项目升级到Springboot3,使用WebFlux自带的WebClient作为HTTP客户端 2、接口类客户端方式调用外部服务,默认超时5S 3、需根据业务动态修改超时时间,如60S 报错如下: java.lang.IllegalStateException: Timeout on bl

    2024年02月12日
    浏览(34)
  • Http客户端OkHttp的基本使用

    OkHttp是一个强大的开源HTTP客户端,它被广泛用于Android和Java应用程序中。OkHttp具有简单易用的API,提供了许多高级功能,如连接池、请求压缩和缓存等。 要使用OkHttp,需要在项目的构建文件中添加以下依赖: 请将 x.x.x 替换为您希望使用的OkHttp版本号。 GET请求 以下是发送G

    2024年02月09日
    浏览(50)
  • 【libevent】http客户端3:简单封装

    LibEventHttp

    2024年02月15日
    浏览(39)
  • 【六、http】go的http的客户端重定向

    重定向过程 :客户浏览器发送http请求----》web服务器接受后发送302状态码响应及对应新的location给客户浏览器–》客户浏览器发现是302响应,则自动再发送一个新的http请求,请求url是新的location地址----》服务器根据此请求寻找资源并发送给客户。在这里location可以重定向到任

    2024年02月05日
    浏览(37)
  • Python 的下一代 HTTP 客户端

    迷途小书童 读完需要 9 分钟 速读仅需 3 分钟 1 环境 windows 10 64bit python 3.8 httpx 0.23.0 2 简介 之前我们介绍过使用 requests ( https://xugaoxiang.com/2020/11/28/python-module-requests/ ) 来进行 http 操作,本篇介绍另一个功能非常类似的第三方库 httpx,它提供了同步和异步的 API,同时支持 HTTP/

    2024年02月12日
    浏览(42)
  • Java常用的Http client客户端

    Apache HttpClient是一个开源的Java HTTP客户端库,具有丰富的功能集,包括自动重试、连接管理、cookie管理、代理支持和认证等。HttpClient已成为Java开发中广泛使用的HTTP客户端之一。 OkHttp是Square公司开发的一个高性能的HTTP客户端库,具有自动重试、连接池、交互式调试和压缩支持

    2024年02月08日
    浏览(38)
  • 探索高效 Python HTTP 客户端:HTTPX

    项目地址:https://gitcode.com/encode/httpx 在现代 Web 开发中,高效的 HTTP 请求库是不可或缺的一部分。这就是我们要向您介绍的 HTTPX 的地方。HTTPX 是一个高性能、功能丰富的 Python HTTP 客户端,旨在成为 requests 库的一个有竞争力的替代品。 HTTPX 提供了全面的异步和同步支持,包括完

    2024年04月14日
    浏览(43)
  • Forest声明式HTTP客户端框架漫谈

    Forest 是一款声明式的 Java 开源 HTTP 框架,相比它的前辈 Httpclient 和 OkHttp 更简明易懂、也更容易维护,使用过程中非常丝滑故想分享给更多的朋友,此处我们进行简单的介绍和使用说明。 Forest为声明式HTTP客户端框架。将繁复的 HTTP 请求细节封装成 Java 接口 + 注解的形式,不

    2024年02月09日
    浏览(38)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包