位置：首页-资讯-后端开发

Feign调用中的两种Header传参方式小结

2023-01-01 15:00

短信预约 -IT技能 免费直播动态提醒

Feign调用中的两种Header传参方式

在Spring Cloud Netflix栈中，各个微服务都是以HTTP接口的形式暴露自身服务的，因此在调用远程服务时就必须使用HTTP客户端。

我们可以使用JDK原生的URLConnection、Apache的Http Client、Netty的异步HTTP Client, Spring的RestTemplate。公司目前使用的是Feign。

下面来和大家一起学习下feign调用中两种Header传参方式。

在请求拦截器中统一配置

每次Feign调用中，需要传递一些安全校验参数，比如说token，bizId啥的，如果单独在每次调用的时候去配置这些重复的逻辑，显然不合适。所以我们可以在Feign的拦截器中统一配置这些权限参数。

如何配置呢？其实很简单。

import org.springframework.context.annotation.Configuration;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import feign.RequestInterceptor;
import feign.RequestTemplate;
import javax.servlet.http.HttpServletRequest;
import java.util.Enumeration;
 
@Configuration
public class FeignConfiguration 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);
            }
        }
    }
}

然后再feignClient中配置自定义的配置类，覆盖默认的配置

@Component
@FeignClient(value = "feignTest" ,configuration = FeignConfiguration.class)
public interface FeignTestService {
}

这样就所有的Feign调用都会在Header调用中加上request中传递过来的参数。不需要单独在每次Feign调用重复添加参数。

通过@RequestHeader注解

上面也说到，我们在拦截器中获取request传递过来的参数，然后再放到header中。在拦截器中配置的一般都是公用的一些参数。

但是如果一个服务接口，需要一些特殊参数。但是其他服务不需要这个参数，这时候我们不必在拦截器中配置其他服务不需要的参数，只需在需要的服务接口上加上@RequestHeader注解，然后在feign调用的时候把参数传过来就ok了。

@PostMapping(value = "/orderDetails")
public ReturnInfo getOrderDetail(@RequestHeader(name = "id") String orderId);

比如说之前在quartz中通过Feign调用其他服务获取优惠券信息，项目中封装的方法获取的attributes 是空的。

ServletRequestAttributes attributes = (ServletRequestAttributes)
                RequestContextHolder.getRequestAttributes();

这时候就不用拦截器了，直接在方法入参上加上 @RequestHeader注解。

这里简单介绍下Feign调用的传参，实际在项目中，大家对Feign调用方法都有自己的封装，代码和上面的可能不一样，但是原理都是差不多的。

调用feign接口时，如何往header中添加参数

Controller接收到请求后，我们可以在service中通过feign直接调用其它服务的接口，但是，controller接收到的请求和通过feign调用其它服务，其它服务接收到的请求，是不一样的。例如我们往往习惯于在header中放入用户的token信息，在不做处理的情况下，其它服务接收到的请求，可能就是无用户信息状态，这种请求应该判定为无效状态。

在服务的提供方或者调用方定义一个拦截器，将当前请求的token信息手动添加到feign请求的header中。

@Configuration
public class FeignRequestInterceptorConfig implements RequestInterceptor {
	@Bean
	public RequestContextListener requestContextListener() {
		return new RequestContextListener();
	}

	@Override
	public void apply(RequestTemplate requestTemplate) {
		ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
		if (ObjectUtils.isEmpty(attributes)) {
			return;
		}
		HttpServletRequest request = attributes.getRequest();
		String token = request.getHeader("token");
		requestTemplate.header("token", token);
	}
}

在使用过程中，可能会涉及到在请求方获取自己的token信息都是为空的，查看一下是否是Hystrix策略导致的，如下配置可以解决该问题。

hystrix:
  command:
    default:
      execution:
        timeout:
          #如果enabled设置为false，则请求超时交给ribbon控制
          enabled: true
        isolation:
          # 隔离策略
          strategy: SEMAPHORE
          thread:
            timeoutInMilliseconds: 100000