如何向 feign 客户端添加请求拦截器？

Posted 2023-02-15

【中文标题】如何向 feign 客户端添加请求拦截器？

【英文标题】：How to add a request interceptor to a feign client?

【发布时间】：2017-03-08 19:28:01

【问题描述】：

我希望每次通过 feign 客户端发出请求时，都为经过身份验证的用户设置一个特定的标头。

这是我的过滤器，我从中获取身份验证并将其设置为 spring 安全上下文：

@EnableEurekaClient
@SpringBootApplication
@EnableFeignClients
public class PerformanceApplication 
    @Bean
    public Filter requestDetailsFilter() 
        return new RequestDetailsFilter();
    

    public static void main(String[] args) 
        SpringApplication.run(PerformanceApplication.class, args);
    

    private class RequestDetailsFilter implements Filter 
        @Override
        public void init(FilterConfig filterConfig) throws ServletException 

        

        @Override
        public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException 
            String userName = ((HttpServletRequest)servletRequest).getHeader("Z-User-Details");
            String pass = ((HttpServletRequest)servletRequest).getHeader("X-User-Details");
            if (pass != null)
                pass = decrypt(pass);
            SecurityContext secure = new SecurityContextImpl();
            org.springframework.security.core.Authentication token = new UsernamePasswordAuthenticationToken(userName, pass);
            secure. setAuthentication(token);
            SecurityContextHolder.setContext(secure);
            filterChain.doFilter(servletRequest, servletResponse);
        

        @Override
        public void destroy() 

        
    
    private String decrypt(String str) 
        try 
            Cipher dcipher = new NullCipher();

            // Decode base64 to get bytes
            byte[] dec = new sun.misc.BASE64Decoder().decodeBuffer(str);

            // Decrypt
            byte[] utf8 = dcipher.doFinal(dec);

            // Decode using utf-8
            return new String(utf8, "UTF8");
         catch (javax.crypto.BadPaddingException e) 
         catch (IllegalBlockSizeException e) 
         catch (UnsupportedEncodingException e) 
         catch (java.io.IOException e) 
        
        return null;
    

这是我的假客户：

@FeignClient("holiday-client")
public interface EmailClient 
    @RequestMapping(value = "/api/email/send", method = RequestMethod.POST)
    void sendEmail(@RequestBody Email email);

这里我有一个请求拦截器：

@Component
public class FeignRequestInterceptor implements RequestInterceptor 
    private String headerValue;

    public FeignRequestInterceptor() 
    

    public FeignRequestInterceptor(String username, String password) 
        this(username, password, ISO_8859_1);
    

    public FeignRequestInterceptor(String username, String password, Charset charset) 
        checkNotNull(username, "username");
        checkNotNull(password, "password");
        this.headerValue = "Basic " + base64encode((username + ":" + password).getBytes(charset));
    

    private static String base64encode(byte[] bytes) 
        BASE64Encoder encoder = new BASE64Encoder();
        return encoder.encode(bytes);
    

    @Override
    public void apply(RequestTemplate requestTemplate) 
        requestTemplate.header("Authorization", headerValue);
    

我不知道如何为我的客户端配置此拦截器以及如何使用用户名和密码设置标头。我怎样才能做到这一点？

【参考方案1】：

我知道这个帖子有点老了，但想解释一下这里发生了什么。

如果您想自定义 Feign 请求，可以使用 RequestInterceptor。这可以是自定义实现，或者您可以重用 Feign 库中可用的内容，例如BasicAuthRequestInterceptor.

如何注册？好吧，根据你使用 Feign 的方式，有两种方法。

如果您使用没有 Spring 的普通 Feign，那么您必须将拦截器设置为 Feign 构建器。一个例子是here。

Feign.builder()
     .requestInterceptor(new MyCustomInterceptor())
     .target(MyClient.class, "http://localhost:8081");

如果您使用 Spring Cloud OpenFeign 并且您使用 @FeignClient 注释来构造您的客户端，那么您必须通过将其定义为 @Component 或 @987654330 从您的 RequestInterceptor 创建一个 bean @ 在您的 @Configuration 课程之一中。示例here。

@Component
public class MyCustomInterceptor implements RequestInterceptor 
    @Override
    public void apply(RequestTemplate template) 
        // do something
    

另外，您可以查看我在该主题中的一篇文章，也许这样可以更好地清除它：Customizing each request with Spring Cloud Feign

【讨论】：

我正在使用带有 @FeignClient 注释的 Spring Cloud OpenFeign。有没有办法只将请求拦截器添加到特定的 feign 客户端，或者是使用 Feign.builder().requestInterceptor 的唯一方法？

@BoomShaka @FeignClient 注解为您提供了一个configuration 属性，您可以在其中指定要为该特定的假客户端选择哪个配置类。在您的情况下，创建一个将请求拦截器定义为 Spring Bean 的配置类，并将该配置应用到您需要的 @FeignClient 注释中。

谢谢。效果很好！

太棒了，干得好。干杯伙伴。

【参考方案2】：

您实际上并不需要自己实现 FeignRequestInterceptor，因为在 feign.auth 包中已经有 BasicAuthRequestInterceptor 的功能完全相同。

话虽如此，您基本上已经设置了几乎所有内容。剩下要做的就是用特定的用户名和密码定义basicAuthRequestInterceptor bean：

@Bean
public RequestInterceptor basicAuthRequestInterceptor() 
    return new BasicAuthRequestInterceptor("username", "password");

【讨论】：

是否可以为 RequestInterceptor @Bean 添加@Qualifier？

当然可以。但是 Feign 不知道自定义限定符。如果需要在 RequestInterceptor 之间切换，则需要引入一些自定义的 Feign Configuration。