Gson自定义解析-如何让同一字段不同类型的结构解析成一个数据结构

引子

现在维护的一个项目，出现这样一个问题：接口是用php开发的，当有值的时候返回的data是一个键值对，当错误的时候data对应的值就变成了[]，[]在gson中只能解析成数组或者collection,因此数据可用Gson解析时就异常了。让改接口是不可能的，因为不仅仅是给这个客户端使用，很多第3方的也会用到同一接口。客户端怎么处理？如何让两个不同结构的数据解析成一个类型呢

registerTypeAdapter

Gson gson = new GsonBuilder()
            .registerTypeAdapter(A.class, new ATypeAdapter ())
            .registerTypeAdapter(B.class, new BTypeAdapter ())
            .create()

registerTypeAdapter的第2个参数可以是JsonSerializer， JsonDeserializer，InstanceCreator，TypeAdapter。

adapter实现序列化与反序列化的实现传入TypeAdapter，如下

Gson gson = new GsonBuilder().registerTypeAdapter(Foo.class,
     new TypeAdapter<Foo>() {
        public Foo read(JsonReader in) throws IOException {
         if (in.peek() == JsonToken.NULL) {//进行非空判断
           in.nextNull();
            return null;
          }
          //读取json串并封装成Foo对象返回之
        }
        /***
        * 该方法在gson.toJons(Obj)的时候会调用
        **/
        public void write(JsonWriter out, Foo src) throws IOException {
          if (src == null) {//进行非空判断
           out.nullValue();
           return;
          }
          //把Food对象制定成你自己定义的格式的字符串进行输出：不一定是json格式了，就看你怎么组织
     out.beginObject();
     out.name("name").value(src.name);
     ...
     out.endObject();
        }
      }).create();

我们反序列化只需要使用JsonDeserializer，序列化时使用JsonSerialize即可。鉴于我们的需求，只需实现JsonDeserializer，判断传入数据的类型即可。

public class CommandAdapter<T> implements JsonDeserializer<T>{

        @Override
        public T deserialize(JsonElement json, Type typeOfT, JsonDeserializationContext context) throws JsonParseException {
            if (json.isJsonObject()) {//判断类型正确，则按默认的返回
                return context.deserialize(json, new TypeToken<T>(){}.getType());
            }
            return null;
        }
    }

调用

Gson gson = new GsonBuilder().registerTypeAdapter(VersionModle.Version.class,new CommandAdapter<VersionModle.Version>()).create();
                    VersionModle modle = gson.fromJson(test, VersionModle.class);

类型说明

JsonElement

JsonPrimitive类进行了封装

JsonNull:

该类没什么可说的，为不可变类。当然在json中所有的JsonNullObject 调用equals方法判断的话都是相等的。

JsonArray:

Json的数组包含的其实也是一个个Json串。所以不难猜出JsonArray中用一个集合类源码中用List<JsonElement>来添加json数组中的每个元素。(详见源码，很简单)

JsonObject:

json对象类，包含了键值对，键是字符串类型，它的值是一个JsonElement。用 LinkedTreeMap<String, JsonElement> members来保存。

同理，我们来解决常见的解析问题，比如返回一组图片，如果只有一个，服务端则会返回一个图片实体，如果多个则是一个数组，我们就只需要判断是JsonArray则正常返回，是JsonObject则解析后封装成array再返回。

参考资料
Gson解析null替换为空字符串
 你如何让GSON忽略空或空对象并清空数组和列表
 Gson全解析（中）-TypeAdapter的使用

最后编辑于：2020.11.09 15:09:09