Retrofit原理浅析

做Android也有几年了，各种Android http类库也用过不少，自己的做过的项目中也一直在尝试怎么封装让API接口定义和API使用者解耦，但一直感觉没有可以让人满意的框架，直到无意中在网上看到了JakeWharton大神的Retrofit这个类库。不得不说，真心是炒鸡解耦。

下面来简单分析一下这个Retrofit2的使用和实现。

类库使用示例

首先定义请求接口

public interface GitHub {
    @GET("/repos/{owner}/{repo}/contributors")
    Call<List<Contributor>> contributors(
        @Path("owner") String owner,
        @Path("repo") String repo);
  }

然后通过Retrofit生成一个刚才定义的接口的实现类，使用的是动态代理。

// Create a very simple REST adapter which points the GitHub API.
Retrofit retrofit = new Retrofit.Builder()
    .baseUrl(API_URL)
    .addConverterFactory(GsonConverterFactory.create())
    .build();

// Create an instance of our GitHub API interface.
GitHub github = retrofit.create(GitHub.class);

之后就可以使用接口进行请求了

// Create a call instance for looking up Retrofit contributors.
Call<List<Contributor>> call = github.contributors("square", "retrofit");

类库原理解析

注解

Retrofit使用注解+java接口来定义后台服务API接口

注解主要分为 方法注解 和 参数注解

生成动态代理实例

Retrofit使用的关键一步就是Retrofit.create函数创建接口动态代理的示例，代码如下

@SuppressWarnings("unchecked") // Single-interface proxy creation guarded by parameter safety.
  public <T> T create(final Class<T> service) {
    Utils.validateServiceInterface(service);
    if (validateEagerly) {
      eagerlyValidateMethods(service);
    }
    return (T) Proxy.newProxyInstance(service.getClassLoader(), new Class<?>[] { service },
        new InvocationHandler() {
          private final Platform platform = Platform.get();

          @Override public Object invoke(Object proxy, Method method, Object... args)
              throws Throwable {
            // If the method is a method from Object then defer to normal invocation.
            if (method.getDeclaringClass() == Object.class) {
              return method.invoke(this, args);
            }
            if (platform.isDefaultMethod(method)) {
              return platform.invokeDefaultMethod(method, service, proxy, args);
            }
            ServiceMethod serviceMethod = loadServiceMethod(method);
            OkHttpCall okHttpCall = new OkHttpCall<>(serviceMethod, args);
            return serviceMethod.callAdapter.adapt(okHttpCall);
          }
        });
  }

可以看到是为接口的每个method创建了一个对应的ServiceMethod,并使用这个ServiceMethod对象创建OkHttpCall,并使用ServiceMethod实例的callAdapter来调用okhttpCall并返回结果。

调用流程

通过上面代码可以看到调用关键的就是三步：

• 1 加载对应method的ServiceMethod实例
• 2 使用ServiceMethod实例和方法调用参数创建OkHttpCall
• 3 调用serviceMethod.callAdapter.adapt(okHttpCall)来产生method所定义的返回(Call<T>或者其他自定义CallAdapter支持的返回)

第一步、加载对应method的ServiceMethod实例

ServiceMethod中有以下四个变量比较重要

final okhttp3.Call.Factory callFactory;
final CallAdapter<?> callAdapter;
private final Converter<ResponseBody, T> responseConverter;
private final ParameterHandler<?>[] parameterHandlers;

• callFactory是用来创建真正要执行的okhttp3.Call的工厂类，可以Retrofit.Builder中设置，如果不设置，默认会new一个OkHttpClient作为callFactory
• callAdapter是用来最终处理OkHttpCall实例并返回接口Method所定义的返回
• responseConverter 用来将Http请求的结果转换成接口Method所定义的结果（return或者Callback<T>中的T）
• parameterHandlers 根据接口Method参数的注解所生成的参数处理Handler数组

然后我们来看Retrofit.loadServiceMethod方法

    ServiceMethod loadServiceMethod(Method method) {
    ServiceMethod result;
    synchronized (serviceMethodCache) {
      result = serviceMethodCache.get(method);
      if (result == null) {
        result = new ServiceMethod.Builder(this, method).build();
        serviceMethodCache.put(method, result);
      }
    }
    return result;
  }

可以看到此处先检查serviceMethodCache是否有该method对应的ServiceMethod实例缓存，如果没有，则创建一个该method对应的ServiceMethod实例并保存到缓存中。
ServiceMethod的创建使用的是建造者模式。

在ServiceMethod.Builder的build方法中，通过解析传入的method的方法定义(参数类型，返回类型，参数注解，方法注解)生成对应的callAdapter,responseConverter,parameterHandlers及其他一些创建请求需要用到的信息。

    public ServiceMethod build() {
      callAdapter = createCallAdapter();
      ......检查返回结果类型......
      responseConverter = createResponseConverter();
      //生成方法注解的处理器
      for (Annotation annotation : methodAnnotations) {
        parseMethodAnnotation(annotation);
      }
      .....方法与注解合法性检查.....
      int parameterCount = parameterAnnotationsArray.length;
      parameterHandlers = new ParameterHandler<?>[parameterCount];
      for (int p = 0; p < parameterCount; p++) {
        .....注解合法性检查....
        parameterHandlers[p] = parseParameter(p, parameterType, parameterAnnotations);
      }
      ......方法与注解合法性检查......
      return new ServiceMethod<>(this);
    }

此处在ServiceMethod.Builder.build()过程在生成过程中还会对method的定义做合法性检查，如：http方法是get就不允许方法参数中有body类型的参数；方法为post则必须有参数为Body类型。

第二步、使用ServiceMethod实例和方法调用参数创建OkHttpCall

获取到method对应的ServiceMethod实例后，会使用该ServiceMethod实例和方法调用的参数Object... args生成一个OkHttpCall。而OkHttpCall实际上是okhttp3.Call的一个包装类，实际调用OkHttpCall的相关执行方法时最终是调用OkHttpCall内部用ServiceMethod.callFactory创建的okhttp3.Call来执行网络请求。

第三步、调用serviceMethod.callAdapter.adapt(okHttpCall)来产生method所定义的返回

Retrofit2默认支持的返回是返回一个Call<T>,利用此Call<T>实例可执行

Response<T> result = call.execute();//同步执行

或

//异步执行
call.enqueue(new Callback(){
    public void onResponse(Call<T> call, Response<T> response){
        //TODO 
    }
    public void onFailure(Call<T> call, Throwable t){
        //TODO 
    }   
});

其中在Android平台Retrofit2会自动使用主线程handler构造一个ExecutorCallAdapterFactory，调用enqueue(Callback)，callback回调会在主线程中回调

另外在Retrofit的扩展Adapter中还提供了RxJavaCallAdapterFactory,Java8CallAdapterFactory,GuavaCallAdapterFactory

以RxJavaCallAdapterFactory为例，RxJavaCallAdapterFactory创建的callAdapter在执行adapt时将OkHttpCall包装一个Rx的Observable，在Observable被subscribe时才会真正的执行http请求。

写在最后

其实Retrofit已经不是一个新库了，目前版本也是第二个大版本了，本身Retrofit已经让http请求解耦很好了，再加上与Rx的配合，就真的是灵活到不行。我也是从去年下半年才开始关注和研究Retrofit的实现，此文章也只是一个浅析，希望能对各位开发同仁有些帮助吧。