为具有不同对象的嵌套 json 改造 gson 转换器

Question

我 JSON 结构如下 -

{
    "status": true,
    "message": "Registration Complete.",
    "data": {
        "user": {
            "username": "user88",
            "email": "user@domain.com",
            "created_on": "1426171225",
            "last_login": null,
            "active": "1",
            "first_name": "User",
            "last_name": "",
            "company": null,
            "phone": null,
            "sign_up_mode": "GOOGLE_PLUS"
        }
    }
}

以上格式很常见。只有 data 键可以保存不同类型的信息，如 user、product、invoice 等

我想在每个休息响应中保持 status、message 和 data 键相同。 data 将根据 status 处理，并且 message 将显示给用户。

所以基本上，所有 api 都需要上述格式。 只是data键里面的信息每次都不一样

我已经设置了以下 class 并将其设置为 gson 转换器 - MyResponse.java

public class MyResponse<T> implements Serializable{
    private boolean status ;
    private String message ;
    private T data;

    public boolean isStatus() {
        return status;
    }

    public void setStatus(boolean status) {
        this.status = status;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

    public T getData() {
        return data;
    }

    public void setData(T data) {
        this.data = data;
    }
}

Deserializer.java

class Deserializer<T> implements JsonDeserializer<T>{
    @Override
    public T deserialize(JsonElement je, Type type, JsonDeserializationContext jdc) throws JsonParseException{
        JsonElement content = je.getAsJsonObject();

        // Deserialize it. You use a new instance of Gson to avoid infinite recursion to this deserializer
        return new Gson().fromJson(content, type);

    }
}

并按如下方式使用它 -

GsonBuilder  gsonBuilder = new GsonBuilder();
gsonBuilder.setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES); 
gsonBuilder.registerTypeAdapter(MyResponse.class, new Deserializer<MyResponse>());
...... ..... ....

restBuilder.setConverter(new GsonConverter(gsonBuilder.create()));

服务接口如下 -

@POST("/register")
public void test1(@Body MeUser meUser, Callback<MyResponse<MeUser>> apiResponseCallback);


@POST("/other")
public void test2(Callback<MyResponse<Product>> apiResponseCallback);

问题

我可以从内部回调访问 status 和 message 字段。但是 data 键中的信息没有被解析，像 MeUser 和 Product 这样的模型总是 returns 为空。

如果我将 json 结构更改为以下代码，则可以完美运行 -

{
        "status": true,
        "message": "Registration Complete.",
        "data": {                
                "username": "user88",
                "email": "user@domain.com",
                "created_on": "1426171225",
                "last_login": null,
                "active": "1",
                "first_name": "User",
                "last_name": "",
                "company": null,
                "phone": null,
                "sign_up_mode": "GOOGLE_PLUS"
        }
    }

如何在 data 对象中指定单独的键并成功解析它？

Answer 1

您的问题是因为 data 属性被定义为 T，您希望它属于 MeUser、Product 等类型，但实际上属于具有 user 等内部属性的对象。要解决这个问题，您需要引入另一个级别的类，它具有所需的属性 user、product、invoice 等。这可以使用 static inner [= 轻松实现21=].

public class MeUser{
  private User user;
  public static class User{
    private String username;
    //add other attributes of the User class
  }
}

Answer 2

如果我可以建议更改 json 中的某些内容，那就是您必须添加一个定义数据类型的新字段，因此 json 应如下所示：

{
   "status": true,
   "message": "Registration Complete.",
   "dataType" : "user",
   "data": {                
            "username": "user88",
            "email": "user@domain.com",
            "created_on": "1426171225",
            "last_login": null,
            "active": "1",
            "first_name": "User",
            "last_name": "",
            "company": null,
            "phone": null,
            "sign_up_mode": "GOOGLE_PLUS"
    }
}

MyResponse class 必须有新文件 DataType 所以它应该如下所示：

public class MyResponse<T> implements Serializable{
    private boolean status ;
    private String message ;
    private DataType dataType ;
    private T data;


    public DataType getDataType() {
        return dataType;
    }

    //... other getters and setters
}

DataType 是定义数据类型的枚举。您必须在构造函数中将 Data.class 作为参数传递。对于所有数据类型，您必须创建新的 classes。 DataType 枚举应如下所示：

public enum DataType {

    @SerializedName("user")
    USER(MeUser.class),
    @SerializedName("product")
    Product(Product.class),
    //other types in the same way, the important think is that 
    //the SerializedName value should be the same as dataType value from json 
    ;


    Type type;

    DataType(Type type) {
        this.type = type;
    }

    public Type getType(){
        return type;
    }
}

Json 的反序列化器应该如下所示：

public class DeserializerJson implements JsonDeserializer<MyResponse> {

    @Override
    public MyResponse deserialize(JsonElement je, Type type, JsonDeserializationContext jdc)
            throws JsonParseException {
        JsonObject content = je.getAsJsonObject();
        MyResponse message = new Gson().fromJson(je, type);
        JsonElement data = content.get("data");
        message.setData(new Gson().fromJson(data, message.getDataType().getType()));
        return message;

    }
}

并且当您创建 RestAdapter 时，在您注册 Deserializator 的行中，您应该使用：

 .registerTypeAdapter(MyResponse.class, new DeserializerJson())

您定义的其他 classes（数据类型），如 Gson 的标准 POJO 在分隔的 classes.

Answer 3

可能有点跑题了，但是如果内部对象包含日期属性会怎样？我的 TypeAdapter 看起来像这样：

 .registerTypeAdapter(Date.class, new DateDeserializer())
                .registerTypeAdapter(GenericNotificationResponse.class, new NotificationDeserializer())
                .setDateFormat("yyyy-MM-dd'T'HH:mm:ss")
                .create();

但是由于由此完成的解析：message.setData(new Gson().fromJson(data, message.getDataType().getType()));

每当它尝试反序列化日期属性时都会抛出错误。有快速解决方法吗？

编辑：绝对将答案标记为已接受 :) 它帮助我解决了我的问题。但是现在日期反序列化器出现了这个问题。

为具有不同对象的嵌套 json 改造 gson 转换器

retrofit gson converter for nested json with different objects

java

android

json

gson

retrofit