使用GSon将JSon转换为多个未知的Java对象类型

17

我有一个Netty解码器,使用GSon将来自Web客户端的JSon转换为适当的Java对象。

要求是:客户端可以发送不相关的类,如Class A、Class B、Class C等,但我想在管道中使用相的单例解码器实例进行转换(因为我使用Spring进行配置)。我面临的问题是需要预先知道class对象。

public Object decode()
{
    gson.fromJson(jsonString, A.class);
}

这不能解码B或C,现在我的库的用户需要为每个类编写单独的解码器,而不是后续转换。我能想到的唯一方法是从Web客户端传递类的字符串名称,例如“org.example.C”,在解码器中解析它,然后使用Class.forName获取类。有更好的方法吗?


2
如果这是一个通用组件,请考虑您希望用户如何配置它。合理的默认值也值得考虑。每个类是否都需要有多个解码器实例,这样做是否有意义? - Jukka
这是我目前的做法,每个类类型一个实例。问题在于,我的库的用户现在需要处理内部细节,如解码器和编码器,并在每次添加新类时在Spring中进行配置。我想让他们免受此类麻烦,而是进行简单的强制转换。 - Abe
4个回答

11
GSon必须知道匹配json字符串的类。如果您不想在fromJson()中提供它,实际上可以在Json中指定它。一种方法是定义一个接口并在其上绑定适配器。
例如:
  class A implements MyInterface {
    // ...
  }

  public Object decode()
  {
    Gson  gson = builder.registerTypeAdapter(MyInterface.class, new MyInterfaceAdapter());
    MyInterface a =  gson.fromJson(jsonString, MyInterface.class);
  }

适配器可以像这样:

public final class MYInterfaceAdapter implements JsonDeserializer<MyInterface>, JsonSerializer<MyInterface> {
  private static final String PROP_NAME = "myClass";

  @Override
  public MyInterface deserialize(JsonElement json, Type typeOfT, JsonDeserializationContext context) throws JsonParseException {
    try {
      String classPath = json.getAsJsonObject().getAsJsonPrimitive(PROP_NAME).getAsString();
      Class<MyInterface> cls = (Class<MyInterface>) Class.forName(classPath);

      return (MyInterface) context.deserialize(json, cls);
    } catch (ClassNotFoundException e) {
      e.printStackTrace();
    }

    return null;
  }

  @Override
  public JsonElement serialize(MyInterface src, Type typeOfSrc, JsonSerializationContext context) {
    // note : won't work, you must delegate this
    JsonObject jo = context.serialize(src).getAsJsonObject();

    String classPath = src.getClass().getName();
    jo.add(PROP_NAME, new JsonPrimitive(classPath));

    return jo;
  }
}

问题在于B类没有实现MyInterface接口。这些类之间没有逻辑联系。但是为了让这段代码正常工作,我可能需要让库的用户实现一个标记接口。 - Abe
所以我会选择一个 TypeAdapterFactory。主要的点是,JSon 必须提供实例化的类。GSon 并不神奇,它不能替你猜测 :) - PomPom
自1.7版本以来,GsonBuilder构建器具有registerTypeHierarchyAdapter方法,在这种情况下可能更合适。请参见讨论 - Vadzim
2
这是绝对错误的。Gson可以将任何有效的JSON反序列化为像这样的语法树:gson.fromJson(json, JsonElement.class)。您可以按照自己的意愿解释由JSON数组(列表)、JSON对象(映射)和JSON基元(数字、字符串、布尔值、null)组成的语法树。 - Miha_x64
1
不要使用这个解决方案。让攻击者自由选择对象类型会使您的应用程序容易受到各种反序列化攻击的威胁。根据所包含的库,可能会导致DoS、内存损坏或删除任意文件,以及可能发生更多的问题。例如,请参见https://www.contrastsecurity.com/security-influencers/serialization-must-die-act-1-kryo-serialization(即使是针对Kryo编写的,也适用于此处)。 - Marcono1234

5
假设您有以下两个可能的JSON响应:
{
  "classA": {"foo": "fooValue"}
}
  or
{
  "classB": {"bar": "barValue"}
}

您可以创建以下类结构:

您可以像这样创建一个类结构:

public class Response {
  private A classA;
  private B classB;
  //more possible responses...
  //getters and setters...
}

public class A {
  private String foo;
  //getters and setters...
}

public class B {
  private String bar;
  //getters and setters...
}

然后,您可以使用以下方法解析任何可能的JSON响应:

Response response = gson.fromJson(jsonString, Response.class);

Gson会忽略所有不对应于类结构中任何属性的JSON字段,因此您可以适应单个类来解析不同的响应...然后您可以检查哪些属性、,...不是,这样您就知道收到了哪个响应。

这是针对发布给用户的库 -> https://github.com/menacher/java-game-server,所以我不知道他们的类。因此,我无法填写响应类。 - Abe
1
@Abe,所以你需要解析一些JSON响应,但你完全不知道它们的样子?这真的是非常辛苦的工作! - MikO
实际上,客户端可以发送类名,因为他们知道自己在发送什么,所以这并不是一种无望的情况。 - Abe

4

不确定这是否是您所要求的,但通过修改RuntimeTypeAdapterFactory类,我创建了一个基于Json源中条件的子类系统。

RuntimeTypeAdapterFactory.class:

/*
 * Copyright (C) 2011 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.gson.typeadapters;

import java.io.IOException;
import java.util.LinkedHashMap;
import java.util.Map;

import com.google.gson.Gson;
import com.google.gson.JsonElement;
import com.google.gson.JsonObject;
import com.google.gson.JsonParseException;
import com.google.gson.JsonPrimitive;
import com.google.gson.TypeAdapter;
import com.google.gson.TypeAdapterFactory;
import com.google.gson.internal.Streams;
import com.google.gson.reflect.TypeToken;
import com.google.gson.stream.JsonReader;
import com.google.gson.stream.JsonWriter;

/**
 * Adapts values whose runtime type may differ from their declaration type. This
 * is necessary when a field's type is not the same type that GSON should create
 * when deserializing that field. For example, consider these types:
 * <pre>   {@code
 *   abstract class Shape {
 *     int x;
 *     int y;
 *   }
 *   class Circle extends Shape {
 *     int radius;
 *   }
 *   class Rectangle extends Shape {
 *     int width;
 *     int height;
 *   }
 *   class Diamond extends Shape {
 *     int width;
 *     int height;
 *   }
 *   class Drawing {
 *     Shape bottomShape;
 *     Shape topShape;
 *   }
 * }</pre>
 * <p>Without additional type information, the serialized JSON is ambiguous. Is
 * the bottom shape in this drawing a rectangle or a diamond? <pre>   {@code
 *   {
 *     "bottomShape": {
 *       "width": 10,
 *       "height": 5,
 *       "x": 0,
 *       "y": 0
 *     },
 *     "topShape": {
 *       "radius": 2,
 *       "x": 4,
 *       "y": 1
 *     }
 *   }}</pre>
 * This class addresses this problem by adding type information to the
 * serialized JSON and honoring that type information when the JSON is
 * deserialized: <pre>   {@code
 *   {
 *     "bottomShape": {
 *       "type": "Diamond",
 *       "width": 10,
 *       "height": 5,
 *       "x": 0,
 *       "y": 0
 *     },
 *     "topShape": {
 *       "type": "Circle",
 *       "radius": 2,
 *       "x": 4,
 *       "y": 1
 *     }
 *   }}</pre>
 * Both the type field name ({@code "type"}) and the type labels ({@code
 * "Rectangle"}) are configurable.
 *
 * <h3>Registering Types</h3>
 * Create a {@code RuntimeTypeAdapter} by passing the base type and type field
 * name to the {@link #of} factory method. If you don't supply an explicit type
 * field name, {@code "type"} will be used. <pre>   {@code
 *   RuntimeTypeAdapter<Shape> shapeAdapter
 *       = RuntimeTypeAdapter.of(Shape.class, "type");
 * }</pre>
 * Next register all of your subtypes. Every subtype must be explicitly
 * registered. This protects your application from injection attacks. If you
 * don't supply an explicit type label, the type's simple name will be used.
 * <pre>   {@code
 *   shapeAdapter.registerSubtype(Rectangle.class, "Rectangle");
 *   shapeAdapter.registerSubtype(Circle.class, "Circle");
 *   shapeAdapter.registerSubtype(Diamond.class, "Diamond");
 * }</pre>
 * Finally, register the type adapter in your application's GSON builder:
 * <pre>   {@code
 *   Gson gson = new GsonBuilder()
 *       .registerTypeAdapter(Shape.class, shapeAdapter)
 *       .create();
 * }</pre>
 * Like {@code GsonBuilder}, this API supports chaining: <pre>   {@code
 *   RuntimeTypeAdapter<Shape> shapeAdapter = RuntimeTypeAdapterFactory.of(Shape.class)
 *       .registerSubtype(Rectangle.class)
 *       .registerSubtype(Circle.class)
 *       .registerSubtype(Diamond.class);
 * }</pre>
 */
public final class RuntimeTypeAdapterFactory<T> implements TypeAdapterFactory {
    private final Class<?> baseType;
    private final RuntimeTypeAdapterPredicate predicate;
    private final Map<String, Class<?>> labelToSubtype = new LinkedHashMap<String, Class<?>>();
    private final Map<Class<?>, String> subtypeToLabel = new LinkedHashMap<Class<?>, String>();

    private RuntimeTypeAdapterFactory(Class<?> baseType, RuntimeTypeAdapterPredicate predicate) {
        if (predicate == null || baseType == null) {
            throw new NullPointerException();
        }
        this.baseType = baseType;
        this.predicate = predicate;
    }

    /**
     * Creates a new runtime type adapter using for {@code baseType} using {@code
     * typeFieldName} as the type field name. Type field names are case sensitive.
     */
    public static <T> RuntimeTypeAdapterFactory<T> of(Class<T> baseType, RuntimeTypeAdapterPredicate predicate) {
        return new RuntimeTypeAdapterFactory<T>(baseType, predicate);
    }

    /**
     * Creates a new runtime type adapter for {@code baseType} using {@code "type"} as
     * the type field name.
     */
    public static <T> RuntimeTypeAdapterFactory<T> of(Class<T> baseType) {
        return new RuntimeTypeAdapterFactory<T>(baseType, null);
    }

    /**
     * Registers {@code type} identified by {@code label}. Labels are case
     * sensitive.
     *
     * @throws IllegalArgumentException if either {@code type} or {@code label}
     *     have already been registered on this type adapter.
     */
    public RuntimeTypeAdapterFactory<T> registerSubtype(Class<? extends T> type, String label) {
        if (type == null || label == null) {
            throw new NullPointerException();
        }
        if (subtypeToLabel.containsKey(type) || labelToSubtype.containsKey(label)) {
            throw new IllegalArgumentException("types and labels must be unique");
        }
        labelToSubtype.put(label, type);
        subtypeToLabel.put(type, label);
        return this;
    }

    /**
     * Registers {@code type} identified by its {@link Class#getSimpleName simple
     * name}. Labels are case sensitive.
     *
     * @throws IllegalArgumentException if either {@code type} or its simple name
     *     have already been registered on this type adapter.
     */
    public RuntimeTypeAdapterFactory<T> registerSubtype(Class<? extends T> type) {
        return registerSubtype(type, type.getSimpleName());
    }

    public <R> TypeAdapter<R> create(Gson gson, TypeToken<R> type) {
        if (type.getRawType() != baseType) {
            return null;
        }

        final Map<String, TypeAdapter<?>> labelToDelegate
                = new LinkedHashMap<String, TypeAdapter<?>>();
        final Map<Class<?>, TypeAdapter<?>> subtypeToDelegate
                = new LinkedHashMap<Class<?>, TypeAdapter<?>>();
        for (Map.Entry<String, Class<?>> entry : labelToSubtype.entrySet()) {
            TypeAdapter<?> delegate = gson.getDelegateAdapter(this, TypeToken.get(entry.getValue()));
            labelToDelegate.put(entry.getKey(), delegate);
            subtypeToDelegate.put(entry.getValue(), delegate);
        }

        return new TypeAdapter<R>() {
            @Override public R read(JsonReader in) throws IOException {
                JsonElement jsonElement = Streams.parse(in);
                String label = predicate.process(jsonElement);
                @SuppressWarnings("unchecked") // registration requires that subtype extends T
                        TypeAdapter<R> delegate = (TypeAdapter<R>) labelToDelegate.get(label);
                if (delegate == null) {
                    throw new JsonParseException("cannot deserialize " + baseType + " subtype named "
                            + label + "; did you forget to register a subtype?");
                }
                return delegate.fromJsonTree(jsonElement);
            }

            @Override public void write(JsonWriter out, R value) throws IOException { // Unimplemented as we don't use write.
                /*Class<?> srcType = value.getClass();
                String label = subtypeToLabel.get(srcType);
                @SuppressWarnings("unchecked") // registration requires that subtype extends T
                        TypeAdapter<R> delegate = (TypeAdapter<R>) subtypeToDelegate.get(srcType);
                if (delegate == null) {
                    throw new JsonParseException("cannot serialize " + srcType.getName()
                            + "; did you forget to register a subtype?");
                }
                JsonObject jsonObject = delegate.toJsonTree(value).getAsJsonObject();
                if (jsonObject.has(typeFieldName)) {
                    throw new JsonParseException("cannot serialize " + srcType.getName()
                            + " because it already defines a field named " + typeFieldName);
                }
                JsonObject clone = new JsonObject();
                clone.add(typeFieldName, new JsonPrimitive(label));
                for (Map.Entry<String, JsonElement> e : jsonObject.entrySet()) {
                    clone.add(e.getKey(), e.getValue());
                }*/
                Streams.write(null, out);
            }
        };
    }
}

RuntimeTypeAdapterPredicate.class:

package com.google.gson.typeadapters;

import com.google.gson.JsonElement;

/**
 * Created by Johan on 2014-02-13.
 */
public abstract class RuntimeTypeAdapterPredicate {

    public abstract String process(JsonElement element);

}

示例(取自我目前正在开发的项目):

ItemTypePredicate.class:

package org.libpoe.serial;

import com.google.gson.JsonElement;
import com.google.gson.JsonObject;
import com.google.gson.typeadapters.RuntimeTypeAdapterPredicate;

/**
 * Created by Johan on 2014-02-13.
 */
public class ItemTypePredicate extends RuntimeTypeAdapterPredicate {

    @Override
    public String process(JsonElement element) {
        JsonObject obj = element.getAsJsonObject();
        int frameType = obj.get("frameType").getAsInt();

        switch(frameType) {
            case 4: return "Gem";
            case 5: return "Currency";
        }
        if (obj.get("typeLine").getAsString().contains("Map")
                && obj.get("descrText").getAsString() != null
                && obj.get("descrText").getAsString().contains("Travel to this Map")) {
            return "Map";
        }

        return "Equipment";
    }
}

使用方法:

RuntimeTypeAdapterFactory<Item> itemAdapter = RuntimeTypeAdapterFactory.of(Item.class, new ItemTypePredicate())
        .registerSubtype(Currency.class)
        .registerSubtype(Equipment.class)
        .registerSubtype(Gem.class)
        .registerSubtype(Map.class);

Gson gson = new GsonBuilder()
        .enableComplexMapKeySerialization()
        .registerTypeAdapterFactory(itemAdapter).create();

层次结构的基类是Item。货币、装备、宝石和地图都继承自这个基类。


这几乎是我想要的,但我的基本要求是识别不相关的类,我认为这是不可能的。 - Abe

1
创建模型类。
public class MyModel {

    private String errorId;

    public String getErrorId() {
        return errorId;
    }

    public void setErrorId(String errorId) {
        this.errorId = errorId;
    }
}

创建子类
   public class SubClass extends MyModel {
        private String subString;

       public String getSubString() {
            return subString;
        }

        public void setSubString(String subString) {
            this.subString = subString;
        }
 }

调用解析Gson的方法

parseGson(subClass);

使用对象类的gson解析方法

   public void parseGson(Object object){
     object = gson.fromJson(response.toString(), object.getClass());
     SubClass subclass = (SubClass)object;
   }

您可以设置全局变量,将其转换为myModel。
((MyModel)object).setErrorId(response.getString("errorid"));

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接