Feign中的RequestInterceptor详解及配置

在微服务架构中，Feign作为一个声明式的Web服务客户端，简化了Web服务客户端的编写。Feign内部整合了Ribbon和Eureka，使得服务调用更加透明。RequestInterceptor是Feign中一个重要的组件，它允许我们在请求发送之前对请求进行拦截和修改。本文将详细介绍RequestInterceptor的作用及其配置方法。

什么是RequestInterceptor？

RequestInterceptor是Feign中的一个接口，它允许我们在发送请求之前对请求模板（RequestTemplate）进行操作。这可以用于添加请求头、修改请求参数等。RequestInterceptor的实现类可以配置到Feign的构建器中，从而在每次请求时自动应用。

RequestInterceptor的作用

1. 添加请求头：可以在所有请求中添加通用的请求头，如认证信息、客户端信息等。
2. 修改请求参数：在请求发送前修改请求模板中的参数。
3. 日志记录：在请求发送前记录日志信息，便于调试和监控。

示例：FeignRequestInterceptor

下面是一个RequestInterceptor的实现示例，它的作用是从当前的HTTP请求中提取用户信息和IP地址，并将其添加到Feign客户端的请求头中。

package com.ruoyi.common.security.feign;import java.util.Map;
import javax.servlet.http.HttpServletRequest;
import org.springframework.stereotype.Component;
import com.ruoyi.common.core.constant.SecurityConstants;
import com.ruoyi.common.core.utils.ServletUtils;
import com.ruoyi.common.core.utils.StringUtils;
import com.ruoyi.common.core.utils.ip.IpUtils;
import feign.RequestInterceptor;
import feign.RequestTemplate;/*** Feign请求拦截器* * @author ruoyi*/
@Component
public class FeignRequestInterceptor implements RequestInterceptor {@Overridepublic void apply(RequestTemplate requestTemplate) {HttpServletRequest httpServletRequest = ServletUtils.getRequest();if (StringUtils.isNotNull(httpServletRequest)) {Map<String, String> headers = ServletUtils.getHeaders(httpServletRequest);// 传递用户信息请求头，防止丢失String userId = headers.get(SecurityConstants.DETAILS_USER_ID);if (StringUtils.isNotEmpty(userId)) {requestTemplate.header(SecurityConstants.DETAILS_USER_ID, userId);}String userKey = headers.get(SecurityConstants.USER_KEY);if (StringUtils.isNotEmpty(userKey)) {requestTemplate.header(SecurityConstants.USER_KEY, userKey);}String userName = headers.get(SecurityConstants.DETAILS_USERNAME);if (StringUtils.isNotEmpty(userName)) {requestTemplate.header(SecurityConstants.DETAILS_USERNAME, userName);}String authentication = headers.get(SecurityConstants.AUTHORIZATION_HEADER);if (StringUtils.isNotEmpty(authentication)) {requestTemplate.header(SecurityConstants.AUTHORIZATION_HEADER, authentication);}// 配置客户端IPrequestTemplate.header("X-Forwarded-For", IpUtils.getIpAddr());}}
}

如何配置RequestInterceptor

在Spring Boot应用中，我们可以通过创建一个配置类来注册RequestInterceptor的Bean，如下所示：

@Configuration
public class FeignAutoConfiguration {@Beanpublic RequestInterceptor requestInterceptor() {return new FeignRequestInterceptor();}
}

通过这种方式，Spring容器会自动检测到这个配置类，并在创建Feign客户端时应用这个拦截器。这样，我们就可以在Feign客户端发起的每个请求都会经过FeignRequestInterceptor的处理，实现请求头的统一管理和添加。

结论

RequestInterceptor是Feign中一个非常强大的功能，它允许我们在请求发送前对请求进行定制化的修改。通过实现RequestInterceptor接口并配置相应的Bean，我们可以在微服务架构中实现请求头的统一管理、日志记录等功能，提高服务调用的灵活性和安全性。