feign源码解析--@RequestHeader为空导致的异常

最近在生产环境遇到一个很奇怪的问题,客户端传递过来的值在写入数据库之后,竟然变成了“{name}”这种字段名的占位符形式。查看日志后发现传过来的值为null(不是空字符串),feign远程调用接口已经声明required =false。feign接口详情如下:

Map test(@RequestHeader(value = "name", required = false) String name, @RequestHeader("remark") String remark);

注:本文基于springboot2.0.6 + springcloud Finchley.SR1,使用的feign-core是9.5.1版本。
feign重写了@RequestHeader、@RequestParam、@PathVariable这三个spring-web注解,参数初始化实现类位于openfeign-core.jar的annotation包,实现了AnnotatedParameterProcessor接口。三个注解的处理方式类似,本文从@RequestHeader开始解析。
回到最初提到的问题。出现这种情况,我们可以对feign的参数值设定做出如下设想:
1.初始化feign接口时,对方法中的参数赋一个默认值。
2.调用接口时,把默认值修改为用户传参。
根据以上猜想,我们先从初始化的代码进行分析。RequestHeaderParameterProcessor的主要方法如下:

public boolean processArgument(AnnotatedParameterContext context, Annotation annotation, Method method) {
    int parameterIndex = context.getParameterIndex();
    Class<?> parameterType = method.getParameterTypes()[parameterIndex];
    MethodMetadata data = context.getMethodMetadata();
    //本文中的参数类型为String 不进入if
    if (Map.class.isAssignableFrom(parameterType)) {
        Util.checkState(data.headerMapIndex() == null, "Header map can only be present once.", new Object[0]);
        data.headerMapIndex(parameterIndex);
        return true;
    } else {
        String name = ((RequestHeader)ANNOTATION.cast(annotation)).value();
        Util.checkState(Util.emptyToNull(name) != null, "RequestHeader.value() was empty 
              on parameter %s", new Object[]{parameterIndex});
        context.setParameterName(name);
        //设置context中的参数初始值,以String.format("{%s}", name)方式填充
        Collection<String> header = context.setTemplateParameter(name, (Collection)data.template().headers().get(name));
        data.template().header(name, header);
        return true;
    }
}

至此可以证明,第一个猜想是正确的,参数默认值是{name}。那么,替换参数是什么逻辑呢?为何null值并没有被替换?
通过分析AnnotatedParameterContext的构造方法不难得出,我们追踪的header存放在RequestTemplate的headers字段,以LinkedHashMap存放。在RequestTemplate的resolve方法中发现headers的初始化:

Map<String, Collection<String>> resolvedHeaders = new LinkedHashMap<String, Collection<String>>();
for (String field : headers.keySet()) {
  Collection<String> resolvedValues = new ArrayList<String>();
  for (String value : valuesOrEmpty(headers, field)) {
    //header的值
    String resolved = expand(value, unencoded);
    resolvedValues.add(resolved);
  }
  resolvedHeaders.put(field, resolvedValues);
}
headers.clear();
headers.putAll(resolvedHeaders);

作为替换header值得关键,expand方法是什么样的呢?

public static String expand(String template, Map<String, ?> variables) {
    // 如果没有设置有效变量,则跳过扩展。
    if (checkNotNull(template, "template").length() < 3) {
      return template;
    }
    checkNotNull(variables, "variables for %s", template);
    boolean inVar = false;
    StringBuilder var = new StringBuilder();
    StringBuilder builder = new StringBuilder();
    for (char c : template.toCharArray()) {
      switch (c) {
        case '{':
          if (inVar) {
            // '{{' 是转义字符,不进行解析
            builder.append("{");
            inVar = false;
            break;
          }
          inVar = true;
          break;
        case '}':
          if (!inVar) {
            builder.append('}');
            break;
          }
          inVar = false;
          String key = var.toString();
          //这里的variables就是header的map,由于header中的name值为null,所以这里只有一个key-value
          Object value = variables.get(var.toString());
          if (value != null) {
            builder.append(value);
          } else {
          //“罪魁祸首”就在这里,又把初始化时的默认值返回了
            builder.append('{').append(key).append('}');
          }
          var = new StringBuilder();
          break;
        default:
          if (inVar) {
            var.append(c);
          } else {
            builder.append(c);
          }
      }
    }
    return builder.toString();
  }

终于找到了问题关键,其实解决方案也很简单,如果是null就替换为空字符串即可(是不是很惊喜~)。
Netflix应该也注意到了这个问题,所以在springcloud最新的RELEASE版本Greenwich.SR2中,已经更新至feign-core 10.2.3并修复了这个问题(springcloud更新实在是太快了,所以我也不知道具体哪个版本修复了这个问题)。最新版本中RequestTemplate已经修改的面目全非,其中resolve方法中对headers的初始化修改为如下方式:

if (!this.headers.isEmpty()) {
  resolved.headers(Collections.emptyMap());
  for (HeaderTemplate headerTemplate : this.headers.values()) {
        //这里的expand返回的已经不是{name},而是"name ",注意后面还有空格。
    String header = headerTemplate.expand(variables);
    if (!header.isEmpty()) {
          //因为测试用的name字段value是空,所以这里必然会是空的
      String headerValues = header.substring(header.indexOf(" ") + 1);
          //name这个header字段就这样被丢弃了。简单粗暴,所以现在如果header值为null,会直接抛异常。
      if (!headerValues.isEmpty()) {
        resolved.header(headerTemplate.getName(), headerValues);
      }
    }
  }
}

总结:解决本问题有两种方案:1.对于传入的值判空,如果为null则赋值空字符串。2.更新springcloud版本为最新。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。