乐闻世界logo

如何在 NestJS 中集成 MongoDB 并实现数据的增删改查操作

前言

在现代的Web应用程序开发中，无论是在数据存储、检索、还是数据流转的各个环节，数据库都扮演着极其重要的角色。MongoDB是一个基于分布式文件存储的开源数据库系统，以其高性能、高可用性和易扩展性著称。

作为JavaScript社区最受欢迎的后端框架之一，NestJS 提供了优雅的解决方案来与各种数据库进行交互，其中就包括了对MongoDB的支持。

本教程将通过一个简单而通俗的实例，带你在NestJS中集成MongoDB。我们将创建一个简易的用户管理系统，实现用户的增删改查操作。

准备工作

在开始之前，请确保你的开发环境中已经安装了以下软件：

  • Node.js（建议使用LTS版本）
  • npm 或 yarn（作为Node.js的包管理工具）
  • MongoDB（你可以在本机上安装MongoDB，或者使用MongoDB Atlas服务）
  • Nest CLI（通过 npm i -g @nestjs/cli 安装）

准备就绪后，我们可以开始动手编写代码了。

集成步骤

一、创建新的 NestJS 项目

使用 Nest CLI 创建一个新项目：

shell
nest new nest-mongodb-example

进入项目目录：

shell
cd nest-mongodb-example

二、安装 MongoDB 模块

在NestJS中操作MongoDB，我们将使用 @nestjs/mongoose模块，同时也需要安装mongoose：

shell
npm install @nestjs/mongoose mongoose

三、配置 MongoDB 连接

我们需要配置NestJS应用来连接到MongoDB数据库。在 src目录下创建一个名为 configs的文件夹，并在其中创建 mongodb.config.ts文件：

javascript
// src/configs/mongodb.config.ts
export default {
  uri: 'mongodb://localhost/nest-mongodb-example',
};

在 app.module.ts中导入上述配置并初始化：

typescript
// src/app.module.ts
import { Module } from '@nestjs/common';
import { MongooseModule } from '@nestjs/mongoose';
import mongodbConfig from './configs/mongodb.config';

@Module({
  imports: [
    MongooseModule.forRoot(mongodbConfig.uri),
    // ...其他模块
  ],
  controllers: [],
  providers: [],
})
export class AppModule {}

四、创建数据模型 Schema

在 MongoDB 中, 我们使用 Schema 定义数据的结构。NestJS配合Mongoose可以让我们方便的操作它。

在 src目录下创建一个 users文件夹用来组织用户相关的文件。在其中创建 user.schema.ts用来定义用户数据模型：

typescript
// src/users/user.schema.ts
import { Prop, Schema, SchemaFactory } from '@nestjs/mongoose';
import { Document } from 'mongoose';

export type UserDocument = User & Document;

@Schema()
export class User {
  @Prop({ required: true })
  username: string;

  @Prop()
  email: string;

  @Prop()
  age: number;
}

export const UserSchema = SchemaFactory.createForClass(User);

五、注册数据模型

然后创建一个对应的服务模块来提供用户的业务逻辑：

shell
nest g module users
nest g service users

这将会自动生成 users.module.ts和 users.service.ts文件。

现在，我们将 User模型和 UserSchema导入到 UsersModule中：

typescript
// src/users/users.module.ts
import { Module } from '@nestjs/common';
import { MongooseModule } from '@nestjs/mongoose';
import { User, UserSchema } from './user.schema';
import { UsersService } from './users.service';

@Module({
  imports: [
    MongooseModule.forFeature([{ name: User.name, schema: UserSchema }])
  ],
  providers: [UsersService]
})
export class UsersModule {}

六、创建操作 MongoDB 的服务

现在，我们的 UsersService中可以通过依赖注入方式访问 User模型了。在 users.service.ts文件中，我们可以实现一些基本的数据库操作：

typescript
// src/users/users.service.ts
import { Injectable, NotFoundException } from '@nestjs/common';
import { InjectModel } from '@nestjs/mongoose';
import { Model } from 'mongoose';
import { User, UserDocument } from './user.schema';
import { CreateUserDto } from './dto/create-user.dto';
import { UpdateUserDto } from './dto/update-user.dto';

@Injectable()
export class UsersService {
  constructor(@InjectModel(User.name) private userModel: Model<UserDocument>) {}

  async create(createUserDto: CreateUserDto): Promise<User> {
    const createdUser = new this.userModel(createUserDto);
    return createdUser.save();
  }

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

  async findOne(id: string): Promise<User> {
    const user = this.userModel.findById(id).exec();
    if (!user) {
      throw new NotFoundException(`User with ID ${id} not found`);
    }
    return user;
  }

  async update(id: string, updateUserDto: UpdateUserDto): Promise<User> {
    const updatedUser = await this.userModel.findByIdAndUpdate(id, updateUserDto, { new: true }).exec();
    if (!updatedUser) {
      throw new NotFoundException(`User with ID ${id} not found`);
    }
    return updatedUser;
  }

  async delete(id: string): Promise<User> {
    const deletedUser = await this.userModel.findByIdAndRemove(id).exec();
    if (!deletedUser) {
      throw new NotFoundException(`User with ID ${id} not found`);
    }
    return deletedUser;
  }
}

七、实现增删改查操作

为了完成我们的CURD操作，我们还需要实现相应的 UsersController来处理HTTP请求。

此时我们同样应该创建DTO（Data Transfer Object）用来安全的传输数据。

首先，创建 create-user.dto.ts:

typescript
// src/users/dto/create-user.dto.ts
export class CreateUserDto {
  readonly username: string;
  readonly email?: string;
  readonly age?: number;
}

// src/users/dto/update-user.dto.ts
import { PartialType } from '@nestjs/mapped-types';
import { CreateUserDto } from './create-user.dto';

export class UpdateUserDto extends PartialType(CreateUserDto) {}

然后创建 UsersController:

shell
nest g controller users

在 users.controller.ts中实现API的接口：

typescript
// src/users/users.controller.ts
import { Controller, Get, Post, Body, Put, Param, Delete } from '@nestjs/common';
import { CreateUserDto } from './dto/create-user.dto';
import { UpdateUserDto } from './dto/update-user.dto';
import { UsersService } from './users.service';
import { User } from './user.schema';

@Controller('users')
export class UsersController {
  constructor(private readonly usersService: UsersService) {}

  @Post()
  async create(@Body() createUserDto: CreateUserDto): Promise<User> {
    return this.usersService.create(createUserDto);
  }

  @Get()
  async findAll(): Promise<User[]> {
    return this.usersService.findAll();
  }

  @Get(':id')
  async findOne(@Param('id') id: string): Promise<User> {
    return this.usersService.findOne(id);
  }

  @Put(':id')
  async update(@Param('id') id: string, @Body() updateUserDto: UpdateUserDto): Promise<User> {
    return this.usersService.update(id, updateUserDto);
  }

  @Delete(':id')
  async delete(@Param('id') id: string): Promise<User> {
    return this.usersService.delete(id);
  }
}

现在，我们把 UsersModule加入到 AppModule的imports数组里：

typescript
// src/app.module.ts
import { Module } from '@nestjs/common';
import { MongooseModule } from '@nestjs/mongoose';
import mongodbConfig from './configs/mongodb.config';
import { UsersModule } from './users/users.module';

@Module({
  imports: [
    MongooseModule.forRoot(mongodbConfig.uri),
    UsersModule,
    // ...其他模块
  ],
  // ...其他配置
})
export class AppModule {}

到这里，我们已经完成了NestJS与MongoDB的集成，以及一个用户增加和查询功能的简单例子。通过这样的方式，我们便实现了在NestJS中针对MongoDB的增删改查操作。下面是每个操作对应的功能：

  • POST /users 创建用户
  • GET /users 获取所有用户列表
  • GET /users/:id 根据ID获取单个用户
  • PUT /users/:id 根据ID更新用户信息
  • DELETE /users/:id 根据ID删除用户

结语

集成NestJS和MongoDB是一个相对直接的过程，感谢NestJS对于Mongoose的封装，使得我们可以非常便捷地管理数据库操作和数据模型。同时，我们可以享受到TypeScript的类型安全和装饰器带来的元数据功效，使得数据库相关代码更加清晰易懂。希望本教程可以帮助你在项目中快速集成NestJS和MongoDB，并构建出强大的后端服务。