上一篇咱们分析了主流的开源框架的源码的第一篇OkHttp3,如今咱们来分析一下本系列第二篇——Retrofit2(源码以2.6.1版为准)。java
代理模式,可参考本人第一篇文章:Binder机制之AIDLandroid
OkHttp的源码分析,可参考上一篇:主流开源框架之OkHttp3深刻了解编程
Retrofit2是基于OkHttp的一个Restful Api请求工具,它是一个类型安全的http客户端请求工具(Type-safe HTTP client for Android and Java ),上一篇文章 [主流开源框架之OkHttp3深刻了解] 咱们已经了解OkHttp的机制和源码,这里咱们就来讲说Retrofit2了,从功能上来讲,Retrofit有点相似Volley,可是使用方式上相对而言Retrofit会更简单,咱们来看一张图: json
咱们的应用程序(即:“Application Layer”层) 经过Retrofti Layer层来封装咱们的请求参数、header头部和url等配置信息,而后交给OkHttp Layer层完成后续的请求操做。等服务端Server层将数据返回给OkHttp Layer层后又会将原始结果返回到Retrofit Layer层,最后由Retrofit Layer层返回给咱们的应用层。 而Retrofit2已经内置了OkHttp,这样Retrofit就能够专一于接口的封装操做,而让OkHttp专一于网络请求的高效操做,二者分工合做更能提升效率。设计模式
总结:api
public interface ApiService {
@GET("api")
Call<ResultBean> getResult(@Query("param") String param);
}
Retrofit RETROFIT_CLIENT = new Retrofit.Builder()
// 设置baseUrl,紧急baseUrl结尾必定要带“/”,不然会有异常的哦
.baseUrl(BASE_URL)
.client(OkHttpHolder.OK_HTTP_CLIENT)
// 直接返回String类型需引入:ScalarsConverterFactory.create()
// 添加响应数据转换器工厂,这里是Gson将得到响应结果转换成Gson对象
.addConverterFactory(GsonConverterFactory.create())
// 添加网络请求适配器工厂,这里是RxJava2将Call转换成Rxjava中的Observable
// .addCallAdapterFactory(RxJava2CallAdapterFactory.create())
.build();
// 建立接口实例
ApiService service = RETROFIT_CLIENT.create(ApiService.class);
// 调用接口中方法获取Call对象,此Call并不是OkHttp中的Call,
// 而是Retrofit对OkHttp中的Call进行封装的,所以使用此Call的同步/异步请求实际上就是使用OkHttp中的Call
Call<ResultBean> call = service.getResult("param");
// 发送同步请求
call.execute();
// 发送异步请求
call.enqueue(new Callback<ResultBean>() {
@Override
public void onResponse(Call<ResultBean> call, Response<ResultBean> response) {
// 主线程
String responseStr = response.body().toString();
Log.e("result", responseStr);
}
@Override
public void onFailure(Call<ResultBean> call, Throwable t) {
// 主线程
Log.e("result", t.getMessage());
}
});
复制代码
从使用上来看,Retrofit2仍是挺简单的,不过要注意这两个配置:数组
// 添加响应数据转换器工厂,这里是Gson将得到响应结果转换成Gson对象
.addConverterFactory(GsonConverterFactory.create())
// 添加网络请求适配器工厂,这里是RxJava2将Call转换成Rxjava中的Observable
.addCallAdapterFactory(RxJava2CallAdapterFactory.create())
复制代码
这里的ConverterFactory表示数据转换器工厂,就是将接收到的响应结果数据转换成想要的类型,例如通常使用Gson来解析服务器返回的数据,这里就添加了一个GsonConverterFactory。CallAdapterFactory表示的是网络请求适配器的工厂,它对应的是接口请求方法的返回类型,是将默认的ExecutorCallbackCall转换成适配其它不一样平台所须要的类型。例如这里添加了RxJava的适配器,那么接口中就能够写成如下这样,返回一个RxJava中的Observable类型。缓存
@GET("api")
Observable<ResultBean> getResult(@Query("param") String param);
复制代码
/**
* ConcurrentHashMap:一个线程安全的、支持高效并发的HashMap;
* Key 是 Method,Value 是 ServiceMethod。
* Method:就是上面接口中定义的getResult,这个方法中有不少注解:@GET、@Path、@Query等
* ServiceMethod:是将Method方法中全部的注解,解析后的对象就是ServiceMethod
* serviceMethodCache:主要是用于缓存ServiceMethod,好比说缓存ServiceMethod中一些网络请求的相关配置、网络请求的方法、数据转换器和网络请求适配器等等
*/
private final Map<Method, ServiceMethod<?, ?>> serviceMethodCache = new ConcurrentHashMap<>();
// Retrofit2中默认使用OkHttp,callFactory实际上就是OkHttpClient
final okhttp3.Call.Factory callFactory;
// 网络请求url的基地址
final HttpUrl baseUrl;
// 数据转换器工厂集合
final List<Converter.Factory> converterFactories;
// 网络请求适配器工厂集合
final List<CallAdapter.Factory> callAdapterFactories;
// Executor,这是个网络请求回调执行者,就是用来切换线程的
final @Nullable Executor callbackExecutor;
// 一个标志位,是否当即解析网络请求接口中的方法(即ApiService中的方法)
final boolean validateEagerly;
复制代码
// Retrofit.Builder类:
public static final class Builder {
// retrofit适配的平台:Android、Java8
private final Platform platform;
// 一下成员和第一部分【retrofit的成员属性】中讲解的同样
private @Nullable
okhttp3.Call.Factory callFactory;
private HttpUrl baseUrl;
private final List<Converter.Factory> converterFactories = new ArrayList<>();
private final List<CallAdapter.Factory> callAdapterFactories = new ArrayList<>();
private @Nullable
Executor callbackExecutor;
private boolean validateEagerly;
Builder(Platform platform) {
this.platform = platform;
}
public Builder() {
this(Platform.get());
}
......
}
复制代码
从Builder的成员中咱们看到了一个陌生的属性 Platform,这个 Platform 很重要,是获取当前须要适配的平台。咱们经过 Builder 的构造函数能够知道,调用了 Platform.get()方法,而后赋值给本身的 platform 变量。安全
class Platform {
private static final Platform PLATFORM = findPlatform();
static Platform get() {
return PLATFORM;
}
private static Platform findPlatform() {
try {
Class.forName("android.os.Build");
if (Build.VERSION.SDK_INT != 0) {
return new Android();
}
} catch (ClassNotFoundException ignored) {
}
try {
Class.forName("java.util.Optional");
return new Java8();
} catch (ClassNotFoundException ignored) {
}
return new Platform();
}
......
static class Android extends Platform {
@IgnoreJRERequirement // Guarded by API check.
@Override
boolean isDefaultMethod(Method method) {
// Api < 24 直接返回false
if (Build.VERSION.SDK_INT < 24) {
return false;
}
/**
* method.isDefault() 判断该方法是否为默认方法
* 默认方法是什么?
* Java 8 新增了接口的默认方法。
* 简单说,默认方法就是接口能够有实现方法,并且不须要实现类去实现其方法。
* 咱们只需在方法名前面加个 default 关键字便可实现默认方法。
* 所以咱们网络请求接口中通常定义的都不是默认方法
*/
return method.isDefault();
}
// 默认回调执行程序,用来切换线程
@Override
public Executor defaultCallbackExecutor() {
return new MainThreadExecutor();
}
// 默认的网络请求适配器
@Override
List<? extends CallAdapter.Factory> defaultCallAdapterFactories(@Nullable Executor callbackExecutor) {
if (callbackExecutor == null) throw new AssertionError();
DefaultCallAdapterFactory executorFactory = new DefaultCallAdapterFactory(callbackExecutor);
// 根据SDK大小返回适配器集合
return Build.VERSION.SDK_INT >= 24
// 仅在CompletableFuture(异步函数式编程)可用时添加(即:Java 8+ / Android API 24+)
? asList(CompletableFutureCallAdapterFactory.INSTANCE, executorFactory)
: singletonList(executorFactory); // 返回仅包含指定对象的不可变列表。 返回的列表是可序列化的。
}
// 默认调用适配器工厂大小
@Override
int defaultCallAdapterFactoriesSize() {
return Build.VERSION.SDK_INT >= 24 ? 2 : 1;
}
// 默认转换器工厂
@Override
List<? extends Converter.Factory> defaultConverterFactories() {
return Build.VERSION.SDK_INT >= 24
// 仅在Optional(Java8为了解决null值判断问题)可用时添加(即:Java 8+ / Android API 24+)。
? singletonList(OptionalConverterFactory.INSTANCE)
: Collections.<Converter.Factory>emptyList(); // 返回空集合
}
// 默认转换器工厂大小
@Override
int defaultConverterFactoriesSize() {
return Build.VERSION.SDK_INT >= 24 ? 1 : 0;
}
// 主线程执行器,内部使用Handler
static class MainThreadExecutor implements Executor {
private final Handler handler = new Handler(Looper.getMainLooper());
@Override
public void execute(Runnable r) {
handler.post(r);
}
}
}
}
复制代码
get 方法会去调用findPlatform方法,经过Class.forName反射查找"android.os.Build"或者"java.util.Optional"并返回不一样平台的platform对象,咱们分析 Android 平台,因此会返回一个Android()对象。咱们在Android对象中看到几个方法:bash
接下来咱们看一下build()方法:
// Retrofit.Builder类:
public static final class Builder {
......
public Retrofit build() {
// baseUrl不可空
if (baseUrl == null) {
throw new IllegalStateException("Base URL required.");
}
// 若请求网络工厂为空,会默认配置为 OkHttpClient
// "此处证时【retrofit的成员属性】中所说 callFactory 实际上就是OkHttpClient"
okhttp3.Call.Factory callFactory = this.callFactory;
if (callFactory == null) {
callFactory = new OkHttpClient();
}
// 若没配置回调执行器,则默认配置为Platform 的defaultCallbackExecutor,
// 上面咱们以前分析过defaultCallbackExecutor,它所返回的就是 MainThreadExecutor
Executor callbackExecutor = this.callbackExecutor;
if (callbackExecutor == null) {
callbackExecutor = platform.defaultCallbackExecutor();
}
// 添加默认的网络请求适配器,先添加开发者本身add的,后添加平台默认的
List<CallAdapter.Factory> callAdapterFactories = new ArrayList<>(this.callAdapterFactories);
callAdapterFactories.addAll(platform.defaultCallAdapterFactories(callbackExecutor));
List<Converter.Factory> converterFactories = new ArrayList<>(
1 + this.converterFactories.size() + platform.defaultConverterFactoriesSize());
// 首先添加内置(默认)转换器工厂,后添加开发者本身add的,若此时Api>24,则最后还会添加默认的转换器工厂
converterFactories.add(new BuiltInConverters());
converterFactories.addAll(this.converterFactories);
converterFactories.addAll(platform.defaultConverterFactories());
return new Retrofit(callFactory, baseUrl, unmodifiableList(converterFactories),
unmodifiableList(callAdapterFactories), callbackExecutor, validateEagerly);
}
}
复制代码
咱们多说一句,上面基本使用时咱们提到过baseUrl结尾要为“/”,不然会抛异常,那么咱们就来看一下baseUrl的构建:
// Retrofit.Builder类:
public Builder baseUrl(String baseUrl) {
checkNotNull(baseUrl, "baseUrl == null");
return baseUrl(HttpUrl.get(baseUrl));
}
public Builder baseUrl(HttpUrl baseUrl) {
checkNotNull(baseUrl, "baseUrl == null");
List<String> pathSegments = baseUrl.pathSegments();
if (!"".equals(pathSegments.get(pathSegments.size() - 1))) {
throw new IllegalArgumentException("baseUrl must end in /: " + baseUrl);
}
this.baseUrl = baseUrl;
return this;
}
复制代码
baseUrl方法实现很是简单就是将baseUrl设置到Retrofit.Builder中,参数类型为String的方法将传入的字符串封装成了一个HttpUrl对象,调用对应重载方法,重载方法中调用pathSegments方法将url分割,而后判断url是不是以斜杠结尾,不是则抛出异常。
至此,咱们的Retrofit就构建完成了。
// Retrofit类:
public <T> T create(final Class<T> service) {
// 验证服务接口
Utils.validateServiceInterface(service);
// 熟不熟悉,惊不惊喜,咱们在【retrofit的成员属性】中说过,validateEagerly为是否当即解析网络请求接口中的方法
if (validateEagerly) {
// 从名字能够看出,“热切地验证方法”,所以就是当即解析请求接口“ApiService”中的方法
eagerlyValidateMethods(service);
}
// retrofit的精华之一:动态代理模式
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 @Nullable
Object invoke(Object proxy, Method method,@Nullable Object[] args) throws Throwable {
// 若是方法是来自Object的方法,则遵循正常调用
if (method.getDeclaringClass() == Object.class) {
return method.invoke(this, args);
}
// 若是该方法是默认方法,则直接调用默认方法
if (platform.isDefaultMethod(method)) {
return platform.invokeDefaultMethod(method, service, proxy, args);
}
// 加载网络请求接口方法,并执行该方法
return loadServiceMethod(method).invoke(args != null ? args : emptyArgs);
}
});
}
private void eagerlyValidateMethods(Class<?> service) {
// 获取当前平台对象
Platform platform = Platform.get();
// 经过接口字节码class类获取全部 “声明的方法”
for (Method method : service.getDeclaredMethods()) {
// 咱们上面【retrofit的Builder】中
// 讲解到通常网络请求接口中都不是默认方法,而且也不会是静态方法,所以此if判断为 true
if (!platform.isDefaultMethod(method) && !Modifier.isStatic(method.getModifiers())) {
// 加载解析请求接口中的方法,该方法后续详细讲解
loadServiceMethod(method);
}
}
}
复制代码
此方法就是Retrofit设计的精髓之一,采用了外观模式和动态代理模式,而且建立了API接口的实例。此方法涉及的逻辑有点多,先来总结一下:
首先判断validateEagerly标识,默认为false,若为true,则先进入eagerlyValidateMethods方法,此方法循环遍历了做为参数传入的网络请求接口类中全部声明的方法,而且判断每一个方法既不是默认方法也不是静态方法就调用loadServiceMethod方法去加载这次遍历的方法。loadServiceMethod是一个用来解析API接口中的方法的方法,具体点来讲就是上面示例中ApiService中的每一个方法会被解析成一个ServiceMethod对象并进行缓存。
不管validateEagerly是true仍是false,都会走到return (T) Proxy.newProxyInstance这一步。这里使用了动态代理返回请求接口类的代理对象,invoke方法中先判断方法是不是Object类中方法,是就不作修改按照原样执行。再调用platform.isDefaultMethod判断是不是默认方法,是就调用platform.invokeDefaultMethod,该方法中抛出异常。最后这一行:
return loadServiceMethod(method).invoke(args != null ? args : emptyArgs)
复制代码
也是正常解析接口方法走到的。这里仍是先调用loadServiceMethod方法,而后执行其返回值ServiceMethod的方法。
如今咱们接着上面说的继续看loadServiceMethod方法:
// Retrofit类:
ServiceMethod<?> loadServiceMethod(Method method) {
// 咱们在【retrofit的成员属性】中说过serviceMethodCache,主要用于缓存ServiceMethod,
// 而ServiceMethod,是将Method方法中全部的注解,解析后的对象就是ServiceMethod
ServiceMethod<?> result = serviceMethodCache.get(method);
// 从缓存中查找ServiceMethod,有则直接返回
if (result != null) return result;
// 若缓存中没有ServiceMethod,则解析请求接口类中的方法建立ServiceMethod,并缓存
synchronized (serviceMethodCache) {
result = serviceMethodCache.get(method);
if (result == null) {
// 解析网络请求接口方法(method)上开发者添加的注释
result = ServiceMethod.parseAnnotations(this, method);
// 以method为key,缓存ServiceMethod
serviceMethodCache.put(method, result);
}
}
return result;
}
复制代码
loadServiceMethod方法中首先在serviceMethodCache缓存中查找这个方法,若是不为空直接返回。找不到进入同步代码块,同步代码块中再次判断缓存中是否存在该方法,不存在调用ServiceMethod.parseAnnotations方法解析方法注解得到解析结果,并将结果ServiceMethod加入缓存。此方法是双重锁定检查(DCL单例模式)。咱们接着看ServiceMethod的parseAnnotations这个解析注解的方法:
// ServiceMethod类:
static <T> ServiceMethod<T> parseAnnotations(Retrofit retrofit, Method method) {
// 解析注解得到一个RequestFactory(请求工厂,保存有跟请求相关的组件)
RequestFactory requestFactory = RequestFactory.parseAnnotations(retrofit, method);
// 获取方法返回类型
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);
}
// RequestFactory类(请求相关的全部组件,可用来构建OkHttp中的完整请求okhttp3.Request):
static RequestFactory parseAnnotations(Retrofit retrofit, Method method) {
return new Builder(retrofit, method).build();
}
private final Method method; // 网络请求接口中的方法
private final HttpUrl baseUrl; // 网络请求基地址
final String httpMethod; // http请求方法类型,好比:GET、POST等
private final @Nullable String relativeUrl; // 网络请求的相对地址,和baseUrl组合即为绝对地址
private final @Nullable Headers headers; // 请求头数据
private final @Nullable MediaType contentType; // 请求内容类型
private final boolean hasBody; // 是否有请求体
private final boolean isFormEncoded; // 表单编码标识
private final boolean isMultipart; // 多文件上传等的标识
private final ParameterHandler<?>[] parameterHandlers; // 接口方法参数处理程序
final boolean isKotlinSuspendFunction; // 是否为kotlin标识
Builder(Retrofit retrofit, Method method) {
this.retrofit = retrofit;
this.method = method;
// 三个数组的初始化
// 1. 初始化请求接口方法上的注解,对应使用例子中的@GET
this.methodAnnotations = method.getAnnotations();
// 2. 初始化请求接口方法参数类型,对应使用例子中的方法参数param的类型String
this.parameterTypes = method.getGenericParameterTypes();
// 3. 初始化请求接口方法参数上的注解,对应使用例子中的方法参数param上的@Query
this.parameterAnnotationsArray = method.getParameterAnnotations();
}
复制代码
咱们先来看一下这一部分代码:
咱们从上面代码中能够简单的看出第1步中,parseAnnotations方法以建造者模式建立一个RequestFactory对象,并在其Builder中初始化了三个数组,分别用来保存请求接口方法中的:
1.方法上的注解、2.方法参数的类型、3.方法参数里的注解
复制代码
咱们接着看第1步中RequestFactory.Builder.build()方法:
// RequestFactory.Builder类:
RequestFactory build() {
// 1. 循环解析方法上的注解
for (Annotation annotation : methodAnnotations) {
parseMethodAnnotation(annotation);
}
// HTTP请求方法类型为空抛出异常
if (httpMethod == null) {
throw methodError(method, "HTTP method annotation is required (e.g., @GET, @POST, etc" +".).");
}
// 注解错误抛出异常,Multipart与FormUrlEncoded必须在有请求体的post请求上使用
if (!hasBody) {
if (isMultipart) {
throw methodError(method,
"Multipart can only be specified on HTTP methods with request body (e.g.," +" @POST).");
}
if (isFormEncoded) {
throw methodError(method, "FormUrlEncoded can only be specified on HTTP methods " + "with "+ "request body (e.g., @POST).");
}
}
// 得到方法参数个数
int parameterCount = parameterAnnotationsArray.length;
parameterHandlers = new ParameterHandler<?>[parameterCount];
// 2. 循环遍历解析每一个请求接口方法的参数
for (int p = 0, lastParameter = parameterCount - 1; p < parameterCount; p++) {
// 传入经过从Builder()构造函数中初始化的parameterTypes和parameterAnnotationsArray对应位置的值
parameterHandlers[p] =
parseParameter(p, parameterTypes[p], parameterAnnotationsArray[p],p == lastParameter);
}
// 3. 判断各类使用错误状况抛出对应异常
if (relativeUrl == null && !gotUrl) {
throw methodError(method, "Missing either @%s URL or @Url parameter.", httpMethod);
}
if (!isFormEncoded && !isMultipart && !hasBody && gotBody) {
throw methodError(method, "Non-body HTTP method cannot contain @Body.");
}
if (isFormEncoded && !gotField) {
throw methodError(method, "Form-encoded method must contain at least one @Field.");
}
if (isMultipart && !gotPart) {
throw methodError(method, "Multipart method must contain at least one @Part.");
}
// 4. 建立RequestFactory对象返回
return new RequestFactory(this);
}
// 1.1 解析方法注解
private void parseMethodAnnotation(Annotation annotation) {
// 根据注解类型,解析方法、路径或者初始化header、isMultipart、isFormEncoded等成员属性
if (annotation instanceof DELETE) {
parseHttpMethodAndPath("DELETE", ((DELETE) annotation).value(), false);
} else if (annotation instanceof GET) {
parseHttpMethodAndPath("GET", ((GET) annotation).value(), false);
} else if (annotation instanceof HEAD) {
parseHttpMethodAndPath("HEAD", ((HEAD) annotation).value(), false);
} else if (annotation instanceof PATCH) {
parseHttpMethodAndPath("PATCH", ((PATCH) annotation).value(), true);
} else if (annotation instanceof POST) {
parseHttpMethodAndPath("POST", ((POST) annotation).value(), true);
} else if (annotation instanceof PUT) {
parseHttpMethodAndPath("PUT", ((PUT) annotation).value(), true);
} else if (annotation instanceof OPTIONS) {
parseHttpMethodAndPath("OPTIONS", ((OPTIONS) annotation).value(), false);
} else if (annotation instanceof HTTP) {
HTTP http = (HTTP) annotation;
parseHttpMethodAndPath(http.method(), http.path(), http.hasBody());
} else if (annotation instanceof retrofit2.http.Headers) {
String[] headersToParse = ((retrofit2.http.Headers) annotation).value();
if (headersToParse.length == 0) {
throw methodError(method, "@Headers annotation is empty.");
}
headers = parseHeaders(headersToParse);
} else if (annotation instanceof Multipart) {
if (isFormEncoded) {
throw methodError(method, "Only one encoding annotation is allowed.");
}
isMultipart = true;
} else if (annotation instanceof FormUrlEncoded) {
if (isMultipart) {
throw methodError(method, "Only one encoding annotation is allowed.");
}
isFormEncoded = true;
}
}
// 1.2 解析Http方法和路径
private void parseHttpMethodAndPath(String httpMethod, String value, boolean hasBody) {
if (this.httpMethod != null) {
throw methodError(method, "Only one HTTP method is allowed. Found: %s and %s.",
this.httpMethod, httpMethod);
}
// 初始化httpMethod和hasBody成员属性
this.httpMethod = httpMethod;
this.hasBody = hasBody;
if (value.isEmpty()) {
return;
}
// 获取相对URL路径和现有查询字符串(若是存在)。
int question = value.indexOf('?');
if (question != -1 && question < value.length() - 1) {
// 确保查询字符串没有任何命名参数。
String queryParams = value.substring(question + 1);
Matcher queryParamMatcher = PARAM_URL_REGEX.matcher(queryParams);
if (queryParamMatcher.find()) {
throw methodError(method, "URL query string \"%s\" must not have replace block. " + "For dynamic query parameters use @Query.", queryParams);
}
}
// 初始化relativeUrl和relativeUrlParamNames成员属性
this.relativeUrl = value;
this.relativeUrlParamNames = parsePathParameters(value);
}
// 2.1 解析请求方法中的参数
private @Nullable ParameterHandler<?> parseParameter(
int p, Type parameterType, @Nullable Annotation[] annotations, boolean allowContinuation) {
ParameterHandler<?> result = null;
if (annotations != null) {
for (Annotation annotation : annotations) {
// 解析参数中的注解,包括参数中的可能包含的路径、查询条件等等
// 因为此方法代码过多,暂就不分析啦,感兴趣的小伙伴自行查看吧。
ParameterHandler<?> annotationAction =
parseParameterAnnotation(p, parameterType, annotations, annotation);
if (annotationAction == null) {
continue;
}
if (result != null) {
throw parameterError(method, p, "Multiple Retrofit annotations found, only one allowed.");
}
result = annotationAction;
}
}
if (result == null) {
if (allowContinuation) {
try {
if (Utils.getRawType(parameterType) == Continuation.class) {
isKotlinSuspendFunction = true;
return null;
}
} catch (NoClassDefFoundError ignored) {
}
}
throw parameterError(method, p, "No Retrofit annotation found.");
}
return result;
}
复制代码
build方法中作了四件事:
接着简单看下HttpServiceMethod的parseAnnotations方法:
// HttpServiceMethod类:
static <ResponseT, ReturnT> HttpServiceMethod<ResponseT, ReturnT> parseAnnotations(
Retrofit retrofit, Method method, RequestFactory requestFactory) {
boolean isKotlinSuspendFunction = requestFactory.isKotlinSuspendFunction;
boolean continuationWantsResponse = false;
boolean continuationBodyNullable = false;
// 得到方法上的全部注解
Annotation[] annotations = method.getAnnotations();
// 1. 获取方法返回类型
Type adapterType;
if (isKotlinSuspendFunction) {
... // 本文不分析kotlin部分
} else {
// 非Kotlin,获取方法返回类型,即用于肯定使用哪一个网络请求适配器
adapterType = method.getGenericReturnType();
}
// 2. 调用createCallAdapter建立一个CallAdapter网络请求适配器
CallAdapter<ResponseT, ReturnT> callAdapter =
createCallAdapter(retrofit, method, adapterType, annotations);
// 得到CallAdapter的响应类型
Type responseType = callAdapter.responseType();
// 是okhttp中的Response抛出异常
if (responseType == okhttp3.Response.class) {
throw methodError(method, "'"
+ getRawType(responseType).getName()
+ "' is not a valid response body type. Did you mean ResponseBody?");
}
// 响应类型不包含泛型类型抛出异常
if (responseType == Response.class) {
throw methodError(method, "Response must include generic type (e.g., " +
"Response<String>)");
}
// TODO support Unit for Kotlin?
if (requestFactory.httpMethod.equals("HEAD") && !Void.class.equals(responseType)) {
throw methodError(method, "HEAD method must use Void as response type.");
}
// 调用createResponseConverter方法建立ResponseConverter数据转换器
Converter<ResponseBody, ResponseT> responseConverter =
createResponseConverter(retrofit, method, responseType);
// 获取请求工厂
okhttp3.Call.Factory callFactory = retrofit.callFactory;
if (!isKotlinSuspendFunction) { // 非Kotlin
// 3. 建立并返回CallAdapted,参数:requestFactory、callFactory、responseConverter、callAdapter
return new CallAdapted<>(requestFactory, callFactory, responseConverter, callAdapter);
} ...
}
// HttpServiceMethod.CallAdapted类:
CallAdapted(RequestFactory requestFactory, okhttp3.Call.Factory callFactory,
Converter<ResponseBody, ResponseT> responseConverter,
CallAdapter<ResponseT, ReturnT> callAdapter) {
super(requestFactory, callFactory, responseConverter);
// 初始化网络适配器
this.callAdapter = callAdapter;
}
复制代码
先来梳理下HttpServiceMethod的parseAnnotations方法的流程:
下面咱们仍是来深刻分别看一下这几步具体逻辑:
// HttpServiceMethod类:
private static <ResponseT, ReturnT> CallAdapter<ResponseT, ReturnT> createCallAdapter(
Retrofit retrofit, Method method, Type returnType, Annotation[] annotations) {
try {
// 调用retrofit.callAdapter方法
return (CallAdapter<ResponseT, ReturnT>) retrofit.callAdapter(returnType, annotations);
} catch (RuntimeException e) { // Wide exception range because factories are user code.
throw methodError(method, e, "Unable to create call adapter for %s", returnType);
}
}
// Retrofit类:
public CallAdapter<?, ?> callAdapter(Type returnType, Annotation[] annotations) {
// 能够看出callAdapter就是一个包装方法,继而调用nextCallAdapter
return nextCallAdapter(null, returnType, annotations);
}
public CallAdapter<?, ?> nextCallAdapter(
@Nullable CallAdapter.Factory skipPast ,Type returnType,Annotation[] annotations) {
checkNotNull(returnType, "returnType == null");
checkNotNull(annotations, "annotations == null");
// 从网络请求适配器工厂集合中查找传入的适配器的位置
// 这里注意到nextCallAdapter方法传递的skipPast参数为null,因此这里indexOf返回-1,最终初始start为0
int start = callAdapterFactories.indexOf(skipPast) + 1;
// 循环遍历网络请求适配器工厂集合
for (int i = start, count = callAdapterFactories.size(); i < count; i++) {
// 调用Factory的get方法,根据网络请求接口方法的返回值,获取对应适配器
CallAdapter<?, ?> adapter = callAdapterFactories.get(i).get(returnType, annotations,this);
// 不为空就返回adapter
if (adapter != null) {
return adapter;
}
}
...
}
复制代码
从这段代码中能够看清晰的看出其调用顺序,nextCallAdapter方法中遍历网络请求适配器工厂集合,根据方法的返回类型调用工厂的get得到CallAdapter。还记得建立工厂集合时默认添加了一个DefaultCallAdapterFactory吗?Retrofit默认方法返回类型Call就对应了这个工厂。进入它的get方法查看一下:
// DefaultCallAdapterFactory类:
@Override
public @Nullable CallAdapter<?, ?> get(
Type returnType, Annotation[] annotations, Retrofit retrofit) {
if (getRawType(returnType) != Call.class) {
return null;
}
if (!(returnType instanceof ParameterizedType)) {
throw new IllegalArgumentException(
"Call return type must be parameterized as Call<Foo> or Call<? extends Foo>");
}
final Type responseType = Utils.getParameterUpperBound(0, (ParameterizedType) returnType);
final Executor executor = Utils.isAnnotationPresent(annotations, SkipCallbackExecutor.class)
? null
: callbackExecutor;
// 默认返回的网络适配器
return new CallAdapter<Object, Call<?>>() {
@Override
public Type responseType() {
return responseType;
}
// 注意此方法,下面会讲到的
@Override
public Call<Object> adapt(Call<Object> call) {
return executor == null ? call : new ExecutorCallbackCall<>(executor, call);
}
};
}
复制代码
DefaultCallAdapterFactory的get方法中根据传入的方法返回类型判断,返回类型不是Call类型就直接返回null。类型正确会返回一个CallAdapter。
// HttpServiceMethod类:
private static <ResponseT> Converter<ResponseBody, ResponseT> createResponseConverter(
Retrofit retrofit, Method method, Type responseType) {
Annotation[] annotations = method.getAnnotations();
try {
// 调用Retorfit中的方法responseBodyConverter
return retrofit.responseBodyConverter(responseType, annotations);
} catch (RuntimeException e) { // Wide exception range because factories are user code.
throw methodError(method, e, "Unable to create converter for %s", responseType);
}
}
// Retrofit类:
public <T> Converter<ResponseBody, T> responseBodyConverter(Type type, Annotation[] annotations) {
// 同callAdapter方法为包装方法
return nextResponseBodyConverter(null, type, annotations);
}
// 该方法逻辑和nextCallAdapter相似
public <T> Converter<ResponseBody, T> nextResponseBodyConverter(
@Nullable Converter.Factory skipPast, Type type, Annotation[] annotations) {
checkNotNull(type, "type == null");
checkNotNull(annotations, "annotations == null");
int start = converterFactories.indexOf(skipPast) + 1;
for (int i = start, count = converterFactories.size(); i < count; i++) {
// 调用数据转换器工厂的responseBodyConverter方法,根据responseType类型获取数据转化器
Converter<ResponseBody, ?> converter =
converterFactories.get(i).responseBodyConverter(type, annotations, this);
if (converter != null) {
//noinspection unchecked
return (Converter<ResponseBody, T>) converter;
}
}
...
}
复制代码
咱们发现createCallAdapter和createResponseConverter,这两个方法的流程很相似,都是会调用Retrofit类中对应方法,以后再调用对应next方法遍历集合,从中得到合适的适配器和转换器。这里来看下经常使用的Gson转换器的responseBodyConverter方法:
// GsonConverterFactory类:
public Converter<ResponseBody, ?> responseBodyConverter(Type type, Annotation[] annotations,
Retrofit retrofit) {
TypeAdapter<?> adapter = gson.getAdapter(TypeToken.get(type));
// 返回一个GsonResponseBodyConverter对象
return new GsonResponseBodyConverter<>(gson, adapter);
}
复制代码
终于能够回到Retrofit的create方法里了,因为以前分析可知loadServiceMethod方法最终会得到一个CallAdapted对象,这里就会接着调用它的invoke方法,而CallAdapted中没有实现invoke方法,invoke方法在其父类HttpServiceMethod中:
// HttpServiceMethod类:
@Override
final @Nullable
ReturnT invoke(Object[] args) {
// 建立了一个Call,实现类:OkHttpCall,注意这个Call还不是OkHttp中的Call类,它仍是Retrofit包中的类
Call<ResponseT> call = new OkHttpCall<>(requestFactory, args, callFactory,responseConverter);
return adapt(call, args);
}
// OkHttpCall类:
final class OkHttpCall<T> implements Call<T> {
// 保存网络请求信息的工厂对象
private final RequestFactory requestFactory;
private final Object[] args; // 网络请求真实参数
private final okhttp3.Call.Factory callFactory;
private final Converter<ResponseBody, T> responseConverter; // 数据转换器
private volatile boolean canceled; // 判断是否取消call
@GuardedBy("this")
private @Nullable okhttp3.Call rawCall; // 这个rawCall才是OkHttp中的Call
@GuardedBy("this")
private boolean executed; // 异步请求时使用的标志位
......
}
// HttpServiceMethod.CallAdapted类:
@Override
protected ReturnT adapt(Call<ResponseT> call, Object[] args) {
return callAdapter.adapt(call);
}
复制代码
总结一下此处的逻辑:
咱们上面【createCallAdapter】使用的是DefaultCallAdapterFactory为例,介绍的适配器的get方法,那么咱们如今也使用DefaultCallAdapterFactory返回的CallAdapter为例,来介绍一下adapt方法:
@Override
public @Nullable CallAdapter<?, ?> get(
Type returnType, Annotation[] annotations, Retrofit retrofit) {
...
return new CallAdapter<Object, Call<?>>() {
@Override
public Type responseType() {
return responseType;
}
@Override
public Call<Object> adapt(Call<Object> call) {
return executor == null
? call
: new ExecutorCallbackCall<>(executor, call);
}
};
}
复制代码
return 返回了CallAdapter,其中adapt方法返回的是一个ExecutorCallbackCall类型,它实现了Retrofit的Call接口,就是最终返回的适配后的Call类型。
总结一下:
Retrofit中的同步异步请求实际上很相似,只是异步请求最后会把回调方法交给【retrofit的Builder】中提到的回调执行器,来切换为主线程并处理回调。Retrofit中同步不管是哪一种网络请求适配器,最后调用的都是OkHttpCall的execute()方法,例如:默认网络请求适配器工厂建立的适配器 adapt 适配后返回的ExecutorCallbackCall类:
// DefaultCallAdapterFactory.ExecutorCallbackCall类:
final Executor callbackExecutor; // 回调执行器
final Call<T> delegate; // 实际上为OkHttpCall
ExecutorCallbackCall(Executor callbackExecutor, Call<T> delegate) {
this.callbackExecutor = callbackExecutor;
this.delegate = delegate;
}
@Override
public Response<T> execute() throws IOException {
return delegate.execute(); // 执行OkHttpCall的execute()方法
}
复制代码
从上面代码能够很明显看出,Retrofit同步请求最后调用的仍是OkHttpCall的execute()方法:
// OkHttpCall类:
@Override
public Response<T> execute() throws IOException {
okhttp3.Call call;
synchronized (this) {
if (executed) throw new IllegalStateException("Already executed.");
executed = true; // 防止重复执行
...
call = rawCall;
if (call == null) {
try {
call = rawCall = createRawCall(); // 建立真实Call
} catch (IOException | RuntimeException | Error e) {
throwIfFatal(e); // Do not assign a fatal error to creationFailure.
creationFailure = e;
throw e;
}
}
}
if (canceled) {
call.cancel();
}
// 执行同步请求,并阻塞等待解析响应
return parseResponse(call.execute());
}
// 建立真实Okhttp Call
private okhttp3.Call createRawCall() throws IOException {
// callFactory实际上为:OkHttpClient(【retrofit的Builder】处有说明)
// requestFactory请求工厂构建OkHttp中的Request(【Retrofit.create(经过动态代理生成请求对象)】有说明)
okhttp3.Call call = callFactory.newCall(requestFactory.create(args));
if (call == null) {
throw new NullPointerException("Call.Factory returned null.");
}
return call;
}
复制代码
execute方法中首先判断当前call是否为空,为空则调用createRawCall方法建立一个Call,这个对象类型能够看到就是OkHttp中的Call类型,接着调用call.execute方法得到OkHttp返回的Response,最后再调用parseResponse方法解析响应结果返回。
// OkHttpCall类:
Response<T> parseResponse(okhttp3.Response rawResponse) throws IOException {
// 得到响应中的body
ResponseBody rawBody = rawResponse.body();
// 移除rawResponse中的body只包含状态(至关于空响应)
rawResponse = rawResponse.newBuilder()
.body(new NoContentResponseBody(rawBody.contentType(), rawBody.contentLength()))
.build();
// 得到响应中的响应码
int code = rawResponse.code();
// 响应码小于200大于300表示错误
if (code < 200 || code >= 300) {
try {
// Buffer the entire body to avoid future I/O.
ResponseBody bufferedBody = Utils.buffer(rawBody);
// 调用Response.error将body和rawResponse返回
return Response.error(bufferedBody, rawResponse);
} finally {
rawBody.close();
}
}
// 响应码为204或者205
if (code == 204 || code == 205) {
rawBody.close();
// 响应码为204或者205调用Response.success返回响应体为空
return Response.success(null, rawResponse);
}
// 将响应体body封装成一个ExceptionCatchingResponseBody对象
ExceptionCatchingResponseBody catchingBody = new ExceptionCatchingResponseBody(rawBody);
try {
// 调用responseConverter.convert方法转换响应结果(实际上就是gson解析数据)
T body = responseConverter.convert(catchingBody);
// 调用Response.success将转换好的body和rawResponse返回
return Response.success(body, rawResponse);
} catch (RuntimeException e) {
// 若是底层源引起异常,则传播该异常,而不是指示它是运行时异常。
catchingBody.throwIfCaught();
throw e;
}
}
// 数据转化器,转换响应结果
final class GsonResponseBodyConverter<T> implements Converter<ResponseBody, T> {
private final Gson gson;
private final TypeAdapter<T> adapter;
GsonResponseBodyConverter(Gson gson, TypeAdapter<T> adapter) {
this.gson = gson;
this.adapter = adapter;
}
@Override
public T convert(ResponseBody value) throws IOException {
JsonReader jsonReader = gson.newJsonReader(value.charStream());
try {
T result = adapter.read(jsonReader);
if (jsonReader.peek() != JsonToken.END_DOCUMENT) {
throw new JsonIOException("JSON document was not fully consumed.");
}
return result;
} finally {
value.close();
}
}
}
复制代码
parseResponse方法中:
Retrofit中的Response和OkHttpCall相似,都不是OkHttp中的,而至关于OkHttp中okhttp3.Response和okhttp3.Call的包装类,而Retrofit中的Response中的success和error实际上就是返回不一样状态的Response。
GsonResponseBodyConverter的convert方法实现就比较简单了,就是调用Gson中的方法了。经过构造中传入的Gson对象建立一个JsonReader并将响应体的字符流传入,最后调用TypeAdapter.read(jsonReader)将请求体解析获得对应实体类。
【Retrofit同步请求execute方法】里已经说了,同步异步请求实际上很相似,那么咱们来看一下OkHttpCall的enqueue方法:
// OkHttpCall类:
@Override
public void enqueue(final Callback<T> callback) {
checkNotNull(callback, "callback == null");
okhttp3.Call call;
Throwable failure;
synchronized (this) {
if (executed) throw new IllegalStateException("Already executed.");
executed = true;
call = rawCall;
failure = creationFailure;
if (call == null && failure == null) {
try {
// 建立OkHttp中的Call,同 同步请求
call = rawCall = createRawCall();
} catch (Throwable t) {
throwIfFatal(t);
failure = creationFailure = t;
}
}
}
if (failure != null) {
callback.onFailure(this, failure);
return;
}
// 判断请求是否取消
if (canceled) {
call.cancel();
}
// 调用OkHttp中的call.enqueue
call.enqueue(new okhttp3.Callback() {
@Override // 响应成功
public void onResponse(okhttp3.Call call, okhttp3.Response rawResponse) {
Response<T> response;
try {
// 返回成功解析Response(同 同步请求)
response = parseResponse(rawResponse);
} catch (Throwable e) {
throwIfFatal(e);
callFailure(e);
return;
}
try {
// 调用callback.onResponse(成功回调)
callback.onResponse(OkHttpCall.this, response);
} catch (Throwable t) {
throwIfFatal(t);
t.printStackTrace(); // TODO this is not great
}
}
@Override // 响应失败
public void onFailure(okhttp3.Call call, IOException e) {
// 处理失败
callFailure(e);
}
private void callFailure(Throwable e) {
try {
// 调用callback.onFailure(失败回调)
callback.onFailure(OkHttpCall.this, e);
} catch (Throwable t) {
throwIfFatal(t);
t.printStackTrace(); // TODO this is not great
}
}
});
}
复制代码
OkHttpCall中的enqueue方法的逻辑和同步方法的逻辑相似,一样仍是先建立OkHttp中的Call,再调用OkHttp中Call的enqueue方法,成功得到到OkHttp的返回结果后再一样经过parseResponse方法解析,解析以后回调callback.onResponse,若OkHttp返回失败则回调callback.onFailure。而在默认的网络请求适配器中会将请求的响应回调发送到主线程中:
// DefaultCallAdapterFactory.ExecutorCallbackCall类:
@Override
public void enqueue(final Callback<T> callback) {
checkNotNull(callback, "callback == null");
delegate.enqueue(new Callback<T>() {
@Override
public void onResponse(Call<T> call, final Response<T> response) {
// 回调执行器,【retrofit的Builder】说明,实际上为MainThreadExecutor
// 而MainThreadExecutor里包含一个在主线程的Handler
// 而MainThreadExecutor中的execute方法中,实际上调用了Handler的post方法将传入的Runnable发回主线程
callbackExecutor.execute(new Runnable() {
@Override
public void run() {
if (delegate.isCanceled()) {
callback.onFailure(ExecutorCallbackCall.this, new IOException(
"Canceled"));
} else {
callback.onResponse(ExecutorCallbackCall.this, response);
}
}
});
}
@Override
public void onFailure(Call<T> call, final Throwable t) {
// 同上
callbackExecutor.execute(new Runnable() {
@Override
public void run() {
callback.onFailure(ExecutorCallbackCall.this, t);
}
});
}
});
}
复制代码
经过默认的网络请求适配器能够看出,不一样适配器对最终的响应有不一样的处理。
思考:
代理模式:为其余对象提供一种代理以控制对这个对象的访问。在某些状况下,一个对象不适合或者不能直接引用另外一个对象,而代理对象能够在客户端和目标对象之间起到中介的做用。
抽象角色:经过接口或抽象类声明真实角色实现的业务方法。
代理角色:实现抽象角色,是真实角色的代理,经过真实角色的业务逻辑方法来实现抽象方法,并能够附加本身的操做。
真实角色:实现抽象角色,定义真实角色所要实现的业务逻辑,供代理角色调用。
注:代理模式职责清晰,真实的角色就是实现实际的业务逻辑,不用关心其余非本职责的事务,经过后期的代理完成一件完成事务,附带的结果就是编程简洁清晰。
适配器模式:将一个类的接口适配成用户所期待的。一个适配容许一般由于接口不兼容而不能在一块儿工做的类工做在一块儿,作法是将类本身的接口包裹在一个已存在的类中。
类适配器:
public class Adaptee { // 源角色
public void SpecificRequest(){
System.out.println("须要适配的接口方法");
}
}
public interface Target { // 目标角色
void Request(); // 期待获得的接口
}
public class Adapter extends Adaptee implements Target { // 适配器角色
@Override
public void Request() {
SpecificRequest(); // 源角色须要适配的方法
System.out.println("被适配后的方法");
}
public static void main(String[] args) {
Target target = new Adapter();
target.Request();
}
}
对象适配器:
public class Adapter implements Target{
//经过组合的方式实现注入
private Adaptee adaptee; // 1
// private Adaptee adaptee = new Adaptee(); // 2
public Adapter(Adaptee adaptee){
this.adaptee=adaptee;
}
@Override
public void Request() {
adaptee.SpecificRequest();
System.out.println("被适配后的方法");
}
}
装饰模式:没必要改变原类文件和使用继承的状况下,动态地扩展一个对象的功能(使得它比原来更“漂亮”,或者在功能上更强大)。它是经过建立一个包装对象,也就是装饰来包裹真实的对象。(java IO 流是典型的装饰模式。)
即做为原来的这个类的使用者还不该该感觉到装饰前与装饰后有什么不一样,即用法不变,不然就破坏了原有类的结构了,因此装饰器模式要作到对被装饰类的使用者透明,这是对装饰器模式的一个基本要求。
复制代码
代理模式详情可参考本人第一篇文章:Binder机制之AIDL
OkHttp的源码分析,可参考上一篇:主流开源框架之OkHttp3深刻了解
参考连接:
...
(注:如有什么地方阐述有误,敬请指正。)