使用Spring定义Mongo Schema验证

时间:2018-05-04 07:26:47

标签: java spring mongodb spring-boot spring-data-mongodb

我想在Mongo中使用带有JSON Schema验证器选项的<-strong>(https://docs.mongodb.com/manual/core/schema-validation/#json-schema)定义一个集合,我不想要JSR-303 Bean验证(这是不是有效答案Spring data mongoDb not null annotation like Spring data Jpa),而是在创建集合时定义使用 CollectionInfos()在JSON中显示的选项。

示例,如果我定义了一个Account模型类,那么:

public class Account {

@Id
private String id;

private String name;

private String surname;

@NotNull
private String username;
}

我希望该集合使用 db.getCollectionInfos(),json喜欢:

[
{
    "name" : "account",
    "type" : "collection",
    "options" : {
        "validator" : {
            "$jsonSchema" : {
                "bsonType" : "object",
                "required" : [ 
                    "username"
                ]
            }
        }
    },
    "info" : {
        "readOnly" : false,
        "uuid" : UUID("979cdc4b-d6f3-4aef-bc89-3eee812773a5")
    },
    "idIndex" : {
        "v" : 2,
        "key" : {
            "_id" : 1
        },
        "name" : "_id_",
        "ns" : "databaseName.account"
    }
}
]

该过程可能类似于 spring.jpa.hibernate.ddl-auto = create ,因为它定义了模式级别的规则,而不是类似于Bean验证器,它定义了应用程序中的规则水平。

1 个答案:

答案 0 :(得分:3)

Spring Data MongoDB从2.1版本开始支持JsonSchema。有关详细信息,请参见Reference Documentation。 您可以使用如下所示的构建器来定义模式。

MongoJsonSchema schema = MongoJsonSchema.builder()
    .required("username")
    .properties(JsonSchemaProperty.string("username"))
    .build();

template.createCollection("account", CollectionOptions.empty().schema(schema));

在编写JSON模式时,不支持从域类型创建。 但是,您可能想参加讨论DATAMONGO-1849和/或尝试PR#733的快照。

建议通过调用类似DomainType的东西将MongoJsonSchema变成MongoJsonSchema schema = schemaCreator.createSchemaFor(DomainType.class);

public class DomainType {

    private final String requiredCtorArg;
    private final @Nullable String nullableCtorArg;
    private String optionalArg;

    public DomainType(String requiredCtorArg, @Nullable String nullableCtorArg) {

        this.requiredCtorArg = requiredCtorArg;
        this.nullableCtorArg = nullableCtorArg;
    }

    // gettter / setter omitted 
}
{
    'type' : 'object',
    'required' : ['requiredCtorArg'],
    'properties' : {
        'requiredCtorArg' : { 'type' : 'string' },
        'nullableCtorArg' : { 'type' : 'string' },
        'optionalArg' : { 'type' : 'string' }
     }
}