使用Retrofit2+GSON解析WordPress插件API时遇空字段子字段转换错误

我之前对接WordPress API的时候也碰到过一模一样的问题！当返回的JSON里某个字段是null，但你的POJO类里又定义了它的子属性时，Gson就会因为没法把null解析成对应的对象而抛出转换错误。给你几个亲测有效的解决办法：

1. 给可能为空的字段添加@Nullable注解 #

如果你的项目用了AndroidX或者JetBrains的Nullable注解，直接给存在子属性的空字段加上这个注解，明确告诉Gson该字段允许为null，不用强行解析成对象：

public class Plugin {
    @Nullable
    @SerializedName("your_sub_field")
    @Expose
    private YourSubClass yourSubField;
    
    // 对应的getter和setter方法
}

2. 自定义TypeAdapter统一处理空对象 #

如果多个字段都存在这种“可能为null但有子属性”的情况，可以写一个通用的TypeAdapter来拦截处理：

public class NullObjectAdapter<T> extends TypeAdapter<T> {
    private final TypeAdapter<T> delegateAdapter;

    public NullObjectAdapter(TypeAdapter<T> delegateAdapter) {
        this.delegateAdapter = delegateAdapter;
    }

    @Override
    public void write(JsonWriter out, T value) throws IOException {
        if (value == null) {
            out.nullValue();
            return;
        }
        delegateAdapter.write(out, value);
    }

    @Override
    public T read(JsonReader in) throws IOException {
        if (in.peek() == JsonToken.NULL) {
            in.nextNull();
            return null;
        }
        return delegateAdapter.read(in);
    }
}

然后在构建Gson实例时注册这个适配器，替换成你出问题的子字段对应的类：

Gson gson = new GsonBuilder()
        .registerTypeAdapter(YourSubClass.class, new NullObjectAdapter<>(new Gson().getAdapter(YourSubClass.class)))
        .create();

3. 用Java 8+的Optional包装可选字段 #

如果你的项目基于Java 8及以上版本，可以用Optional来包装可能为空的子字段，Gson会自动识别并处理null情况：

public class Plugin {
    @SerializedName("your_sub_field")
    @Expose
    private Optional<YourSubClass> yourSubField;
    
    // 对应的getter和setter方法
}

记得构建Gson时要启用Java 8支持：

Gson gson = new GsonBuilder()
        .registerTypeAdapterFactory(OptionalTypeAdapterFactory.forOptional())
        .create();

4. 先排查API返回的JSON结构 #

有时候问题根源在API返回的内容上，某些字段可能在不同场景下返回null或对象。你可以给Retrofit添加日志拦截器，打印完整的JSON响应，确认哪些字段是不稳定的：

HttpLoggingInterceptor loggingInterceptor = new HttpLoggingInterceptor();
loggingInterceptor.setLevel(HttpLoggingInterceptor.Level.BODY);

OkHttpClient okHttpClient = new OkHttpClient.Builder()
        .addInterceptor(loggingInterceptor)
        .build();

// 把这个okHttpClient传给Retrofit实例
Retrofit retrofit = new Retrofit.Builder()
        .baseUrl("your_wordpress_api_url")
        .client(okHttpClient)
        .addConverterFactory(GsonConverterFactory.create(gson))
        .build();

通过日志就能精准定位到出问题的字段，再针对性处理。

内容的提问来源于stack exchange，提问作者Damjan Kalšan