Android Retrofit 2.5.0 源码分析

主要参考文章:
Android Retrofit 2.0 的详细 使用攻略(含实例讲解)
Android:手把手带你 深入读懂 Retrofit 2.0 源码

主要过程:
1、建造者模式- 初始化所需 变量
2、使用retrofit.create(AccessApi.class) 生成动态代理对象,调用方法时,解析方法上的 注解+参数+参数的注解 生成ServiceMethod 并缓存
3、ServiceMethod 中能获取到retrofit初始化的变量,ServiceMethod.invoke(...) 中使用 这些变量发起请求callAdapter.adapt(new OkHttpCall<>(requestFactory, args, callFactory, responseConverter));
4、以rxjava为例,ServiceMethod.invoke(...) 返回来Observable, 订阅者->callAdapter->OkHttpCall->okhttp3.Call->网络请求->okhttp3.Call->OkHttpCall->converter数据解析->callAdapter->订阅者

1、初始化

主要是初始化以下 Retrofit 变量

变量 说明
callFactory OkHttpClient 调用newCall(...) 生成 原始请求
CallbackExecutor MainThreadExecutor使用handler切换到主线程
CallAdapterFactories 对OkHttpCall在一次包装,可以理解为CallAdapter(OkHttpCall(okhttp3.Call))
ConverterFactories 在OkHttpCall中 对 返回的原始数据进行 解析
HttpLoggingInterceptor loggerInterceptor = new HttpLoggingInterceptor();//打印 信息
loggerInterceptor.setLevel(HttpLoggingInterceptor.Level.BODY);
OkHttpClient client = new OkHttpClient.Builder().addNetworkInterceptor(loggerInterceptor).build();
// 初始化Retrofit
mRetrofit = new Retrofit.Builder()
    .client(client)
    .baseUrl(baseUrl)
    .addConverterFactory(GsonConverterFactory.create(buildGson()))
    .addCallAdapterFactory(RxJava2CallAdapterFactory.create())
    .build();

1.1 Retrofit.Builder() 变量

private final Platform platform; //平台类型
private @Nullable okhttp3.Call.Factory callFactory;//OkHttpClient

private @Nullable HttpUrl baseUrl;
//自己添加的 GsonConverterFactory
private final List<Converter.Factory> converterFactories = new ArrayList<>();
//自己添加的 RxJava2CallAdapterFactory
private final List<CallAdapter.Factory> callAdapterFactories = new ArrayList<>();
//没赋值 就是用 platform.defaultCallbackExecutor() = MainThreadExecutor
private @Nullable Executor callbackExecutor;
private boolean validateEagerly;

平台类型 有 Android, java8;这里主要看android

平台类型 CallbackExecutor CallAdapterFactories ConverterFactories
Android MainThreadExecutor CompletableFutureCallAdapterFactory
(api 24以上才有)
ExecutorCallAdapterFactory
OptionalConverterFactory
(api 24以上才有)
java8 。。。 。。。 。。。

1.2 Retrofit.Builder.build() 得到Retrofit 实例

Retrofit(okhttp3.Call.Factory callFactory, HttpUrl baseUrl,
List<Converter.Factory> converterFactories, List<CallAdapter.Factory> callAdapterFactories,
@Nullable Executor callbackExecutor, boolean validateEagerly) {

  this.callFactory = callFactory;//OkHttpClient
  this.baseUrl = baseUrl;
  this.converterFactories = converterFactories; // Copy+unmodifiable at call site.
  //BuiltInConverters + 自己添加的 + android平台 
  //BuiltInConverters、GsonConverterFactory、 OptionalConverterFactory(api24以上有)
  this.callAdapterFactories = callAdapterFactories; // Copy+unmodifiable at call site.
  //自己添加的+android平台  RxJava2CallAdapterFactory,CompletableFutureCallAdapterFactory(>api24)、ExecutorCallAdapterFactory
  this.callbackExecutor = callbackExecutor;//android 平台来说就是 MainThreadExecutor
  this.validateEagerly = validateEagerly;//作用:是否提前对业务接口中的注解进行验证转换的标志位

}
-- CallbackExecutor CallAdapterFactories ConverterFactories
Retrofit.Builder MainThreadExecutor CompletableFutureCallAdapterFactory(>api24)
ExecutorCallAdapterFactory
OptionalConverterFactory
(>api24)
Retrofit MainThreadExecutor RxJava2CallAdapterFactory
CompletableFutureCallAdapterFactory(>api24)
ExecutorCallAdapterFactory
BuiltInConverters
GsonConverterFactory
OptionalConverterFactory
(>api24)

2、使用

构建用了动态代理, 最终是通过okhttp
2.1 ServiceMethod 构建

public class JavaBean {}
public interface AccessApi {
  @GET("openapi.do?keyfrom=Yanzhikai&key=2032414398&type=data&doctype=json&version=1.1&q=car")
  Call<JavaBean> getCall();
}
AccessApi NetService = retrofit.create(AccessApi.class);
Call<JavaBean> call = NetService.getCall();

retrofit.create(AccessApi.class) 生成 代理对象

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();
        private final Object[] emptyArgs = new Object[0];

        @Override public Object invoke(Object proxy, Method method, @Nullable 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);
            }
            //1.8之后接口可以有默认的实现
            if (platform.isDefaultMethod(method)) {
                return platform.invokeDefaultMethod(method, service, proxy, args);
            }
            return loadServiceMethod(method).invoke(args != null ? args : emptyArgs);
        }
       });
}

loadServiceMethod(…) —> ServiceMethod.parseAnnotations(this, method); 根据方法的注解 生成 ServiceMethod实例

static <T> ServiceMethod<T> parseAnnotations(Retrofit retrofit, Method method) {
    RequestFactory requestFactory = RequestFactory.parseAnnotations(retrofit, method);
    //解析方法的注解,方法参数的注解,加上各种校验注解使用的正确性,构造出RequestFactory,待新建请求时使用

    Type returnType = method.getGenericReturnType();
    if (Utils.hasUnresolvableType(returnType)) {
        throw methodError(method,"Method return type must not include a type variable or wildcard: %s", returnType);
    }
    if (returnType == void.class) {
        throw methodError(method, "Service methods cannot return void.");
    }
    return HttpServiceMethod.parseAnnotations(retrofit, method, requestFactory);
}

HttpServiceMethod<ResponseT, ReturnT> extends ServiceMethod<ReturnT>
返回了 new HttpServiceMethod<>(requestFactory, callFactory, callAdapter, responseConverter)

参1、requestFactory = RequestFactory.parseAnnotations(retrofit, method);
参2、callFactory = retrofit.callFactory//OkHttpClient
参3、callAdapter 从 retrofit.callAdapterFactories 中 根据返参和注解,查找并生成 合适的CallAdapter;
参4、responseConverter 从 retrofit.converterFactories中 根据返参和注解,查找并生成 合适的Converter

2.2 ServiceMethod 方法的调用

@Override ReturnT invoke(Object[] args) {
return callAdapter.adapt(
    new OkHttpCall<>(requestFactory, args, callFactory, responseConverter));
}

OkHttpCall中会新建 原始请求,okhttp3 的请求

private okhttp3.Call createRawCall() throws IOException {
  okhttp3.Call call = callFactory.newCall(requestFactory.create(args));
  if (call == null) {
    throw new NullPointerException("Call.Factory returned null.");
  }
  return call;
}

OkHttpCall.enqueue(final Callback<T> callback) --> 调用 okhttp3.Call.enqueue(new okhttp3.Callback() {...}
结果返回后通过 responseConverter.convert(...) 将okhttp3 返回的数据 解析 为 想要的返回值(如Gson 转型)最后是一层一层回调出去。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念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

推荐阅读更多精彩内容