[发明专利]一种根据TypeScript类型生成Mongoose模型的方法

说明书

本发明公开了一种根据TypeScript类型生成Mongoose模型的方法，涉及生成Mongoose模型技术领域，具体为一种根据TypeScript类型生成Mongoose模型的方法，包括以下步骤：步骤一：开启TypeScript的类型信息输出，有两种方法均可等价；步骤二：给数据库模型类的不同条件，加上不同修饰器；步骤三：若有跨字段索引，则给数据库模型类加上@index()修饰器步骤四：若有第三方插件需要引入，则给数据库模型类加上@plugin()修饰器；步骤五：使用getSchema方法，传入数据库模型类，得到Mongoose的约束模型；步骤六：使用getModel方法，传入数据库模型类，得到有类型约束的Mongoose的数据库模型实例。本发明收集TypeScript的类型信息，自动生成Mongoose所需要的类型模型信息，并且可以使用简化的修饰器，设置类型模型的属性和索引信息。

技术领域

本发明涉及生成Mongoose模型技术领域，具体为一种根据TypeScript类型生成Mongoose模型的方法。

背景技术

TypeScript类型信息可以提供强类型语言的类型推断，可以在代码编译时检查类型约束产生的错误，降低代码书写时产生的错误。Mongoose是一种MongoDB的ODM(ObjectDocumentMapper，对象文档映射器)由于MongoDB本身是不提供类型约束的，即Collection(集合)内可以存储任意类型的Document(文档)，Mongoose在此基础上实现了一套类型模型，以提供数据校验和类型约束。但是两者之间的数据尽管在逻辑上是相通的，但是在实际上并不互相兼容。

发明内容

针对现有技术的不足，本发明提供了一种根据TypeScript类型生成Mongoose模型的方法，解决了上述背景技术中提出TypeScript和Mongoose两者之间的数据尽管在逻辑上是相通的，但是在实际上并不互相兼容的问题。

为实现以上目的，本发明通过以下技术方案予以实现：一种根据TypeScript类型生成Mongoose模型的方法，包括以下步骤：

步骤一：开启TypeScript的类型信息输出，有两种方法均可等价；

步骤二：给数据库模型类的不同条件，加上不同修饰器；

步骤三：若有跨字段索引，则给数据库模型类加上@index()修饰器

步骤四：若有第三方插件需要引入，则给数据库模型类加上@plugin()修饰器；

步骤五：使用getSchema方法，传入数据库模型类，得到Mongoose的约束模型；

步骤六：使用getModel方法，传入数据库模型类，得到有类型约束的Mongoose的数据库模型实例；

步骤七：使用上步得到的数据库模型实例进行增删改查操作，可以同时得到类型提示以及数据库类型约束。

可选的，所述步骤一中的两种方法分别为：在编译时传递—emitDecoratorMetadata，以及修改tsconfig.json文件，设置compilerOptions.emitDecoratorMetadata为true。

可选的，所述步骤二中，进一步地，包括以下内容：对数据模型类加上@model()修饰器；给数据库模型类的_id字段，加上@id()修饰器；给数据库模型类的各个属性字段，加上@prop()修饰器。

可选的，所述步骤二中，进一步地，包括以下内容：给数据库模型类的各个数组字段，加上@array()修饰器；给数据库模型类必填字段，加上@required()修饰器；给数据库模型类需要索引的字段，加上@indexed()修饰器。