Retrofit2自定义CallAdapter

前言

本节将介绍如何自定一个CallAdapter,通过源码的级别讲解Retrofit2的CallAdapter。

先看一下CallAdapter接口定义及各方法的作用,已上注释:
public interface CallAdapter<R, T> {
  //返回此适配器将HTTP响应正文转换为Java时使用的值类型对象。 例如, Call <Repo>的响应类型是Repo。 这个类型用于准备传递给adapt的call。
  Type responseType();

//这个方法很重要,会在 Retrofit的create(final Class<T> service)方法中被调用,并把okHttpCall即Call传进来serviceMethod.callAdapter.adapt(okHttpCall),接下来我们可以对Call进行操作了
  T adapt(Call<R> call);

//CallAdapter工厂,retrofit默认的DefaultCallAdapterFactory其中不对Call做处理,是直接返回Call。
abstract class Factory {
// 在这个方法中判断是否是我们支持的类型,returnType 即Call<Requestbody>和`Observable<Requestbody>`
// RxJavaCallAdapterFactory 就是判断returnType是不是Observable<?> 类型
// 不支持时返回null
//返回值必须是Custom并且带有泛型(参数类型),根据APIService接口中的方法返回值,确定returnType,如: CustomCall<String> getCategories();,那确定returnType就是CustomCall<String>
public abstract @Nullable CallAdapter<?, ?> get(Type returnType, Annotation[] annotations,
    Retrofit retrofit);

 // 用于获取泛型的参数 如 Call<Requestbody> 中 Requestbody
protected static Type getParameterUpperBound(int index, ParameterizedType type) {
  return Utils.getParameterUpperBound(index, type);
}

 // 用于获取泛型的原始类型 如 Call<Requestbody> 中的 Call
//  如Call<Requestbody>拿到的原始类型就是Call
protected static Class<?> getRawType(Type type) {
  return Utils.getRawType(type);
      }

   }
 }

看看Retrofit默认使用的DefaultCallAdapterFactory,默认不做处理直接返回Call:

final class DefaultCallAdapterFactory extends CallAdapter.Factory {

static final CallAdapter.Factory INSTANCE = new DefaultCallAdapterFactory();

//重要的方法,注意看哥们
@Override
public CallAdapter<?, ?> get(Type returnType, Annotation[] annotations, Retrofit retrofit) {
//判断APIService接口方法的返回值,是否为Call,如果返回值不是Call,那么不做处理,返回null就是不处理。
if (getRawType(returnType) != Call.class) {
  return null;
}

//这里和我们在上面的介绍是一样的,底层也是调用了getParameterUpperBound(0, (ParameterizedType) returnType)方法,获取泛型的参数,即返回值类型,以便后期Converter做转换操作,
final Type responseType = Utils.getCallResponseType(returnType);

return new CallAdapter<Object, Call<?>>() {
  @Override public Type responseType() {
    return responseType;
  }
//直接返回Call
  @Override public Call<Object> adapt(Call<Object> call) {
    return call;
  }
};
}
}
没有demo说再多也没用,下面来自定义一个叫CustomCallAdapter:
  • 第一步定义CustomCall,专门处理Call的数据

     public static class CustomCall<R> {
    
    public final Call<R> call;
    
    public CustomCall(Call<R> call) {
        this.call = call;
    }
    
    public R get() throws IOException {
          return call.execute().body();
          }
    }
    
  • 第二步定义CustomCallAdapter实现 Call<T> 到 CustomCall<T>的转换,这里需要注意的是最后的泛型,是我们要返回的类型:

    public class CustomCallAdapter implements CallAdapter<R, CustomCall<R>> {
    private final Type responseType;
    
    public CustomCallAdapter(Type responseType) {
      this.responseType = responseType;
    }
    
    /**
     * 真正数据的类型,如Call<T> 中的 T,这个T会作为  Converter.Factory.responseConverter的第一个参数
     *
     * @return
     */
    @Override
    public Type responseType() {
      return responseType;
      }
    
    @Override
      public CustomCall<R> adapt(Call<R> call) {
          return new CustomCall<>(call);
        }
    }
    
  • 第三部提供一个CustomCallAdapterFactory用于向Retrofit提供CustomCallAdapter:

    public class CustomCallAdapterFactory extends CallAdapter.Factory {
    
    public static CustomCallAdapterFactory create() {
      return new CustomCallAdapterFactory();
    }
    
    @Nullable
    @Override
    public CallAdapter<?, ?> get(Type returnType, Annotation[] annotations, Retrofit retrofit) {
    
      //获取原始类型
      Class<?> rawType = getRawType(returnType);
    
      //返回值必须是Custom并且带有泛型(参数类型),根据APIService接口中的方法返回值,确定returnType
      //如 CustomCall<String> getCategories();,那确定returnType就是CustomCall<String>
      if (rawType == CustomCall.class && returnType instanceof ParameterizedType) {
          Type callReturnType = getParameterUpperBound(0, (ParameterizedType) returnType);
          return new CustomCallAdapter(callReturnType);
      }
    
      return null;
      }
    }
    
  • 第四步使用addCallAdapterFactory向Retrofit注册CustomCallAdapterFactory

Retrofit retrofit = new Retrofit.Builder()
            .baseUrl(GitHubService.GLABALURL)
            .addCallAdapterFactory(CustomCallAdapterFactory.create())
            .addConverterFactory(StringConverterFactory.create())
            .addConverterFactory(GsonConverterFactory.create(gson))
            .client(client)
            .build();

注: addCallAdapterFactory与addConverterFactory同理,也有先后顺序。

最后来看看retrofit执行流程:

create(final Class<T> service)---> loadServiceMethod(method)---->
ServiceMethod.Builder..build()--->createCallAdapter()--->
method.getGenericReturnType()--->callAdapter(returnType,   annotations)--->
nextCallAdapter(null, returnType, annotations)--->
createResponseConverter()--->method.getAnnotations()--->
etrofit.responseBodyConverter(responseType, annotations)--->
nextResponseBodyConverter(null, type, annotations)

上面的是retrofit的执行流程,按照上面的步骤可以查看所有的源代码。

本节就到这里,下一节将会讲解,Converter 的自定义。可能文中会有疏漏或错误,敬请指正,谢谢大家!

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

推荐阅读更多精彩内容

  • 本文将顺着构建请求对象->构建请求接口->发起同步/异步请求的流程,分析Retrofit是如何实现的。 开始之前,...
    zhuhf阅读 1,612评论 0 10
  • Retrofit这个开源库出来也有一定年头了,记得之前还是在V1.0的版本的时候,之前在三月份也写过一个Retro...
    lovejjfg阅读 1,442评论 0 5
  • 简介 刚接触Retrofit的时候,就写了一篇简单的使用介绍:Retrofit 2.0基本使用方法,算是对Retr...
    Whyn阅读 2,841评论 4 24
  • Retrofit 源码解析 简单用法 Retrofit最简单的用法就是定义一个接口,创建Retrofit对象,调用...
    Kingty阅读 790评论 3 14
  • 1.早睡早起做到:早上6:30起床,晚上10:00上床,10:30睡觉。 2.背单词25个已经完成。 3.时间管理...
    爱婉红枫阅读 134评论 0 0