【SpringBoot系列】微服务远程调用Open Feign深度学习

简介: 【4月更文挑战第9天】微服务远程调度open Feign 框架学习

[toc]


前言

通常一个服务需要调用 Http 端点,Feign 来自 OpenFeign 项目使得以声明式方式调用 http 端点变得更加容易。Spring 通过其 Spring Cloud OpenFeign 集成了 openfeign 集成。

一、引入Feign Client

feign 的实际项目是 OpenFeign https://github.com/OpenFeign/feign ,Spring自带启动器,将以下依赖项添加到项目

<dependency>
   <groupId>org.springframework.cloud</groupId>
   <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
AI 代码解读

我们创建一个名为 feign-serviceA 的服务,该服务将调用 feign-serviceB 。feign-serviceB 公开一个 GET 端点 /hello,它返回一个简单的 hello 响应正文。为了使用来自 feign-serviceA 的 feign 客户端调用端点,我们需要执行以下操作 -

  • 创建一个带有@FeignClient注释的界面,如下所示
@FeignClient(url = "<host:port for serviceB>", name = "serviceB")
public interface ServiceBClient{

    @GetMapping("/hello")
    public ResponseEntity<String> sayHello();
}
AI 代码解读
  • 为主启动类添加@EnableFeignClients 注解

设置好了,我们可以像任何正常的方法调用一样简单地自动连接ServiceBClient并调用方法sayHello。

二、Feign 配置

Feign 自带有一些组件,这些组件用于调用远程端点并编码/解码请求响应。

  • 客户端 - 要进行 HTTP 调用,需要 http 客户端。默认情况下,openfeign 带有默认客户端。我们可以用 ApacheHttpClient、OkHttpClient 或 ApacheHC5FeignClient 覆盖它。这些客户端是委托客户端的包装器。例如,ApacheHttpClient 包装一个 httpcomponents、httpclient。

  • 解码器 - 需要将 feign Response 转换为 feign 方法返回类型的实际类型。默认情况下,spring 提供了一个 OptionalDecoder,它委托给 ResponseEntityDecoder,后者进一步委托给 SpringDecoder,我们可以通过定义一个 Bean 来覆盖它 解码器 。

  • 编码器 - 我们通过向它传递对象来调用feign方法,需要将其转换为 http 请求正文。默认情况下,spring 提供 SpringEncoder。

除了上面的组件外,feign还支持缓存等功能。我们可以创建一个配置类并覆盖上述组件的默认值。如果我们想覆盖单个组件的默认值,@Feign接受配置参数,我们可以使用它来定义默认值的自定义覆盖。

三、重试机制

Feign 已经支持重试机制。但是,默认情况下,它使用 Retry.NEVER_RETRY 。例如,我们可以创建一个自定义重试器,它将重试任何状态代码> 400的请求,以下是我们的 CustomRetryer 的代码:

public class CustomRetryer extends Retryer.Default{
   
    public CustomRetryer(long period, long maxPeriod, int maxAttempts){
   
        super(period, maxPeriod, maxAttempts);
    }

    @Override
    public void continueOrPropagate(RetryableException e){
   
        log.info("Going to retry for ", e);
        super.continueOrPropagate(e);
    }

    @Override
    public Retryer clone(){
   
        return new CustomRetryer(5,SECONDS.toMillis(1), 5);
    }
}
AI 代码解读

一个重要的事实是 feign Retry 适用于 IOException 或从某些 errorDecoder 引发的 RetryableException ,以下是自定义解码器的样子:

 @Bean
    public ErrorDecoder errorDecoder(){
   
        return (methodKey, response) -> {
   
            byte[] body = {
   };
            try {
   
                if (response.body() != null) {
   
                    body = Util.toByteArray(response.body().asInputStream());
                }
            } catch (IOException ignored) {
    // NOPMD
            }
            FeignException exception = new FeignException.BadRequest(response.reason(), response.request(), body, response.headers());
            if (response.status() >= 400) {
   
                return new RetryableException(
                        response.status(),
                        response.reason(),
                        response.request().httpMethod(),
                        exception,
                        Date.from(Instant.now().plus(15, ChronoUnit.MILLIS)),
                        response.request());
            }
            return exception;
        };
    }
AI 代码解读

四、弹性

我们在前面介绍了通过重试实现的一种弹性形式,Spring 对 feign 有 CircuitBreaker 支持,它通过单独的 Feign 构建器 FeignCircuitBreaker.Builder 来实现它,Circuitbreaker 的实际实现来自 resilience4j 库。

五、拦截器

有时我们想通过添加一些额外的信息来修改请求,例如,我们可以为每个请求添加一些标头,我们可以通过使用 RequestInterceptor 来实现这一点,在下面添加了填充标头 userid 的拦截器。

@Bean
public RequestInterceptor userIdRequestInterceptor(){
     return (template) -> {
        template.header("userid", "somerandomtext");
    };
}
AI 代码解读

feign-serviceB 读取此标头并返回为标头,我们请求curl,我们得到的响应如下:

< HTTP/1.1 200
< connection: keep-alive
< date: Sat, 20 Aug 2022 15:27:47 GMT
< keep-alive: timeout=60
< userid: somerandomtext
< Content-Type: text/plain;charset=UTF-8
< Content-Length: 7
<
* transfer closed with 7 bytes remaining to read
AI 代码解读

我们看到 userid 已添加到响应中。一个非常有用的拦截器应用程序是当 feign 必须发送 oauth2 访问令牌时。Out of the spring 提供了一个 OAuth2FeignRequestInterceptor,它为每个请求添加访问令牌。

六、负载均衡

从 spring boot 2.4.0 开始,feign 与 spring-cloud-loadbalancer 集成,后者可以从各种服务发现提供商获取客户端 url 信息,并使该信息可供 feign 使用。feign 的使用简化了发出 http 请求的各个方面。在典型的生产环境中,我们可能需要重写多个组件,如客户端、解码器、errorDecoder 等。同样在 Spring 生态系统中,feign 与弹性、负载平衡、指标等很好地集成在一起,这使得我们在微服务架构中可以自动选择它。

小结

本节我们学习了Spring Feign Client,我们介绍了Feign的配置,重试机制,弹性以及拦截器,负载均衡等能力。Spring Feign Client在微服务调度过程中起到了重要的作用,通过Spring Feign Client,我们可以实现对其他服务的调度能力,后面我们会对Spring Boot系列继续进行深入学习,欢迎大家持续关注,如果你还喜欢小编的风格,请点赞+关注,给小编一个三连赞,小编一定会特别开心哒。

相关文章
微服务——SpringBoot使用归纳——Spring Boot 中集成Redis——Redis 介绍
本文介绍在 Spring Boot 中集成 Redis 的方法。Redis 是一种支持多种数据结构的非关系型数据库(NoSQL),具备高并发、高性能和灵活扩展的特点,适用于缓存、实时数据分析等场景。其数据以键值对形式存储,支持字符串、哈希、列表、集合等类型。通过将 Redis 与 Mysql 集群结合使用,可实现数据同步,提升系统稳定性。例如,在网站架构中优先从 Redis 获取数据,故障时回退至 Mysql,确保服务不中断。
90 0
微服务——SpringBoot使用归纳——Spring Boot 中集成Redis——Redis 介绍
|
23天前
|
微服务——SpringBoot使用归纳——Spring Boot中集成 Shiro——Shiro 身份和权限认证
本文介绍了 Apache Shiro 的身份认证与权限认证机制。在身份认证部分,分析了 Shiro 的认证流程,包括应用程序调用 `Subject.login(token)` 方法、SecurityManager 接管认证以及通过 Realm 进行具体的安全验证。权限认证部分阐述了权限(permission)、角色(role)和用户(user)三者的关系,其中用户可拥有多个角色,角色则对应不同的权限组合,例如普通用户仅能查看或添加信息,而管理员可执行所有操作。
59 0
微服务——SpringBoot使用归纳——Spring Boot中集成 Shiro——Shiro 三大核心组件
本课程介绍如何在Spring Boot中集成Shiro框架,主要讲解Shiro的认证与授权功能。Shiro是一个简单易用的Java安全框架,用于认证、授权、加密和会话管理等。其核心组件包括Subject(认证主体)、SecurityManager(安全管理员)和Realm(域)。Subject负责身份认证,包含Principals(身份)和Credentials(凭证);SecurityManager是架构核心,协调内部组件运作;Realm则是连接Shiro与应用数据的桥梁,用于访问用户账户及权限信息。通过学习,您将掌握Shiro的基本原理及其在项目中的应用。
66 0
微服务——SpringBoot使用归纳——Spring Boot中使用监听器——Spring Boot中自定义事件监听
本文介绍了在Spring Boot中实现自定义事件监听的完整流程。首先通过继承`ApplicationEvent`创建自定义事件,例如包含用户数据的`MyEvent`。接着,实现`ApplicationListener`接口构建监听器,用于捕获并处理事件。最后,在服务层通过`ApplicationContext`发布事件,触发监听器执行相应逻辑。文章结合微服务场景,展示了如何在微服务A处理完逻辑后通知微服务B,具有很强的实战意义。
50 0
微服务——SpringBoot使用归纳——Spring Boot中使用监听器——监听器介绍和使用
本文介绍了在Spring Boot中使用监听器的方法。首先讲解了Web监听器的概念,即通过监听特定事件(如ServletContext、HttpSession和ServletRequest的创建与销毁)实现监控和处理逻辑。接着详细说明了三种实际应用场景:1) 监听Servlet上下文对象以初始化缓存数据;2) 监听HTTP会话Session对象统计在线用户数;3) 监听客户端请求的Servlet Request对象获取访问信息。每种场景均配有代码示例,帮助开发者理解并应用监听器功能。
47 0
微服务——SpringBoot使用归纳——Spring Boot事务配置管理——常见问题总结
本文总结了Spring Boot中使用事务的常见问题,虽然通过`@Transactional`注解可以轻松实现事务管理,但在实际项目中仍有许多潜在坑点。文章详细分析了三个典型问题:1) 异常未被捕获导致事务未回滚,需明确指定`rollbackFor`属性;2) 异常被try-catch“吃掉”,应避免在事务方法中直接处理异常;3) 事务范围与锁范围不一致引发并发问题,建议调整锁策略以覆盖事务范围。这些问题看似简单,但一旦发生,排查难度较大,因此开发时需格外留意。最后,文章提供了课程源代码下载地址,供读者实践参考。
37 0
微服务——SpringBoot使用归纳——Spring Boot事务配置管理——Spring Boot 事务配置
本文介绍了 Spring Boot 中的事务配置与使用方法。首先需要导入 MySQL 依赖,Spring Boot 会自动注入 `DataSourceTransactionManager`,无需额外配置即可通过 `@Transactional` 注解实现事务管理。接着通过创建一个用户插入功能的示例,展示了如何在 Service 层手动抛出异常以测试事务回滚机制。测试结果表明,数据库中未新增记录,证明事务已成功回滚。此过程简单高效,适合日常开发需求。
72 0
微服务——SpringBoot使用归纳——Spring Boot事务配置管理——事务相关
本文介绍Spring Boot事务配置管理,阐述事务在企业应用开发中的重要性。事务确保数据操作可靠,任一异常均可回滚至初始状态,如转账、购票等场景需全流程执行成功才算完成。同时,事务管理在Spring Boot的service层广泛应用,但根据实际需求也可能存在无需事务的情况,例如独立数据插入操作。
25 0
微服务——SpringBoot使用归纳——Spring Boot集成MyBatis——基于 xml 的整合
本教程介绍了基于XML的MyBatis整合方式。首先在`application.yml`中配置XML路径,如`classpath:mapper/*.xml`,然后创建`UserMapper.xml`文件定义SQL映射,包括`resultMap`和查询语句。通过设置`namespace`关联Mapper接口,实现如`getUserByName`的方法。Controller层调用Service完成测试,访问`/getUserByName/{name}`即可返回用户信息。为简化Mapper扫描,推荐在Spring Boot启动类用`@MapperScan`注解指定包路径避免逐个添加`@Mapper`
42 0
微服务——SpringBoot使用归纳——Spring Boot中集成ActiveMQ——ActiveMQ安装
本教程介绍ActiveMQ的安装与基本使用。首先从官网下载apache-activemq-5.15.3版本,解压后即可完成安装,非常便捷。启动时进入解压目录下的bin文件夹,根据系统选择win32或win64,运行activemq.bat启动服务。通过浏览器访问`http://127.0.0.1:8161/admin/`可进入管理界面,默认用户名密码为admin/admin。ActiveMQ支持两种消息模式:点对点(Queue)和发布/订阅(Topic)。前者确保每条消息仅被一个消费者消费,后者允许多个消费者同时接收相同消息。
58 0
微服务——SpringBoot使用归纳——Spring Boot中集成ActiveMQ——ActiveMQ安装
AI助理

你好,我是AI助理

可以解答问题、推荐解决方案等