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

相关文章

Java中流式并行操作parallelStream的原理和使用方法

《Java中流式并行操作parallelStream的原理和使用方法》本文详细介绍了Java中的并行流(parallelStream)的原理、正确使用方法以及在实际业务中的应用案例,并指出在使用并行流... 目录Java中流式并行操作parallelStream0. 问题的产生1. 什么是parallelS

Linux join命令的使用及说明

《Linuxjoin命令的使用及说明》`join`命令用于在Linux中按字段将两个文件进行连接,类似于SQL的JOIN,它需要两个文件按用于匹配的字段排序,并且第一个文件的换行符必须是LF,`jo... 目录一. 基本语法二. 数据准备三. 指定文件的连接key四.-a输出指定文件的所有行五.-o指定输出

Java中Redisson 的原理深度解析

《Java中Redisson的原理深度解析》Redisson是一个高性能的Redis客户端,它通过将Redis数据结构映射为Java对象和分布式对象,实现了在Java应用中方便地使用Redis,本文... 目录前言一、核心设计理念二、核心架构与通信层1. 基于 Netty 的异步非阻塞通信2. 编解码器三、

Linux jq命令的使用解读

《Linuxjq命令的使用解读》jq是一个强大的命令行工具,用于处理JSON数据,它可以用来查看、过滤、修改、格式化JSON数据,通过使用各种选项和过滤器,可以实现复杂的JSON处理任务... 目录一. 简介二. 选项2.1.2.2-c2.3-r2.4-R三. 字段提取3.1 普通字段3.2 数组字段四.

Linux kill正在执行的后台任务 kill进程组使用详解

《Linuxkill正在执行的后台任务kill进程组使用详解》文章介绍了两个脚本的功能和区别,以及执行这些脚本时遇到的进程管理问题,通过查看进程树、使用`kill`命令和`lsof`命令,分析了子... 目录零. 用到的命令一. 待执行的脚本二. 执行含子进程的脚本,并kill2.1 进程查看2.2 遇到的

Java HashMap的底层实现原理深度解析

《JavaHashMap的底层实现原理深度解析》HashMap基于数组+链表+红黑树结构,通过哈希算法和扩容机制优化性能,负载因子与树化阈值平衡效率,是Java开发必备的高效数据结构,本文给大家介绍... 目录一、概述:HashMap的宏观结构二、核心数据结构解析1. 数组(桶数组)2. 链表节点(Node

详解SpringBoot+Ehcache使用示例

《详解SpringBoot+Ehcache使用示例》本文介绍了SpringBoot中配置Ehcache、自定义get/set方式,并实际使用缓存的过程,文中通过示例代码介绍的非常详细,对大家的学习或者... 目录摘要概念内存与磁盘持久化存储:配置灵活性:编码示例引入依赖:配置ehcache.XML文件:配置

Java 虚拟线程的创建与使用深度解析

《Java虚拟线程的创建与使用深度解析》虚拟线程是Java19中以预览特性形式引入,Java21起正式发布的轻量级线程,本文给大家介绍Java虚拟线程的创建与使用,感兴趣的朋友一起看看吧... 目录一、虚拟线程简介1.1 什么是虚拟线程?1.2 为什么需要虚拟线程?二、虚拟线程与平台线程对比代码对比示例:三

从基础到高级详解Go语言中错误处理的实践指南

《从基础到高级详解Go语言中错误处理的实践指南》Go语言采用了一种独特而明确的错误处理哲学,与其他主流编程语言形成鲜明对比,本文将为大家详细介绍Go语言中错误处理详细方法,希望对大家有所帮助... 目录1 Go 错误处理哲学与核心机制1.1 错误接口设计1.2 错误与异常的区别2 错误创建与检查2.1 基础

k8s按需创建PV和使用PVC详解

《k8s按需创建PV和使用PVC详解》Kubernetes中,PV和PVC用于管理持久存储,StorageClass实现动态PV分配,PVC声明存储需求并绑定PV,通过kubectl验证状态,注意回收... 目录1.按需创建 PV(使用 StorageClass)创建 StorageClass2.创建 PV