这是一份很详细的 Retrofit 2.0 使用教程（含实例讲解）

前言

• 在Andrroid开发中，网络请求十分经常使用
• 而在Android网络请求库中，Retrofit是当下最热的一个网络请求库

• 今天，我将献上一份很是详细Retrofit v2.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地址

• Android-Async-Http
• Volley
• OkHttp
• Retrofit

3. 使用介绍

使用 Retrofit 的步骤共有7个：

步骤1：添加Retrofit库的依赖 
步骤2：建立 接收服务器返回数据 的类 
步骤3：建立 用于描述网络请求 的接口 
步骤4：建立 Retrofit 实例 
步骤5：建立 网络请求接口实例 并 配置网络请求参数 
步骤6：发送网络请求（异步 / 同步）

 

步骤7： 处理服务器返回的数据

接下来，咱们一步步进行讲解。

步骤1：添加Retrofit库的依赖

1. 在 Gradle加入Retrofit库的依赖

 

build.gradle

• 1
• 2
• 3
• 4
• 5
• 6

2. 添加 网络权限 
AndroidManifest.xml

• 1

步骤2：建立 接收服务器返回数据 的类

Reception.java

• 1
• 2
• 3
• 4
• 5

步骤3：建立 用于描述网络请求 的接口

• Retrofit将 Http请求 抽象成 Java接口：采用 注解 描述网络请求参数 和配置网络请求参数  

  1.  
  2.  

GetRequest_Interface.interface

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10

下面详细介绍Retrofit 网络请求接口 的注解类型。

注解类型

注解说明

第一类：网络请求方法

详细说明： 
a. @GET、@POST、@PUT、@DELETE、@HEAD 
以上方法分别对应 HTTP中的网络请求方式

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8

此处特地说明URL的组成：Retrofit把 网络请求的URL 分红了两部分设置：

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13

• 网络请求的完整 Url =在建立Retrofit实例时经过.baseUrl()设置 +网络请求接口的注解设置（下面称 “path“ ） 
• 具体整合的规则以下：

 

b. @HTTP

• 做用：替换@GET、@POST、@PUT、@DELETE、@HEAD注解的做用 及 更多功能拓展
• 具体使用：经过属性method、path、hasBody进行设置

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11

第二类：标记

a. @FormUrlEncoded

• 做用：表示发送form-encoded的数据

 

b. @Multipart

 

• 做用：表示发送form-encoded的数据（适用于 有文件 上传的场景） 

 

 

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16
• 17
• 18
• 19
• 20
• 21
• 22
• 23
• 24
• 25
• 26
• 27
• 28
• 29
• 30

第三类：网络请求参数

详细说明

a. @Header & @Headers

• 做用：添加请求头 &添加不固定的请求头
• 具体使用以下：

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13

b. @Body

 

• 做用：以 Post方式 传递 自定义数据类型 给服务器
• 特别注意：若是提交的是一个Map，那么做用至关于 @Field 

 

 

• 1
• 2
• 3

c. @Field & @FieldMap

• 做用：发送 Post请求 时提交请求的表单字段
• 具体使用：与 @FormUrlEncoded 注解配合使用

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16
• 17
• 18
• 19
• 20
• 21
• 22
• 23
• 24
• 25
• 26
• 27
• 28

d. @Part & @PartMap

• 做用：发送 Post请求 时提交请求的表单字段

   

• 具体使用：与 @Multipart 注解配合使用

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16
• 17
• 18
• 19
• 20
• 21
• 22
• 23
• 24
• 25
• 26
• 27
• 28
• 29
• 30
• 31
• 32
• 33
• 34
• 35
• 36
• 37
• 38
• 39
• 40
• 41
• 42
• 43
• 44
• 45
• 46

e. @Query和@QueryMap

• 做用：用于 @GET 方法的查询参数（Query = Url 中 ‘?’ 后面的 key-value）

   

• 具体使用：配置时只须要在接口方法中增长一个参数便可：

• 1
• 2
• 3
• 4
• 5
• 6

f. @Path

• 做用：URL地址的缺省值
• 具体使用：

• 1
• 2
• 3
• 4
• 5
• 6
• 7

g. @Url

• 做用：直接传入一个请求的 URL变量 用于URL设置
• 具体使用：

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8

汇总

步骤4：建立 Retrofit 实例

• 1
• 2
• 3
• 4
• 5

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 

   

• 使用时须要在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：建立 网络请求接口实例

• 1
• 2
• 3
• 4
• 5

步骤6：发送网络请求（异步 / 同步）

 

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16
• 17
• 18
• 19

步骤7：处理返回数据

经过response类的 body（）对返回的数据进行处理

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16
• 17
• 18
• 19
• 20
• 21

4. 实例讲解

接下来，我将用两个实例分别对 Retrofit GET方式 和 POST方式进行 网络请求 讲解。

4.1 实例1

• 实现功能：将中文翻译成英文
• 实现方案：采用Get方法对 金山词霸API 发送网络请求 

   

• 步骤说明

步骤1：添加Retrofit库的依赖 
步骤2：建立 接收服务器返回数据 的类 
步骤3：建立 用于描述网络请求 的接口 
步骤4：建立 Retrofit 实例 
步骤5：建立 网络请求接口实例 并 配置网络请求参数 
步骤6：发送网络请求（采用最经常使用的异步方式）

 

步骤7： 处理服务器返回的数据

接下来，咱们一步步进行讲解。

• 具体使用

步骤1：添加Retrofit库的依赖

1. 在 Gradle加入Retrofit库的依赖

 

build.gradle

• 1
• 2
• 3
• 4
• 5
• 6

2. 添加 网络权限 
AndroidManifest.xml

• 1

步骤2：建立 接收服务器返回数据 的类

• 金山词霸API 的数据格式说明以下：

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11

• 根据 金山词霸API 的数据格式，建立 接收服务器返回数据 的类：

Translation.java

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16
• 17
• 18
• 19
• 20
• 21
• 22
• 23
• 24

步骤3：建立 用于描述网络请求 的接口

采用 注解 描述 网络请求参数。 
GetRequest_Interface.java

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9

接下来的步骤均在GetRequest.java内实现（看注释）

步骤4：建立Retrofit对象 
步骤5：建立 网络请求接口 的实例 
步骤6：发送网络请求

 

步骤7：处理返回数据

GetRequest.java

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16
• 17
• 18
• 19
• 20
• 21
• 22
• 23
• 24
• 25
• 26
• 27
• 28
• 29
• 30
• 31
• 32
• 33
• 34
• 35
• 36
• 37
• 38
• 39
• 40
• 41

因为此处采用了 Gson 解析，因此须要在 Gradle加入依赖 
build.gradle

• 1

运行结果

Demo地址

Carson_Ho的Github：https://github.com/Carson-Ho/RetrofitDemo

4.2 实例2

• 实现的功能：将 英文 翻译成 中文
• 实现方法：采用Post方法对 有道API 发送网络请求 

   

• 使用步骤

步骤1：添加Retrofit库的依赖 
步骤2：建立 接收服务器返回数据 的类 
步骤3：建立 用于描述网络请求 的接口 
步骤4：建立 Retrofit 实例 
步骤5：建立 网络请求接口实例 并 配置网络请求参数 
步骤6：发送网络请求（采用最经常使用的异步方式）

 

步骤7： 处理服务器返回的数据

接下来，咱们一步步进行Retrofit的使用。

• 具体使用

步骤1：添加Retrofit库的依赖

1. 在 Gradle加入Retrofit库的依赖

 

build.gradle

• 1
• 2
• 3
• 4
• 5
• 6

2. 添加 网络权限 
AndroidManifest.xml

• 1

步骤2：建立 接收服务器返回数据 的类

• API 的数据格式说明以下：

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16
• 17
• 18
• 19
• 20
• 21
• 22
• 23
• 24
• 25

• 根据 有道API 的数据格式，建立 接收服务器返回数据 的类：

Translation.java

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16
• 17
• 18
• 19
• 20
• 21
• 22
• 23
• 24
• 25
• 26
• 27
• 28
• 29
• 30
• 31
• 32
• 33
• 34
• 35
• 36
• 37
• 38
• 39
• 40
• 41
• 42
• 43
• 44
• 45
• 46
• 47
• 48
• 49
• 50
• 51
• 52
• 53
• 54
• 55
• 56
• 57
• 58
• 59
• 60
• 61
• 62
• 63
• 64
• 65
• 66

步骤3：建立 用于描述网络请求 的接口

采用 注解 描述 网络请求参数。

PostRequest_Interface.java

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9

接下来的步骤均在PostRequest.java内实现（看注释）

步骤4：建立Retrofit对象 
步骤5：建立 网络请求接口 的实例 
步骤6：发送网络请求

 

步骤7：处理返回数据

PostRequest.java

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16
• 17
• 18
• 19
• 20
• 21
• 22
• 23
• 24
• 25
• 26
• 27
• 28
• 29
• 30
• 31
• 32
• 33
• 34
• 35
• 36
• 37
• 38
• 39
• 40
• 41
• 42
• 43
• 44
• 45

因为此处采用了 Gson 解析，因此须要在 Gradle 加入依赖 
build.gradle

• 1

运行结果

Demo地址

Carson_Ho的Github：https://github.com/Carson-Ho/RetrofitDemo

5. Retrofit 的拓展使用

• Retrofit的使用场景很是丰富，如支持RxJava和Prototocobuff
• 具体设置也很是简单 & 方便：

• 1
• 2
• 3
• 4
• 5
• 6
• 7

具体关于 RxJava的使用这里就不展开，请期待下篇关于 Rxjava的文章。

6. 总结

• 看完本文，相信你已经很是熟悉 Retrofit 2.0 的使用
• 若是你但愿继续阅读 Retrofit 2.0 的源码，请看我写的文章:Android：手把手带你深刻剖析 Retrofit 2.0 源码
• 接下来，我将继续分析与 Retrofit 配合使用的 RxJava，有兴趣能够继续关注Carson_Ho的安卓开发笔记