在项目的整个生命周期中,当我们构建新功能时,经常需要向应用程序添加新资源。这些资源通常需要多次重复操作,每次定义新资源时我们都必须重复这些操作。
让我们设想一个真实场景:需要为两个实体(例如用户和产品实体)暴露 CRUD 端点。按照最佳实践,每个实体都需要执行以下多项操作:
nest g mo)以保持代码组织性并建立清晰边界(将相关组件分组)nest g co)来定义 CRUD 路由(或 GraphQL 应用的查询/变更)nest g s)来实现和隔离业务逻辑步骤真不少!
为了加速这一重复性流程,Nest CLI 提供了一个生成器(schematic),它能自动生成所有样板代码,帮助我们省去这些繁琐操作,大幅简化开发体验。
该 schematic 支持生成 HTTP 控制器、 微服务 控制器、GraphQL 解析器(包括代码优先和架构优先两种模式)以及 WebSocket 网关。
要创建新资源,只需在项目根目录下运行以下命令:
nest g resource 命令不仅会生成所有 NestJS 构建块(模块、服务、控制器类),还会生成实体类、DTO 类以及测试文件(.spec)。
下方可以看到生成的控制器文件(用于 REST API):
此外,它会自动为所有 CRUD 端点创建占位符(REST API 的路由、GraphQL 的查询和变更、微服务和 WebSocket 网关的消息订阅)——所有这些都无需手动操作。
生成的服务类不与任何特定的 ORM(或数据源) 绑定。这使得生成器具有足够通用性,可满足任何项目的需求。默认情况下,所有方法都将包含占位符,允许您根据项目特定的数据源进行填充。
同样地,如果您想为 GraphQL 应用生成解析器,只需选择 GraphQL (code first)(或 GraphQL (schema first))作为传输层。
在这种情况下,NestJS 将生成解析器类而非 REST API 控制器:
若要避免生成测试文件,可传入 --no-spec 标志,如下所示: nest g resource users --no-spec
我们可以看到,不仅所有样板化的变更和查询都已生成,而且所有内容都已完美整合。我们正在使用 UsersService 服务、User 实体以及我们的 DTO 对象。