本文主要是介绍Retrofit源码解析(一):基础使用,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!
前言
才发现已经有一个月没更新博客了,上个月发布了两篇Chat:
线性布局和相对布局的实现原理
我的安卓生涯:从6k到25K,都经历了什么
都是高质量的内容和技术分享,所以占用了比较多的时间,感兴趣的朋友可以支持一下我的创作,十分感谢~
今天准备跟大家分享一下Retrofit的用法和源码的实现原理。Retrofit是对Okhttp的二次封装的开源库,目的是让okhttp使用起来更方便,更简洁,通过注解等信息封装成Okhttp请求,完成整个网络请求的过程,现在已经是非常流行的框架之一,是我们技术学习之路的必选内容。
Okhttp源码分析博客地址:https://blog.csdn.net/u011315960/article/details/80017877
源码地址:Retrofit的github地址
正文
首先我们回顾一下Retrofit的用法:
首先需要定义我们的接口文件,这个类必须是接口类型:
/*** Created by li.zhipeng on 2018/8/29.*/
public interface TestApi {/*** 模拟GET一个数据请求*/@GETResponseWrapper getData(@Url String url);/*** 模拟POST一个数据请求*/@POST@FormUrlEncodedResponseWrapper postData(@Url String url, @Field("wd") String key);
}
非常简单的get请求,我们需要指定请求的类型@Get,@POST,@PUT等等,这写请求类型的注解可以设置网络请求的相对地址。如果有参数,还可以指定网络请求的参数,通过@Field(“paramName”),注解内的value是提交的参数对应的key。
有些用过Retrofit的朋友可能会问:为什么你的返回类型是ResponseWrapper?
其实这是我通过Retrofit的api指定的返回的类型,我们可以按照自己的需要指定任何类型。
接下来初始化Retrofit的配置信息,并解析定义的接口文件:
val retrofit = Retrofit.Builder()// 必填项.baseUrl("http://www.baidu.com").client(OkHttpClient())// 对得到的结果进行转换,常用的有加密解密,json转换等等.addConverterFactory(StringConvertFactory())// 对返回的结果进行封装,常用的有之间转化成Rxjava对象// 这里我们简单的进行包装.addCallAdapterFactory(ResponseWrapperCallAdapterFactory()).build()api = retrofit.create(TestApi::class.java)
baseUrl:请求的基础地址,如果没有参数中没有指定@Url地址,真实的网络地址是baseUrl + @GET注解的value相对地址。
client:发起网络请求的OkhttpClient对象。
addConverterFactory:添加网络请求的转换工厂类,可以处理网络请求过程中Request或者Response,例如可以把Response中的数据流转换成字符串。
addCallAdapterFactory:设置网络请求的返回类型。demo中直接返回自定义的ResponseWrapper,所以刚刚的接口文件返回的类型就只能是ResponseWrapper。
接下来看看我自定义的StringConvertFactory:
/*** Created by li.zhipeng on 2018/8/29.** 把得到的数据response转换成String*/
public class StringConvertFactory extends Converter.Factory {@Overridepublic Converter<ResponseBody, String> responseBodyConverter(Type type, Annotation[] annotations, Retrofit retrofit) {return new Converter<ResponseBody, String>() {@Overridepublic String convert(@NonNull ResponseBody value) throws IOException {return value.string();}};}
}
很简单,把response的内容取出来,返回String字符串。
再看看ResponseWrapperCallAdapterFactory:
/*** Created by li.zhipeng on 2018/8/29.** 把得到网络请求结果String,转换成ResponseWrapper*/
public class ResponseWrapperCallAdapterFactory extends CallAdapter.Factory {@Overridepublic CallAdapter<String, ResponseWrapper> get(@NonNull final Type returnType, @NonNull Annotation[] annotations, @NonNull Retrofit retrofit) {return new CallAdapter<String, ResponseWrapper>() {@Overridepublic Type responseType() {return returnType;}@Overridepublic ResponseWrapper adapt(@NonNull Call<String> call) {try {return new ResponseWrapper(call.execute().body());} catch (IOException e) {e.printStackTrace();}return new ResponseWrapper("error");}};}
}
这里主要是实现adapt方法,对返回值类型进行转换,这里ResponseWrapper就是一个包装类,把得到的String保存起来。值得注意的是,我们在这里直接发起了同步的网络请求,所以别忘了实际使用中,不能在主线程发起网络请求。
看一下没什么卵用的ResponseWrapper:
/*** Created by li.zhipeng on 2018/8/29.* <p>* 网络请求包装类*/
public class ResponseWrapper {public String response;public ResponseWrapper(String response) {this.response = response;}}
最后在MainActivity中发起网络请求:
Thread {val result = api.postData("www.baidu.com", "111").responserunOnUiThread {val textView = findViewById<TextView>(R.id.textView)textView.text = result}
}.start()
看一下运行结果:
我们已经得到了请求的数据,Retrofit的基础使用就是这些,当然还有其他的api,这里简单介绍一下:
callFactory: 跟client一样,指定运行Okhttp网络请求的工厂类,OkhttpClient已经实现了Factory中的方法。
callAdapterFactories:同时设置多个CallAdapterFactoty。
converterFactories:同时设置多个ConvertFactoty.
callbackExecutor:执行callback的线程池,用的很少。Android默认是主线程。
validateEagerly:是否一次在创建接口文件代理时,解析所有的接口方法。
总结
本来想把基础使用和源码解析写成一篇,考虑一下还是分开吧,谁也不愿意看又臭又长的长篇大论,所以下一篇继续分析:Retrofit的源码。
demo下载地址:https://github.com/li504799868/RetrofitDemo
这篇关于Retrofit源码解析(一):基础使用的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!