Retrofit 2.0 使用详解实战
前言
在
Andrroid
开发中,网络请求十分常用而在
Android
网络请求库中,Retrofit
是当下最热的一个网络请求库
Github截图
今天,我将献上一份非常详细
Retrofit v2.0
的使用教程,希望你们会喜欢。
如果对
Retrofit v2.0
的源码感兴趣,可看文章:Android:手把手带你深入剖析 Retrofit 2.0 源码
目录
目录
1. 简介
示意图
特别注意:
准确来说,Retrofit 是一个 RESTful 的 HTTP 网络请求框架的封装。
原因:网络请求的工作本质上是
OkHttp
完成,而 Retrofit 仅负责 网络请求接口的封装
本质过程
App应用程序通过 Retrofit 请求网络,实际上是使用 Retrofit 接口层封装请求参数、Header、Url 等信息,之后由 OkHttp 完成后续的请求操作
在服务端返回数据之后,OkHttp 将原始的结果交给 Retrofit,Retrofit根据用户的需求对结果进行解析
2. 与其他开源请求库对比
除了Retrofit,如今Android中主流的网络请求框架有:
Android-Async-Http
Volley
OkHttp
下面是简单介绍:
网络请求加载 - 介绍
一图让你了解全部的网络请求库和他们之间的区别!
网络请求库 - 对比
附:各个主流网络请求库的Github地址
3. 使用介绍
使用 Retrofit 的步骤共有7个:
步骤1:添加Retrofit库的依赖
步骤2:创建 接收服务器返回数据 的类
步骤3:创建 用于描述网络请求 的接口
步骤4:创建 Retrofit 实例
步骤5:创建 网络请求接口实例 并 配置网络请求参数
步骤6:发送网络请求(异步 / 同步)
封装了 数据转换、线程切换的操作
**步骤7: **处理服务器返回的数据
接下来,我们一步步进行讲解。
步骤1:添加Retrofit库的依赖
1. 在 Gradle
加入Retrofit
库的依赖
build.gradle
2. 添加 网络权限
AndroidManifest.xml
步骤2:创建 接收服务器返回数据 的类
Reception.java
步骤3:创建 用于描述网络请求 的接口
Retrofit将 Http请求 抽象成 Java接口:采用 注解 描述网络请求参数 和配置网络请求参数
用 动态代理 动态 将该接口的注解“翻译”成一个 Http 请求,最后再执行 Http 请求
注:接口中的每个方法的参数都需要使用注解标注,否则会报错
GetRequest_Interface.interface
下面详细介绍Retrofit 网络请求接口 的注解类型。
注解类型
注解类型
注解说明
第一类:网络请求方法
网络请求方法注解
详细说明:
a. @GET、@POST、@PUT、@DELETE、@HEAD
以上方法分别对应 HTTP中的网络请求方式
此处特意说明URL的组成:Retrofit把 网络请求的URL 分成了两部分设置:
网络请求的完整 Url =在创建Retrofit实例时通过.baseUrl()设置 +网络请求接口的注解设置(下面称 “path“ )
具体整合的规则如下:
URL整合规则
建议采用第三种方式来配置,并尽量使用同一种路径形式。
b. @HTTP
作用:替换@GET、@POST、@PUT、@DELETE、@HEAD注解的作用 及 更多功能拓展
具体使用:通过属性method、path、hasBody进行设置
第二类:标记
标记类注解
a. @FormUrlEncoded
作用:表示发送form-encoded的数据
每个键值对需要用@Filed来注解键名,随后的对象需要提供值。
b. @Multipart
作用:表示发送form-encoded的数据(适用于 有文件 上传的场景)
每个键值对需要用@Part来注解键名,随后的对象需要提供值。
具体使用如下:
GetRequest_Interface
第三类:网络请求参数
网络请求参数注解
详细说明
a. @Header & @Headers
作用:添加请求头 &添加不固定的请求头
具体使用如下:
b. @Body
作用:以
Post
方式 传递 自定义数据类型 给服务器特别注意:如果提交的是一个Map,那么作用相当于
@Field
不过Map要经过
FormBody.Builder
类处理成为符合 Okhttp 格式的表单,如:
c. @Field & @FieldMap
作用:发送 Post请求 时提交请求的表单字段
具体使用:与
@FormUrlEncoded
注解配合使用
d. @Part & @PartMap
作用:发送 Post请求 时提交请求的表单字段
与@Field的区别:功能相同,但携带的参数类型更加丰富,包括数据流,所以适用于 有文件上传 的场景
具体使用:与
@Multipart
注解配合使用
e. @Query和@QueryMap
作用:用于
@GET
方法的查询参数(Query = Url 中 ‘?’ 后面的 key-value)
如:url = http://www.println.net/?cate=android,其中,Query = cate
具体使用:配置时只需要在接口方法中增加一个参数即可:
f. @Path
作用:URL地址的缺省值
具体使用:
g. @Url
作用:直接传入一个请求的 URL变量 用于URL设置
具体使用:
汇总
汇总
步骤4:创建 Retrofit 实例
a. 关于数据解析器(Converter)
Retrofit支持多种数据解析方式
使用时需要在Gradle添加依赖
数据解析器 | Gradle依赖 |
---|---|
Gson | com.squareup.retrofit2:converter-gson:2.0.2 |
Jackson | com.squareup.retrofit2:converter-jackson:2.0.2 |
Simple XML | com.squareup.retrofit2:converter-simplexml:2.0.2 |
Protobuf | com.squareup.retrofit2:converter-protobuf:2.0.2 |
Moshi | com.squareup.retrofit2:converter-moshi:2.0.2 |
Wire | com.squareup.retrofit2:converter-wire:2.0.2 |
Scalars | com.squareup.retrofit2:converter-scalars:2.0.2 |
b. 关于网络请求适配器(CallAdapter)
Retrofit支持多种网络请求适配器方式:guava、Java8和rxjava
使用时如使用的是
Android
默认的CallAdapter
,则不需要添加网络请求适配器的依赖,否则则需要按照需求进行添加
Retrofit 提供的CallAdapter
使用时需要在Gradle添加依赖:
网络请求适配器 | Gradle依赖 |
---|---|
guava | com.squareup.retrofit2:adapter-guava:2.0.2 |
Java8 | com.squareup.retrofit2:adapter-java8:2.0.2 |
rxjava | com.squareup.retrofit2:adapter-rxjava:2.0.2 |
步骤5:创建 网络请求接口实例
步骤6:发送网络请求(异步 / 同步)
封装了 数据转换、线程切换的操作
步骤7:处理返回数据
通过response
类的 body()
对返回的数据进行处理
4. 实例讲解
接下来,我将用两个实例分别对 Retrofit GET方式 和 POST方式进行 网络请求 讲解。
4.1 实例1
实现功能:将中文翻译成英文
实现方案:采用
Get
方法对 金山词霸API 发送网络请求
采用
Gson
进行数据解析
金山词典
步骤说明
步骤1:添加Retrofit库的依赖
步骤2:创建 接收服务器返回数据 的类
步骤3:创建 用于描述网络请求 的接口
步骤4:创建 Retrofit 实例
步骤5:创建 网络请求接口实例 并 配置网络请求参数
步骤6:发送网络请求(采用最常用的异步方式)
封装了 数据转换、线程切换的操作
**步骤7: **处理服务器返回的数据
接下来,我们一步步进行讲解。
具体使用
步骤1:添加Retrofit库的依赖
1. 在 Gradle
加入Retrofit
库的依赖
build.gradle
2. 添加 网络权限
AndroidManifest.xml
步骤2:创建 接收服务器返回数据 的类
金山词霸API 的数据格式说明如下:
API格式说明
根据 金山词霸API 的数据格式,创建 接收服务器返回数据 的类:
Translation.java
步骤3:创建 用于描述网络请求 的接口
采用 **注解 ** 描述 网络请求参数。
GetRequest_Interface.java
接下来的步骤均在GetRequest.java内实现(看注释)
步骤4:创建Retrofit对象
步骤5:创建 网络请求接口 的实例
步骤6:发送网络请求
以最常用的 异步请求 为例
步骤7:处理返回数据
GetRequest.java
由于此处采用了 Gson 解析,所以需要在 Gradle加入依赖
build.gradle
运行结果
运行结果
Demo地址
Carson_Ho的Github:https://github.com/Carson-Ho/RetrofitDemo
4.2 实例2
实现的功能:将 英文 翻译成 中文
实现方法:采用
Post方法
对 有道API 发送网络请求
采用
Gson
进行数据解析
有道翻译
使用步骤
步骤1:添加Retrofit库的依赖
步骤2:创建 接收服务器返回数据 的类
步骤3:创建 用于描述网络请求 的接口
步骤4:创建 Retrofit 实例
步骤5:创建 网络请求接口实例 并 配置网络请求参数
步骤6:发送网络请求(采用最常用的异步方式)
封装了 数据转换、线程切换的操作
**步骤7: **处理服务器返回的数据
接下来,我们一步步进行Retrofit的使用。
具体使用
步骤1:添加Retrofit库的依赖
1. 在 Gradle
加入Retrofit
库的依赖
build.gradle
2. 添加 网络权限
AndroidManifest.xml
步骤2:创建 接收服务器返回数据 的类
API 的数据格式说明如下:
数据格式说明
根据 有道API 的数据格式,创建 接收服务器返回数据 的类:
Translation.java
步骤3:创建 用于描述网络请求 的接口
采用 注解 描述 网络请求参数。
PostRequest_Interface.java
接下来的步骤均在PostRequest.java内实现(看注释)
步骤4:创建Retrofit对象
步骤5:创建 网络请求接口 的实例
步骤6:发送网络请求
以最常用的 异步请求 为例
步骤7:处理返回数据
PostRequest.java
由于此处采用了 Gson 解析,所以需要在 Gradle
加入依赖
build.gradle
运行结果
运行结果
Demo地址
Carson_Ho的Github:https://github.com/Carson-Ho/RetrofitDemo
5. Retrofit 的拓展使用
Retrofit的使用场景非常丰富,如支持
RxJava
和Prototocobuff
具体设置也非常简单 & 方便:
具体关于 RxJava
的使用这里就不展开,请期待下篇关于 Rxjava
的文章。
评论