Genson多态/通用序列化

时间:2015-11-06 13:32:30

标签: java json serialization json-deserialization genson

我正在尝试使用Genson 1.3在Java中实现JSON序列化以获取多态类型,包括:

  • NumberŠ
  • 阵列
  • Enum班级

下面的SSCCE大致展示了我想要实现的目标:

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

import com.owlike.genson.Genson;
import com.owlike.genson.GensonBuilder;

/**
 * A Short, Self Contained, Compilable, Example for polymorphic serialization
 * and deserialization.
 */
public class GensonPolymoprhicRoundTrip {

    // our example enum
    public static enum RainState {
        NO_RAIN,
        LIGHT_RAIN,
        MODERATE_RAIN,
        HEAVY_RAIN,
        LIGHT_SNOW,
        MODERATE_SNOW,
        HEAVY_SNOW;
    }

    public static class Measurement<T> {
        public T value;
        public int qualityValue;
        public String source;

        public Measurement() {
        }
        public Measurement(T value, int qualityValue, String source) {
            this.value = value;
            this.qualityValue = qualityValue;
            this.source = source;
        }
    }

    public static class DTO {
        public List<Measurement<?>> measurements;

        public DTO(List<Measurement<?>> measurements) {
            this.measurements = measurements;
        }
    }

    public static void main(String... args) {
        Genson genson = new GensonBuilder()
        .useIndentation(true)
        .useRuntimeType(true)
        .useClassMetadataWithStaticType(false)
        .addAlias("RainState", RainState.class)
        .useClassMetadata(true)
        .create();

        DTO dto = new DTO(
                new ArrayList(Arrays.asList(
                        new Measurement<Double>(15.5, 8500, "TEMP_SENSOR"),
                        new Measurement<double[]>(new double[] {
                                2.5,
                                1.5,
                                2.0
                        }, 8500, "WIND_SPEED"),
                        new Measurement<RainState>(RainState.LIGHT_RAIN, 8500, "RAIN_SENSOR")
                        )));
        String json = genson.serialize(dto);
        System.out.println(json);
        DTO deserialized = genson.deserialize(json, DTO.class);
    }
}

Numbers和Arrays开箱即用,但是enum类提供了一些挑战。在这种情况下,序列化的JSON表单必须是IMO JSON对象,包括:

  • 类型成员
  • value member

查看EnumConverter课程,我发现我需要提供自定义Converter。但是,我无法完全掌握如何正确注册Converter,以便在反序列化期间调用它。如何使用Genson解决这个序列化?

1 个答案:

答案 0 :(得分:1)

非常适合提供完整的示例!

第一个问题是DTO没有没有arg构造函数,但Genson甚至支持具有参数的构造函数的类。您只需通过构建器使用'useConstructorWithArguments(true)'启用它。

然而,这不能解决完整的问题。目前,Genson仅对序列化为json对象的类型具有完全多态支持。因为Genson会在其中添加一个名为“@class”的属性。对此有一个open issue

对大多数情况应该适用的最佳解决方案可能是定义一个自动包装json对象中所有值的转换器,因此处理类元数据的转换器将能够生成它。这可以是一个“足够好”的解决方案,同时等待Genson正式支持。

首先定义包装转换器

public static class LiteralAsObjectConverter<T> implements Converter<T> {
    private final Converter<T> concreteConverter;

    public LiteralAsObjectConverter(Converter<T> concreteConverter) {
        this.concreteConverter = concreteConverter;
    }

    @Override
    public void serialize(T object, ObjectWriter writer, Context ctx) throws Exception {
        writer.beginObject().writeName("value");
        concreteConverter.serialize(object, writer, ctx);
        writer.endObject();
    }

    @Override
    public T deserialize(ObjectReader reader, Context ctx) throws Exception {
        reader.beginObject();
        T instance = null;
        while (reader.hasNext()) {
            reader.next();
            if (reader.name().equals("value")) instance = concreteConverter.deserialize(reader, ctx);
            else throw new IllegalStateException(String.format("Encountered unexpected property named '%s'", reader.name()));
        }
        reader.endObject();
        return instance;
    }
}

然后你需要用ChainedFactory注册它,它允许你委托默认转换器(这样它可以自动与任何其他类型一起使用)。

Genson genson = new GensonBuilder()
            .useIndentation(true)
            .useConstructorWithArguments(true)
            .useRuntimeType(true)
            .addAlias("RainState", RainState.class)
            .useClassMetadata(true)
            .withConverterFactory(new ChainedFactory() {
                @Override
                protected Converter<?> create(Type type, Genson genson, Converter<?> nextConverter) {
                    if (Wrapper.toAnnotatedElement(nextConverter).isAnnotationPresent(HandleClassMetadata.class)) {
                      return new LiteralAsObjectConverter(nextConverter);
                    } else {
                      return nextConverter;
                    }
                }
            }).create();

这个解决方案的缺点是 useClassMetadataWithStaticType需要设置为true ...但我认为它是可接受的,因为它是一个优化并且可以修复但是会暗示Gensons代码中的一些更改,其余的仍然有效。

如果您对这个问题感兴趣,那么您试图尝试解决该问题并打开PR来提供此功能作为Genson的一部分将会非常棒。