feign请求的封装

使用Feign类的build()方法获得ReflectiveFeign的实例，通过newInstance()方法获得所需要代理接口的代理类。

public <T> T target(Class<T> apiType, String url) {
  return target(new HardCodedTarget<T>(apiType, url));
}

 

首先将被代理的接口以及目标的url封装为target，具体的newInstance()实现在了ReflectiveFeign之中。

 

@SuppressWarnings("unchecked")
@Override
public <T> T newInstance(Target<T> target) {
  Map<String, MethodHandler> nameToHandler = targetToHandlersByName.apply(target);
  Map<Method, MethodHandler> methodToHandler = new LinkedHashMap<Method, MethodHandler>();
  List<DefaultMethodHandler> defaultMethodHandlers = new LinkedList<DefaultMethodHandler>();

  for (Method method : target.type().getMethods()) {
    if (method.getDeclaringClass() == Object.class) {
      continue;
    } else if(Util.isDefault(method)) {
      DefaultMethodHandler handler = new DefaultMethodHandler(method);
      defaultMethodHandlers.add(handler);
      methodToHandler.put(method, handler);
    } else {
      methodToHandler.put(method, nameToHandler.get(Feign.configKey(target.type(), method)));
    }
  }
  InvocationHandler handler = factory.create(target, methodToHandler);
  T proxy = (T) Proxy.newProxyInstance(target.type().getClassLoader(), new Class<?>[]{target.type()}, handler);

  for(DefaultMethodHandler defaultMethodHandler : defaultMethodHandlers) {
    defaultMethodHandler.bindTo(proxy);
  }
  return proxy;
}

 

此处，需要根据targetToHandlersByName的apply()方法，根据之前封装的target内的方法生成相应的MethodHandler。

 

public Map<String, MethodHandler> apply(Target key) {
  List<MethodMetadata> metadata = contract.parseAndValidatateMetadata(key.type());
  Map<String, MethodHandler> result = new LinkedHashMap<String, MethodHandler>();
  for (MethodMetadata md : metadata) {
    BuildTemplateByResolvingArgs buildTemplate;
    if (!md.formParams().isEmpty() && md.template().bodyTemplate() == null) {
      buildTemplate = new BuildFormEncodedTemplateFromArgs(md, encoder);
    } else if (md.bodyIndex() != null) {
      buildTemplate = new BuildEncodedTemplateFromArgs(md, encoder);
    } else {
      buildTemplate = new BuildTemplateByResolvingArgs(md);
    }
    result.put(md.configKey(),
               factory.create(key, md, buildTemplate, options, decoder, errorDecoder));
  }
  return result;
}

public List<MethodMetadata> parseAndValidatateMetadata(Class<?> targetType) {
  checkState(targetType.getTypeParameters().length == 0, "Parameterized types unsupported: %s",
             targetType.getSimpleName());
  checkState(targetType.getInterfaces().length <= 1, "Only single inheritance supported: %s",
             targetType.getSimpleName());
  if (targetType.getInterfaces().length == 1) {
    checkState(targetType.getInterfaces()[0].getInterfaces().length == 0,
               "Only single-level inheritance supported: %s",
               targetType.getSimpleName());
  }
  Map<String, MethodMetadata> result = new LinkedHashMap<String, MethodMetadata>();
  for (Method method : targetType.getMethods()) {
    if (method.getDeclaringClass() == Object.class ||
        (method.getModifiers() & Modifier.STATIC) != 0 ||
        Util.isDefault(method)) {
      continue;
    }
    MethodMetadata metadata = parseAndValidateMetadata(targetType, method);
    checkState(!result.containsKey(metadata.configKey()), "Overrides unsupported: %s",
               metadata.configKey());
    result.put(metadata.configKey(), metadata);
  }
  return new ArrayList<MethodMetadata>(result.values());
}

 

在apply()方法中，首先通过BaseContract的parseAndValidateMetadata()方法对所要代理的服务接口进行验证，保证接口的数量小于等于1，并且遍历接口内的方法，保证被代理的方法不是接口的默认方法并且不是接口的默认方法。

 

 

之后根据接口的所要代理的方法去调用parseAndValidateMetadata()方法继续验证。

protected MethodMetadata parseAndValidateMetadata(Class<?> targetType, Method method) {
  MethodMetadata data = new MethodMetadata();
  data.returnType(Types.resolve(targetType, targetType, method.getGenericReturnType()));
  data.configKey(Feign.configKey(targetType, method));

  if(targetType.getInterfaces().length == 1) {
    processAnnotationOnClass(data, targetType.getInterfaces()[0]);
  }
  processAnnotationOnClass(data, targetType);


  for (Annotation methodAnnotation : method.getAnnotations()) {
    processAnnotationOnMethod(data, methodAnnotation, method);
  }
  checkState(data.template().method() != null,
             "Method %s not annotated with HTTP method type (ex. GET, POST)",
             method.getName());
  Class<?>[] parameterTypes = method.getParameterTypes();

  Annotation[][] parameterAnnotations = method.getParameterAnnotations();
  int count = parameterAnnotations.length;
  for (int i = 0; i < count; i++) {
    boolean isHttpAnnotation = false;
    if (parameterAnnotations[i] != null) {
      isHttpAnnotation = processAnnotationsOnParameter(data, parameterAnnotations[i], i);
    }
    if (parameterTypes[i] == URI.class) {
      data.urlIndex(i);
    } else if (!isHttpAnnotation) {
      checkState(data.formParams().isEmpty(),
                 "Body parameters cannot be used with form parameters.");
      checkState(data.bodyIndex() == null, "Method has too many Body parameters: %s", method);
      data.bodyIndex(i);
      data.bodyType(Types.resolve(targetType, targetType, method.getGenericParameterTypes()[i]));
    }
  }

  if (data.headerMapIndex() != null) {
    checkState(Map.class.isAssignableFrom(parameterTypes[data.headerMapIndex()]),
            "HeaderMap parameter must be a Map: %s", parameterTypes[data.headerMapIndex()]);
  }

  if (data.queryMapIndex() != null) {
    checkState(Map.class.isAssignableFrom(parameterTypes[data.queryMapIndex()]),
            "QueryMap parameter must be a Map: %s", parameterTypes[data.queryMapIndex()]);
  }

  return data;
}

 

此处，是将整个方法抽象为MethodMetadata方法的元数据，顾名思义，方法的重要属性都会存储在这个类里面，并且生成这一方法在feign中的configKey。

 

public static String configKey(Class targetType, Method method) {
  StringBuilder builder = new StringBuilder();
  builder.append(targetType.getSimpleName());
  builder.append('#').append(method.getName()).append('(');
  for (Type param : method.getGenericParameterTypes()) {
    param = Types.resolve(targetType, targetType, param);
    builder.append(Types.getRawType(param).getSimpleName()).append(',');
  }
  if (method.getParameterTypes().length > 0) {
    builder.deleteCharAt(builder.length() - 1);
  }
  return builder.append(')').toString();
}

 

Configkey以类名方法名以及参数作为区分定位一个方法的key。

 

 

之后如果该类实现了接口，则去其接口类去扫描Header注解，否则在本接口去扫描该注解。

protected void processAnnotationOnClass(MethodMetadata data, Class<?> targetType) {
  if (targetType.isAnnotationPresent(Headers.class)) {
    String[] headersOnType = targetType.getAnnotation(Headers.class).value();
    checkState(headersOnType.length > 0, "Headers annotation was empty on type %s.",
               targetType.getName());
    Map<String, Collection<String>> headers = toMap(headersOnType);
    headers.putAll(data.template().headers());
    data.template().headers(null); // to clear
    data.template().headers(headers);
  }
}

 

并将该注解的内容转为map存储在方法元数据中。

 

 

在扫描完毕接口上的注解，之后将会取得该方法上的注解，依次通过processAnnotationOnMethod()方法去解析注解上的内容存储在方法元数据当中。在方法元数据当中，关于http请求的参数都存储在template之中。

protected void processAnnotationOnMethod(MethodMetadata data, Annotation methodAnnotation,
                                         Method method) {
  Class<? extends Annotation> annotationType = methodAnnotation.annotationType();
  if (annotationType == RequestLine.class) {
    String requestLine = RequestLine.class.cast(methodAnnotation).value();
    checkState(emptyToNull(requestLine) != null,
               "RequestLine annotation was empty on method %s.", method.getName());
    if (requestLine.indexOf(' ') == -1) {
      checkState(requestLine.indexOf('/') == -1,
          "RequestLine annotation didn't start with an HTTP verb on method %s.",
          method.getName());
      data.template().method(requestLine);
      return;
    }
    data.template().method(requestLine.substring(0, requestLine.indexOf(' ')));
    if (requestLine.indexOf(' ') == requestLine.lastIndexOf(' ')) {
      // no HTTP version is ok
      data.template().append(requestLine.substring(requestLine.indexOf(' ') + 1));
    } else {
      // skip HTTP version
      data.template().append(
          requestLine.substring(requestLine.indexOf(' ') + 1, requestLine.lastIndexOf(' ')));
    }

    data.template().decodeSlash(RequestLine.class.cast(methodAnnotation).decodeSlash());

  } else if (annotationType == Body.class) {
    String body = Body.class.cast(methodAnnotation).value();
    checkState(emptyToNull(body) != null, "Body annotation was empty on method %s.",
               method.getName());
    if (body.indexOf('{') == -1) {
      data.template().body(body);
    } else {
      data.template().bodyTemplate(body);
    }
  } else if (annotationType == Headers.class) {
    String[] headersOnMethod = Headers.class.cast(methodAnnotation).value();
    checkState(headersOnMethod.length > 0, "Headers annotation was empty on method %s.",
               method.getName());
    data.template().headers(toMap(headersOnMethod));
  }
}

 

如果定义了requestLine注解，则会根据空空格的位置去解析得到请求的方法类型，http版本以及请求的路径。

 

而Body注解和Header注解则是直接存储在元数据中。

 

在解析完毕之后，根据方法的configKey和方法的元数据作为机制对存储在map中。 之后继续通过processAnnotationsOnParameter(0方法去解析方法参数上的注解。

@Override
protected boolean processAnnotationsOnParameter(MethodMetadata data, Annotation[] annotations,
                                                int paramIndex) {
  boolean isHttpAnnotation = false;
  for (Annotation annotation : annotations) {
    Class<? extends Annotation> annotationType = annotation.annotationType();
    if (annotationType == Param.class) {
      String name = ((Param) annotation).value();
      checkState(emptyToNull(name) != null, "Param annotation was empty on param %s.",
          paramIndex);
      nameParam(data, name, paramIndex);
      if (annotationType == Param.class) {
        Class<? extends Param.Expander> expander = ((Param) annotation).expander();
        if (expander != Param.ToStringExpander.class) {
          data.indexToExpanderClass().put(paramIndex, expander);
        }
      }
      isHttpAnnotation = true;
      String varName = '{' + name + '}';
      if (data.template().url().indexOf(varName) == -1 &&
          !searchMapValuesContainsExact(data.template().queries(), varName) &&
          !searchMapValuesContainsSubstring(data.template().headers(), varName)) {
        data.formParams().add(name);
      }
    } else if (annotationType == QueryMap.class) {
      checkState(data.queryMapIndex() == null, "QueryMap annotation was present on multiple parameters.");
      data.queryMapIndex(paramIndex);
      data.queryMapEncoded(QueryMap.class.cast(annotation).encoded());
      isHttpAnnotation = true;
    } else if (annotationType == HeaderMap.class) {
      checkState(data.headerMapIndex() == null, "HeaderMap annotation was present on multiple parameters.");
      data.headerMapIndex(paramIndex);
      isHttpAnnotation = true;
    }
  }
  return isHttpAnnotation;
}

 

此处，扫描参数上的注解进行相应的解析，以Param注解为例子，当得到了相应的参数，以及参数上Param上的value中的名字时候将参数相应的位置与name的对应放在方法元数据当中，并且根据之前路径寻找可以注入的位置并记录相应的参数。

 

 

在完成了三个位置注解的扫描解析之后，回到targetToHandlersByName的apply()方法，则会一次根据之前得到的方法元数据去生成方法的代理处理类methodHandler，以之前生成的configKey作为键，methodHandler作为只存储在map中并返回，之后回到newInstance()中继续生成代理。

 

在最终，将方法类与方法的代理实现作为映射存储在map中，交由最后目标类的代理实现。

 

在得到了代理之后，在代理类中的invoke()方法中，根据之前方法与方法代理的映射寻找相应的methodHandler来调用。

@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
  if ("equals".equals(method.getName())) {
    try {
      Object
          otherHandler =
          args.length > 0 && args[0] != null ? Proxy.getInvocationHandler(args[0]) : null;
      return equals(otherHandler);
    } catch (IllegalArgumentException e) {
      return false;
    }
  } else if ("hashCode".equals(method.getName())) {
    return hashCode();
  } else if ("toString".equals(method.getName())) {
    return toString();
  }
  return dispatch.get(method).invoke(args);
}

@Override
public Object invoke(Object[] argv) throws Throwable {
  RequestTemplate template = buildTemplateFromArgs.create(argv);
  Retryer retryer = this.retryer.clone();
  while (true) {
    try {
      return executeAndDecode(template);
    } catch (RetryableException e) {
      retryer.continueOrPropagate(e);
      if (logLevel != Logger.Level.NONE) {
        logger.logRetry(metadata.configKey(), logLevel);
      }
      continue;
    }
  }
}

 

此处会根据之前解析的模板http请求模板，将得到的调用参数构造成请求模板requestTemplate。

 

真正的request的生成在调用了executeAndDecode()方法后，在target中生成。

@Override
public Request apply(RequestTemplate input) {
  if (input.url().indexOf("http") != 0) {
    input.insert(0, url());
  }
  return input.request();
}


public Request request() {
  Map<String, Collection<String>> safeCopy = new LinkedHashMap<String, Collection<String>>();
  safeCopy.putAll(headers);
  return Request.create(
      method,
      new StringBuilder(url).append(queryLine()).toString(),
      Collections.unmodifiableMap(safeCopy),
      body, charset
  );
}

 

之后就会是request的调用与response的解析。