说明:该文章转载于https://www.jianshu.com/p/a3e162261ab6
前言
- 在
Andrroid
开发中,网络请求十分常用 - 而在
Android
网络请求库中,Retrofit
是当下最热的一个网络请求库
- 今天,我将献上一份非常详细
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
dependencies {
compile 'com.squareup.retrofit2:retrofit:2.0.2' // Retrofit库 }
2. 添加 网络权限
AndroidManifest.xml
<uses-permission android:name="android.permission.INTERNET"/>
步骤2:创建 接收服务器返回数据 的类
Reception.java
public class Reception { ... // 根据返回数据的格式和数据解析方式(Json、XML等)定义 // 下面会在实例进行说明 }
步骤3:创建 用于描述网络请求 的接口
- Retrofit将 Http请求 抽象成 Java接口:采用 注解 描述网络请求参数 和配置网络请求参数
- 用 动态代理 动态 将该接口的注解“翻译”成一个 Http 请求,最后再执行 Http 请求
- 注:接口中的每个方法的参数都需要使用注解标注,否则会报错
GetRequest_Interface.interface
public interface GetRequest_Interface { @GET("openapi.do?keyfrom=Yanzhikai&key=2032414398&type=data&doctype=json&version=1.1&q=car") Call<Translation> getCall(); // @GET注解的作用:采用Get方法发送网络请求 // getCall() = 接收网络请求数据的方法 // 其中返回类型为Call<*>,*是接收数据的类(即上面定义的Translation类) // 如果想直接获得Responsebody中的内容,可以定义网络请求返回值为Call<ResponseBody> }
下面详细介绍Retrofit 网络请求接口 的注解类型。
注解类型
注解说明
第一类:网络请求方法
详细说明:
a. @GET、@POST、@PUT、@DELETE、@HEAD
以上方法分别对应 HTTP中的网络请求方式
public interface GetRequest_Interface { @GET("openapi.do?keyfrom=Yanzhikai&key=2032414398&type=data&doctype=json&version=1.1&q=car") Call<Translation> getCall(); // @GET注解的作用:采用Get方法发送网络请求 // getCall() = 接收网络请求数据的方法 // 其中返回类型为Call<*>,*是接收数据的类(即上面定义的Translation类) }
此处特意说明URL的组成:Retrofit把 网络请求的URL 分成了两部分设置:
// 第1部分:在网络请求接口的注解设置 @GET("openapi.do?keyfrom=Yanzhikai&key=2032414398&type=data&doctype=json&version=1.1&q=car") Call<Translation> getCall(); // 第2部分:在创建Retrofit实例时通过.baseUrl()设置 Retrofit retrofit = new Retrofit.Builder() .baseUrl("http://fanyi.youdao.com/") //设置网络请求的Url地址 .addConverterFactory(GsonConverterFactory.create()) //设置数据解析器 .build(); // 从上面看出:一个请求的URL可以通过 替换块 和 请求方法的参数 来进行动态的URL更新。 // 替换块是由 被{}包裹起来的字符串构成 // 即:Retrofit支持动态改变网络请求根目录
- 网络请求的完整 Url =在创建Retrofit实例时通过.baseUrl()设置 +网络请求接口的注解设置(下面称 “path“ )
- 具体整合的规则如下:
建议采用第三种方式来配置,并尽量使用同一种路径形式。
b. @HTTP
- 作用:替换@GET、@POST、@PUT、@DELETE、@HEAD注解的作用 及 更多功能拓展
- 具体使用