如何使用Gson处理具有相同属性名称的不同数据类型?

时间:2015-08-01 06:09:43

标签: java json gson deserialization json-deserialization

我目前正在使用Gson在Java中编写RSS提要解析器。我正在转换RSS'将XML转换为JSON,然后使用Gson将JSON反序列化为Java POJO(稍微有点迂回但有其原因)。对于下面列出的Feed#1( BBC )进行反序列化,一切正常,但对于下面列出的Feed#2( NPR ),我开始获得例外情况抛出。

我想我已经确定了问题,但我不确定如何解决它:

这两个RSS源(例如)出现了问题:

  1. http://feeds.bbci.co.uk/news/rss.xml
  2. http://www.npr.org/rss/rss.php?id=1001
  3. 对于这些不同的RSS源,一个名为" guid"作为a)对象返回2个字段(如 BBC RSS Feed)或b)字符串(如 NPR RSS Feed)。

    以下是相关JSON的一些释义版本:

    BBC RSS Feed

    // is returning 'guid' as an object
    "item" : 
    [
        {
            // omitted other fields for brevity
            "guid" : {
                "isPermalink" : false,
                "content" : "http:\/\/www.bbc.co.uk\/news\/uk-england-33745057"
            },
        },
        {
            // ...
        }
    ]
    

    NPR RSS Feed

    // is returning 'guid' as a string
    "item" : 
    [
        {
          // omitted other fields for brevity
          "guid" : "http:\/\/www.npr.org\/sections\/thetwo-way\/2015\/07\/31\/428188125\/chimps-in-habeas-corpus-case-will-no-longer-be-used-for-research?utm_medium=RSS&utm_campaign=news"
        },
        {
          // ...
        }
    ]
    

    我在Java中用这样建模:

    // RSSFeedItem.java
    private Guid guid;
    
    // GUID.java
    private boolean isPermalink;
    private String content;
    

    所以在这种情况下,它可以完美地调用

    Gson gson = new Gson();
    RssFeed rssFeed = gson.fromJson(jsonData, RssFeed.class);
    

    用于 BBC RSS Feed,但在解析 NPR RSS Feed时会抛出异常。

    导致我得出以下类型错误结论的具体错误如下(当尝试反序列化 NPR RSS Feed时):

    Severe:    com.google.gson.JsonSyntaxException: java.lang.IllegalStateException:
               Expected BEGIN_OBJECT but was STRING at line 1 column 673 path
               $.rss.channel.item[0].guid
    

    所以,无论如何,要点:如何处理Gson的情况,哪个字段作为可能不同的数据类型返回?我猜测可能有某种类型的我可以使用技巧或注释,但我不确定,在检查了Gson的文档后,我找不到现成的答案。

4 个答案:

答案 0 :(得分:4)

我的回答是使用类层次结构。

abstract class Guid {
    private boolean isPermalink;
    private String content;
    // getters and setters omitted
}

class GuidObject extends Guid {} 
class GuidString extends Guid {}

class RssFeedItem {
    // super class to receive instances of sub classes
    private Guid guid; 
}

Guid注册反序列化器:

GsonBuilder builder = new GsonBuilder();
builder.registerTypeAdapter(Guid.class, new JsonDeserializer<Guid>() {
        @Override
        public Guid deserialize(JsonElement json, Type typeOfT, JsonDeserializationContext context) throws JsonParseException {
            // Dispatch based on the type of json
            if (json.isJsonObject()) {
                // If it's an object, it's essential we deserialize
                // into a sub class, otherwise we'll have an infinite loop
                return context.deserialize(json, GuidObject.class);
            } else if (json.isJsonPrimitive()) {
                // Primitive is easy, just set the most
                // meaningful field. We can also use GuidObject here
                // But better to keep it clear.
                Guid guid = new GuidString();
                guid.setContent(json.getAsString());
                return guid;
            }
            // Cannot parse, throw exception
            throw new JsonParseException("Expected Json Object or Primitive, was " + json + ".");
        }
    });

通过这种方式,您可以处理更复杂的JSON对象,并根据您喜欢的任何条件进行调度。

答案 1 :(得分:4)

您可以使用TypeAdapter。我们的想法是只在不同的情况(字符串或对象)之间进行选择,并委托实际的反序列化。

注册工厂:

public class RSSFeedItem {

    @JsonAdapter(GuidAdapterFactory.class)
    private Guid guid;
}

创建适配器:

public class GuidAdapterFactory implements TypeAdapterFactory {

    @Override
    public <T> TypeAdapter<T> create(Gson gson, TypeToken<T> type) {
        return (TypeAdapter<T>) new GuidAdapter(gson);
    }
}

决定如何处理guid:

public class GuidAdapter extends TypeAdapter<Guid> {

    private final Gson gson;

    public GuidAdapter(Gson gson) {
        this.gson = gson;
    }

    @Override
    public void write(JsonWriter jsonWriter, Guid guid) throws IOException {
        throw new RuntimeException("Not implemented");
    }

    @Override
    public Guid read(JsonReader jsonReader) throws IOException {
        switch (jsonReader.peek()) {
            case STRING:
                // only a String, create the object
                return new Guid(jsonReader.nextString(), true);

            case BEGIN_OBJECT:
                // full object, forward to Gson
                return gson.fromJson(jsonReader, Guid.class);

            default:
                throw new RuntimeException("Expected object or string, not " + jsonReader.peek());
        }
    }
}

一些评论:

  • 它才有效,因为适配器已注册属性。在委托实际反序列化时,全局注册会触发递归调用。

  • 只需要工厂,因为我们需要对Gson对象的引用,否则我们可以直接注册适配器类。

  • 我认为TypeAdapterDeserializer效率更高,因为它不需要构建JsonElement树,尽管在这种情况下差异可能微不足道。

答案 2 :(得分:3)

根据调用

将其设为Object Class而不是Other Class Type和Type cast
// RSSFeedItem.java
private Object guid;

答案 3 :(得分:2)

这是我的示例代码,希望您觉得有用

public <T> List<T> readData(InputStream inputStream, Class<T> clazz) throws Exception {        
            ArrayList<Object> arrayList = new ArrayList<>();            
            GsonBuilder gsonBuilder = new GsonBuilder();
            Gson gson = gsonBuilder.create();
            JsonReader jsonReader = new JsonReader(new InputStreamReader(inputStream, "UTF_8"));
            jsonReader.setLenient(true);
            JsonToken jsonToken = jsonReader.peek();
            switch (jsonToken) {
                case BEGIN_ARRAY:
                    jsonReader.beginArray();
                    while (jsonReader.hasNext()) {
                        arrayList.add(gson.fromJson(jsonReader, clazz));
                    }
                    jsonReader.endArray();
                    break;
                case BEGIN_OBJECT:
                    T data = clazz.cast(gson.fromJson(jsonReader, clazz));
                    arrayList.add(data);
                    break;
                case NUMBER:
                    Integer number = Integer.parseInt(jsonReader.nextString());
                    arrayList.add(number);
                    break;
                default:
                    jsonReader.close();
                    inputStream.close();
                    return Collections.emptyList();
            }
            jsonReader.close();
            inputStream.close();
            return (List<T>) arrayList;        
    }

parseRecursive中的另一个Streams.java(您可以通过Google搜索),如下所示:

private static JsonElement parseRecursive(JsonReader reader)
            throws IOException {
        switch (reader.peek()) {
        case STRING:
            return new JsonPrimitive(reader.nextString());
        case NUMBER:
            String number = reader.nextString();
            return new JsonPrimitive(JsonPrimitive.stringToNumber(number));
        case BOOLEAN:
            return new JsonPrimitive(reader.nextBoolean());
        case NULL:
            reader.nextNull();
            return JsonNull.createJsonNull();
        case BEGIN_ARRAY:
            JsonArray array = new JsonArray();
            reader.beginArray();
            while (reader.hasNext()) {
                array.add(parseRecursive(reader));
            }
            reader.endArray();
            return array;
        case BEGIN_OBJECT:
            JsonObject object = new JsonObject();
            reader.beginObject();
            while (reader.hasNext()) {
                object.add(reader.nextName(), parseRecursive(reader));
            }
            reader.endObject();
            return object;
        case END_DOCUMENT:
        case NAME:
        case END_OBJECT:
        case END_ARRAY:
        default:
            throw new IllegalArgumentException();
        }
    }

更新:您还可以参考parse(JsonReader reader)课程中的Streams(gson-2.3.1.jar)

喜欢这个

JsonElement jsonElement = Streams.parse(jsonReader);