retrofit 已经流行很久了,它是Square开源的一款优秀的网络框架,这个框架对okhttp进行了封装,让我们使用okhttp做网路请求更加简单。但是光学会使用只是让我们多了一个技能,学习其源码才能让我们更好的成长。
本篇文章是在分析retrofit的源码流程,有大量的代码,读者最好把源码下载下来导入IDE,然后跟着一起看,效果会更好
源码下载地址
retrofit入门
- 定义网络请求的API接口:
interface GithubApiService {
@GET("users/{name}/repos")
Call<ResponseBody> searchRepoInfo(@Path("name") String name);
}
使用了注解表明请求方式,和参数类型,这是retrofit的特性,也正是简化了我们的网络请求过程的地方!
- 初始化一个retrofit的实例:
Retrofit retrofit = new Retrofit.Builder()
.baseUrl("https://api.github.com/")
.build();
retrofit的实例化很简单,采用链式调用的设计,把需要的参数传进去即可,复杂的参数我们这里就不举例了。
- 生成接口实现类:
GithubApiService githubService = retrofit.create(service)
Call<ResponseBody> call = githubService.searchRepoInfo("changmu175");
我们调用retrofit的create
方法就可以把我们定义的接口转化成实现类,我们可以直接调用我们定义的方法进行网络请求,但是我们只定义了一个接口方法,也没有方法体,请求方式和参数类型都是注解,create
是如何帮我们整理参数,实现方法体的呢?一会我们通过源码解析再去了解。
- 发起网络请求
//同步请求方式
call.request();
//异步请求方式
call.enqueue(new Callback<ResponseBody>() {
@Override
public void onResponse(Call<ResponseBody> call, Response<ResponseBody> response) {
//请求成功回调
}
@Override
public void onFailure(Call<ResponseBody> call, Throwable t) {
//请求与失败回调
}
});
至此,retrofit的一次网络请求示例已经结束,基于对okhttp的封装,让网络请求已经简化了很多。当然retrofit最适合的还是REST API类型的接口,方便简洁。
下面我们就看看retrofit的核心工作是如何完成的!
retrofit初始化
retrofit的初始化采用了链式调用的设计
Retrofit retrofit = new Retrofit.Builder()
.baseUrl("https://api.github.com/")
.build();
很明显这个方法是在传一些需要的参数,我们简单的跟踪一下:
首先看看Builder()
的源码:
public Builder() {
this(Platform.get());
}
这句代码很简单就是调用了自己的另一个构造函数:
Builder(Platform platform) {
this.platform = platform;
}
这个构造函数也很简单,就是一个赋值,我们把之前的Platform.get()
点开,看看里面做在什么:
private static final Platform PLATFORM = findPlatform();
static Platform get() {
return PLATFORM;
}
我们发现这里使用使用了一个饿汉式单例,使用Platform.get()
返回一个实例,这样写的好处是简单,线程安全,效率高,不会生成多个实例!
我们再看看findPlatform()
里做了什么:
private static Platform findPlatform() {
try {
Class.forName("android.os.Build");
if (Build.VERSION.SDK_INT != 0) {
return new Android();
}
} catch (ClassNotFoundException ignored) {
}
....省略部分代码...
}
所以是判断了一下系统,然后根据系统实例化一个对象。这里面应该做了一些和Android平台相关的事情,属于细节,我们追究,感兴趣的可以只看看。
再看看baseUrl(url)
的源码
public Builder baseUrl(String baseUrl) {
checkNotNull(baseUrl, "baseUrl == null");
HttpUrl httpUrl = HttpUrl.parse(baseUrl);
....
return baseUrl(httpUrl);
}
public Builder baseUrl(HttpUrl baseUrl) {
checkNotNull(baseUrl, "baseUrl == null");
....
this.baseUrl = baseUrl;
return this;
}
这两段代码也很简单,校验URL,生成httpUrl
对象,然后赋值给baseUrl
看看build()
方法在做什么
参数基本设置完了,最后就要看看build()
这个方法在做什么:
public Retrofit build() {
if (baseUrl == null) {
throw new IllegalStateException("Base URL required.");
}
okhttp3.Call.Factory callFactory = this.callFactory;
if (callFactory == null) {
callFactory = new OkHttpClient();
}
....
return new Retrofit(callFactory, baseUrl, unmodifiableList(converterFactories),