前言:已经有很多的retrofit源码分析了。为什么还要写这篇文章呢。有几个目的吧
1、自己记录下分析过程的心得,加深印象。
2、希望能作为辅助参考帮助到其他学习retrofit源码的人。
3、与之前参考过的文章做个相互印证,也希望各位看到有什么错误的理解能提出来,有助于自己改正。
之前分析过Retrofit,大概的了解了注解和方法在何时被解析。以及动态代理的妙用。但是最近生出一个问题,gson转化器是什么时候被调用了?一时不能给出答案。这次便带着这个疑问去看了。
一、从构建retrofit实例说起,带着我的疑问去看(GsonConverter配置以后在什么位置调用了呢?)
retrofit = new Retrofit.Builder()
.client(EmptyUtils.checkNotNull(client))
.addConverterFactory(ScalarsConverterFactory.create())
.addConverterFactory(EmptyUtils.checkNotNull(converterFactory()))
.addCallAdapterFactory(EmptyUtils.checkNotNull(callAdapterFactory()))
.baseUrl(EmptyUtils.checkNotNull(baseUrl()))
.build();
一般来讲,我们会根据 Builder().build()来生成一个Retrofit实例。其中包含了各种配置。
(请求的客户端。json解析器,rxjava2calladapter)
当我们构建出来 retrofit 实例之后,这些配置就被设置到了retrofit 之中。下面是builder 的参数。
private final Platform platform; //平台。是java平台还是Android平台
private @Nullable okhttp3.Call.Factory callFactory; //client 一般来说我们配置的okhttpclient
private HttpUrl baseUrl; //url地址,不多说
//转换器,addConverterFactory的时候,多个都添加到了这个list中
private final List<Converter.Factory> converterFactories = new ArrayList<>();
//执行适配器(我是这么叫的),calladapter 通过 addCallAdapterFactory 添加的实例都放入了这个list
private final List<CallAdapter.Factory> callAdapterFactories = new ArrayList<>();
执行build的时候,将添加好的配置设置到了retrofit之中。
public Retrofit build() {
if (baseUrl == null) {
throw new IllegalStateException("Base URL required.");
}
okhttp3.Call.Factory callFactory = this.callFactory;
if (callFactory == null) {
callFactory = new OkHttpClient();
}
Executor callbackExecutor = this.callbackExecutor;
if (callbackExecutor == null) {
callbackExecutor = platform.defaultCallbackExecutor();
}
// Make a defensive copy of the adapters and add the default Call adapter.
List<CallAdapter.Factory> callAdapterFactories = new ArrayList<>(this.callAdapterFactories);
callAdapterFactories.add(platform.defaultCallAdapterFactory(callbackExecutor));
// Make a defensive copy of the converters.
List<Converter.Factory> converterFactories =
new ArrayList<>(1 + this.converterFactories.size());
// Add the built-in converter factory first. This prevents overriding its behavior but also
// ensures correct behavior when using converters that consume all types.
converterFactories.add(new BuiltInConverters());
converterFactories.addAll(this.converterFactories);
//将各个参数传入构造方法,生成retrofit实例,之前各种add只是将参数添加到了builder对象中,
//执行build才是真正将各个参数配置给了retrofit对象。这也是builder模式的使用方法。
return new Retrofit(callFactory, baseUrl, unmodifiableList(converterFactories),
unmodifiableList(callAdapterFactories), callbackExecutor, validateEagerly);
}
生成对象之后,我们会使用retrofit.create(XXXXService.class); //XXXXService是interface类型的。那我们就从create方法去入手。
public <T> T create(final Class<T> service) {
//1、验证服务接口。 检验文件是否是interface类型。 如果不是抛出异常。
Utils.validateServiceInterface(service);
if (validateEagerly) {
eagerlyValidateMethods(service);
}
//返回类型是通过动态代理生成的对象。T就是传入的接口类。
//动态代理的invoke方法,会在每个方法调用的时候执行。也就是xxxxservice.doAction()的时候;(例子,假设doAction是接口中的一个方法);
return (T) Proxy.newProxyInstance(service.getClassLoader(), new Class<?>[] { service },
new InvocationHandler() {
//获取平台类型。检查是Android还是Java。我们可以忽略,因为开发Android,平台类型一般都是Android。这里会得到一个Android类型的Platform对象。
private final Platform platform = Platform.get();
@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.
//检查方法是否来自Object。如果是就正常调用。我们传入的是接口类,所以这里不会执行,直接跳过。
if (method.getDeclaringClass() == Object.class) {
return method.invoke(this, args);
}
//这里我们向isDefaultMethod方法里面看,可以看到android平台的这个方法永远返回false。所以此处也是跳过。
if (platform.isDefaultMethod(method)) {
return platform.invokeDefaultMethod(method, service, proxy, args);
}
//这里是重点!!!,从这里开始去解析目前正在执行的方法。 就是去我们传入的接口类中,找到当前调用的doAction方法。同时去解析注解和各种参数。得到一个ServiceMethod对象。
ServiceMethod<Object, Object> serviceMethod =
(ServiceMethod<Object, Object>) loadServiceMethod(method);
//用serviceMethod对象生成一个OkHttpCall对象.serviceMethod中有解析到的各种配置。
OkHttpCall<Object> okHttpCall = new OkHttpCall<>(serviceMethod, args);
//返回一个对象,如果我们没有使用rxjava 那么拿到的是call对象。如果使用了rxjava。那么拿到的是Observable对象。
//此处拿到的返回对象,是在xxxxservice.doAction()时得到的对象。决定返回对象的类型。是在retrofit.builder.addCallAdapterFactory的时候.
return serviceMethod.adapt(okHttpCall);
}
});
}
至此。create分析的差不多了。 到此位置,以rxjava2为例,得到了一个Observable对象。 拿着这个对象可以进行后续的操作。
当然还有loadServiceMethod 与serviceMethod.adapt(okHttpCall)两个方法内部没有分析。这个放到后面补充