logologo
文档仓库
文档仓库
logologo
开始

概述

第一步
控制器
提供者
模块
中间件
异常过滤器
管道
守卫
拦截器
自定义装饰器

基础

自定义提供程序
异步提供者
动态模块
注入作用域
循环依赖
模块引用
懒加载模块
执行上下文
生命周期事件
发现服务
平台无关
单元测试

技术

配置
SQL
Mongo
验证
缓存
序列化
版本控制
任务调度
队列
日志
Cookies
事件
压缩
文件上传
文件流
HTTP 模块
Session
MVC
性能(Fastify)
SSE

安全

认证
授权
加密与哈希
Helmet
CORS
CSRF
速率限制

GraphQL

快速开始
解析器
变更
订阅
标量
指令
接口
联合与枚举
字段中间件
类型映射
插件
复杂度
扩展
CLI 插件
生成SDL
共享模型
其他功能
联邦

WebSocket

网关
异常过滤器
管道
守卫
拦截器
适配器

微服务

基础
Redis
MQTT
NATS
RabbitMQ
Kafka
gRPC
自定义传输
异常过滤器
管道
守卫
拦截器
部署
独立应用程序

CLI

概述
工作区
库
用法
脚本

OpenAPI

介绍
装饰器
类型映射
操作
其他特性
安全
类型与参数
CLI 插件

实用示例

REPL
CRUD生成器
SWC
Passport(认证)
热重载
MikroORM
TypeORM
Mongoose
Sequelize
路由模块
Swagger
健康检查
CQRS
Compodoc
Prisma
Sentry
静态资源
Commander
异步本地存储
Necord
套件(原Automock)

常见问题

Serverless
HTTP 适配器
长连接
全局前缀
原始请求体
混合应用
HTTPS & 多服务器
请求生命周期
错误

开发工具

概述
CI/CD
迁移指南
API参考(官方)

生态与案例

谁在用
精彩资源

支持

支持

社区

贡献者

最后更新于: 2025/11/18 02:11:37

上一页TypeORM
下一页Sequelize

#MongoDB (Mongoose)

警告

在本文中,您将学习如何基于 Mongoose 包从头开始使用自定义组件创建 DatabaseModule。因此,该解决方案包含许多额外工作,您可以直接使用现成的专用 @nestjs/mongoose 包来避免这些操作。了解更多信息,请参阅此处 。

Mongoose 是最受欢迎的 MongoDB 对象建模工具。

#快速开始

要开始使用这个库,我们需要先安装所有必需的依赖项:

$ npm install --save mongoose

我们首先需要使用 connect() 函数建立与数据库的连接。connect() 函数返回一个 Promise,因此我们必须创建一个异步提供者 。

database.providers.ts
import * as mongoose from 'mongoose';

export const databaseProviders = [
 {
   provide: 'DATABASE_CONNECTION',
   useFactory: (): Promise<typeof mongoose> =>
     mongoose.connect('mongodb://localhost/nest'),
 },
];
提示

遵循最佳实践,我们在单独的文件中声明了自定义提供者,该文件具有 *.providers.ts 后缀。

接下来,我们需要导出这些提供者,使它们对应用程序的其余部分可访问 。

database.module.ts
import { Module } from '@nestjs/common';
import { databaseProviders } from './database.providers';

@Module({
 providers: [...databaseProviders],
 exports: [...databaseProviders],
})
export class DatabaseModule {}

现在我们可以使用 @Inject() 装饰器注入 Connection 对象。每个依赖于 Connection 异步提供者的类都将等待 Promise 解析完成。

#模型注入

在 Mongoose 中,所有内容都源自 Schema。让我们定义 CatSchema:

schemas/cat.schema.ts
import * as mongoose from 'mongoose';

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

CatsSchema 属于 cats 目录。该目录代表 CatsModule。

现在是时候创建一个 Model 提供者了:

cats.providers.ts
import { Connection } from 'mongoose';
import { CatSchema } from './schemas/cat.schema';

export const catsProviders = [
 {
   provide: 'CAT_MODEL',
   useFactory: (connection: Connection) => connection.model('Cat', CatSchema),
   inject: ['DATABASE_CONNECTION'],
 },
];
警告

在实际应用中应避免使用魔法字符串 。CAT_MODEL 和 DATABASE_CONNECTION 都应保存在独立的 constants.ts 文件中。

现在我们可以通过 @Inject() 装饰器将 CAT_MODEL 注入到 CatsService 中:

cats.service.ts
import { Model } from 'mongoose';
import { Injectable, Inject } from '@nestjs/common';
import { Cat } from './interfaces/cat.interface';
import { CreateCatDto } from './dto/create-cat.dto';

@Injectable()
export class CatsService {
 constructor(
   @Inject('CAT_MODEL')
   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();
 }
}

在上例中我们使用了 Cat 接口。该接口扩展了 mongoose 包中的 Document:

import { Document } from 'mongoose';

export interface Cat extends Document {
  readonly name: string;
  readonly age: number;
  readonly breed: string;
}

数据库连接是异步的 ,但 Nest 使这个过程对终端用户完全透明。CatModel 类会等待数据库连接,而 CatsService 会延迟到模型准备就绪。整个应用会在所有类实例化完成后启动。

以下是最终的 CatsModule:

cats.module.ts
import { Module } from '@nestjs/common';
import { CatsController } from './cats.controller';
import { CatsService } from './cats.service';
import { catsProviders } from './cats.providers';
import { DatabaseModule } from '../database/database.module';

@Module({
 imports: [DatabaseModule],
 controllers: [CatsController],
 providers: [
   CatsService,
   ...catsProviders,
 ],
})
export class CatsModule {}
提示

不要忘记将 CatsModule 导入根模块 AppModule。

#示例

一个可用的示例在此处查看。