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中的拦截。有兴趣的可以试一下。

总结

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

相关文章

  • 教你构建第一个Java Applet程序

    教你构建第一个Java Applet程序

    本文的主要目的是创建一个简单的Java applet,需要的朋友可以参考下
    2014-10-10
  • Java利用InputStream类实现文件读取与处理

    Java利用InputStream类实现文件读取与处理

    在Java开发中,输入流(InputStream)是一个非常重要的概念,它涉及到文件读写、网络传输等多个方面,InputStream类是Java中输入流的抽象基类,定义了读取输入流数据的方法,本文将以InputStream类为切入点,介绍Java中的输入流概念及其应用,需要的朋友可以参考下
    2023-11-11
  • Spring中Bean注入源码示例解析

    Spring中Bean注入源码示例解析

    这篇文章主要为大家介绍了Spring中Bean注入源码示例解析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-01-01
  • java驼峰转换的方法

    java驼峰转换的方法

    这篇文章主要为大家详细介绍了java驼峰转换的方法,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-07-07
  • Mybatis集成到Spring容器的详细步骤

    Mybatis集成到Spring容器的详细步骤

    在现在的JavaEE开发过程中,我们经常会使用到Spring+SpringMVC+Mybatis这个组合,那么Mybatis是如何集成到Spring中的呢,下面通过实例代码给大家详细讲解,感兴趣的朋友跟随小编一起看看吧
    2024-03-03
  • SpringBoot+Redis实现消息的发布与订阅的示例代码

    SpringBoot+Redis实现消息的发布与订阅的示例代码

    本文主要介绍了SpringBoot+Redis实现消息的发布与订阅,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2022-04-04
  • SpringBoot中使用configtree读取树形文件目录中的配置详解

    SpringBoot中使用configtree读取树形文件目录中的配置详解

    这篇文章主要介绍了SpringBoot中使用configtree读取树形文件目录中的配置详解,configtree通过spring.config.import + configtree:前缀的方式,加载以文件名为key、文件内容为value的配置属性,需要的朋友可以参考下
    2023-12-12
  • mybatis-plus返回查询总记录数方式

    mybatis-plus返回查询总记录数方式

    这篇文章主要介绍了mybatis-plus返回查询总记录数方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-01-01
  • java使用htmlparser提取网页纯文本例子

    java使用htmlparser提取网页纯文本例子

    这篇文章主要介绍了java使用htmlparser提取网页纯文本例子,需要的朋友可以参考下
    2014-04-04
  • SpringBoot详细讲解异步任务如何获取HttpServletRequest

    SpringBoot详细讲解异步任务如何获取HttpServletRequest

    在使用框架日常开发中需要在controller中进行一些异步操作减少请求时间,但是发现在使用@Anysc注解后会出现Request对象无法获取的情况,本文就此情况给出完整的解决方案
    2022-04-04

最新评论