SpringCloud组件OpenFeign之拦截器解读

 更新时间:2023年04月26日 10:29:06   作者:luffylv  
这篇文章主要介绍了SpringCloud组件OpenFeign之拦截器用法。具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教

SpringCloud组件OpenFeign之拦截器

OpenFeign组件中有这么一个接口——RequestInterceptor 。

我们来看一下源码中关于这个接口的介绍。

package feign;
 
/**
 * 可以配置零个或多个请求拦截器,可以用于例如给所有请求添加请求头信息.但是不能保证拦截器的应用顺 
 * 序。一旦拦截器被应用,就会调用Target类中的apply(RequestTemplate)方法去创建不可变的http请 
 * 求,该请求通过Client类中的execute(Request, feign.Request.Options)发送。
 *
 * 拦截器是在设置rest模板参数后才被应用的,因此不能再拦截器中添加参数,比如不能再    
 * apply(RequestTemplate)方法中给/path/{foo}/bar中的foo设置参数。
 * 这个类类似于RequestInterceptor.intercept()方法,可以实现读取、删除或以其他方式改变请求模板 
 * 的任何部分。
 */
public interface RequestInterceptor {
 
  /**
   * 可以被每个请求调用。使用RequestTemplate提供的这个方法可以添加数据。
   */
  void apply(RequestTemplate template);
}

通过对该类及方法的注释可以了解到RequestInterceptor接口的apply方法可以对请求进行拦截,可以在该方法中添加请求头信息。

实践一下。

一、创建一个拦截器在请求头中添加traceId信息

场景如下,使用拦截器在请求头中添加traceId属性,服务端可以获取到该traceId,用于日志追踪。

方式一:创建自定义拦截器+@Configuration

package com.example.rtbootconsumer.config.interceptor;
 
import com.example.rtbootconsumer.common.utils.TraceIdUtil;
import feign.Request;
import feign.RequestInterceptor;
import feign.RequestTemplate;
import org.apache.commons.lang3.StringUtils;
import org.springframework.context.annotation.Configuration;
 
/**
 * @Description Feign接口请求拦截器
 **/
@Configuration
public class FeignRequestInterceptor implements RequestInterceptor {
 
    /**
     * @description: 将traceId设置到请求头
     */
    @Override
    public void apply(RequestTemplate template) {
        String traceId = TraceIdUtil.getTraceId();
        if (StringUtils.isNotEmpty(traceId)) {
            template.header("traceId", traceId);
        }
    }
}

方式二:创建自定义拦截器+配置@FeignClient注解的configuration属性

package com.example.rtbootconsumer.config.interceptor;
 
import com.example.rtbootconsumer.common.utils.TraceIdUtil;
import feign.Request;
import feign.RequestInterceptor;
import feign.RequestTemplate;
import org.apache.commons.lang3.StringUtils;
import org.springframework.context.annotation.Configuration;
 
/**
 * @Description Feign接口请求拦截器
 **/
public class FeignRequestInterceptor implements RequestInterceptor {
 
    /**
     * @description: 将traceId设置到请求头
     */
    @Override
    public void apply(RequestTemplate template) {
        String traceId = TraceIdUtil.getTraceId();
        if (StringUtils.isNotEmpty(traceId)) {
            template.header("traceId", traceId);
        }
    }
}
package com.example.rtbootconsumer.feignservice;
 
import com.example.rtbootconsumer.pojo.User;
import com.example.rtbootconsumer.vo.ResultBody;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.*;
 
import java.util.List;
 
 
@FeignClient(name = "service-provider", path = "/testComm", url = "${addr.url}",configuration = FeignRequestInterceptor.class)
public interface UserFeignService {
 
    @PostMapping(value = "/getUser")
    public ResultBody<User> getUser(@RequestBody User user);
}

二、创建两个拦截器

也可以同时创建多个拦截器实现拦截器链的功能。

此时再创建一个拦截器FeignRequestInterceptor2,用于在请求头中设置属性名为test,值为lalala信息。

方式一:同上

package com.example.rtbootconsumer.config.interceptor;
 
import com.example.rtbootconsumer.common.utils.TraceIdUtil;
import feign.Request;
import feign.RequestInterceptor;
import feign.RequestTemplate;
import org.apache.commons.lang3.StringUtils;
import org.springframework.context.annotation.Configuration;
 
/**
 * @Description Feign接口请求拦截器
 **/
@Configuration
public class FeignRequestInterceptor2 implements RequestInterceptor {
 
    /**
     * @description: 将test设置到请求头
     */
    @Override
    public void apply(RequestTemplate template) {
        String traceId = TraceIdUtil.getTraceId();
        if (StringUtils.isNotEmpty(traceId)) {
            template.header("test", "lalala");
        }
    }
}

方式二:同上,注意这里设置的@FeignClient注解的configuration属性值是两个拦截器的class数组。

package com.example.rtbootconsumer.feignservice;
 
import com.example.rtbootconsumer.pojo.User;
import com.example.rtbootconsumer.vo.ResultBody;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.*;
 
import java.util.List;
 
 
@FeignClient(name = "service-provider", path = "/testComm", url = "${addr.url}",configuration = {FeignRequestInterceptor.class,FeignRequestInterceptor2.class})
public interface UserFeignService {
 
    @PostMapping(value = "/getUser")
    public ResultBody<User> getUser(@RequestBody User user);
 
    @PostMapping(value = "/testList")
    public ResultBody<List<User>> testList(@RequestBody List<User> list);
}

三、注意

在创建并配置拦截器时有两点需要特别注意。

1.在使用方式一去创建拦截器时

会拦截所有请求。用方式二时若@FeignClient注解的configuration属性未设置拦截器,那么并不会拦截该接口下所有方法的请求。拦截器只会拦截所有configuration属性值设置了拦截器的接口下所有方法的请求。因此使用方式二更灵活。

2.拦截器执行顺序

若使用方式一去创建多个拦截器时,正如前面注释所讲,不能保证拦截器的执行顺序。

但是使用方式二则可以控制拦截器的执行顺序,拦截器的执行顺序和@FeignClient注解中configuration属性中拦截器的配置顺序有关。

若配置为 {FeignRequestInterceptor.class,FeignRequestInterceptor2.class}),则会先执行FeignRequestInterceptor中的拦截,再执行FeignRequestInterceptor2中的拦截。

若配置为 {FeignRequestInterceptor2.class,FeignRequestInterceptor.class}),则会先执行FeignRequestInterceptor2中的拦截,再执行FeignRequestInterceptor中的拦截。有兴趣的可以试一下。

总结

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • Mybatis传递多个参数的三种实现方法

    Mybatis传递多个参数的三种实现方法

    这篇文章主要介绍了Mybatis传递多个参数的三种实现方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-04-04
  • 深入学习Java 动态代理

    深入学习Java 动态代理

    Java 动态代理机制的出现,使得 Java 开发人员不用手工编写代理类,只要简单地指定一组接口及委托类对象,便能动态地获得代理类。下面小编和大家来一起学习一下吧
    2019-05-05
  • SpringBoot整合WebService的实现示例

    SpringBoot整合WebService的实现示例

    本文主要介绍了SpringBoot整合WebService,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-11-11
  • 剑指Offer之Java算法习题精讲数组与字符和等差数列

    剑指Offer之Java算法习题精讲数组与字符和等差数列

    跟着思路走,之后从简单题入手,反复去看,做过之后可能会忘记,之后再做一次,记不住就反复做,反复寻求思路和规律,慢慢积累就会发现质的变化
    2022-03-03
  • 关于Spring Boot对jdbc的支持问题

    关于Spring Boot对jdbc的支持问题

    这篇文章主要介绍了关于Spring Boot对jdbc的支持问题,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-04-04
  • mybatis快速上手并运行程序

    mybatis快速上手并运行程序

    MyBatis 是一款优秀的持久层框架,它支持自定义 SQL、存储过程以及高级映射。MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO为数据库中的记录
    2022-01-01
  • Java设计模式之责任链模式的示例详解

    Java设计模式之责任链模式的示例详解

    责任链模式是将链中的每一个节点看做是一个对象,每个节点处理的请求均不相同,且内部自动维护下一个节点对象,当一个请求从链式的首段发出时,会沿着链的路径依次传递给每一个节点对象。本文将通过示例和大家详细聊聊责任链模式,需要的可以参考一下
    2022-11-11
  • Spring中@PropertySource和@Value注解详解

    Spring中@PropertySource和@Value注解详解

    这篇文章主要介绍了Spring中@PropertySource和@Value注解详解,@PropertySource注解可以方便和灵活的向Spring的环境容器(org.springframework.core.env.Environment Environment)中注入一些属性,这些属性可以在Bean中使用,需要的朋友可以参考下
    2023-11-11
  • java使用RandomAccessFile类基于指针读写文件实例代码

    java使用RandomAccessFile类基于指针读写文件实例代码

    这篇文章主要介绍了java使用RandomAccessFile类基于指针读写文件实例代码,具有一定参考价值,需要的朋友可以了解下。
    2017-10-10
  • java多线程文件下载器的实现

    java多线程文件下载器的实现

    本文主要介绍了java多线程文件下载器的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-11-11

最新评论