Mongo

    Nest 支持两种方法与 MongoDB 数据库集成。您可以使用这里描述的内置 TypeORM 模块（它有一个 MongoDB 连接器），或者使用 Mongoose，最流行的 MongoDB 对象建模工具。在本章中，我们将描述后者，使用专用的 @nestjs/mongoose 包。

    首先安装所需依赖：

    $ npm i @nestjs/mongoose mongoose

    安装过程完成后，我们可以将 MongooseModule 导入到根 AppModule 中。

    import { Module } from '@nestjs/common';
import { MongooseModule } from '@nestjs/mongoose';

@Module({
  imports: [MongooseModule.forRoot('mongodb://localhost/nest')],
})
export class AppModule {}

    forRoot() 方法接受与 Mongoose 包中的 mongoose.connect() 相同的配置对象，如这里所述。

    模型注入

    使用 Mongoose，一切都派生自 Schema。每个模式映射到一个 MongoDB 集合，并定义该集合中文档的形状。模式用于定义 Models。模型负责从底层 MongoDB 数据库创建和读取文档。

    模式可以使用 NestJS 装饰器创建，也可以使用 Mongoose 手动创建。使用装饰器创建模式大大减少了样板代码并提高了整体代码可读性。

    让我们定义 CatSchema：

    import { Prop, Schema, SchemaFactory } from '@nestjs/mongoose';
import { HydratedDocument } from 'mongoose';

export type CatDocument = HydratedDocument<Cat>;

@Schema()
export class Cat {
  @Prop()
  name: string;

  @Prop()
  age: number;

  @Prop()
  breed: string;
}

export const CatSchema = SchemaFactory.createForClass(Cat);
    提示

    注意，您还可以使用 DefinitionsFactory 类（来自 nestjs/mongoose）生成原始模式定义。这允许您手动修改基于您提供的元数据生成的模式定义。这对于某些可能难以用装饰器表示所有内容的边缘情况很有用。

    @Schema() 装饰器将类标记为模式定义。它将我们的 Cat 类映射到同名的 MongoDB 集合，但末尾附加一个 "s" - 因此最终的 mongo 集合名称将是 cats。此装饰器接受一个可选参数，即模式选项对象。将其视为您通常作为 mongoose.Schema 类构造函数的第二个参数传递的对象（例如 new mongoose.Schema(_, options)）。要了解有关可用模式选项的更多信息，请参阅此章节。

    @Prop() 装饰器定义文档中的属性。例如，在上面的模式定义中，我们定义了三个属性：name、age 和 breed。这些属性的模式类型通过 TypeScript 元数据（和反射）功能自动推断。然而，在更复杂的场景中，类型不能隐式反射（例如，数组或嵌套对象结构），必须显式指示类型，如下所示：

    @Prop([String])
tags: string[];

    或者，@Prop() 装饰器接受一个选项对象参数（了解更多关于可用选项）。通过这种方式，您可以指示属性是否是必需的，指定默认值，或将其标记为不可变。例如：

    @Prop({ required: true })
name: string;

    如果您想指定与另一个模型的关系，以便稍后填充，您也可以使用 @Prop() 装饰器。例如，如果 Cat 有 Owner，存储在名为 owners 的不同集合中，则该属性应具有类型和引用。例如：

    import * as mongoose from 'mongoose';
import { Owner } from '../owners/schemas/owner.schema';

// 在类定义内部
@Prop({ type: mongoose.Schema.Types.ObjectId, ref: 'Owner' })
owner: Owner;

    如果有多个所有者，您的属性配置应该如下所示：

    @Prop({ type: [{ type: mongoose.Schema.Types.ObjectId, ref: 'Owner' }] })
owners: Owner[];

    如果您不打算始终填充对另一个集合的引用，考虑使用 mongoose.Types.ObjectId 作为类型：

    @Prop({ type: { type: mongoose.Schema.Types.ObjectId, ref: 'Owner' } })
// 这确保字段不会与填充的引用混淆
owner: mongoose.Types.ObjectId;

    然后，当您稍后需要选择性地填充它时，您可以使用指定正确类型的存储库函数：

    import { Owner } from './schemas/owner.schema';

// 例如，在服务或存储库内部
async findAllPopulated() {
  return this.catModel.find().populate<{ owner: Owner }>("owner");
}
    提示

    如果没有要填充的外部文档，类型可能是 Owner | null，具体取决于您的 Mongoose 配置。或者，它可能会抛出错误，在这种情况下类型将是 Owner。

    最后，原始模式定义也可以传递给装饰器。这在例如属性表示未定义为类的嵌套对象时很有用。为此，使用 @nestjs/mongoose 包中的 raw() 函数，如下所示：

    @Prop(raw({
  firstName: { type: String },
  lastName: { type: String }
}))
details: Record<string, any>;

    或者，如果您不喜欢使用装饰器，您可以手动定义模式。例如：

    export const CatSchema = new mongoose.Schema({
  name: String,
  age: Number,
  breed: String,
});

    cat.schema 文件位于 cats 目录中的一个文件夹中，我们还在其中定义了 CatsModule。虽然您可以将模式文件存储在任何您喜欢的地方，但我们建议将它们存储在其相关域对象附近，在适当的模块目录中。

    让我们看看 CatsModule：

    import { Module } from '@nestjs/common';
import { MongooseModule } from '@nestjs/mongoose';
import { CatsController } from './cats.controller';
import { CatsService } from './cats.service';
import { Cat, CatSchema } from './schemas/cat.schema';

@Module({
  imports: [MongooseModule.forFeature([{ name: Cat.name, schema: CatSchema }])],
  controllers: [CatsController],
  providers: [CatsService],
})
export class CatsModule {}

    MongooseModule 提供 forFeature() 方法来配置模块，包括定义哪些模型应该在当前作用域中注册。如果您还想在另一个模块中使用这些模型，请将 MongooseModule 添加到 CatsModule 的 exports 部分，并在另一个模块中导入 CatsModule。

    注册模式后，您可以使用 @InjectModel() 装饰器将 Cat 模型注入到 CatsService 中：

    import { Model } from 'mongoose';
import { Injectable } from '@nestjs/common';
import { InjectModel } from '@nestjs/mongoose';
import { Cat } from './schemas/cat.schema';
import { CreateCatDto } from './dto/create-cat.dto';

@Injectable()
export class CatsService {
  constructor(@InjectModel(Cat.name) private catModel: Model<Cat>) {}

  async create(createCatDto: CreateCatDto): Promise<Cat> {
    const createdCat = new this.catModel(createCatDto);
    return createdCat.save();
  }

  async findAll(): Promise<Cat[]> {
    return this.catModel.find().exec();
  }
}

    连接

    有时您可能需要访问原生 Mongoose Connection 对象。例如，您可能希望在连接对象上进行原生 API 调用。您可以使用 @InjectConnection() 装饰器注入 Mongoose Connection，如下所示：

    import { Injectable } from '@nestjs/common';
import { InjectConnection } from '@nestjs/mongoose';
import { Connection } from 'mongoose';

@Injectable()
export class CatsService {
  constructor(@InjectConnection() private connection: Connection) {}
}

    会话

    要使用 Mongoose 启动会话，建议使用 @InjectConnection 注入数据库连接，而不是直接调用 mongoose.startSession()。这种方法可以更好地集成 NestJS 依赖注入系统，确保正确的连接管理。

    以下是如何启动会话的示例：

    import { InjectConnection } from '@nestjs/mongoose';
import { Connection } from 'mongoose';

@Injectable()
export class CatsService {
  constructor(@InjectConnection() private readonly connection: Connection) {}

  async startTransaction() {
    const session = await this.connection.startSession();
    session.startTransaction();
    // 此处是您的事务逻辑
  }
}

    在此示例中，@InjectConnection() 用于将 Mongoose 连接注入到服务中。注入连接后，您可以使用 connection.startSession() 开始新会话。此会话可用于管理数据库事务，确保跨多个查询的原子操作。启动会话后，记得根据您的逻辑提交或中止事务。

    多个数据库

    一些项目需要多个数据库连接。这也可以通过此模块实现。要使用多个连接，首先创建连接。在这种情况下，连接命名变得强制性。

    import { Module } from '@nestjs/common';
import { MongooseModule } from '@nestjs/mongoose';

@Module({
  imports: [
    MongooseModule.forRoot('mongodb://localhost/test', {
      connectionName: 'cats',
    }),
    MongooseModule.forRoot('mongodb://localhost/users', {
      connectionName: 'users',
    }),
  ],
})
export class AppModule {}
    注意

    请注意，您不应该有多个没有名称或具有相同名称的连接，否则它们将被覆盖。

    通过此设置，您必须告诉 MongooseModule.forFeature() 函数应该使用哪个连接。

    @Module({
  imports: [
    MongooseModule.forFeature([{ name: Cat.name, schema: CatSchema }], 'cats'),
  ],
})
export class CatsModule {}

    您还可以注入给定连接的 Connection：

    import { Injectable } from '@nestjs/common';
import { InjectConnection } from '@nestjs/mongoose';
import { Connection } from 'mongoose';

@Injectable()
export class CatsService {
  constructor(@InjectConnection('cats') private connection: Connection) {}
}

    要将给定的 Connection 注入到自定义提供者（例如，工厂提供者），使用 getConnectionToken() 函数，传递连接名称作为参数。

    {
  provide: CatsService,
  useFactory: (catsConnection: Connection) => {
    return new CatsService(catsConnection);
  },
  inject: [getConnectionToken('cats')],
}

    如果您只是想从命名数据库注入模型，您可以使用连接名称作为 @InjectModel() 装饰器的第二个参数。

    @Injectable()
export class CatsService {
  constructor(@InjectModel(Cat.name, 'cats') private catModel: Model<Cat>) {}
}

    钩子（中间件）

    中间件（也称为 pre 和 post 钩子）是在执行异步函数期间传递控制的函数。中间件在模式级别指定，对于编写插件很有用（来源）。在编译模型后调用 pre() 或 post() 在 Mongoose 中不起作用。要在模型注册之前注册钩子，请使用 MongooseModule 的 forFeatureAsync() 方法以及工厂提供者（即 useFactory）。通过这种技术，您可以访问模式对象，然后使用 pre() 或 post() 方法在该模式上注册钩子。见下面的例子：

    @Module({
  imports: [
    MongooseModule.forFeatureAsync([
      {
        name: Cat.name,
        useFactory: () => {
          const schema = CatsSchema;
          schema.pre('save', function () {
            console.log('Hello from pre save');
          });
          return schema;
        },
      },
    ]),
  ],
})
export class AppModule {}

    与其他工厂提供者一样，我们的工厂函数可以是 async 并且可以通过 inject 注入依赖项。

    @Module({
  imports: [
    MongooseModule.forFeatureAsync([
      {
        name: Cat.name,
        imports: [ConfigModule],
        useFactory: (configService: ConfigService) => {
          const schema = CatsSchema;
          schema.pre('save', function() {
            console.log(
              `${configService.get('APP_NAME')}: Hello from pre save`,
            ),
          });
          return schema;
        },
        inject: [ConfigService],
      },
    ]),
  ],
})
export class AppModule {}

    插件

    要为给定模式注册插件，使用 forFeatureAsync() 方法。

    @Module({
  imports: [
    MongooseModule.forFeatureAsync([
      {
        name: Cat.name,
        useFactory: () => {
          const schema = CatsSchema;
          schema.plugin(require('mongoose-autopopulate'));
          return schema;
        },
      },
    ]),
  ],
})
export class AppModule {}

    要一次为所有模式注册插件，请调用 Connection 对象的 .plugin() 方法。您应该在创建模型之前访问连接；为此，使用 connectionFactory：

    import { Module } from '@nestjs/common';
import { MongooseModule } from '@nestjs/mongoose';

@Module({
  imports: [
    MongooseModule.forRoot('mongodb://localhost/test', {
      connectionFactory: (connection) => {
        connection.plugin(require('mongoose-autopopulate'));
        return connection;
      }
    }),
  ],
})
export class AppModule {}

    鉴别器

    鉴别器是一种模式继承机制。它们使您能够在同一个底层 MongoDB 集合上拥有多个具有重叠模式的模型。

    假设您想在单个集合中跟踪不同类型的事件。每个事件都会有一个时间戳。

    @Schema({ discriminatorKey: 'kind' })
export class Event {
  @Prop({
    type: String,
    required: true,
    enum: [ClickedLinkEvent.name, SignUpEvent.name],
  })
  kind: string;

  @Prop({ type: Date, required: true })
  time: Date;
}

export const EventSchema = SchemaFactory.createForClass(Event);
    提示

    Mongoose 区分不同鉴别器模型的方式是通过 "鉴别器键"，默认为 __t。Mongoose 向您的模式添加一个名为 __t 的 String 路径，用于跟踪此文档是哪个鉴别器的实例。 您也可以使用 discriminatorKey 选项来定义用于鉴别的路径。

    SignedUpEvent 和 ClickedLinkEvent 实例将存储在与通用事件相同的集合中。

    现在，让我们定义 ClickedLinkEvent 类，如下所示：

    @Schema()
export class ClickedLinkEvent {
  kind: string;
  time: Date;

  @Prop({ type: String, required: true })
  url: string;
}

export const ClickedLinkEventSchema = SchemaFactory.createForClass(ClickedLinkEvent);

    和 SignUpEvent 类：

    @Schema()
export class SignUpEvent {
  kind: string;
  time: Date;

  @Prop({ type: String, required: true })
  user: string;
}

export const SignUpEventSchema = SchemaFactory.createForClass(SignUpEvent);

    有了这个，使用 discriminators 选项为给定模式注册鉴别器。它适用于 MongooseModule.forFeature 和 MongooseModule.forFeatureAsync：

    import { Module } from '@nestjs/common';
import { MongooseModule } from '@nestjs/mongoose';

@Module({
  imports: [
    MongooseModule.forFeature([
      {
        name: Event.name,
        schema: EventSchema,
        discriminators: [
          { name: ClickedLinkEvent.name, schema: ClickedLinkEventSchema },
          { name: SignUpEvent.name, schema: SignUpEventSchema },
        ],
      },
    ]),
  ]
})
export class EventsModule {}

    测试

    在对应用程序进行单元测试时，我们通常希望避免任何数据库连接，使我们的测试套件更易于设置和执行速度更快。但是我们的类可能依赖于从连接实例中提取的模型。我们如何解析这些类？解决方案是创建模拟模型。

    为了使这更容易，@nestjs/mongoose 包公开了一个 getModelToken() 函数，该函数基于令牌名称返回准备好的注入令牌。使用此令牌，您可以使用任何标准自定义提供者技术轻松提供模拟实现，包括 useClass、useValue 和 useFactory。例如：

    @Module({
  providers: [
    CatsService,
    {
      provide: getModelToken(Cat.name),
      useValue: catModel,
    },
  ],
})
export class CatsModule {}

    在此示例中，每当任何消费者使用 @InjectModel() 装饰器注入 Model<Cat> 时，都会提供硬编码的 catModel（对象实例）。

    异步配置

    当您需要异步传递模块选项而不是静态传递时，使用 forRootAsync() 方法。与大多数动态模块一样，Nest 提供了几种处理异步配置的技术。

    一种技术是使用工厂函数：

    MongooseModule.forRootAsync({
  useFactory: () => ({
    uri: 'mongodb://localhost/nest',
  }),
});

    与其他工厂提供者一样，我们的工厂函数可以是 async 并且可以通过 inject 注入依赖项。

    MongooseModule.forRootAsync({
  imports: [ConfigModule],
  useFactory: async (configService: ConfigService) => ({
    uri: configService.get<string>('MONGODB_URI'),
  }),
  inject: [ConfigService],
});

    或者，您可以使用类而不是工厂来配置 MongooseModule，如下所示：

    MongooseModule.forRootAsync({
  useClass: MongooseConfigService,
});

    上面的构造在 MongooseModule 内部实例化 MongooseConfigService，使用它来创建所需的选项对象。请注意，在此示例中，MongooseConfigService 必须实现 MongooseOptionsFactory 接口，如下所示。MongooseModule 将在提供的类的实例化对象上调用 createMongooseOptions() 方法。

    @Injectable()
export class MongooseConfigService implements MongooseOptionsFactory {
  createMongooseOptions(): MongooseModuleOptions {
    return {
      uri: 'mongodb://localhost/nest',
    };
  }
}

    如果您想重用现有的选项提供者，而不是在 MongooseModule 内部创建私有副本，请使用 useExisting 语法。

    MongooseModule.forRootAsync({
  imports: [ConfigModule],
  useExisting: ConfigService,
});

    连接事件

    您可以通过使用 onConnectionCreate 配置选项来监听 Mongoose 连接事件。这允许您在建立连接时实现自定义逻辑。例如，您可以为 connected、open、disconnected、reconnected 和 disconnecting 事件注册事件监听器，如下所示：

    MongooseModule.forRoot('mongodb://localhost/test', {
  onConnectionCreate: (connection: Connection) => {
    connection.on('connected', () => console.log('connected'));
    connection.on('open', () => console.log('open'));
    connection.on('disconnected', () => console.log('disconnected'));
    connection.on('reconnected', () => console.log('reconnected'));
    connection.on('disconnecting', () => console.log('disconnecting'));

    return connection;
  },
}),

    在此代码片段中，我们正在建立与 mongodb://localhost/test 处的 MongoDB 数据库的连接。onConnectionCreate 选项使您能够设置特定的事件监听器来监控连接的状态：

    • connected：当连接成功建立时触发。
    • open：当连接完全打开并准备好操作时触发。
    • disconnected：当连接丢失时调用。
    • reconnected：当连接在断开后重新建立时调用。
    • disconnecting：当连接正在关闭过程中时发生。

    您还可以将 onConnectionCreate 属性合并到使用 MongooseModule.forRootAsync() 创建的异步配置中：

    MongooseModule.forRootAsync({
  useFactory: () => ({
    uri: 'mongodb://localhost/test',
    onConnectionCreate: (connection: Connection) => {
      // 在此处注册事件监听器
      return connection;
    },
  }),
}),

    这提供了一种灵活的方式来管理连接事件，使您能够有效地处理连接状态的变化。

    子文档

    要在父文档中嵌套子文档，您可以如下定义您的模式：

    @Schema()
export class Name {
  @Prop()
  firstName: string;

  @Prop()
  lastName: string;
}

export const NameSchema = SchemaFactory.createForClass(Name);

    然后在父模式中引用子文档：

    @Schema()
export class Person {
  @Prop(NameSchema)
  name: Name;
}

export const PersonSchema = SchemaFactory.createForClass(Person);

export type PersonDocumentOverride = {
  name: Types.Subdocument<Types.ObjectId> & Name;
};

export type PersonDocument = HydratedDocument<Person, PersonDocumentOverride>;

    如果您想包含多个子文档，您可以使用子文档数组。相应地覆盖属性的类型很重要：

    @Schema()
export class Person {
  @Prop([NameSchema])
  name: Name[];
}

export const PersonSchema = SchemaFactory.createForClass(Person);

export type PersonDocumentOverride = {
  name: Types.DocumentArray<Name>;
};

export type PersonDocument = HydratedDocument<Person, PersonDocumentOverride>;

    虚拟属性

    在 Mongoose 中，虚拟是存在于文档上但不会持久化到 MongoDB 的属性。它不会存储在数据库中，而是在每次访问时动态计算。虚拟通常用于派生或计算值，例如组合字段（例如，通过连接 firstName 和 lastName 创建 fullName 属性），或用于创建依赖于文档中现有数据的属性。

    class Person {
  @Prop()
  firstName: string;

  @Prop()
  lastName: string;

  @Virtual({
    get: function (this: Person) {
      return `${this.firstName} ${this.lastName}`;
    },
  })
  fullName: string;
}
    提示

    @Virtual() 装饰器从 @nestjs/mongoose 包导入。

    在此示例中，fullName 虚拟派生自 firstName 和 lastName。即使它在访问时表现得像一个普通属性，它也永远不会保存到 MongoDB 文档中。

    示例

    可用的工作示例在这里。