CRUD generator (TypeScript only)

导读

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

简介

让我们想象一个真实场景，我们需要为 2 个实体公开 CRUD 端点，比如 用户 和 产品 实体。 按照最佳实践，对于每个实体，我们都必须执行以下几个操作：

  • 生成一个模块（nest g mo）以保持代码井然有序并建立清晰的边界（对相关组件进行分组）
  • 生成一个控制器（nest g co）来定义 CRUD 路由（或 GraphQL 应用程序的查询/变异）
  • 生成一个服务（nest g s）来实现和隔离业务逻辑
  • 生成一个实体类/接口来表示资源数据形状
  • 生成数据传输对象（或 GraphQL 应用程序的输入）来定义如何通过网络发送数据

步骤太多了！

为了帮助加快这个重复的过程，Nest CLI 提供了一个生成器（示意图），可以自动生成所有样板代码，帮助我们避免做所有这些事情，并使开发人员的体验更加简单。

注意

该原理图支持生成 HTTP 控制器、Microservice 控制器、GraphQL 解析器（代码优先和模式优先）和 WebSocket 网关。

生成新资源

要创建新资源，只需在项目的根目录中运行以下命令：

shell
$ nest g resource

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

您可以在下面看到生成的控制器文件（用于 REST API）：

ts
@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（代码优先）（或 GraphQL（架构优先））作为传输层。

在这种情况下，NestJS 将生成解析器类而不是 REST API 控制器：

shell
$ 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。

ts
import { Args, Int, Mutation, Query, Resolver } 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)
  }
}