美文网首页程序员
Retrofit系列文章翻译5—多个 Query 参数使用同一名

Retrofit系列文章翻译5—多个 Query 参数使用同一名

作者: 张金富呵呵 | 来源:发表于2016-08-17 11:35 被阅读905次

原文链接:https://futurestud.io/blog/retrofit-multiple-query-parameters-of-same-name
本文属于我们的Retrofit 系列, 描述了如何使用一个或多个相同名字query参数执行请求. 下面的列表显示了该系列的所有文章:

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 定义动态请求头

Query 参数

Query 参数是从客户机到服务器传送数据的常用方法. 我们都知道他们的请求. 让我们看下实例, 通过id=123指定特定的task.

https://api.example.com/tasks?id=123 

示例返回的响应是只有 id=123的task.
Retrofit 的query 参数方法定义直截了当.

Retrofit 1.9

public interface TaskService {  
    @GET("/tasks")
    Task getTask(@Query("id") long taskId);
}

Retrofit 2

public interface TaskService {  
    @GET("/tasks")
    Call<Task> getTask(@Query("id") long taskId);
}

getTask(…) 方法需要taskId参数. 此参数将会被 Retrofit 映射到给定的@Query()参数名. 本例中 参数名为id, 最终的请求url看起来像这样

/tasks?id=<taskId>

多个 Query 参数

有些用例需要传递多个同名的query参数. 考虑到前面的从API请求task的例子,我们可以扩展query参数以接受多个任务的id的列表.
我们想创建的请求 url 看起来像这样

https://api.example.com/tasks?id=123&id=124&id=125 

预期的服务器响应应该是query参数给定的ids=[123, 124, 125]的task列表.
Retrofit 的执行多个同名 query 参数请求的方法是通过提供id列表作为参数(没搞懂,译者注). Retrofit 会连接给定的列表中名称相同的多个查询参数.

Retrofit 1.9

public interface TaskService {  
    @GET("/tasks")
    List<Task> getTask(@Query("id") List<Long> taskIds);
}

Retrofit 2

public interface TaskService {  
    @GET("/tasks")
    Call<List<Task>> getTask(@Query("id") List<Long> taskIds);
}

由此产生的请求的url看起来像在本节(多个查询参数)的开始的上面的例子.
请享受编程并使用 Retrofit. 如果你遇到了问题或者困难, 请 Twitter @futurestud_io.

相关文章

网友评论

    本文标题:Retrofit系列文章翻译5—多个 Query 参数使用同一名

    本文链接:https://www.haomeiwen.com/subject/qzjmsttx.html