GSON 忽略类型错误的元素

json android java gson retrofit

2022-09-02 09:26:11

我正在使用Retrofit（与OkHttp和GSON结合使用）与在线Web服务进行通信。Web 服务在其所有响应之间都有一个默认的包装器，类似于：

{  
  "resultCode":"OK",
  "resultObj":"Can be a string or JSON object / array",
  "error":"",
  "message":""
}

在此示例中，将是或。此外，仅当处理请求时发生错误时才包含任何内容。最后，但并非最不重要的一点是，将包含调用的实际结果（这是示例中的字符串，但某些调用返回JSON数组或JSON对象）。resultCodeOKNOerrormessageresultObj

为了处理这个元数据，我创建了一个泛型类，就像这样：

public class ApiResult<T> {

    private String error;
    private String message;
    private String resultCode;
    private T resultObj;

    // + some getters, setters etcetera
}

我还创建了表示有时给出的响应的类，并且定义了一个用于改造的接口，看起来有点像这样：resultObj

public interface SomeWebService {

    @GET("/method/string")
    ApiResult<String> someCallThatReturnsAString();

    @GET("/method/pojo")
    ApiResult<SomeMappedResult> someCallThatReturnsAnObject();

}

只要请求有效，这一切都可以正常工作。但是，当服务器端发生错误时，它仍然会返回 String 类型的。这会导致Retrofit RestAdapter / GSON库中崩溃，并显示如下消息：resultObjsomeCallThatReturnsAnObject

改造。RetrofitError： com.google.gson.JsonSyntaxException： java.lang.IllegalStateException：

预期BEGIN_OBJECT，但在第 1 行第 110 列路径 $.resultObj 处为 STRING

现在，最后，我的问题是：

有没有一种（简单的）方法来告诉GSON，如果它与预期的类型不匹配，它应该忽略（又名“nullify”）属性？
我可以告诉GSON将空字符串视为空字符串吗？

答案 1

像这样定义模型：

public class ApiResult {

    private String error;
    private String message;
    private String resultCode;
    private MyResultObject resultObj;
}

然后，为 MyResultObject 创建一个 TypeAdapterFactory：

public class MyResultObjectAdapterFactory implements TypeAdapterFactory {

    @Override
    @SuppressWarnings("unchecked")
    public <T> TypeAdapter<T> create(Gson gson, TypeToken<T> type) {
        if (type.getRawType()!= MyResultObject.class) return null;

        TypeAdapter<MyResultObject> defaultAdapter = (TypeAdapter<MyResultObject>) gson.getDelegateAdapter(this, type);
        return (TypeAdapter<T>) new MyResultObjectAdapter(defaultAdapter);
    }

    public class MyResultObjectAdapter extends TypeAdapter<MyResultObject> {

        protected TypeAdapter<MyResultObject> defaultAdapter;


        public MyResultObjectAdapter(TypeAdapter<MyResultObject> defaultAdapter) {
            this.defaultAdapter = defaultAdapter;
        }

        @Override
        public void write(JsonWriter out, MyResultObject value) throws IOException {
            defaultAdapter.write(out, value);
        }

        @Override
        public MyResultObject read(JsonReader in) throws IOException {
            /* 
            This is the critical part. So if the value is a string,
            Skip it (no exception) and return null.
            */
            if (in.peek() == JsonToken.STRING) {
                in.skipValue();
                return null;
            }
            return defaultAdapter.read(in);
        }
    }
}

最后，为Gson注册MyResultObjectAdapterFactory：

Gson gson = new GsonBuilder()
    .registerTypeAdapterFactory(new MyResultObjectAdapterFactory())
    .create();

现在，当使用该Gson对象反序列化ApiResult json时，如果它是字符串，则resultObj将设置为null。

我希望这能解决您的问题=）

答案 2

我遇到了类似的问题，最后提出了以下解决方案：

为了尝试将元素解析为 or，请尝试将数据存储到一个简单的 java.lang.Object 中StringArray

这可以防止解析崩溃或引发异常。

例如。使用GSON注释，模型的属性将如下所示：

@SerializedName("resultObj")
@Expose
private java.lang.Object resultObj;

接下来，在运行时访问数据时，可以检查属性是否为实例。resultObjString

if(apiResultObject instanceof String ){
    //Cast to string and do stuff

} else{
    //Cast to array and do stuff

}

原文：https://stackoverflow.com/a/34178082/3708094