Retrofit系列文章翻译6—同步与异步请求

2024年1月29日 422次阅读 来源: 张金富呵呵

原文链接：https://futurestud.io/blog/retrofit-synchronous-and-asynchronous-requests
在此前发布的文章中，我们带您经历如何设置 Retrofit 来集成对任何Web服务或API的认证。这篇文章将向您展示如何通过两种方式执行实际请求：同步或异步。

Retrofit 系列目录

  1. 开始创建android客户端[已翻译]
  2. Android上的基本认证[已翻译]
  3. Android上的令牌认证[已翻译]
  4. Android上的OAuth
  5. 多个 Query 参数使用同一名字[已翻译]
  6. 同步与异步请求
  7. 在请求体里发送对象[已翻译]
  8. 自定义一个响应转换器[已翻译]
  9. 添加自定义请求头
  10. 可选的 Query 参数
  11. 如何集成 XML 转换器
  12. 使用 Log Level 调试请求
  13. 如何上传文件
  14. Series Round-Up
  15. Retrofit 2 — 1.9 升级指南
  16. Retrofit 2 — 如何上传文件
  17. Retrofit 2 — Log 请求与响应
  18. Retrofit 2 — Android 上的 Hawk 认证
  19. Retrofit 2 — 简单错误处理
  20. 如何在 Retrofit 1 里使用 OkHttp 3
  21. Retrofit 2 — 图书更新发布庆典
  22. 提交表单数据 — Urlencoded
  23. 提交表单数据 — Urlencoded 使用FieldMap
  24. Retrofit 2 — 在 OkHttp 拦截器里管理请求头部
  25. Retrofit 2 — 如何给每一个请求添加 Query 参数
  26. Retrofit 2 — 使用QueryMap 添加多个 Query 参数
  27. Retrofit 2 — 如何在请求时使用动态 Url
  28. Retrofit 2 — Url 处理，分辨和解析
  29. Retrofit 2 — POST 和PUT 请求里的常量, 默认值和逻辑值
  30. Retrofit 2 — 如何下载文件
  31. Retrofit 2 — 取消请求
  32. Retrofit 2 — 重用分析请求
  33. Retrofit 2 — 如何在运行时修改 API Base Url
  34. 可选Path参数
  35. 如何刷新 Access Token
  36. Retrofit 2 — 如何提交文本请求体
  37. Retrofit 2 — 使用 Query 参数来分页
  38. Retrofit 2 — 使用 链接头和动态 Url 来分页(比如GitHub)
  39. Retrofit 2 — 使用范围头字段来分页 (比如 Heroku)
  40. Retrofit 2 — 转换器介绍
  41. Retrofit 2 — 添加并自定义 Gson 转换器
  42. Retrofit 2 — 实现自定义转换器
  43. Retrofit 2 — 只在开发环境里启用日志
  44. Retrofit 2 — 如何上传多个文件
  45. Retrofit 2 — Passing Multiple Parts Along a File with @PartMap
  46. Retrofit 2 — 模仿服务端响应基本概念
  47. Retrofit 2 — 模仿服务端响应自定义网络行为
  48. Retrofit 2 — 使用 @HeaderMap 定义动态请求头

Retrofit 支持同步和异步请求. 用户通过设置返回类型（同步或异步）定义具体的执行。

同步请求

Retrofit 1.9 的同步请求通过定义一个返回类型声明. 下面的例子中当执行getTasks 方法时, 我们期望一个Task列表作为响应.

Retrofit 1.9

public interface TaskService {  
    @GET("/tasks")
    List<Task> getTasks();
}

Retrofit 2

public interface TaskService {  
    @GET("/tasks")
    Call<List<Task>> getTasks();
}

在 Retrofit 2，每个请求被包裹成一个Call对象. 实际的同步或异步请求使用在随后创建的call对象上的方法来执行不同的流程 . 无论如何，在 Retrofit 2 中对于同步和异步请求的接口定义是相同的.
同步方法是在主线程上执行. 这意味着, 在请求执行过程中UI被阻塞, 没有任何交互可能.

警告: 同步请求在 Android 4.0 及以上版本中可能导致程序崩溃. 你将得到一个 NetworkOnMainThreadException 错误.

同步方法提供了直接使用返回值的能力，因为你的网络请求阻塞一切.
对于非阻塞UI，你必须自己在一个独立的线程中执行请求. 这意味着，在等待响应过程中你仍然可以与应用程序交互.

得到同步请求的结果

让我们将目标转向实际请求. 此处 Retrofit 版本1 到 版本2 有变化. 下列代码片段展示了 Retrofit 的同步请求执行, 此处假设你已经熟悉了先前文章介绍的ServiceGenerator类.

Retrofit 1.9

TaskService taskService = ServiceGenerator.createService(TaskService.class);  
List<Task> tasks = taskService.getTasks();

Retrofit 2

TaskService taskService = ServiceGenerator.createService(TaskService.class);  
Call<List<Task>> call = taskService.getTasks();  
List<Task>> tasks = call.execute().body();

在 Retrofit 2 中, 使用call对象的.execute()方法将会执行同步请求. 反序列化的响应体通过响应对象的.body()方法获得.

异步请求

除了同步调用, Retrofit 支持开箱即用的异步请求. 在 Retrofit1.9 中异步请求没有返回类型. 相反，定义的方法需要一个类型的回调作为最后方法的参数.

Retrofit 1.9

public interface TaskService {  
    @GET("/tasks")
    void getTasks(Callback<List<Task>> cb);
}

Retrofit 2

public interface TaskService {  
    @GET("/tasks")
    Call<List<Task>> getTasks();
}

Retrofit 在单独的线程中执行并处理方法体. Callback 类是通用的，它映射你定义的返回类型. 在我们的例子中返回的是Task列表, Callback做内部的映射.

如上面已经提到的: Retrofit 2 的接口定义对于同于和异步请求都是相同的. 所需的返回类型被封装到Call对象, 实际的请求执行决定它的类型 (同步/异步).

得到异步请求的结果

使用异步请求迫使你实现一个Callback与它的两个回调方法: success 和failure. 当从服务类调用异步的getTasks()方法时，你必须实现一个新的Callback和定义一旦请求完成应做什么. 下列代码片段展示了示范性的实现.

Retrofit 1.9

TaskService taskService = ServiceGenerator.createService(TaskService.class);  
taskService.getTasks(new Callback<List<Task>>() {  
    @Override
    public void success(List<Task> tasks, Response response) {
        // here you do stuff with returned tasks
    }

    @Override
    public void failure(RetrofitError error) {
        // you should handle errors, too
    }
});

Retrofit 2

TaskService taskService = ServiceGenerator.createService(TaskService.class);  
Call<List<Task>> call = taskService.getTasks();  
call.enqueue(new Callback<List<Task>>() {  
    @Override
    public void onResponse(Call<List<Task>> call, Response<List<Task>> response) {
        if (response.isSuccessful()) {
            // tasks available
        } else {
            // error response, no access to resource?
        }
    }

    @Override
    public void onFailure(Call<List<Task>> call, Throwable t) {
        // something went completely south (like no internet connection)
        Log.d("Error", t.getMessage());
    }
}

获得原生 HTTP 响应

如果你需要原始的HTTP响应对象，只是将其定义为方法的返回类型. Response类像任何其他类一样同时适用于两种方法.

Retrofit 1.9

// synchronous
@GET("/tasks")
Response getTasks();

// asynchronous
@GET("/tasks")
void getTasks(Callback<Response> cb);

Retrofit 2
在 Retrofit 2 中，你并不需要定义Response类作为返回类型，而是你可以在onResponse()回调方法内得到它. 让我们看一下下列的代码片段如何得到原生响应:

call.enqueue(new Callback<List<Task>>() {  
    @Override
    public void onResponse(Call<List<Task>> call, Response<List<Task>> response) {
        // get raw response
        Response raw = response.raw();
    }

    @Override
    public void onFailure(Call<List<Task>> call, Throwable t) {}
}

祝您编码愉快! 如果你遇到任何问题或者需要帮助, 请 Twitter @futurestud_io.

附加资源

Retrofit API 声明 的 synchronous vs. asynchronous vs. observable章节

    原文作者：张金富呵呵
    原文地址: https://www.jianshu.com/p/d59c39a275c4
    本文转自网络文章，转载此文章仅为分享知识，如有侵权，请联系博主进行删除。
点赞