}
直接返回参数,也就是OkHttpCall<Object>
的对象。所以如果没有自定义callAdapter
的时候,我们定义接口的时候返回值类型应该是个Call
类型的。
那么,至此这个create
方法已经帮我们实现了我们定义的接口,并返回我们需要的值。
请求参数整理
我们定义的接口已经被实现,但是我们还是不知道我们注解的请求方式,参数类型等是如何发起网络请求的呢?
这时我们可能应该关注一下ServiceMethod<Object, Object>
对象的构建了:
ServiceMethod<Object, Object> serviceMethod =
(ServiceMethod<Object, Object>) loadServiceMethod(method);
主要的逻辑都在这个loadServiceMethod(method)
里面,我们看看方法体:
ServiceMethod<?, ?> loadServiceMethod(Method method) {
ServiceMethod<?, ?> result = serviceMethodCache.get(method);
if (result != null) return result;
synchronized (serviceMethodCache) {
result = serviceMethodCache.get(method);
if (result == null) {
result = new ServiceMethod.Builder<>(this, method).build();
serviceMethodCache.put(method, result);
}
}
return result;
}
逻辑很简单,就是先从一个 serviceMethodCache
中取ServiceMethod<?, ?>
对象,如果没有,则构建ServiceMethod<?, ?>
对象,然后放进去serviceMethodCache
中,这个serviceMethodCache
是一个HashMap
:
private final Map<Method, ServiceMethod<?, ?>> serviceMethodCache = new ConcurrentHashMap<>();
所以构建ServiceMethod<?, ?>
对象的主要逻辑还不在这个方法里,应该在new ServiceMethod.Builder<>(this, method).build();
里面。这也是个链式调用,一般都是参数赋值,我们先看看Builder<>(this, method)
方法:
Builder(Retrofit retrofit, Method method) {
this.retrofit = retrofit;
this.method = method;
this.methodAnnotations = method.getAnnotations();
this.parameterTypes = method.getGenericParameterTypes();
this.parameterAnnotationsArray = method.getParameterAnnotations();
}
果然,这里获取了几个重要的参数:
-
retrofit
实例 -
method
,接口方法 -
接口方法的注解
methodAnnotations
,在retrofit
里一般为请求方式 -
参数类型
parameterTypes
-
参数注解数组
parameterAnnotationsArray
,一个参数可能有多个注解
我们再看看build()
的方法:
public ServiceMethod build() {
callAdapter = createCallAdapter();
responseType = callAdapter.responseType();
responseConverter = createResponseConverter();
for (Annotation annotation : methodAnnotations) {
parseMethodAnnotation(annotation);
}
if (httpMethod == null) {
throw methodError(“HTTP method annotation is required (e.g., @GET, @POST, etc.).”);
}
int parameterCount = parameterAnnotationsArray.length;
parameterHandlers = new ParameterHandler<?>[parameterCount];
for (int p = 0; p < parameterCount; p++) {
Type parameterType = parameterTypes[p];
if (Utils.hasUnresolvableType(parameterType)) {
throw parameterError(p, “Parameter type must not include a type variable or wildcard: %s”,
parameterType);
}
Annotation[] parameterAnnotations = parameterAnnotationsArray[p];
if (parameterAnnotations == null) {
throw parameterError(p, “No Retrofit annotation found.”);
}
parameterHandlers[p] = parseParameter(p, parameterType, parameterAnnotations);
}
return new ServiceMethod<>(this);
}
这个方法挺长的,删了些无关紧要的代码还是很长。首先一开始先获取几个重要对象:callAdapter
、responseType
和responseConverter
,这三个对象都跟最后的结果有关,我们先不管。
看到一个for
循环,遍历方法的注解,然后解析:
for (Annotation annotation : methodAnnotations) {
parseMethodAnnotation(annotation);
}
private void parseMethodAnnotation(Annotation annotation) {
if (annotation instanceof DELETE) {
parseHttpMethodAndPath(“DELETE”, ((DELETE) annotation).value(), false);
} else if (annotation instanceof GET) {
parseHttpMethodAndPath(“GET”, ((GET) annotation).value(), false);
}
…
这个方法的方法体我删掉了后面的一部分,因为逻辑都是一样,根据不同的方法注解作不同的解析,得到网络请求的方式httpMethod
。但是主要的方法体还是if
里面的方法:
private void parseHttpMethodAndPath(String httpMethod, String value, boolean hasBody) {
…
// Get the relative URL path and existing query string, if present.
int question = value.indexOf(‘?’);
if (question != -1 && question < value.length() - 1) {
// Ensure the query string does not have any named parameters.
String queryParams = value.substring(question + 1);
Matcher queryParamMatcher = PARAM_URL_REGEX.matcher(queryParams);
if (queryParamMatcher.find()) {
throw methodError("URL query string “%s” must not have replace block. "
- “For dynamic query parameters use @Query.”, queryParams);
}
}
this.relativeUrl = value;
this.relativeUrlParamNames = parsePathParameters(value);
}
逻辑不复杂,就是校验这个value
的值 是否合法,规则就是不能有“?”如果有则需要使用@Query
注解。最后this.relativeUrl = value;
。这个relativeUrl
就相当于省略域名的URL,一般走到这里我们能得到的是:users/{name}/repos
这样的。里面的“{name}”是一会我们需要赋值的变量。
我们继续看刚才的build()
方法:
解析完方法的注解之后,需要解析参数的注解数组,这里实例化了一个一维数组:
parameterHandlers = new ParameterHandler<?>[parameterCount];
然后遍历取出参数的类型:
Type parameterType = parameterTypes[p];
取出参数注解:
Annotation[] parameterAnnotations = parameterAnnotationsArray[p];
然后把参数类型、参数注解都放在一起进行解析,解析的结果放到刚才实例化的数组parameterHandlers
里面:
parameterHandlers[p] = parseParameter(p, parameterType, parameterAnnotations);
那我们再看看这个方法里做了什么:
private ParameterHandler<?> parseParameter(int p, Type parameterType, Annotation[] annotations) {
ParameterHandler<?> result = null;
for (Annotation annotation : annotations) {
ParameterHandler<?> annotationAction = parseParameterAnnotation(
p, parameterType, annotations, annotation);
}
}
这个方法的主要代码也很简单,解析参数注解,得到一个ParameterHandler<?> annotationAction
对象。
那我继续看方法里面的代码。当我们点进parseParameterAnnotation( p, parameterType, annotations, annotation);
的源码里面去之后发现这个方法的代码接近500行!但是大部分逻辑类似,都是通过if else
判断参数的注解,我们取一段我们刚才的例子相关的代码出来:
if (annotation instanceof Path) {
if (gotQuery) {
throw parameterError(p, “A @Path parameter must not come after a @Query.”);
}
if (gotUrl) {
throw parameterError(p, “@Path parameters may not be used with @Url.”);
}
if (relativeUrl == null) {
throw parameterError(p, “@Path can only be used with relative url on @%s”, httpMethod);
}
gotPath = true;
Path path = (Path) annotation;
String name = path.value();
validatePathName(p, name);
Converter<?, String> converter = retrofit.stringConverter(type, annotations);
return new ParameterHandler.Path<>(name, converter, path.encoded());
}
前面做了一些校验,后面取出注解的名字:name
,然后用正则表达校验这个name
是否合法。然后构建一个Converter<?, String>对象
:
Converter<?, String> converter = retrofit.stringConverter(type, annotations);
点击去看看:
public Converter<T, String> stringConverter(Type type, Annotation[] annotations) {
…
for (int i = 0, count = converterFactories.size(); i < count; i++) {
Converter<?, String> converter =
converterFactories.get(i).stringConverter(type, annotations, this);
if (converter != null) {
//noinspection unchecked
return (Converter<T, String>) converter;
}
}
return (Converter<T, String>) BuiltInConverters.ToStringConverter.INSTANCE;
}
看到核心代码是converter
的stringConverter(type, annotations, this)
方法:
因为我们刚才的示例中被没有通过:addConverterFactory(ConverterFactory)
添加一个ConverterFactory
,所以这里会返回一个空:
public @Nullable Converter<?, String> stringConverter(Type type, Annotation[] annotations,
Retrofit retrofit) {
return null;
}
所以最后会执行最后一句代码:
return (Converter<T, String>) BuiltInConverters.ToStringConverter.INSTANCE;
我们点进去看看这个INSTANCE
:
static final ToStringConverter INSTANCE = new ToStringConverter();
是BuiltInConverters
内的内部类ToStringConverter
的单例。所以这里我们得到的就
是BuiltInConverters.ToStringConverter
的实例。
最后用这个对象构建一个Path
(因为示例中的参数类型是path,所以我们看这个代码):
new ParameterHandler.Path<>(name, converter, path.encoded());
我们看看这个Path
类的构造函数:
Path(String name, Converter<T, String> valueConverter, boolean encoded) {
this.name = checkNotNull(name, “name == null”);
this.valueConverter = valueConverter;
this.encoded = encoded;
}
只是赋值,并且我们看到这个类继承自:ParameterHandler<T>
,所以我们回到刚才的build()
方法,发现把参数类型,参数注解放在一起解析之后存储到了这个ParameterHandler<T>
数组中,中间主要做了多种合法性校验,并根据注解的类型,生成不同的
ParameterHandler<T>
子类,如注解是Url
则生成ParameterHandler.RelativeUrl()
对象,如果注解是Path
,则生成:
ParameterHandler.Path<>(name, converter, path.encoded())
对象等等。
我们查看了ParameterHandler<T>
类,发现它有一个抽象方法:
abstract void apply(RequestBuilder builder, @Nullable T value) throws IOException;
这个方法每个子类都必须复写,那我们看看Path
里面怎么复写的:
@Override
void apply(RequestBuilder builder, @Nullable T value) throws IOException {
builder.addPathParam(name, valueConverter.convert(value), encoded);
}
就是把value
被添加到RequestBuilder
中,我们看一下这个addPathParam
方法:
void addPathParam(String name, String value, boolean encoded) {
relativeUrl = relativeUrl.replace(“{” + name + “}”, canonicalizeForPath(value, encoded));
}
这个方法把我们传进来的值value
按照编码格式转换,然后替换relativeUrl
中的{name}
,构成一个有效的省略域名的URL。至此,URL的拼接已经完成!
总结:Retrofit使用动态代理模式实现我们定义的网络请求接口,在重写invoke方法的时候构建了一个ServiceMethod对象,在构建这个对象的过程中进行了方法的注解解析得到网络请求方式httpMethod
,以及参数的注解分析,拼接成一个省略域名的URL
Retrofit网络请求
我们刚才解析了apply
方法,我们看看apply方法是谁调用的呢?跟踪一下就发先只有toCall(args);
方法:
okhttp3.Call toCall(@Nullable Object… args) throws IOException {
RequestBuilder requestBuilder = new RequestBuilder(httpMethod, baseUrl, relativeUrl, headers,
contentType, hasBody, isFormEncoded, isMultipart);
@SuppressWarnings(“unchecked”) // It is an error to invoke a method with the wrong arg types.
ParameterHandler[] handlers = (ParameterHandler[]) parameterHandlers;
int argumentCount = args != null ? args.length : 0;
if (argumentCount != handlers.length) {
throw new IllegalArgumentException(“Argument count (” + argumentCount
- “) doesn’t match expected count (” + handlers.length + “)”);
}
for (int p = 0; p < argumentCount; p++) {
handlers[p].apply(requestBuilder, args[p]);
}
return callFactory.newCall(requestBuilder.build());
}
这个方法一开始就构建了RequestBuilder
,传进去的参数包含:
httpMethod,baseUrl,relativeUrl,headers,contentType,hasBody,isFormEncoded,isMultipart
!
然后获取了parameterHandlers
,我们上边分析的时候,知道这个数组是存参数注解的解析结果的,并对其进行遍历调用了如下方法:
for (int p = 0; p < argumentCount; p++) {
handlers[p].apply(requestBuilder, args[p]);
}
把参数值传进RequestBuilder
中。
最后调用callFactory.newCall(requestBuilder.build())
生成一个okhttp3.Call
。
我们看一下这个build
方法:
Request build() {
HttpUrl url;
HttpUrl.Builder urlBuilder = this.urlBuilder;
if (urlBuilder != null) {
url = urlBuilder.build();
} else {
// No query parameters triggered builder creation, just combine the relative URL and base URL.
//noinspection ConstantConditions Non-null if urlBuilder is null.
url = baseUrl.resolve(relativeUrl);
if (url == null) {
throw new IllegalArgumentException(
"Malformed URL. Base: " + baseUrl + ", Relative: " + relativeUrl);
}
}
RequestBody body = this.body;
if (body == null) {
// Try to pull from one of the builders.
if (formBuilder != null) {
body = formBuilder.build();
} else if (multipartBuilder != null) {
body = multipartBuilder.build();
} else if (hasBody) {
// Body is absent, make an empty body.
body = RequestBody.create(null, new byte[0]);
}
}
MediaType contentType = this.contentType;
if (contentType != null) {
if (body != null) {
body = new ContentTypeOverridingRequestBody(body, contentType);
} else {
requestBuilder.addHeader(“Content-Type”, contentType.toString());
}
}
return requestBuilder
.url(url)
.method(method, body)
.build();
}
可以看到okhttp的请求体在这里构建,当所有的参数满足的时候,则调用了
Request.Builder requestBuilder
.url(url)
.method(method, body)
自我介绍一下,小编13年上海交大毕业,曾经在小公司待过,也去过华为、OPPO等大厂,18年进入阿里一直到现在。
深知大多数Android工程师,想要提升技能,往往是自己摸索成长或者是报班学习,但对于培训机构动则几千的学费,着实压力不小。自己不成体系的自学效果低效又漫长,而且极易碰到天花板技术停滞不前!
因此收集整理了一份《2024年Android移动开发全套学习资料》,初衷也很简单,就是希望能够帮助到想自学提升又不知道该从何学起的朋友,同时减轻大家的负担。
既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,基本涵盖了95%以上Android开发知识点,真正体系化!
由于文件比较大,这里只是将部分目录大纲截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频,并且后续会持续更新
如果你觉得这些内容对你有帮助,可以添加V获取:vip204888 (备注Android)
总结
最后对于程序员来说,要学习的知识内容、技术有太多太多,要想不被环境淘汰就只有不断提升自己,从来都是我们去适应环境,而不是环境来适应我们!
这里附上上述的技术体系图相关的几十套腾讯、头条、阿里、美团等公司2021年的面试题,把技术点整理成了视频和PDF(实际上比预期多花了不少精力),包含知识脉络 + 诸多细节,由于篇幅有限,这里以图片的形式给大家展示一部分。
相信它会给大家带来很多收获:
当程序员容易,当一个优秀的程序员是需要不断学习的,从初级程序员到高级程序员,从初级架构师到资深架构师,或者走向管理,从技术经理到技术总监,每个阶段都需要掌握不同的能力。早早确定自己的职业方向,才能在工作和能力提升中甩开同龄人。
1581623)]
[外链图片转存中…(img-nqJaxAbe-1711961581623)]
既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,基本涵盖了95%以上Android开发知识点,真正体系化!
由于文件比较大,这里只是将部分目录大纲截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频,并且后续会持续更新
如果你觉得这些内容对你有帮助,可以添加V获取:vip204888 (备注Android)
[外链图片转存中…(img-uQqpg8db-1711961581623)]
总结
最后对于程序员来说,要学习的知识内容、技术有太多太多,要想不被环境淘汰就只有不断提升自己,从来都是我们去适应环境,而不是环境来适应我们!
这里附上上述的技术体系图相关的几十套腾讯、头条、阿里、美团等公司2021年的面试题,把技术点整理成了视频和PDF(实际上比预期多花了不少精力),包含知识脉络 + 诸多细节,由于篇幅有限,这里以图片的形式给大家展示一部分。
相信它会给大家带来很多收获:
[外链图片转存中…(img-kvSS2sOK-1711961581623)]
[外链图片转存中…(img-EXkTTDmF-1711961581624)]
当程序员容易,当一个优秀的程序员是需要不断学习的,从初级程序员到高级程序员,从初级架构师到资深架构师,或者走向管理,从技术经理到技术总监,每个阶段都需要掌握不同的能力。早早确定自己的职业方向,才能在工作和能力提升中甩开同龄人。