关于mongodb子类多态问题的解决方案

2023年10月26日 685次阅读 来源: 杰克家的猫

问题

系统采用spring data+mongodb driver方式进行对象的保存，以及进行相关的序列化以及反序列化。

由于在业务系统设计过程中，需要根据业务不同保存不同的子类，然后展示时也要相应的展示。这就要求mongo在保存时保存完整的数据，并且反序列化时也要能映射到正常的类。

方案

fastjson的JSONType_seeAlso_cn

在fastjson-1.2.11版本中，@JSONType支持seeAlso配置，类似于JAXB中的XmlSeeAlso。

从用法上看基本能满足需求，相比jackson方案比较简洁，也支持隐藏类的展示。不过在序列化类的时候需要加上@type关键字注明类名或者别名。如果要改变关键字，可以使用setDefaultTypeKey来改变。

JavaBean Config

@JSONType(seeAlso={Dog.class, Cat.class})
public static class Animal {
}

@JSONType(typeName = "dog")
public static class Dog extends Animal {
    public String dogName;
}

@JSONType(typeName = "cat")
public static class Cat extends Animal {
    public String catName;
}

Usage

Dog dog = new Dog();
dog.dogName = "dog1001";

String text = JSON.toJSONString(dog, SerializerFeature.WriteClassName);
Assert.assertEquals("{\"@type\":\"dog\",\"dogName\":\"dog1001\"}", text);

jackson的XmlSeeAlso

Jackson可以轻松的将Java对象转换成json对象和xml文档，同样也可以将json、xml转换成Java对象。

可以通过配置多态类型处理，配置相对复杂一点，不过比较灵活。支持使用多种识别码以及识别码可以选择多种方式，包括兄弟属性，扩展属性以及已存在属性等，并且也支持隐藏类名，以及自定义每个类的识别码。

JavaBean Config

public class Car extends Vehicle {
    private int seatingCapacity;
    private double topSpeed;
 
    public Car(String make, String model, int seatingCapacity, double topSpeed) {
        super(make, model);
        this.seatingCapacity = seatingCapacity;
        this.topSpeed = topSpeed;
    }
 
    // no-arg constructor, getters and setters
}

@JsonTypeInfo(
  use = JsonTypeInfo.Id.NAME, 
  include = JsonTypeInfo.As.PROPERTY, 
  property = "type")
@JsonSubTypes({ 
  @Type(value = Car.class, name = "car"))
public abstract class Vehicle {
    // fields, constructors, getters and setters
}

Usage

  • use:定义使用哪一种类型识别码，它有下面几个可选值：
    1. JsonTypeInfo.Id.CLASS：使用完全限定类名做识别
    2. JsonTypeInfo.Id.MINIMAL_CLASS：若基类和子类在同一包类，使用类名(忽略包名)作为识别码
    3. JsonTypeInfo.Id.NAME：一个合乎逻辑的指定名称
    4. JsonTypeInfo.Id.CUSTOM：自定义识别码，由@JsonTypeIdResolver对应，稍后解释
    5. JsonTypeInfo.Id.NONE：不使用识别码
  • include(可选):指定识别码是如何被包含进去的，它有下面几个可选值：
    1. JsonTypeInfo.As.PROPERTY：作为数据的兄弟属性
    2. JsonTypeInfo.As.EXISTING_PROPERTY：作为POJO中已经存在的属性
    3. JsonTypeInfo.As.EXTERNAL_PROPERTY：作为扩展属性
    4. JsonTypeInfo.As.WRAPPER_OBJECT：作为一个包装的对象
    5. JsonTypeInfo.As.WRAPPER_ARRAY：作为一个包装的数组
      property(可选):制定识别码的属性名称
      此属性只有当use为JsonTypeInfo.Id.CLASS（若不指定property则默认为@class）、JsonTypeInfo.Id.MINIMAL_CLASS(若不指定property则默认为@c)、JsonTypeInfo.Id.NAME(若不指定property默认为@type)，include为JsonTypeInfo.As.PROPERTY、JsonTypeInfo.As.EXISTING_PROPERTY、JsonTypeInfo.As.EXTERNAL_PROPERTY时才有效
  • defaultImpl(可选)：如果类型识别码不存在或者无效，可以使用该属性来制定反序列化时使用的默认类型
  • visible(可选，默认为false)：是否可见
    属性定义了类型标识符的值是否会通过JSON流成为反序列化器的一部分，默认为fale,也就是说,jackson会从JSON内容中处理和删除类型标识符再传递给JsonDeserializer。

结果

通过对这两种方法的调研，都能满足在序列化以及反序列化时实现子类多态，并且不会有泄漏类名的风险。

发现在mongodb保存类时正常，但是当查询类的内容时，mongodb会直接使用定义的父类进行反序列化。后面通过对mongodb存储以及查询原理的调研发现，mongodb在存储时并不是采用json进行保存，而是采用了BSON这种格式。也就是拓展了JSON的相关信息。

JSON can only represent a subset of the types supported by BSON. To preserve type information, MongoDB adds the following extensions to the JSON format:

* Strict mode. Strict mode representations of BSON types conform to the JSON RFC. Any JSON parser can parse these strict mode representations as key/value pairs; however, only the MongoDB internal JSON parser recognizes the type information conveyed by the format.
* mongo Shell mode. The MongoDB internal JSON parser and the mongo shell can parse this mode.

而mongodb的driver在解析保存的信息时，也是使用的BSON的相关解析方案。于是想是否可以修改相关解析器来实现。发现mongodb在进行序列化以及凡序列化时使用MappingMongoConverter的行为进行定义。于是修改相关定义

@Override
    public MappingMongoConverter mappingMongoConverter() throws Exception {
        DbRefResolver dbRefResolver = new DefaultDbRefResolver(mongoDbFactory());
        ObjectMapper mapper = new ObjectMapper()
                .configure(FAIL_ON_UNKNOWN_PROPERTIES, false)
                .registerModule(new SimpleModule() {
                    {
                        addDeserializer(ObjectId.class, new JsonDeserializer<ObjectId>() {
                            @Override
                            public ObjectId deserialize(JsonParser p, DeserializationContext ctxt) throws IOException, JsonProcessingException {
                                TreeNode oid = p.readValueAsTree().get("$oid");
                                String string = oid.toString().replaceAll("\"", "");

                                return new ObjectId(string);
                            }
                        });
                    }
                });

        MappingMongoConverter converter = new MappingMongoConverter(dbRefResolver, mongoMappingContext()) {
            @Override
            public <S> S read(Class<S> clazz, DBObject dbo) {
                String string = JSON.serialize(dbo);
                try {
                    return mapper.readValue(string, clazz);
                } catch (IOException e) {
                    throw new RuntimeException(string, e);
                }
            }

            @Override
            public void write(Object obj, DBObject dbo) {
                String string = null;
                try {
                    string = mapper.writeValueAsString(obj);
                } catch (JsonProcessingException e) {
                    throw new RuntimeException(string, e);
                }
                dbo.putAll((DBObject) JSON.parse(string));
            }
        };

        return converter;
    }

然后修改driver相关的Converter，但是测试发现，获取到的bson数据会带有额外的元数据，导致类无法正常反序列化。后面通过查看文档发现，需要增加JsonWriterSettings来对元数据进行处理。

JsonWriterSettings settings = JsonWriterSettings.builder()
                .int64Converter((value, writer) -> writer.writeNumber(value.toString()))
                .objectIdConverter((value,write)->write.writeString(value.toString()))
                .dateTimeConverter((value, writer) -> writer.writeString(value.toString())
                .build();

然后进行相关测试，没发现什么问题。但是后面排查发现，系统还采用了mongoGridFSd的方案，Converter也是采用的此方案，但是bson在转换时，对于binary对象是没有数据展示的，于是修改相关Converter为原来的方案。至此问题解决。

    原文作者：杰克家的猫
    原文地址: https://www.jianshu.com/p/45455a802dd9
    本文转自网络文章，转载此文章仅为分享知识，如有侵权，请联系博主进行删除。
点赞