OpenFeign设置header的3种方式

Posted 2023-04-11 java技术媛

设置OpenFeign的FeignClient的Header信息

在微服务间使用Feign进行远程调用时需要在 header 中添加信息，那么 SpringBoot和SpringCloud OpenFeign的@FeignClient如何设置 header 呢？有5种方式可以设置请求头信息:

• 在@RequestMapping注解里添加headers属性
• 在方法参数前面添加@RequestHeader注解
• 实现RequestInterceptor接口
由于Feign是完全支持Spring MVC注解的, 所以推荐使用前两种Feign设置header的方式, 即: Spring MVC中使用注解设置header.

1、在@RequestMapping注解里添加headers属性

在application.yml中配置

my.name=wtl
@PostMapping(value = "/service/rest/v1/script/scriptName/run",headers = "Authorization=Basic YWRtaW46QFdUTDE5OTIwMTE4MDI3MQ==","Content-Type=text/plain","AppSecret=$my.name")
    String runScript(@PathVariable("scriptName") String scriptName);

2、在方法参数前面添加@RequestHeader注解

设置单个header属性

@PostMapping(value = "/service/rest/v1/script/scriptName/run",headers = "Content-Type=text/plain","AppSecret=$my.name")

    String runScript(@PathVariable("scriptName") String scriptName,@RequestHeader("Authorization") String authorization);

public String runScript(String scriptName) 
        return nexusOpenFeign.runScript(scriptName,"Basic YWRtaW46QFdUTDE5OTIwMTE4MDI3MQ==");
    

设置多个header属性

@PostMapping(value = "/service/rest/v1/script/scriptName/run")
    String runScript(@PathVariable("scriptName") String scriptName,@RequestHeader MultiValueMap<String, String> headers);

public String runScript(String scriptName) 
        MultiValueMap<String, String> headers = new HttpHeaders();
        headers.put("Authorization", Collections.singletonList("Basic YWRtaW46QFdUTDE5OTIwMTE4MDI3MQ=="));
        headers.add("Content-Type","text/plain");
        return nexusOpenFeign.runScript(scriptName,headers);
    

3、实现RequestInterceptor接口

如果FeignRequestInterceptor注入到spring容器的话就会全局生效, 就是说即使在没有指定configuration属性的FeignClient该配置也会生效。
配置@Component或@Service 或 @Configuration 就可以将该配置注入spring容器中, 即可实现全局配置, 从而该项目中的所有FeignClient的feign接口都可以使用该配置.
如果只想给指定FeignClient的feign接口使用该配置, 请勿将该类配置注入spring中。

@Configuration
public class FeignRequestInterceptor implements RequestInterceptor 
 
    @Override
    public void apply(RequestTemplate template) 
        template.header(HttpHeaders.AUTHORIZATION, "tokenVal");
    
 

@FeignClient(url = "$user.api.url", name = "user", configuration = FeignRequestInterceptor.class)
public interface UserFeignClient 
    @GetMapping(value = "/simple/id")
    public User findById(@RequestParam("id") String id);

OpenFeign 源码默认超时时间与设置超时时间

查看资料都说openfeign的默认超时时间为1s，然后自己延时5s测试依然正常运行。

估计是版本升级，默认超时时间产生了改动。

	<dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
            <version>3.0.4</version>
   	</dependency>

openfeign版本为3.0.4，默认超时源码如下图

可以看到默认连接时长为10s，默认读取时长为60s。

现在设置超时时长使用feign，而不再是ribbon(假设设置5s)：

feign:
  client:
    config:
      default:
        # 指的是建立连接所用的时间，适用于网络状态正常的情况下，两端连接所用的时间
        ConnectTimeOut: 5000
        # 指的是建立连接后从服务器读取可用资源所用的时间
        ReadTimeOut: 5000