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

上一页REPL
下一页SWC

#CRUD 生成器(仅限 TypeScript)

在项目的整个生命周期中,当我们构建新功能时,经常需要向应用程序添加新资源。这些资源通常需要多次重复操作,每次定义新资源时我们都必须重复这些操作。

#介绍

让我们设想一个真实场景:需要为两个实体(例如用户和产品实体)暴露 CRUD 端点。按照最佳实践,每个实体都需要执行以下多项操作:

  • 生成模块(nest g mo)以保持代码组织性并建立清晰边界(将相关组件分组)
  • 生成控制器(nest g co)来定义 CRUD 路由(或 GraphQL 应用的查询/变更)
  • 生成服务(nest g s)来实现和隔离业务逻辑
  • 生成实体类/接口来表示资源数据结构
  • 生成数据传输对象(或 GraphQL 应用的输入)来定义数据在网络中的传输格式

步骤真不少!

为了加速这一重复性流程,Nest CLI 提供了一个生成器(schematic),它能自动生成所有样板代码,帮助我们省去这些繁琐操作,大幅简化开发体验。

注意

该 schematic 支持生成 HTTP 控制器、 微服务 控制器、GraphQL 解析器(包括代码优先和架构优先两种模式)以及 WebSocket 网关。

#生成新资源

要创建新资源,只需在项目根目录下运行以下命令:

$ nest g resource

nest g resource 命令不仅会生成所有 NestJS 构建块(模块、服务、控制器类),还会生成实体类、DTO 类以及测试文件(.spec)。

下方可以看到生成的控制器文件(用于 REST API):

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

  @Post()
  create(@Body() createUserDto: CreateUserDto) {
    return this.usersService.create(createUserDto);
  }

  @Get()
  findAll() {
    return this.usersService.findAll();
  }

  @Get(':id')
  findOne(@Param('id') id: string) {
    return this.usersService.findOne(+id);
  }

  @Patch(':id')
  update(@Param('id') id: string, @Body() updateUserDto: UpdateUserDto) {
    return this.usersService.update(+id, updateUserDto);
  }

  @Delete(':id')
  remove(@Param('id') id: string) {
    return this.usersService.remove(+id);
  }
}

此外,它会自动为所有 CRUD 端点创建占位符(REST API 的路由、GraphQL 的查询和变更、微服务和 WebSocket 网关的消息订阅)——所有这些都无需手动操作。

注意

生成的服务类不与任何特定的 ORM(或数据源) 绑定。这使得生成器具有足够通用性,可满足任何项目的需求。默认情况下,所有方法都将包含占位符,允许您根据项目特定的数据源进行填充。

同样地,如果您想为 GraphQL 应用生成解析器,只需选择 GraphQL (code first)(或 GraphQL (schema first))作为传输层。

在这种情况下,NestJS 将生成解析器类而非 REST API 控制器:

$ nest g resource users

> ? What transport layer do you use? GraphQL (code first)
> ? Would you like to generate CRUD entry points? Yes
> CREATE src/users/users.module.ts (224 bytes)
> CREATE src/users/users.resolver.spec.ts (525 bytes)
> CREATE src/users/users.resolver.ts (1109 bytes)
> CREATE src/users/users.service.spec.ts (453 bytes)
> CREATE src/users/users.service.ts (625 bytes)
> CREATE src/users/dto/create-user.input.ts (195 bytes)
> CREATE src/users/dto/update-user.input.ts (281 bytes)
> CREATE src/users/entities/user.entity.ts (187 bytes)
> UPDATE src/app.module.ts (312 bytes)
提示

若要避免生成测试文件,可传入 --no-spec 标志,如下所示: nest g resource users --no-spec

我们可以看到,不仅所有样板化的变更和查询都已生成,而且所有内容都已完美整合。我们正在使用 UsersService 服务、User 实体以及我们的 DTO 对象。

import { Resolver, Query, Mutation, Args, Int } from '@nestjs/graphql';
import { UsersService } from './users.service';
import { User } from './entities/user.entity';
import { CreateUserInput } from './dto/create-user.input';
import { UpdateUserInput } from './dto/update-user.input';

@Resolver(() => User)
export class UsersResolver {
  constructor(private readonly usersService: UsersService) {}

  @Mutation(() => User)
  createUser(@Args('createUserInput') createUserInput: CreateUserInput) {
    return this.usersService.create(createUserInput);
  }

  @Query(() => [User], { name: 'users' })
  findAll() {
    return this.usersService.findAll();
  }

  @Query(() => User, { name: 'user' })
  findOne(@Args('id', { type: () => Int }) id: number) {
    return this.usersService.findOne(id);
  }

  @Mutation(() => User)
  updateUser(@Args('updateUserInput') updateUserInput: UpdateUserInput) {
    return this.usersService.update(updateUserInput.id, updateUserInput);
  }

  @Mutation(() => User)
  removeUser(@Args('id', { type: () => Int }) id: number) {
    return this.usersService.remove(id);
  }
}