Retrofit原理浅析

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接口

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

注解 类型 作用
@GET 方法注解 表明HTTP请求方法为GET,(可选)注解的value属性用来设置相对/绝对url
@POST 方法注解 表明HTTP请求方法为POST,(可选)注解的value属性用来设置相对/绝对url
@PUT 方法注解 表明HTTP请求方法为PUT,(可选)注解的value属性用来设置相对/绝对url
@DELETE 方法注解 表明http请求方法为DELETE,(可选)注解的value属性用来设置相对/绝对url
@PATCH 方法注解 表明HTTP请求方法为PATCH,(可选)注解的value属性用来设置相对/绝对url
@HEAD 方法注解 表明HTTP请求方法为HEAD,(可选)注解的value属性用来设置相对/绝对url
@OPTIONS 方法注解 表明HTTP请求方法为OPTIONS,(可选)注解的value属性用来设置相对/绝对url
@HTTP 方法注解 通过@HTTP注解指定http协议的请求方法,是否允许body,(可选)注解的value属性用来设置相对/绝对url
@FormUrlEncoded 方法注解 表明发起HTTP请求的RequestBody是form表单方式
@Multipart 方法注解 表明发起HTTP请求的RequestBody是Multipar方式
@Headers 方法注解 使用注解的value值数组作为HTTP请求的头,用于一些固定的Header参数
@Streaming 方法注解 用于需要直接返回流的函数
@Url 参数注解 HTTP请求的url路径(相对/绝对),可以包含{path_holder},如:http://xxx.com/{user_holder}/detail
@Path 参数注解 用于动态替换URL路径中的path_holder
@Body 参数注解 表明此参数用作HTTP请求的body
@Field 参数注解 表明此参数用作HTTP请求的form表单参数,key为注解的value值
@FieldMap 参数注解 以map形式传入的form表单参数
@Header 参数注解 表明此参数用作HTTP请求的header,key为注解的value值
@HeaderMap 参数注解 以map形式传入的多个header键值对
@Part 参数注解 表明参数为Http的multipart参数之一
@PartMap 参数注解 以map形式传入的multipart参数表
@Query 参数注解 GET方法的query参数,用于拼接完整请求路径
@QueryMap 参数注解 以map传入的GET方法的query参数,用于拼接完整请求路径

生成动态代理实例

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的实现,此文章也只是一个浅析,希望能对各位开发同仁有些帮助吧。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,839评论 6 482
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,543评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 153,116评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,371评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,384评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,111评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,416评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,053评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,558评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,007评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,117评论 1 334
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,756评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,324评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,315评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,539评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,578评论 2 355
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,877评论 2 345

推荐阅读更多精彩内容