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

2024-06-04 16:48

本文主要是介绍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源码解析(一):基础使用的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1030561

相关文章

网页解析 lxml 库--实战

lxml库使用流程 lxml 是 Python 的第三方解析库,完全使用 Python 语言编写,它对 XPath表达式提供了良好的支 持,因此能够了高效地解析 HTML/XML 文档。本节讲解如何通过 lxml 库解析 HTML 文档。 pip install lxml lxm| 库提供了一个 etree 模块,该模块专门用来解析 HTML/XML 文档,下面来介绍一下 lxml 库

中文分词jieba库的使用与实景应用(一)

知识星球:https://articles.zsxq.com/id_fxvgc803qmr2.html 目录 一.定义: 精确模式(默认模式): 全模式: 搜索引擎模式: paddle 模式(基于深度学习的分词模式): 二 自定义词典 三.文本解析   调整词出现的频率 四. 关键词提取 A. 基于TF-IDF算法的关键词提取 B. 基于TextRank算法的关键词提取

使用SecondaryNameNode恢复NameNode的数据

1)需求: NameNode进程挂了并且存储的数据也丢失了,如何恢复NameNode 此种方式恢复的数据可能存在小部分数据的丢失。 2)故障模拟 (1)kill -9 NameNode进程 [lytfly@hadoop102 current]$ kill -9 19886 (2)删除NameNode存储的数据(/opt/module/hadoop-3.1.4/data/tmp/dfs/na

Hadoop数据压缩使用介绍

一、压缩原则 (1)运算密集型的Job,少用压缩 (2)IO密集型的Job,多用压缩 二、压缩算法比较 三、压缩位置选择 四、压缩参数配置 1)为了支持多种压缩/解压缩算法,Hadoop引入了编码/解码器 2)要在Hadoop中启用压缩,可以配置如下参数

Makefile简明使用教程

文章目录 规则makefile文件的基本语法:加在命令前的特殊符号:.PHONY伪目标: Makefilev1 直观写法v2 加上中间过程v3 伪目标v4 变量 make 选项-f-n-C Make 是一种流行的构建工具,常用于将源代码转换成可执行文件或者其他形式的输出文件(如库文件、文档等)。Make 可以自动化地执行编译、链接等一系列操作。 规则 makefile文件

使用opencv优化图片(画面变清晰)

文章目录 需求影响照片清晰度的因素 实现降噪测试代码 锐化空间锐化Unsharp Masking频率域锐化对比测试 对比度增强常用算法对比测试 需求 对图像进行优化,使其看起来更清晰,同时保持尺寸不变,通常涉及到图像处理技术如锐化、降噪、对比度增强等 影响照片清晰度的因素 影响照片清晰度的因素有很多,主要可以从以下几个方面来分析 1. 拍摄设备 相机传感器:相机传

JAVA智听未来一站式有声阅读平台听书系统小程序源码

智听未来,一站式有声阅读平台听书系统 🌟&nbsp;开篇:遇见未来,从“智听”开始 在这个快节奏的时代,你是否渴望在忙碌的间隙,找到一片属于自己的宁静角落?是否梦想着能随时随地,沉浸在知识的海洋,或是故事的奇幻世界里?今天,就让我带你一起探索“智听未来”——这一站式有声阅读平台听书系统,它正悄悄改变着我们的阅读方式,让未来触手可及! 📚&nbsp;第一站:海量资源,应有尽有 走进“智听

【C++】_list常用方法解析及模拟实现

相信自己的力量,只要对自己始终保持信心,尽自己最大努力去完成任何事,就算事情最终结果是失败了,努力了也不留遗憾。💓💓💓 目录   ✨说在前面 🍋知识点一:什么是list? •🌰1.list的定义 •🌰2.list的基本特性 •🌰3.常用接口介绍 🍋知识点二:list常用接口 •🌰1.默认成员函数 🔥构造函数(⭐) 🔥析构函数 •🌰2.list对象

pdfmake生成pdf的使用

实际项目中有时会有根据填写的表单数据或者其他格式的数据,将数据自动填充到pdf文件中根据固定模板生成pdf文件的需求 文章目录 利用pdfmake生成pdf文件1.下载安装pdfmake第三方包2.封装生成pdf文件的共用配置3.生成pdf文件的文件模板内容4.调用方法生成pdf 利用pdfmake生成pdf文件 1.下载安装pdfmake第三方包 npm i pdfma

零基础学习Redis(10) -- zset类型命令使用

zset是有序集合,内部除了存储元素外,还会存储一个score,存储在zset中的元素会按照score的大小升序排列,不同元素的score可以重复,score相同的元素会按照元素的字典序排列。 1. zset常用命令 1.1 zadd  zadd key [NX | XX] [GT | LT]   [CH] [INCR] score member [score member ...]