在使用 Retrofit 等 HTTP 客户端发起 @GET 请求时，我们经常需要传递一些复杂的参数，例如 JSON 格式的过滤器条件。直接将 JSON 字符串拼接到 URL 中，可能会遇到 URL 编码问题，导致 API 无法正确解析参数。本文将介绍如何使用 Gson 库构建 JSON 对象，并将其作为参数传递，从而避免这些问题。
使用 Gson 构建 JSON 对象
首先，需要在项目中引入 Gson 库。在 build.gradle(:app) 文件中添加以下依赖：
implementation 'com.google.code.gson:gson:2.8.9'
然后，就可以使用 Gson 库构建 JSON 对象了。以下是一个示例代码，演示如何创建一个包含 field 和 value 字段的 JSON 对象：
import com.google.gson.JsonObject;
public class Example {
public static void main(String[] args) {
JsonObject filters = new JsonObject();
filters.addProperty("field", "user_id");
filters.addProperty("value", "633a71e6644de2ad5123c57b");
System.out.println(filters.toString());
}
}这段代码首先导入 com.google.gson.JsonObject 类。然后，创建一个 JsonObject 对象 filters。使用 addProperty 方法向 filters 对象添加键值对。最后，使用 toString 方法将 filters 对象转换为 JSON 字符串，并打印到控制台。
输出结果如下：
{"field":"user_id","value":"633a71e6644de2ad5123c57b"}将 JSON 对象作为 @GET 请求的参数传递
接下来，需要将构建好的 JSON 对象作为 @GET 请求的参数传递给 API。Retrofit 允许我们使用 @Query 注解将参数添加到 URL 中。
假设我们有一个 API 接口如下：
import retrofit2.Call;
import retrofit2.http.GET;
import retrofit2.http.Query;
public interface ApiService {
@GET("users")
Call getUsers(@Query("filters") String filters);
} 在这个接口中，getUsers 方法使用 @Query("filters") 注解，将 filters 参数添加到 URL 中。
现在，可以使用以下代码调用 API：
import com.google.gson.JsonObject;
import retrofit2.Call;
import retrofit2.Callback;
import retrofit2.Response;
import retrofit2.Retrofit;
import retrofit2.converter.scalars.ScalarsConverterFactory;
public class Example {
public static void main(String[] args) {
JsonObject filters = new JsonObject();
filters.addProperty("field", "user_id");
filters.addProperty("value", "633a71e6644de2ad5123c57b");
Retrofit retrofit = new Retrofit.Builder()
.baseUrl("https://example.com/api/")
.addConverterFactory(ScalarsConverterFactory.create())
.build();
ApiService apiService = retrofit.create(ApiService.class);
Call call = apiService.getUsers(filters.toString());
call.enqueue(new Callback() {
@Override
public void onResponse(Call call, Response response) {
System.out.println("Response: " + response.body());
}
@Override
public void onFailure(Call call, Throwable t) {
System.err.println("Error: " + t.getMessage());
}
});
}
} 这段代码首先构建了一个 JsonObject 对象 filters。然后，创建了一个 Retrofit 实例，并指定了 API 的 base URL 和转换器工厂。接下来，创建了一个 ApiService 接口的实例，并调用了 getUsers 方法，将 filters.toString() 作为参数传递给 API。最后，使用 enqueue 方法异步执行 API 请求，并在回调函数中处理 API 响应。
注意事项
- 确保 Gson 库已正确添加到项目中。
- 使用 JsonObject 或其他 Gson 提供的类来构建 JSON 对象，避免手动拼接 JSON 字符串。
- 使用 toString 方法将 JSON 对象转换为 JSON 字符串。
- 在 Retrofit 接口中使用 @Query 注解将 JSON 字符串作为参数传递。
- 根据 API 的要求，可能需要对 JSON 字符串进行 URL 编码。Gson 库本身不负责 URL 编码，如果需要，可以使用 URLEncoder.encode 方法进行编码。
总结
通过使用 Gson 库构建 JSON 对象，并将其作为 @GET 请求的参数传递，可以有效地避免 URL 编码问题，确保 API 能够正确解析和处理请求。这种方法不仅适用于简单的键值对，还适用于更复杂的 JSON 结构。在实际开发中，可以根据具体的需求，灵活运用 Gson 库提供的各种功能，构建符合要求的 JSON 对象。
