原文链接:https://futurestud.io/blog/retrofit-multiple-query-parameters-of-same-name
本文属于我们的Retrofit 系列, 描述了如何使用一个或多个相同名字query
参数执行请求. 下面的列表显示了该系列的所有文章:
Retrofit 系列目录
- 开始创建android客户端[已翻译]
- Android上的基本认证[已翻译]
- Android上的令牌认证[已翻译]
- Android上的OAuth
- 多个 Query 参数使用同一名字
- 同步与异步请求[已翻译]
- 在请求体里发送对象[已翻译]
- 自定义一个响应转换器[已翻译]
- 添加自定义请求头
- 可选的 Query 参数
- 如何集成 XML 转换器
- 使用 Log Level 调试请求
- 如何上传文件
- Series Round-Up
- Retrofit 2 — 1.9 升级指南
- Retrofit 2 — 如何上传文件
- Retrofit 2 — Log 请求与响应
- Retrofit 2 — Android 上的 Hawk 认证
- Retrofit 2 — 简单错误处理
- 如何在 Retrofit 1 里使用 OkHttp 3
- Retrofit 2 — 图书更新发布庆典
- 提交表单数据 — Urlencoded
- 提交表单数据 — Urlencoded 使用FieldMap
- Retrofit 2 — 在 OkHttp 拦截器里管理请求头部
- Retrofit 2 — 如何给每一个请求添加 Query 参数
- Retrofit 2 — 使用QueryMap 添加多个 Query 参数
- Retrofit 2 — 如何在请求时使用动态 Url
- Retrofit 2 — Url 处理,分辨和解析
- Retrofit 2 — POST 和PUT 请求里的常量, 默认值和逻辑值
- Retrofit 2 — 如何下载文件
- Retrofit 2 — 取消请求
- Retrofit 2 — 重用分析请求
- Retrofit 2 — 如何在运行时修改 API Base Url
- 可选Path参数
- 如何刷新 Access Token
- Retrofit 2 — 如何提交文本请求体
- Retrofit 2 — 使用 Query 参数来分页
- Retrofit 2 — 使用 链接头和动态 Url 来分页(比如GitHub)
- Retrofit 2 — 使用范围头字段来分页 (比如 Heroku)
- Retrofit 2 — 转换器介绍
- Retrofit 2 — 添加并自定义 Gson 转换器
- Retrofit 2 — 实现自定义转换器
- Retrofit 2 — 只在开发环境里启用日志
- Retrofit 2 — 如何上传多个文件
- Retrofit 2 — Passing Multiple Parts Along a File with @PartMap
- Retrofit 2 — 模仿服务端响应基本概念
- Retrofit 2 — 模仿服务端响应自定义网络行为
- 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.