快捷導(dǎo)航

OpenFeign設(shè)置header的三種方式總結(jié)

更新時(shí)間：2023年04月03日 11:23:43 作者：java技術(shù)媛

在微服務(wù)間使用Feign進(jìn)行遠(yuǎn)程調(diào)用時(shí)需要在header中添加信息,下面這篇文章主要給大家介紹了關(guān)于OpenFeign設(shè)置header的三種方式,文中通過(guò)實(shí)例代碼介紹的非常詳細(xì),需要的朋友可以參考下

設(shè)置OpenFeign的FeignClient的Header信息

在微服務(wù)間使用Feign進(jìn)行遠(yuǎn)程調(diào)用時(shí)需要在 header 中添加信息，那么 SpringBoot和SpringCloud OpenFeign的@FeignClient如何設(shè)置 header 呢？有5種方式可以設(shè)置請(qǐng)求頭信息:

• 在@RequestMapping注解里添加headers屬性

• 在方法參數(shù)前面添加@RequestHeader注解

• 實(shí)現(xiàn)RequestInterceptor接口

由于Feign是完全支持Spring MVC注解的, 所以推薦使用前兩種Feign設(shè)置header的方式, 即: Spring MVC中使用注解設(shè)置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、在方法參數(shù)前面添加@RequestHeader注解

設(shè)置單個(gè)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==");
    }

設(shè)置多個(gè)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、實(shí)現(xiàn)RequestInterceptor接口

如果FeignRequestInterceptor注入到spring容器的話(huà)就會(huì)全局生效, 就是說(shuō)即使在沒(méi)有指定configuration屬性的FeignClient該配置也會(huì)生效。
配置@Component或@Service 或 @Configuration 就可以將該配置注入spring容器中, 即可實(shí)現(xiàn)全局配置, 從而該項(xiàng)目中的所有FeignClient的feign接口都可以使用該配置.

如果只想給指定FeignClient的feign接口使用該配置, 請(qǐng)勿將該類(lèi)配置注入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);
}