[享学Feign] 八、Feign是如何生成接口代理对象的？Feign实例的构建器Feign.Builder详解

public abstract class Feign {

	// 唯一的public的抽象方法，用于为目标target创建一个代理对象实例
	public abstract <T> T newInstance(Target<T> target);

	// -----------------静态方法-----------------

	// 工具方法，生成configKey
	// MethodMetadata#configKey属性的值就来自于此方法
	public static String configKey(Class targetType, Method method) { ... }

	// Feign的实例统一，有且只能通过builder构建，文下有详解，它是重点
	public static Builder builder() {
	  return new Builder();
	}
}

static final class ParseHandlersByName {

	// 提取器
    private final Contract contract;
    private final Options options;
    
    private final Encoder encoder;
    private final Decoder decoder;
    private final ErrorDecoder errorDecoder;
    private final QueryMapEncoder queryMapEncoder;

	// 这个工厂只产生SynchronousMethodHandler实例
	// 从这也很好理解：所有的Method最终的处理器都是SynchronousMethodHandler
    private final SynchronousMethodHandler.Factory factory;
	... // 省略构造器


	public Map<String, MethodHandler> apply(Target key) {
		// 通过Contract提取出该类所有方法的元数据信息：MethodMetadata
		// 它会解析注解，不同的实现支持的注解是不一样的
		List<MethodMetadata> metadata = contract.parseAndValidatateMetadata(key.type());

	  // 一个方法一个方法的处理，生成器对应的MethodHandler处理器
	  // 上篇文章有讲过，元数据都是交给RequestTemplate.Factory去构建成为一个请求模版的
      Map<String, MethodHandler> result = new LinkedHashMap<>();
      for (MethodMetadata md : metadata) {
		// 这里其实我觉得使用接口RequestTemplate.Factory buildTemplate更加的合适
		BuildTemplateByResolvingArgs buildTemplate;
		
		// 针对不同元数据参数，调用不同的RequestTemplate.Factory实现类完成处理
		if (!md.formParams().isEmpty() && md.template().bodyTemplate() == null) {
			// 若存在表单参数formParams，并且没有body模版，那就执行表单形式的构建
			buildTemplate = new BuildFormEncodedTemplateFromArgs(md, encoder, queryMapEncoder);
		} else if (md.bodyIndex() != null) {
			// 若存在body，那就是body喽
			buildTemplate = new BuildEncodedTemplateFromArgs(md, encoder, queryMapEncoder);
		} else {
			// 否则就是普通形式：查询参数构建方式
			buildTemplate = new BuildTemplateByResolvingArgs(md, queryMapEncoder);
		}

		// 通过factory.create创建出MethodHandler实例，缓存结果
		result.put(md.configKey(), factory.create(...));
		return result;
	}
}

public class ReflectiveFeign extends Feign {
	
  // 文上有解释次类的作用：提供方法，给接口每个方法生成一个处理器
  private final ParseHandlersByName targetToHandlersByName;
  // 它是调度中心
  private final InvocationHandlerFactory factory;
  private final QueryMapEncoder queryMapEncoder;

  ... // 省略构造器
}

ReflectiveFeign：

  @Override
  public <T> T newInstance(Target<T> target) {
	
	// 拿到该接口所有方法对应的处理器的Map
  	Map<String, MethodHandler> nameToHandler = targetToHandlersByName.apply(target);
  
	// 真要处理调用的Method对应的处理器Map
	Map<Method, MethodHandler> methodToHandler = new LinkedHashMap<>();
	// 简单的说：对接口默认方法作为处理方法提供支持，不用发http请求喽，一般可忽略
	List<DefaultMethodHandler> defaultMethodHandlers = new LinkedList<>();

	// 查阅该接口所有的Method。
	// .getMethods()会获取接口的所有的public方法，包括default方法哦（因为defualt方法也是public的）
	for (Method method : target.type().getMethods()) {
		... //如果是Object的方法，直接continue。method.getDeclaringClass() == Object.class
		... // 如果是Defualt默认方法，那该方法就用DefaultMethodHandler去处理
		... // 否则，就nameToHandler.get(Feign.configKey(target.type(), method))用它去处理
	}

	// 为该目标接口类型创建一个InvocationHandler
	// 它持有methodToHandler这个Map，负责全局调度所有的Method方法
	// 并且为此接口创建一个代理对象
	InvocationHandler handler = factory.create(target, methodToHandler);
	T proxy = (T) Proxy.newProxyInstance(target.type().getClassLoader(), new Class<?>[] {target.type()}, handler);

	// 根据前文知道：要想调用DefaultMethodHandler#invoke之前，必须先bind
	// 因此这里千万别忘了来一次bind绑定动作
    for (DefaultMethodHandler defaultMethodHandler : defaultMethodHandlers) {
      defaultMethodHandler.bindTo(proxy);
    }
    return proxy;
  }

public static class Builder {

	// 请求模版的拦截器，默认的空的，木有哦，你可以自定义，在builder的时候加进来
	private final List<RequestInterceptor> requestInterceptors = new ArrayList<>();

	// 这是Feign自己的日志级别，默认不输出日志
	// 因此若你要打印请求日志，这里级别需要调高
	private Logger.Level logLevel = Logger.Level.NONE;
	// 默认使用的日志记录器，也是不作为
	private Logger logger = new NoOpLogger();

	// 默认使用的提取器，就是支持@RequestLine源生注解的这种
	private Contract contract = new Contract.Default();
	// 默认使用JDK的`HttpURLConnection`发送请求，并且是非SSL加密的
	private Client client = new Client.Default(null, null);

	// 请务必注意：默认情况下Feign是开启了重试的
	// 100ms重试一次，一共重试5次。最长持续1s钟
	// 在生产环境下，重试请务必慎用
	private Retryer retryer = new Retryer.Default();
	// 默认10s链接超时，60s读取超时
	private Options options = new Options();

	// 默认编码器：只支持String类型的编码
	// 请注意：编码器的生效时机哦~~~（没有标注@Param注解会交给编码器处理）
    private Encoder encoder = new Encoder.Default();
    // 默认只能解码String类型和字节数组类型
    private Decoder decoder = new Decoder.Default();

	// 支持把@QueryMap标注在Map or Bean前面
	// Bean需要有public的get方法才算一个属性
	private QueryMapEncoder queryMapEncoder = new QueryMapEncoder.Default();
	// 把异常、错误码包装为FeignException异常向上抛出
	private ErrorDecoder errorDecoder = new ErrorDecoder.Default();
	
	// FeignInvocationHandler是它唯一的实现
	private InvocationHandlerFactory invocationHandlerFactory = new InvocationHandlerFactory.Default();

	// 默认不会解码404
	private boolean decode404;
	private boolean closeAfterDecode = true;
	// 异常传播策略：NONE代表不包装 不处理，直接抛
	private ExceptionPropagationPolicy propagationPolicy = NONE;
}

Feign.Builder：

	// 这两个方法调用其一，方法二是一的加强版
    public Builder decoder(Decoder decoder) {
      this.decoder = decoder;
      return this;
    }
    public Builder mapAndDecode(ResponseMapper mapper, Decoder decoder) {
      this.decoder = new ResponseMappingDecoder(mapper, decoder);
      return this;
    }

	// 拦截器一个个添加，可以多次调用添加多个
    public Builder requestInterceptor(RequestInterceptor requestInterceptor) {
      this.requestInterceptors.add(requestInterceptor);
      return this;
    }
    // 请注意：如果一次性添加多个，那么此方法相当于set方法哦，并不是add
    public Builder requestInterceptors(Iterable<RequestInterceptor> requestInterceptors) {
      this.requestInterceptors.clear();
      for (RequestInterceptor requestInterceptor : requestInterceptors) {
        this.requestInterceptors.add(requestInterceptor);
      }
      return this;
    }

	// 构建：返回一个ReflectiveFeign实例
    public Feign build() {
      	...
      	return new ReflectiveFeign( ... );
    }

@Test
public void fun1() {
    Feign feign = Feign.builder().build();
    DemoClient client = feign.newInstance(new Target.HardCodedTarget<>(DemoClient.class, "http://localhost:8080"));
    System.out.println(client);
}

HardCodedTarget(type=DemoClient, url=http://localhost:8080)

Feign.Builder

	// 很显然：方法一对调用者更加友好，因为Class和URL这些是使用者没有门槛的
	// 方法一依赖于方法二，它内部帮你构建Target的实例
    public <T> T target(Class<T> apiType, String url) {
      return target(new HardCodedTarget<T>(apiType, url));
    }
    public <T> T target(Target<T> target) {
      return build().newInstance(target);
    }

@Test
public void fun2(){
    DemoClient client = Feign.builder().target(DemoClient.class, "http://localhost:8080");
    System.out.println(client);
}