Android Retrofit Get @Query - Java

在 Android 应用开发中，我们常常需要从服务器上获取数据。其中一个常见的 HTTP 请求方式是 GET 请求，并且我们可能需要在请求 URL 上带上查询参数，以获得所需要的数据。Retrofit 是 Android 开发者常用的网络请求库之一，它非常方便地支持 GET 请求的查询参数设置。本文将介绍如何使用 Retrofit 发送带有查询参数的 GET 请求。

准备工作

在使用 Retrofit 之前，我们需要在项目中引入 Retrofit 库。我们可以使用 Gradle 将 Retrofit 添加到项目中：

implementation 'com.squareup.retrofit2:retrofit:2.x.x'

注意：在 Gradle 依赖中，2.x.x 可以替换为 Retrofit 的具体版本号。

使用 Retrofit 进行网络请求时需要添加转换器，以此确定要如何解析传输的数据格式。例如，我们可以使用 Gson 转换器来解析 JSON 数据。我们需要添加以下依赖项：

implementation 'com.squareup.retrofit2:converter-gson:2.x.x'

定义 API 接口

对于每个不同的 API，我们需要定义不同的接口。在 Retrofit 中，我们使用 Java 接口和注释来定义 API。

假设我们正在调用一个公共 API，该 API 提供了一个查询字符串参数以获取一些特定数据。我们可以创建一个 Retrofit 接口来描述此 API：

public interface MyApi {
  @GET("/data")
  Call<MyData> getData(@Query("param1") String param1, @Query("param2") String param2);
}

在这个接口中，我们使用 @GET 注释来指示这是一个 GET 请求类型。我们在括号中提供了转换后的查询 URL [baseURL]/data，其中 baseURL 是基本 URL，我们将在创建 Retrofit 服务实例时指定。我们通过 @Query 注释添加查询参数 param1 和 param2。

此 API 的响应解析为 MyData 对象。此对象应该是一个由 Gson 转换器解析的类，以解析 JSON 数据。

创建 Retrofit 服务

一旦我们定义了 API 接口，我们需要创建一个 Retrofit 实例来执行网络请求。我们需要使用 Retrofit 构建器来指定基本 URL 和转换器。我们可以使用以下方法来创建一个 Retrofit 服务实例：

Retrofit retrofit = new Retrofit.Builder()
    .baseUrl(BASE_URL)
    .addConverterFactory(GsonConverterFactory.create())
    .build();

MyApi api = retrofit.create(MyApi.class);

在 Retrofit.Builder() 中，我们指定基本 URL 和转换器构建器。我们使用 baseUrl 方法指定基本 URL，然后使用 addConverterFactory 方法指定转换器。我们使用 Gson 转换器创建一个转换器工厂实例。我们使用 build 方法创建一个 Retrofit 实例。

最后，我们通过 create 方法从 Retrofit 实例中创建 MyApi 接口的实例。然后我们可以使用这个实例来执行网络请求。例如，我们可以使用以下方法来发送查询参数请求：

Call<MyData> call = api.getData("value1", "value2");
call.enqueue(new Callback<MyData>() {
  @Override
  public void onResponse(Call<MyData> call, Response<MyData> response) {
    // 请求成功的回调方法
    // 处理返回的数据
  }

  @Override
  public void onFailure(Call<MyData> call, Throwable t) {
    // 请求失败的回调方法 
    // 处理失败情况
  }
});

我们将参数 value1 和 value2 传递给 getData 方法，并将响应对象解析为 MyData 对象。我们使用 enqueue 方法将请求放入请求队列中，并使用回调方法处理请求结果。在回调方法中，我们可以处理成功或失败情况，并处理返回的数据。

总结

带有查询参数的 GET 请求是 HTTP 请求的常见方式，也是与服务器通信时常用的方式之一。使用 Retrofit 构建 Web API 时，我们可以使用 @Query 注释轻松添加查询参数。在 Retrofit 中，我们使用 Java 接口和注释来构建 Web API 定义。在创建 Retrofit 实例时，我们将指定基本 URL 和转换器。通过执行回调来处理网络请求响应。