如何为Feign客户端添加自定义请求头？

在微服务架构中，服务契约非常重要。Feign客户端是一个流行的构建微服务之间契约的方法。但是，在实际应用中，我们可能需要在Feign请求中添加自定义的请求头。那么，如何为Feign客户端添加自定义请求头呢？下面就让我们一步步进行探讨。

一、在@FeignClient注解中添加configuration属性

在@FeignClient注解中添加configuration属性，并且设置为FeignConfig.class，可以为Feign客户端应用自定义的Feign配置。以下是一个完整的示例：

@FeignClient(name = "exampleService", url = "${example-service.ribbon.listOfServers}", configuration = FeignConfig.class)
public interface ExampleServiceClient {
    @GetMapping("/example")
    String getExample();
}

在这个示例中，Feign客户端的名称为“exampleService”，URL由Ribbon进行负载均衡操作，并且配置为使用FeignConfig中定义的定制化配置。

二、为Feign客户端创建自定义的Feign配置类

需要创建一个Feign配置类，并在此类中实现定制化配置。在这个配置类中，我们可以添加请求拦截器，设置请求头等等。以下是一个完整的Feign配置类的示例：

@Configuration
public class FeignConfig {
    @Autowired
    private TokenProvider tokenProvider;

    @Bean
    public RequestInterceptor requestInterceptor() {
        return requestTemplate -> {
            requestTemplate.header("Authorization", "Bearer " + tokenProvider.getAccessToken());
        };
    }
}

在这个示例中，我们首先使用@Configuration注解标识这是一个配置类。然后，定义了一个@Autowired注解的TokenProvider成员变量来获取访问令牌。接下来，我们创建了一个名为requestInterceptor()的Bean方法，并且使用@Bean注解将其标记为Spring Bean。

在requestInterceptor()方法中，我们将Feign的RequestInterceptor接口注入，它有一个名为requestTemplate的参数。在方法体中，我们添加了我们想要的请求头，这里是Authorization请求头，我们从TokenProvider获取了令牌，并以Bearer格式添加到请求头中。这样，每个使用Feign客户端的请求都将带有我们设置的Authorization请求头。

三、使用Feign客户端

有了上面的步骤，我们现在可以使用Feign客户端来发起请求，并且自定义请求头已经添加到请求中。以下是一个完整的示例：

@RestController
public class ExampleController {
    @Autowired
    private ExampleServiceClient exampleServiceClient;

    @GetMapping("/example")
    public String getExample() {
        return exampleServiceClient.getExample();
    }
}

在这个示例中，我们首先使用@RestController注解标识这是一个控制器类。然后，我们通过@Autowired注解注入了ExampleServiceClient类的实例。在getExample()方法中，我们通过这个实例调用了getExample()方法，这个方法实际上是Feign客户端中定义的方法。可以看到，我们并没有进行任何的请求头设置，但是Feign客户端将会自动添加我们在配置类中定义的请求头。

四、结论

通过上面的步骤，我们可以为Feign客户端轻松添加自定义请求头。在实际应用中，可以根据实际情况设置自定义请求头，这有助于实现更高级别的安全认证以及服务跟踪等功能。希望这篇文章能够帮助到您在微服务架构中正确地使用Feign客户端。