Spring Cloud Feign--统一设置Header--方法/实例

简介

        本文介绍Feign如何统一设置Header。

        Feign的用法和SpringMVC的用法基本一致。设置单个header的方法很简单，见：。本文只介绍全局设置header的方法。

方法概述

        方法是：实现RequestInterceptor接口，将它作为配置类。

        如果这个实现类注入到Spring容器的话就会全局有效，即使在没有指定configuration属性的FeignClient也会使用该配置。

        如果只想给指定FeignClient的feign接口使用该配置，不要将该类配置注入Spring中，需要进行手动指定（假设实现类名为：TestFeignIntercepter）：

@FeignClient(name = "user", configuration = {TestRequestInterceptor.class})
public interface UserFeignClient {
    @GetMapping(value = "/user/{id}")
    public User findById(@RequestParam("id") String id);
}

简单示例

public class TestFeignInterceptor implements RequestInterceptor {
    @Override
    public void apply(RequestTemplate requestTemplate) {
        String url = requestTemplate.url();
        // 只对特定url进行签名添加Header的操作
        if (!url.startsWith("/test/api")) {
            return;
        }
        
        requestTemplate.header("Authorization", "xxx");
    }
}

项目实例

实例1：转发Controller的所有header

import feign.RequestInterceptor;
import feign.RequestTemplate;
import java.util.Enumeration;
import javax.servlet.http.HttpServletRequest;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.context.request.RequestAttributes;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

public class FeignTransmitAllHeaderInterceptor implements RequestInterceptor {
    
    @Override
    public void apply(RequestTemplate template) {
        ServletRequestAttributes attributes = (ServletRequestAttributes)
                RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();
        Enumeration<String> headerNames = request.getHeaderNames();
        if (headerNames != null) {
            while (headerNames.hasMoreElements()) {
                String name = headerNames.nextElement();
                String values = request.getHeader(name);
                template.header(name, values);
            }
        }
    }
}

实例2：转发Controller的header（修改部分header）

import feign.RequestInterceptor;
import feign.RequestTemplate;
import java.util.Enumeration;
import javax.servlet.http.HttpServletRequest;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.context.request.RequestAttributes;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

public class FeignTransmitAllHeaderInterceptor implements RequestInterceptor {

    @Override
    public void apply(RequestTemplate requestTemplate) {
        RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
        if (requestAttributes != null) {
            ServletRequestAttributes attributes = (ServletRequestAttributes)requestAttributes;
            HttpServletRequest request = attributes.getRequest();
            Enumeration<String> headerNames = request.getHeaderNames();
            if (headerNames != null) {
                while(headerNames.hasMoreElements()) {
                    String headerName; = (String)headerNames.nextElement();
                    String headerValue = request.getHeader(headerName);
                    if (!headerName.equals("content-length")) {
                        requestTemplate.header(headerName, headerValue);
                    }
                }

                String path = request.getContextPath();
                String modifiedReferer = request.getScheme() + "://" + request.getServerName() 
                         + ":" + request.getServerPort() + path + request.getServletPath();
                requestTemplate.header("referer", modifiedReferer);
            }
        }
    }
}