在写作业项目处理网络请求问题时了解了几个框架,比如Google的Volley,Square的OkHttp和Retrofit等,后来看到大家都在推荐使用Retrofit2。然后在实际使用中也发现使用起来很方便代码很简洁,只需要定义接口然后调用即可。这也让我对这个框架的原理感到了好奇。下面分享一下它的基本原理以及我对于其源码学习的一些小小的心得体会。
Retrofit2的使用
什么是Retrofit2
(这里就直接复制粘贴了)
Retrofit是针对于Android/Java的、基于okHttp的、一种轻量级且安全的、并使用注解方式的网络请求框架。
Retrofit2的使用详解
这里先放上Retrofit2的官方文档,其实看文档对其的使用应该就没有什么问题了,因为真的很简单很好用!这里就大致过一下它的使用步骤:
1)在gradle中加入依赖
compile 'com.squareup.retrofit2:retrofit:2.3.0'
compile 'com.google.code.gson:gson:2.8.1'
compile 'com.squareup.retrofit2:converter-gson:2.3.0'
(如果要和rxjava整合可以再加入retrofit2:adapter-rxjava)
2)在AndroidManifest文件中打开访问网络的权限
<uses-permission android:name="android.permission.INTERNET"/>
3)创建Retrofit2实例
// 定义访问的主机地址
retrofit = new Retrofit.Builder().baseUrl(BASEURL)
//解析方法
.addConverterFactory(GsonConverterFactory.create()) .build();
4)定义接口
public interface GitHubService {
@GET("users/{user}/repos")
Call<List<Repo>> listRepos(@Path("user") String user);
}
这里就直接使用官方文档给出的例子了,注解的话参见下图
5)创建对象调用接口
GitHubService service = retrofit.create(GitHubService.class);
Call<List<Repo>> repos = service.listRepos("octocat");
这段代码的意思大概是首先获取Retrofit对象,然后通过动态代理获取到所定义的接口,通过调用接口里面的方法获取到Call类型返回值,最后进行网络请求操作
Retrofit的原理
Retrofit的思想主要是动态代理,看了几个源码的解析感觉ServiceMethod像一个中央处理器很重要,这里就主要解析一下ServiceMethod的创建过程,先看一段Retrofit的源码(这是上面调用接口时的create方法源码):
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, Object... args)
throws Throwable {
if (method.getDeclaringClass() == Object.class) {
return method.invoke(this, args);
}
if (platform.isDefaultMethod(method)) {
return platform.invokeDefaultMethod(method, service, proxy, args);
}
//转换成ServiceMethod
ServiceMethod serviceMethod = loadServiceMethod(method);
//通过serviceMethod, args获取到okHttpCall 对象
OkHttpCall okHttpCall = new OkHttpCall<>(serviceMethod, args);
//进一步封装okHttpCall并返回Call对象
return serviceMethod.callAdapter.adapt(okHttpCall);
}
});
在接口调用的时候调用的这个create方法可以看到其实是用newProxyInstance()方法来返回一个类的代理实例,它需要的参数有调用的方法名method、参数列表args。这两者可以转换成一个ServiceMethod对象。上面用到的方法的源码如下
ServiceMethod loadServiceMethod(Method method) {
ServiceMethod result;
synchronized (serviceMethodCache) {
result = serviceMethodCache.get(method);
if (result == null) {
//通过ServiceMethod.Builder()方法来构建ServiceMethod
result = new ServiceMethod.Builder(this, method).build();
//放入缓存方便之后使用
serviceMethodCache.put(method, result);
}
}
return result;
}
public ServiceMethod build() {
//构建CallAdapter对象
callAdapter = createCallAdapter();
//构建responseConverter转换器对象(转换成合适的类型)
responseType = callAdapter.responseType();
if (responseType == Response.class || responseType == okhttp3.Response.class) {
throw methodError("'"
+ Utils.getRawType(responseType).getName()
+ "' is not a valid response body type. Did you mean ResponseBody?");
}
responseConverter = createResponseConverter();
...
return new ServiceMethod<>(this);
}
有了ServiceMethod后,下面的工作大致是OkHttpCall调用ServiceMethod获得一个可以执行的Request对象,然后等到Http请求返回后,再将response body传入ServiceMethod中,ServiceMethod调用Converter接口将response body转成一个Java对象
参考文献:
Android 网络框架之Retrofit2使用详解及从源码中解析原理
你真的会用Retrofit2吗?Retrofit2完全教程
Retrofit2 源码解析