使用 Gson 构建 JSON 对象并传递给 @GET API-java教程-PHP中文网

使用 Gson 构建 JSON 对象并传递给 @GET API

聖光之護

发布： 2025-07-29 16:42:18

原创

910人浏览过

使用 gson 构建 json 对象并传递给 @get api

本文旨在解决在使用 Retrofit 的 @GET API 传递复杂参数时，参数无法正确编码的问题。通过引入 Gson 库，我们可以方便地构建 JSON 对象，并将其作为参数传递，从而避免手动编码带来的错误。本文将提供详细的步骤和示例代码，帮助开发者轻松实现复杂参数的传递。

在使用 Retrofit 构建 Android 应用时，经常需要通过 @GET API 传递参数。当参数比较简单时，可以直接使用键值对的方式传递。但是，当参数比较复杂，例如需要传递 JSON 数组时，直接传递可能会遇到编码问题，导致服务器无法正确解析。本文将介绍如何使用 Gson 库构建 JSON 对象，并将其作为参数传递给 @GET API，从而解决参数编码问题。

1. 添加 Gson 依赖

首先，需要在 build.gradle(:app) 文件中添加 Gson 依赖。

implementation 'com.google.code.gson:gson:2.8.9'

登录后复制

请确保将 2.8.9 替换为最新版本的 Gson 库。添加依赖后，需要同步 Gradle 文件。

2. 构建 JSON 对象

接下来，使用 Gson 库构建 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 对象，并使用 addProperty() 方法添加键值对。最后，使用 toString() 方法将 JSON 对象转换为字符串并打印出来。输出结果如下：

{"field":"user_id","value":"633a71e6644de2ad5123c57b"}

登录后复制

3. 在 Retrofit 接口中使用 JSON 对象

Find JSON Path Online

Easily find JSON paths within JSON objects using our intuitive Json Path Finder

查看详情

现在，可以在 Retrofit 接口中使用 JSON 对象作为参数。

import retrofit2.Call;
import retrofit2.http.GET;
import retrofit2.http.Query;

public interface ApiService {
    @GET("your_api_endpoint")
    Call<ResponseBody> getData(@Query("filters") String filters);
}

登录后复制

在这个接口中，我们定义了一个 getData() 方法，它接受一个名为 filters 的字符串参数，并使用 @Query 注解将其添加到 URL 中。注意，这里我们将 JSON 对象转换为字符串传递。

4. 调用 API

最后，调用 API 并传递 JSON 字符串。

import com.google.gson.JsonObject;
import okhttp3.ResponseBody;
import retrofit2.Call;
import retrofit2.Callback;
import retrofit2.Response;
import retrofit2.Retrofit;
import retrofit2.converter.gson.GsonConverterFactory;

public class NetworkRequest {

    public static void main(String[] args) {
        // 构建 JSON 对象
        JsonObject filters = new JsonObject();
        filters.addProperty("field", "user_id");
        filters.addProperty("value", "633a71e6644de2ad5123c57b");
        String filtersJson = filters.toString();

        // 创建 Retrofit 实例
        Retrofit retrofit = new Retrofit.Builder()
                .baseUrl("https://your_base_url/")
                .addConverterFactory(GsonConverterFactory.create())
                .build();

        // 创建 ApiService 实例
        ApiService apiService = retrofit.create(ApiService.class);

        // 调用 API
        Call<ResponseBody> call = apiService.getData(filtersJson);
        call.enqueue(new Callback<ResponseBody>() {
            @Override
            public void onResponse(Call<ResponseBody> call, Response<ResponseBody> response) {
                if (response.isSuccessful()) {
                    // 处理成功响应
                    try {
                        System.out.println("Response: " + response.body().string());
                    } catch (Exception e) {
                        e.printStackTrace();
                    }
                } else {
                    // 处理失败响应
                    System.out.println("Error: " + response.message());
                }
            }

            @Override
            public void onFailure(Call<ResponseBody> call, Throwable t) {
                // 处理网络错误
                System.out.println("Failure: " + t.getMessage());
            }
        });
    }
}

登录后复制

这段代码首先构建 JSON 对象并将其转换为字符串。然后，创建一个 Retrofit 实例，并使用 GsonConverterFactory 将 JSON 响应转换为 Java 对象。接下来，创建 ApiService 实例，并调用 getData() 方法，传递 JSON 字符串。最后，使用 enqueue() 方法异步执行请求，并在回调函数中处理响应。

注意事项