OpenFeign之@Headers注解
@Headers注解
@Headers是OpenFeign中的一个注解,用于指定请求头部信息。它可以添加多个键值对,每个键值对表示一个请求头部。
@Headers注解可以应用于方法级别或类级别。当应用于方法级别时,它将覆盖类级别的@Headers注解。
该注解常用于设置Content-Type、Accept、Authorization等请求头部信息。
使用方法:
- 在方法上添加@Headers注解。
- 在注解中指定请求头信息,格式为key=value,多个请求头之间用逗号分隔。
以下是使用@Headers注解的示例:
@FeignClient(name = "example-service")
public interface ExampleService {
@GetMapping("/example")
@Headers({"Content-Type: application/json", "Authorization: Bearer token"})
String getExampleData();
}
在这个示例中,我们定义了一个名为ExampleService的Feign客户端接口,其中有一个名为getExampleData的方法。通过在该方法上添加@Headers注解,我们指定了请求头信息,包括Content-Type和Authorization。
对于像token这样的认证信息,一般是不固定的,这就需要使用参数来进行传递,在@Headers注解中使用{}语法就可以引用方法参数。
示例:
@FeignClient(name = "example-service")
public interface ExampleService {
@GetMapping("/example")
@Headers({"Content-Type: application/json", "Authorization: Bearer {token}"})
String getExampleData(@Param("token") String token);
}
在这个示例中,我们在getExampleData方法的参数中添加了一个名为token的参数。然后,在@Headers注解中,我们使用{token}引用了这个参数的值,并将其设置为Authorization请求头的值。这样,当调用getExampleData方法时,传入的token参数值将被自动设置到请求头中。