Retrofit 源码分析初探

时间:2022-04-15 07:21:38

现如今,Android开发中,网络层Retrofit+Okhttp组合好像已成标配,身为技术人员,这么火的框架当然得一探究竟,不为装逼,纯粹是为了充电而已。

基本使用介绍

介绍源码前,我们先看下Retrofit的基本使用,大致了解下流程,跟着这个流程来分析源码才不会乱。

1、初始化Retrofit对象

?
1
2
3
4
5
Retrofit retrofit = new Retrofit.Builder()
    //使用自定义的mGsonConverterFactory
    .addConverterFactory(GsonConverterFactory.create())
    .baseUrl("http://apis.baidu.com/txapi/")
    .build();

2、定义接口

?
1
2
3
4
5
public interface APi {
 
  @GET("hello/world")
  Call<News> getNews(@Query("num") String num,@Query("page")String page);
}

3、发起网络请求

?
1
2
3
4
5
6
7
8
9
10
11
12
13
mApi = retrofit.create(APi.class);
Call<News> news = mApi.getNews("1", "10");
news.enqueue(new Callback<News>() {
  @Override
  public void onResponse(Call<News> call, Response<News> response) {
 
  }
 
  @Override
  public void onFailure(Call<News> call, Throwable t) {
 
  }
});

Retrofit本质分析

看到上面的整个流程,不去探究源码的话肯定一脸懵逼,我就定义了一个接口,指定了下返回值,为毛这个接口就可以直接用了?接口的实现呢?我随便写一个返回值,不指定返回Call行不行?待着这些疑问,我们大致也可以猜出Retrofit是干什么的了。

猜测:Retrofit主要就是为我们定义的接口创造了一个实例,然后这个实例调用接口中的方法将我们定义在注解中的值拼装成发起http请求所要的信息,最后利用这些信息产生一个我们在接口返回值中规定的对象,这个对象可以用来发起真正的请求。
简单的讲,Retrofit就是把注解中的东西拼成http请求的对象,然后由这个对象去发起请求。

验证猜测

是谁实现了这个接口

发起网络请求时,有这样一句:

?
1
mApi = retrofit.create(APi.class);

很明显,接口的实现应该是这个create干的事,我们跟进去看看源码:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
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();
 
    @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);
     }
     if (platform.isDefaultMethod(method)) {
      return platform.invokeDefaultMethod(method, service, proxy, args);
     }
     ServiceMethod<Object, Object> serviceMethod =
       (ServiceMethod<Object, Object>) loadServiceMethod(method);
     OkHttpCall<Object> okHttpCall = new OkHttpCall<>(serviceMethod, args);
     return serviceMethod.adapt(okHttpCall);
    }
   });
}

这里我们不用去看一些细节,只去关注我们想知道的,这个Create方法到底干了什么,看到Proxy.newProxyInstance,哦!这就很明显了,这里接口之所以能够直接调用是使用了动态代理技术,产生了一个代理对象。binggo,一个问题解决!!!

什么时候开始将注解中参数拼装成http请求的信息的?

动态代理是干什么的?(大家最好单独去学习下Java的动态代理,有时候非常有用,资料网上大把大把的)
使用动态代理一般是为了拦截方法,好在个方法执行的时候,在执行之前或之后干些自己的事情。这里回顾下Retrofit的使用,通过Create方法产生代理对象后直接就调用定义的方法了。那么,所有的小动作必然是在调用接口方法的时候干的。具体就是invoke中的方法

?
1
2
3
4
5
6
7
8
9
10
if (method.getDeclaringClass() == Object.class) {
 return method.invoke(this, args);
}
if (platform.isDefaultMethod(method)) {
 return platform.invokeDefaultMethod(method, service, proxy, args);
}
ServiceMethod<Object, Object> serviceMethod =
  (ServiceMethod<Object, Object>) loadServiceMethod(method);
OkHttpCall<Object> okHttpCall = new OkHttpCall<>(serviceMethod, args);
return serviceMethod.adapt(okHttpCall);

前两个if判断主要是为了跳过object和object中内置的一些方法,除了这些,剩下的所有方法必然是我们在接口中定义的,也就是我们要拦截的。那么真正干事的就是三句:

?
1
2
3
4
ServiceMethod<Object, Object> serviceMethod =
        (ServiceMethod<Object, Object>) loadServiceMethod(method);
      OkHttpCall<Object> okHttpCall = new OkHttpCall<>(serviceMethod, args);
      return serviceMethod.adapt(okHttpCall);

其中loadServiceMethod()方法就是用来拼装http请求信息的,这个问题解决!

如何产生发起http请求对象的?

经过上面的分析, OkHttpCall<Object> okHttpCall = new OkHttpCall<>(serviceMethod, args);这就很明显就是用来生产这个对象的。

如何将对象转换成我们在接口中指定的返回值的?

这里要说明下,之前我们定义接口的时候是这样的:

?
1
2
@GET("hello/world")
  Call<News> getNews(@Query("num") String num,@Query("page")String page);

这里的Call和Okhttp的Call其实很像,其实连方法都几乎一样,但是Retrofit和Rxjava一起用的时候又可以这样定义

?
1
2
3
4
@GET("book/search")
  Observable<Book> getSearchBook(@Query("q") String name,
                  @Query("tag") String tag, @Query("start") int start,
                  @Query("count") int count);

这里指定的返回值不再是Call,而是变成了RxJava的Observable,所以这里肯定有一步转换,能将之前拼装的信息转换成我们指定的对象,具体核心就是最后一行的serviceMethod.adapt()干的。

总结

经过以上分析,我们对Retrofit大致是干什么的很清楚了,主要就是拼装http信息,并转换成我们要的能够发起http请求的对象。本文只是一个初探,后面我们将对每一步进行深入分析。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持服务器之家。

原文链接:https://www.jianshu.com/p/35edc0f0ab45