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一个数据请求
     */
    @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下载地址:https://github.com/li504799868/RetrofitDemo

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,558评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,002评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,036评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,024评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,144评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,255评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,295评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,068评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,478评论 1 305
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,789评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,965评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,649评论 4 336
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,267评论 3 318
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,982评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,223评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,800评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,847评论 2 351

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,908评论 25 707
  • 前言 在Android开发中,网络请求十分常用 而在Android网络请求库中,Retrofit是当下最热的一个网...
    Carson带你学安卓阅读 70,689评论 48 393
  • 真好!今天是周日,又可以好好看书了,泡上一壶自家烤的茶,放着Soft music .如果还能再配上窗外嘀嗒的雨...
    雲雁阅读 290评论 0 0
  • 第一天,好像没有什么想说,想分享的。 只愿能够通过文字,找回丢失的自己,继续起航。
    禾火的秋阅读 166评论 0 0
  • 和林燕的关系真的是很难用言语来描述清楚。在中学时代,我们是英语学习的好伙伴及竞争者,我们也是写作的相互促进者,我们...
    天山彤老阅读 701评论 0 0