今天嘗試用feign去調用其他部門提供的一個HTTP接口扇救,該接口要求在請求中設置一個username頭部滑频,用于身份鑒權。
@FeignClient(name = "kafka-client", url = "http://kafka.xxx.com")
public interface KafkaClient {
@GetMapping(value = "/api/clusterManager/listTopics")
@Headers( {"cache-control: no-cache", "username: wangyong@xxx.com"})
TopicsResponse listTopics(@RequestParam("clusterName") String clusterName,
@RequestParam("clusterArea") String clusterArea);
}
代碼寫好好荷愕,嘗試去進行訪問,確拋出如下錯誤信息:
{
"timestamp": 1551768926170,
"status": 500,
"error": "Internal Server Error",
"exception": "com.netflix.zuul.exception.ZuulException",
"message": "pre:AuthAccessFilter"
}
異常堆棧信息如下:
at feign.FeignException.errorStatus(FeignException.java:62)
at feign.codec.ErrorDecoder$Default.decode(ErrorDecoder.java:91)
at feign.SynchronousMethodHandler.executeAndDecode(SynchronousMethodHandler.java:134)
at feign.SynchronousMethodHandler.invoke(SynchronousMethodHandler.java:76)
at feign.ReflectiveFeign$FeignInvocationHandler.invoke(ReflectiveFeign.java:103)
at com.sun.proxy.$Proxy147.listTopics(Unknown Source)
at com.yidian.data.exptmgr.controller.KafkaController.getKafkaTopics(KafkaController.java:35)
// 省略更多異常堆棧信息
于是我嘗試通過debug來找到問題的根源棍矛,通過debug我發(fā)現(xiàn)feign會先將請求參數(shù)構建成Request對象安疗,request信息如下:
request
從圖中可看到,該Request實例的headers屬性為空够委,而Request又是根據(jù)RequestTemplate模板對象生成的荐类,RequestTemplate實例信息如下:
RequestTemplate
到這里可以看出,問題是出在RequestTemplate的構建構成中茁帽,于是我就去跟蹤RequestTemplate構建的代碼玉罐,發(fā)現(xiàn)RequestTemplate是根據(jù)MethodMetadata構建而成,而MethodMetadata就是對方法配置的抽象潘拨。
RequestTemplate template = resolve(argv, mutable, varBuilder);
if (metadata.queryMapIndex() != null) {
// add query map parameters after initial resolve so that they take
// precedence over any predefined values
template = addQueryMapQueryParameters(argv, template);
}
if (metadata.headerMapIndex() != null) {
template = addHeaderMapHeaders(argv, template);
}
從上述代碼可以看到吊输,header的設置是由metadata的headerMapIndex 屬性決定的,那么铁追,設置headerMapIndex的位置季蚂,必然就和Header的解析相關,于是通過查看方法引用,我找到了下面的代碼:
private void parseHeaders(MethodMetadata md, Method method,
RequestMapping annotation) {
// TODO: only supports one header value per key
if (annotation.headers() != null && annotation.headers().length > 0) {
for (String header : annotation.headers()) {
int index = header.indexOf('=');
if (!header.contains("!=") && index >= 0) {
md.template().header(resolve(header.substring(0, index)),
resolve(header.substring(index + 1).trim()));
}
}
}
}
從代碼中我們可以清晰的看到扭屁,解析過程中是從@RequestMapping或其派生注解的header屬性中解析Header的算谈,并且Header的key和value需要用“=”進行分割。
于是我修改成下面的形式料滥,問題就解決了:
@GetMapping(value = "/api/clusterManager/listTopics",
headers = {"cache-control=no-cache", "username=wangyong@xxx.com"})
TopicsResponse listTopics(@RequestParam("clusterName") String clusterName,
@RequestParam("clusterArea") String clusterArea);