Retrofit源码解析(一):基础用

作者 : 开心源码 本文共3439个字,预计阅读时间需要9分钟 发布时间: 2022-05-12 共131人阅读

前言

才发现已经有一个月没升级博客了,上个月发布了两篇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一个数据请求     */    @GET    ResponseWrapper getData(@Url String url);    /**     * 模拟POST一个数据请求     */    @POST    @FormUrlEncoded    ResponseWrapper 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 {    @Override    public Converter<ResponseBody, String> responseBodyConverter(Type type, Annotation[] annotations, Retrofit retrofit) {        return new Converter<ResponseBody, String>() {            @Override            public 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  {    @Override    public CallAdapter<String, ResponseWrapper> get(@NonNull final Type returnType, @NonNull Annotation[] annotations, @NonNull Retrofit retrofit) {        return new CallAdapter<String, ResponseWrapper>() {            @Override            public Type responseType() {                return returnType;            }            @Override            public 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").response     runOnUiThread {          val textView = findViewById<TextView>(R.id.textView)          textView.text = result     }}.start()

看一下运行结果:

Screenshot_2018-08-29-12-12-34.png

我们已经得到了请求的数据,Retrofit的基础用就是这些,当然还有其余的api,这里简单详情一下:

callFactory: 跟client一样,指定运行Okhttp网络请求的工厂类,OkhttpClient已经实现了Factory中的方法。
callAdapterFactories:同时设置多个CallAdapterFactoty。
converterFactories:同时设置多个ConvertFactoty.
callbackExecutor:执行callback的线程池,使用的很少。Android默认是主线程。
validateEagerly:能否一次在创立接口文件代理商时,解析所有的接口方法。

总结

原本想把基础用和源码解析写成一篇,考虑一下还是分开吧,谁也不愿意看又臭又长的长篇大论,所以下一篇继续分析:Retrofit的源码。

demo下载地址: li504799868/RetrofitDemo

说明
1. 本站所有资源来源于用户上传和网络,如有侵权请邮件联系站长!
2. 分享目的仅供大家学习和交流,您必须在下载后24小时内删除!
3. 不得使用于非法商业用途,不得违反国家法律。否则后果自负!
4. 本站提供的源码、模板、插件等等其他资源,都不包含技术服务请大家谅解!
5. 如有链接无法下载、失效或广告,请联系管理员处理!
6. 本站资源售价只是摆设,本站源码仅提供给会员学习使用!
7. 如遇到加密压缩包,请使用360解压,如遇到无法解压的请联系管理员
开心源码网 » Retrofit源码解析(一):基础用

发表回复