idea快速生成crud_使用NestJS，@nestjsx/crud和TestMace进行快速轻松的CRUD

作者：cy45vsf | 来源：互联网 | 2023-08-24 10:09

idea快速生成crud如今，RESTAPI已成为Web应用程序开发标准，可以将Web开发分为两个单独的部分。UI使用了几种主流框架，例如

idea快速生成crud

如今&＃xff0c;REST API已成为Web应用程序开发标准&＃xff0c;可以将Web开发分为两个单独的部分。 UI使用了几种主流框架&＃xff0c;例如Angular&＃xff0c;React&＃xff0c;Vue。后端开发人员可以从多种语言和框架中自由选择。今天&＃xff0c;我想讨论NestJS框架。我们将使用Nest和&＃64; nestjsx / crud包创建一个简单的CRUD应用程序。

为什么选择NestJS

最近&＃xff0c;Javascript社区中出现了许多后端框架。它们都提供与Nest相同的功能&＃xff0c;但是Nest体系结构使其在其他软件中脱颖而出。下列NestJS功能可让您创建可用于生产环境的应用程序&＃xff0c;并为大型团队扩展开发规模&＃xff1a;

TypeScript作为主要的编程语言。尽管NestJS支持Javascript&＃xff0c;但它可能无法正常工作&＃xff0c;尤其是在第三方程序包中。
DI容器&＃xff0c;允许创建松耦合的组件&＃xff1b;
框架功能分为独立的可互换组件。例如&＃xff0c;既快速和fastify可以用作发动机罩下的框架&＃xff0c;以及用于数据库巢提供typeorm &＃xff0c; 猫鼬 &＃xff0c; sequelize绑定开箱;
NestJS独立于平台&＃xff0c;并支持REST&＃xff0c;GraphQL&＃xff0c;Websockets&＃xff0c;gRPC等。

该框架的灵感来自Angular &＃xff08;前端框架&＃xff09;&＃xff0c;从概念上讲它们有很多共同点。

NestJS安装和项目部署

&＃64; nest / cli是一个Nest软件包&＃xff0c;可用于快速部署基本的应用程序框架。全局安装此软件包&＃xff1a;

npm install -- global &＃64;nest/cli

之后&＃xff0c;生成运行命令nest new nest-rest名为nest-rest的应用程序框架。

dmitrii&＃64;dmitrii-HP-ZBook-17-G3:~/projects $ nest new nest-rest ⚡ We will scaffold your appin a few seconds.. CREATE /nest-rest/.prettierrc (51 bytes) CREATE /nest-rest/README.md (3370 bytes) CREATE /nest-rest/nest-cli.json (84 bytes) CREATE /nest-rest/nodemon-debug.json (163 bytes) CREATE /nest-rest/nodemon.json (67 bytes) CREATE /nest-rest/package.json (1805 bytes) CREATE /nest-rest/tsconfig.build.json (97 bytes) CREATE /nest-rest/tsconfig.json (325 bytes) CREATE /nest-rest/tslint.json (426 bytes) CREATE /nest-rest/src/app.controller.spec.ts (617 bytes) CREATE /nest-rest/src/app.controller.ts (274 bytes) CREATE /nest-rest/src/app.module.ts (249 bytes) CREATE /nest-rest/src/app.service.ts (142 bytes) CREATE /nest-rest/src/main.ts (208 bytes) CREATE /nest-rest/ test /app.e2e-spec.ts (561 bytes) CREATE /nest-rest/ test /jest-e2e.json (183 bytes) ? Which package manager would you ❤️ to use? yarn ✔ Installation in progress... ☕ &＃x1f680; Successfully created project nest-rest &＃x1f449; Get started with the following commands: $ cd nest-rest $ yarn run start Thanks for installing Nest &＃x1f64f;Please consider donating to our open collectiveto help us maintain this package.&＃x1f377; Donate: https://opencollective.com/nest

选择yarn作为程序包管理器。

现在&＃xff0c;您可以运行npm start命令来启动服务器。按照链接http&＃xff1a;// localhost&＃xff1a;3000查看主页。很好&＃xff0c;但这不是我们想要的。

设置数据库

考虑到该项目的数据库管理系统&＃xff0c;我决定使用PostrgreSQL。口味各不相同&＃xff0c;我相信这是最成熟的数据库管理系统&＃xff0c;具有您可能需要的所有可能功能。正如我已经提到的&＃xff0c;Nest提供了与不同软件包的集成以使用数据库。由于选择了PostgreSQL&＃xff0c;因此选择TypeORM作为ORM是合乎逻辑的。因此&＃xff0c;让我们安装所有必需的软件包以进行数据库集成&＃xff1a;

yarn add typeorm &＃64; nestjs / typeorm pg

现在&＃xff0c;让我们看看我们需要每个包装的用途&＃xff1a;

typeorm — ORM附带&＃xff1b;
&＃64; nestjs / typeorm — NestJS的TypeORM包。它添加了辅助装饰器和模块&＃xff0c;可随时导入到项目模块中&＃xff1b;
pg — PostgreSQL驱动程序。
version: &＃39;3.1&＃39; services: db: image: postgres:11.2 restart: always environment: POSTGRES_PASSWORD: example volumes:- ../db:/var/lib/postgresql/data- ./postgresql.conf:/etc/postgresql/postgresql.conf ports:- 5432 :5432 adminer: image: adminer restart: always ports:- 8080 :8080

如您所见&＃xff0c;此文件配置运行2个容器&＃xff1a;
1. db —包含数据库的容器。我们正在使用PostgreSQL版本11.2&＃xff1b;
2. 管理员-数据库管理员。它提供了一个Web界面来查看和管理数据库。
为了与TCP连接进行交互&＃xff0c;我添加了以下config 。

就是这样&＃xff0c;现在您可以使用docker-compose up -d命令或docker-compose up命令运行容器&＃xff0c;以在单独的控制台窗口中运行它们。通过这种方式查看日志更为简单。

好了&＃xff0c;安装软件包&＃xff0c;运行数据库&＃xff0c;现在我们必须将它们放在一起。为此&＃xff0c;将ormconfig.js文件添加到项目根目录&＃xff1a;

const process &＃61; require ( &＃39;process&＃39; ); const username &＃61; process.env.POSTGRES_USER || "postgres" ; const password &＃61; process.env.POSTGRES_PASSWORD || "example" ; module .exports &＃61; {"type" : "postgres" ,"host" : "localhost" ,"port" : 5432 ,username,password,"database" : "postgres" ,"synchronize" : true ,"dropSchema" : false ,"logging" : true ,"entities" : [__dirname &＃43; "/src/**/*.entity.ts" , __dirname &＃43; "/dist/**/*.entity.js" ],"migrations" : [ "migrations/**/*.ts" ],"subscribers" : [ "subscriber/**/*.ts" , "dist/subscriber/**/.js" ],"cli" : {"entitiesDir" : "src" ,"migrationsDir" : "migrations" ,"subscribersDir" : "subscriber"} }

此配置将用于TypeORM CLI。

让我们再仔细看看。在第3行和第4行中&＃xff0c;我们从环境变量中获取用户名和密码。当您有多个环境&＃xff08;开发&＃xff0c;阶段&＃xff0c;产品等&＃xff09;时&＃xff0c;这非常方便。默认的用户名是postgres&＃xff0c;密码—例如。其余的配置非常琐碎&＃xff0c;因此让我们仅考虑最重要的参数。
1. synchronize 。它指定启动应用程序时是否应自动创建数据库模式。请注意&＃xff0c;如果在生产中使用此参数&＃xff0c;将会丢失一些数据。但是&＃xff0c;此参数对于调试和开发很有用。您可以改为从TypeORM CLI运行schema&＃xff1a;sync命令。
2. dropSchema 。建立连接后&＃xff0c;它将删除架构。与上一个参数一样&＃xff0c;此参数只能用于调试和开发。
3. entities 。它指定在哪里可以找到模型描述。请注意&＃xff0c;此处支持掩码搜索。
4. cli.entitiesDir 这是默认情况下存储从TypeORM CLI创建的模型的目录。
为了充分利用Nest应用程序中的TypeORM功能&＃xff0c;我们需要将TypeOrmModule导入AppModule 。您的AppModule将如下所示&＃xff1a;

import { Module } from &＃39;&＃64;nestjs/common&＃39; ; import { AppController } from &＃39;./app.controller&＃39; ; import { AppService } from &＃39;./app.service&＃39; ; import { TypeOrmModule } from &＃39;&＃64;nestjs/typeorm&＃39; ; import * as process from "process" ; const username &＃61; process.env.POSTGRES_USER || &＃39;postgres&＃39; ; const password &＃61; process.env.POSTGRES_PASSWORD || &＃39;example&＃39; ; &＃64;Module ({imports: [TypeOrmModule.forRoot({type : &＃39;postgres&＃39; ,host: &＃39;localhost&＃39; ,port: 5432 ,username,password,database: &＃39;postgres&＃39; ,entities: [__dirname &＃43; &＃39;/**/*.entity{.ts,.js}&＃39; ],synchronize: true ,}),],controllers: [AppController],providers: [AppService], }) export class AppModule {}

如您所见&＃xff0c;我们将与ormconfig.ts文件中相同的数据库配置传递给forRoot方法。

我们还有另一件事要做-将一些任务添加到package.json中以使用TypeORM。事实是CLI是用Javascript编写的&＃xff0c;因此可以在NodeJS中运行&＃xff0c;但是我们所有的模型和迁移都是用Typescript编写的。因此&＃xff0c;在使用CLI之前&＃xff0c;我们需要先对它们进行转换。为此&＃xff0c;我们需要在全局安装ts-node软件包&＃xff1a;

npm install -g ts-node

将以下命令添加到package.json&＃xff1a;

"typeorm" : "ts-node -r tsconfig-paths/register ./node_modules/typeorm/cli.js" , "migration:generate" : "yarn run typeorm migration:generate -n" , "migration:create" : "yarn run typeorm migration:create -n" , "migration:run" : "yarn run typeorm migration:run"

第一个命令是typeorm&＃xff0c;它添加ts-node作为包装以运行TypeORM CLI。其他命令只是您作为开发人员每天都会使用的有用的约定&＃xff1a;
1. “migration:generate” -根据模型的更改生成迁移。
2. “migration:create” —创建一个空的迁移文件。
3. “migration:run” —运行迁移。
终于可以了&＃xff01; 我们已经添加了所有必需的软件包&＃xff0c;将应用程序配置为通过CLI和应用程序本身与数据库交互&＃xff0c;并启动了数据库管理系统。现在是时候向我们的应用程序添加一些逻辑了。

安装CRUD软件包

您可以设计一个API&＃xff0c;以仅使用Nest来创建&＃xff0c;读取&＃xff0c;更新和删除实体。这种方法是最灵活的一种&＃xff0c;但在某些情况下可能会过分。例如&＃xff0c;如果您需要快速创建原型&＃xff0c;则可以牺牲灵活性以提高开发速度。许多框架允许您从实体数据模型描述生成CRUD API。 Nest也不例外。 &＃64; nestjsx / crud包使事情发生。它的功能非常令人兴奋&＃xff1a;

DBMS独立性&＃xff1b;
易于安装和设置&＃xff1b;
强大的查询语言&＃xff0c;具有过滤&＃xff0c;分页&＃xff0c;排序&＃xff0c;关系&＃xff0c;嵌套关系&＃xff0c;缓存等&＃xff1b;
一个带有查询生成器的前端使用包&＃xff1b;
简单的控制器方法覆盖&＃xff1b;
小配置
全面的文档支持。

它由几个软件包组成&＃xff1a;

&＃64; nestjsx / crud —核心程序包&＃xff0c;它提供&＃64;Crud&＃xff08;&＃xff09;装饰器用于端点的生成&＃xff0c;配置和验证&＃xff1b;
&＃64; nestjsx / crud-request —请求生成器/解析器包用于前端使用&＃xff1b;
&＃64; nestjsx / crud-typeorm — TypeORM软件包&＃xff0c;它为基本TypeOrmCrudService提供CRUD数据库操作的方法。

对于我们的应用程序&＃xff0c;我们需要&＃64; nestjsx / crud和&＃64; nestjsx / crud-typeorm软件包。让我们安装它们&＃xff1a;

yarnadd &＃64;nestjsx/crud class -transformer class - validator

声明类模型实例转换规则和传入请求验证分别需要class-transformer和class-validator包。这些软件包是由同一作者创建的&＃xff0c;因此具有类似的实现。

CRUD实施

让我们以用户列表作为模型。用户具有以下字段&＃xff1a; id &＃xff0c; username &＃xff0c; displayName &＃xff0c; email 。 Id是一个自动递增字段&＃xff0c; email和username -唯一字段。就那么简单&＃xff01; 现在&＃xff0c;让我们以Nest应用程序的形式将创意变为现实。

首先&＃xff0c;让我们创建一个用户模块&＃xff0c;该模块将负责与用户合作。在项目根目录的NestJS CLI中运行nest g module users命令。

dmitrii&＃64;dmitrii-HP-ZBook-17-G3:~/projects/nest-rest git:(master*)$ nest g module users CREATE /src/users/users.module.ts (82 bytes) UPDATE /src/app.module.ts (312 bytes)

添加实体文件夹&＃xff0c;您将在其中存储此模块模型。在此处添加带有用户模型描述的user.entity.ts文件&＃xff1a;

import { Column, Entity, PrimaryGeneratedColumn } from &＃39;typeorm&＃39; ; &＃64;Entity () export class User {&＃64;PrimaryGeneratedColumn ()id: string ;&＃64;Column ({unique: true })email: string ;&＃64;Column ({unique: true })username: string ;&＃64;Column ({nullable: true })displayName: string ; }

对于我们的应用程序找到这种模式&＃xff0c;我们需要进口TypeOrmModule与以下内容为UsersModule &＃xff1a;

import { Module } from &＃39;&＃64;nestjs/common&＃39; ; import { UsersController } from &＃39;./controllers/users/users.controller&＃39; ; import { UsersService } from &＃39;./services/users/users.service&＃39; ; import { TypeOrmModule } from &＃39;&＃64;nestjs/typeorm&＃39; ; import { User } from &＃39;./entities/user.entity&＃39; ; &＃64;Module ({controllers: [UsersController],providers: [UsersService],imports: [TypeOrmModule.forFeature([User])] }) export class UsersModule {}

我们导入TypeOrmModule并将此模块模型列表作为forFeature参数传递。

现在我们需要创建一个相应的数据库实体。这就是我们需要的迁移机制。要基于模型更改创建迁移&＃xff0c;请运行以下命令&＃xff1a;

$ npm run migration:generate -- CreateUserTable Migration /home/dmitrii/projects/nest-rest/migrations/1563346135367-CreateUserTable.ts has been generated successfully. Donein 1.96s.

看&＃xff0c;您不必手动编写迁移&＃xff0c;它是自动创建的。这是魔法&＃xff01; 但这仅仅是一个开始。让我们看一下我们的迁移文件&＃xff1a;

import {MigrationInterface, QueryRunner} from "typeorm" ;export class CreateUserTable1563346816726 implements MigrationInterface {public async up(queryRunner: QueryRunner): Promise {await queryRunner.query( &＃96;CREATE TABLE "user" ("id" SERIAL NOT NULL, "email" character varying NOT NULL, "username" character varying NOT NULL, "displayName" character varying, CONSTRAINT "UQ_e12875dfb3b1d92d7d7c5377e22" UNIQUE ("email"), CONSTRAINT "UQ_78a916df40e02a9deb1c4b75edb" UNIQUE ("username"), CONSTRAINT "PK_cace4a159ff9f2512dd42373760" PRIMARY KEY ("id"))&＃96; );}public async down(queryRunner: QueryRunner): Promise {await queryRunner.query( &＃96;DROP TABLE "user"&＃96; );}}

如您所见&＃xff0c;不仅会自动生成运行&＃xff0c;而且还会自动生成回滚方法。难以置信&＃xff01;

现在&＃xff0c;我们只需要运行此迁移。使用以下命令&＃xff1a;

npmrun migration: run .

模式更改刚刚被传输到数据库。

现在&＃xff0c;让我们创建一个服务于用户的服务&＃xff0c;并从TypeOrmCrudService继承它。我们需要将相关的实体存储库&＃xff08;在我们的例子中是用户存储库&＃xff09;传递给父构造函数参数。

import { Injectable } from &＃39;&＃64;nestjs/common&＃39; ; import { TypeOrmCrudService } from &＃39;&＃64;nestjsx/crud-typeorm&＃39; ; import { User } from &＃39;../../entities/user.entity&＃39; ; import { InjectRepository } from &＃39;&＃64;nestjs/typeorm&＃39; ; import { Repository } from &＃39;typeorm&＃39; ; &＃64;Injectable () export class UsersService extends TypeOrmCrudService{constructor ( &＃64;InjectRepository (User) usersRepository: Repository ){super (usersRepository);} }

我们将在用户控制器中需要此服务。要创建控制器&＃xff0c;请在CLI中运行nest g controller users/controllers/users命令。

dmitrii&＃64;dmitrii-HP-ZBook-17-G3:~/projects/nest-rest git:(master*)$ nest g controller users/controllers/users CREATE /src/users/controllers/users/users.controller.spec.ts (486 bytes) CREATE /src/users/controllers/users/users.controller.ts (99 bytes) UPDATE /src/users/users.module.ts (188 bytes)

打开控制器&＃xff0c;并向其中添加一些&＃64; nestjsx / crud魔术。为UsersController类添加以下装饰器&＃xff1a;

&＃64;Crud ({model: {type : User} })

&＃64;Crud装饰器向控制器添加了一些有用的方法来处理模型。在装饰器配置的model.type字段中指定模型类型。

下一步是实现CrudController接口。控制器的整个代码如下所示&＃xff1a;

import { Controller } from &＃39;&＃64;nestjs/common&＃39; ; import { Crud, CrudController } from &＃39;&＃64;nestjsx/crud&＃39; ; import { User } from &＃39;../../entities/user.entity&＃39; ; import { UsersService } from &＃39;../../services/users/users.service&＃39; ; &＃64;Crud ({model: {type : User} }) &＃64;Controller ( &＃39;users&＃39; ) export class UsersController implements CrudController{constructor ( public service: UsersService ){} }

就这样&＃xff01; 控制器现在支持模型的全部操作。不可能是真的让我们来看看我们的应用程序&＃xff01;

在TestMace中创建请求方案

为了测试我们的服务&＃xff0c;我们将使用TestMace — API设计的IDE。为什么选择TestMace&＃xff1f; 与同类产品相比&＃xff0c;它具有一些优势&＃xff1a;

强大的变量机制。有几种变量类型&＃xff0c;每种类型都有其自己的用途&＃xff1a;默认变量&＃xff0c;动态变量&＃xff0c;环境变量。每个变量都属于一个特定的节点&＃xff0c;支持继承&＃xff1b;
创建方案而无需编程。我们待会儿再讨论。
一种人类可读的格式&＃xff0c;可以将您的项目存储在版本控制系统中&＃xff1b;
自动完成功能&＃xff0c;语法突出显示&＃xff0c;变量值突出显示&＃xff1b;
API描述支持&＃43;从Swagger导入。

让我们运行npm start命令启动服务器并访问用户列表。根据控制器配置&＃xff0c;可以在localhost:3000/users找到该列表。让我们向这个网址发送请求。
运行TestMace后&＃xff0c;您可以看到以下界面&＃xff1a;

在屏幕的左上方&＃xff0c;有一个项目树&＃xff0c;其中“ 项目”是一个根节点。让我们创建第一个请求以获取用户列表。右键单击Project节点&＃xff0c;然后选择Add node- > RequestStep 。

在URL字段中插入localhost:3000/users并发送请求。您将在响应正文中获得一个200码和一个空数组。这很有意义&＃xff0c;我们尚未添加任何内容。

让我们用以下步骤创建一个方案&＃xff1a;

创建一个用户&＃xff1b;
通过其ID请求用户&＃xff1b;
通过其ID删除用户。

我们走吧。为方便起见&＃xff0c;创建一个Folder节点。实际上&＃xff0c;这只是一个用于存储整个方案的文件夹。要创建Folder节点&＃xff0c;请在Project节点上单击鼠标右键&＃xff0c;然后选择Add node-> Folder 。将其命名为check-create 。在此节点内添加您的第一个请求以创建用户。将新节点命名为create-user 。目前&＃xff0c;我们具有以下节点层次结构&＃xff1a;

现在转到“ 创建用户节点”选项卡。输入以下请求参数&＃xff1a;

请求类型-POST &＃xff1b;
URL — localhost:3000/users &＃xff1b;
{“email": “user&＃64;user.com", “displayName": “New user", “username": “user"} — JSON&＃xff0c;值为{“email": “user&＃64;user.com", “displayName": “New user", “username": “user"} 。

发送请求。该应用程序告诉我们记录已创建。

让我们检查一下。我们需要保存所添加用户的ID&＃xff0c;以便以后使用。这就是我们的动态变量机制可以为我们提供的帮助。让我们使用前面的示例看看它是如何工作的。右键单击id节点&＃xff0c;然后在“解析”选项卡上选择“ 分配给变量” 。在对话框窗口中设置参数&＃xff1a;

节点指定变量的父节点。选择检查创建 &＃xff1b;
变量名。我们将其命名为userId 。

这就是创建动态变量的样子&＃xff1a;

完成后&＃xff0c;每次您发送此请求时&＃xff0c;动态变量值都会更新。由于动态变量支持分层继承&＃xff0c;因此userId变量将在任何嵌套级别的check-create节点子代中始终可用。

在下一个请求中&＃xff0c;我们将需要此变量。让我们获取新添加的用户。使用localhost:3000/users/${$dynamicVar.userId}作为url参数&＃xff0c;将check-if-exists请求创建为check-create节点的子项。 ${variable_name}构造用于获取变量值。由于有了动态变量&＃xff0c;因此必须访问$ dynamicVar &＃xff0c;因此构造将如下所示&＃xff1a; ${dynamicVar.userId} 。发送请求&＃xff0c;并确保它能够满足要求。

最后要做的是删除用户。由于电子邮件和用户名字段是唯一的&＃xff0c;因此我们不仅需要发送最终请求以检查其是否正常运行&＃xff0c;而且还需要清理数据库。使用以下参数在check-create节点中创建删除用户请求&＃xff1a;