如何使用 NestJS 开发 Node 应用

NestJS是一个高效、可扩展的Node.js框架，用于构建服务端应用程序。它使用TypeScript（也支持JavaScript）、完全支持面向对象编程、函数响应式编程，以及函数式编程。NestJS的设计理念是利用最新的JavaScript特性帮助开发者轻松创建可维护和可测试的代码。其中最突出的特点之一是其模块化结构，这使得它能够适应不同规模的应用程序，从简单的API到大型企业级应用程序。

NestJS通过提供一个层次化的依赖注入系统，可以让开发者高效地组织代码结构，实现不同组件之间的解耦。这种方式使得单元测试变得简单，并能提高代码的可复用性。

I. 介绍 NESTJS

在深入了解如何使用NestJS开发Node.js应用程序之前，必须首先理解NestJS的核心概念。NestJS的主要元素包括控制器、提供者、模块和中间件。

控制器是处理进入特定路径请求的逻辑单位。它们通常与特定请求的路由路径关联。

提供者是一个广义术语，可以是服务、工厂、助手等。它们可以注入控制器和其他服务中，提供不同的功能。

模块是一个收集相关代码的容器。一个模块可以包含控制器、提供者和甚至是其他模块。

中间件是在路由处理器之前调用的函数。中间件函数可以访问请求和响应对象，并可以修改它们。

II. 环境设置

开发NestJS应用之前，需要设置开发环境。你需要安装Node.js和NPM。NestJS官方推荐Node.js版本是10.13.0或更高。一旦这些基础软件安装完毕，你可以使用NestJS CLI来创建和管理项目。

npm i -g @nestjs/cli

nestjs new project-name

安装CLI并创建新项目之后，可以通过执行npm run start来启动应用，默认情况下，它将监听3000端口。

III. 创建控制器

当你的环境准备好后，就可以开始创建第一个控制器。控制器负责处理传入请求和返回响应给客户端。

import { Controller, Get } from '@nestjs/common';

@Controller('cats')
export class CatsController {
  @Get()
  findAll(): string {
    return 'This action returns all cats';
  }
}

@Controller装饰器用来定义基础的请求路径。@Get装饰器则是用来处理特定的HTTP GET请求。

IV. 服务和依赖注入

服务是在NestJS中被定义为提供者的类。这些服务可以处理应用逻辑并且可以通过依赖注入的方式在控制器中使用。

import { Injectable } from '@nestjs/common';

@Injectable()
export class CatsService {
  findAll(): string {
    return 'This action returns all cats from the service';
  }
}

在控制器中，我们可以通过构造函数依赖注入这些服务：

import { Controller, Get } from '@nestjs/common';

import { CatsService } from './cats.service';
@Controller('cats')
export class CatsController {
  constructor(private catsService: CatsService) {}
  @Get()
  findAll(): string {
    return this.catsService.findAll();
  }
}

依赖注入允许我们的控制器和其他组件保持独立和解耦，这使得单元测试等过程变得简单。

V. 中间件的使用

中间件可以对请求进行预处理，比如鉴权或者日志记录。在NestJS中，中间件是使用函数或者类来实现的，它们需要实现NestMiddleware接口。

import { Injectable, NestMiddleware } from '@nestjs/common';

import { Request, Response, NextFunction } from 'express';
@Injectable()
export class LoggerMiddleware implements NestMiddleware {
  use(req: Request, res: Response, next: NextFunction) {
    console.log('Request...');
    next();
  }
}

然后可以在模块中配置中间件：

import { MiddlewareConsumer, Module, NestModule } from '@nestjs/common';

import { LoggerMiddleware } from './common/middleware/logger.middleware';
@Module({})
export class ApPMOdule implements NestModule {
  configure(consumer: MiddlewareConsumer) {
    consumer
      .apply(LoggerMiddleware)
      .forRoutes('cats');
  }
}

VI. 异常过滤器

当你的应用程序遇到错误时，异常过滤器可以捕获异常并给客户返回定义好的响应。

import { ExceptionFilter, Catch, ArgumentsHost, HttpException } from '@nestjs/common';

import { Request, Response } from 'express';
@Catch(HttpException)
export class HttpExceptionFilter implements ExceptionFilter {
  catch(exception: HttpException, host: ArgumentsHost) {
    const ctx = host.switchToHttp();
    const response = ctx.getResponse<Response>();
    const request = ctx.getRequest<Request>();
    const status = exception.getStatus();
    response
      .status(status)
      .json({
        statusCode: status,
        timestamp: new Date().toISOString(),
        path: request.url,
      });
  }
}

异常过滤器可以全局注册，也可以特定于某个控制器或者请求方法。

VII. 管道

管道用于处理和转换输入数据。例如，验证请求对象，确保它所需的属性存在且有效。

import { PipeTransform, Injectable, ArgumentMetadata } from '@nestjs/common';

@Injectable()
export class ValidationPipe implements PipeTransform {
  transform(value: any, metadata: ArgumentMetadata) {
    // 执行验证逻辑
    return value;
  }
}

管道可用于控制器级别或者方法级别。

VIII. 守卫

守卫决定某个请求是否可以被处理。通常用于鉴权。

import { Injectable, CanActivate, ExecutionContext } from '@nestjs/common';

@Injectable()
export class RolesGuard implements CanActivate {
  canActivate(
    context: ExecutionContext,
  ): boolean | Promise<boolean> | Observable<boolean> {
    // 添加授权逻辑以决定请求是否继续处理
    return true;
  }
}

守卫可以为整个应用、特定模块或者请求方法设置。

IX. 微服务

NestJS也支持微服务架构，可以轻松创建和管理微服务。

import { Controller, Get } from '@nestjs/common';

import { MessagePattern } from '@nestjs/microservices';
@Controller()
export class MathController {
  @MessagePattern({ cmd: 'sum' })
  sum(data: number[]): number {
    return (data || []).reduce((a, b) => a + b);
  }
}

通过MessagePattern装饰器，你可以监听传入的消息(例如，通过RabbitMQ或Kafka)并对其做出响应。

X. WebSocket

NestJS提供了WebSocket支持，因此可以轻松创建实时功能的应用程序。

import { SubscribeMessage, WebSocketGateway } from '@nestjs/websockets';

@WebSocketGateway()
export class EventsGateway {
  @SubscribeMessage('events')
  onEvent(client: any, data: any): string {
    return 'Hello world!';
  }
}

使用@WebSocketGateway()装饰器和@SubscribeMessage()可以处理WebSocket消息。

XI. GraphQL集成

NestJS具备GraphQL集成，提供了一个快速、简单的实现GraphQL API的方法。

import { Query, Resolver } from '@nestjs/graphql';

@Resolver('Cats')
export class CatsResolver {
  constructor(private catsService: CatsService) {}
  @Query(() => [CatType])
  async getCats() {
    return this.catsService.findAll();
  }
}

@Resolver和@Query装饰器使得在NestJS中实现GraphQL查询变得简单。

XII. 数据库集成

NestJS可以集成多种数据库，包括但不限于MongoDB、PostgreSQL和MySQL。NestJS提供了TypeORM和Mongoose等集成方案，以便在应用程序中处理数据库操作。

import { Module } from '@nestjs/common';

import { TypeOrmModule } from '@nestjs/typeorm';
import { Cats } from './cats.entity';
@Module({
  imports: [
    TypeOrmModule.forFeature([Cats])
  ],
})
export class CatsModule {}

使用TypeOrmModule.forFeature()可以容易地将仓库注入到服务中，用于数据库实体操作。

XIII. 安全性

安全性是任何Web应用程序的重要方面。NestJS通过集成如Helmet、Cors和RateLimiter等中间件来提高应用安全性。

import { NestFactory } from '@nestjs/core';

import * as helmet from 'helmet';
async function bootstrap() {
  const app = awAIt NestFactory.create(AppModule);
  app.use(helmet());
  await app.listen(3000);
}
bootstrap();

使用helmet()可以帮助保护应用程序免受一些已知的Web漏洞。

在您熟悉这些核心概念和功能之后，您就能够开始利用NestJS的强大功能来构建和扩展您的Node.js应用程序了。NestJS的文档是一个非常好的资源，提供了详细的指导和示例，有助于深化您的学习和应用开发。

相关问答FAQs：

Q1：NestJS 是什么？如何使用它来开发 Node 应用？

A1：NestJS 是一个基于 TypeScript 的开发框架，它结合了 Express、Fastify 和其他一些功能强大的模块，用于构建可扩展的、高效的 Node.js 应用程序。要使用 NestJS 开发 Node 应用，首先需要安装 Node.js 和 npm。然后，使用 npm 安装 NestJS 脚手架工具，创建一个新的 NestJS 项目。接下来，使用命令行工具来生成控制器、模块和服务等必要的代码文件。最后，可以编写业务逻辑和路由处理程序来实现具体功能。

Q2：NestJS 和 Express 有什么区别？为什么要选择 NestJS 开发应用？

A2：NestJS 和 Express 都是 Node.js 的 Web 框架，但它们有一些区别。Express 是一个轻量级框架，非常简洁和易于使用，适用于快速构建简单的应用。而 NestJS 是一个更加强大、可扩展和模块化的框架，它提供了更多的功能和抽象层，使得开发者能够更好地组织和管理代码结构。选择 NestJS 开发应用的原因包括：使用 TypeScript 开发，具有静态类型检查和更好的可维护性；提供了丰富的装饰器和依赖注入功能，可以轻松构建模块化和可测试的代码；支持多种数据库和第三方模块等。

Q3：在使用 NestJS 开发 Node 应用过程中，有哪些常见的问题和解决方案？

A3：在使用 NestJS 开发应用时，可能会遇到一些常见的问题。例如，如何处理验证和授权的问题？可以使用 NestJS 的身份验证和授权模块来实现用户身份验证和访问控制。另一个问题是如何处理错误和异常？NestJS 提供了异常过滤器和全局异常处理器，可以统一处理应用中的错误和异常。此外，如何进行单元测试和集成测试？可以使用内置的测试模块来编写和运行各种类型的测试。还有，如何处理应用的配置和环境变量？可以使用 NestJS 的配置模块和环境变量来管理应用的配置项。通过深入研究和使用 NestJS 提供的官方文档和社区资源，可以找到更多关于这些问题的解决方案。

最后建议，企业在引入信息化系统初期，切记要合理有效地运用好工具，这样一来不仅可以让公司业务高效地运行，还能最大程度保证团队目标的达成。同时还能大幅缩短系统开发和部署的时间成本。特别是有特定需求功能需要定制化的企业，可以采用我们公司自研的企业级低代码平台：织信Informat。 织信平台基于数据模型优先的设计理念，提供大量标准化的组件，内置AI助手、组件设计器、自动化（图形化编程）、脚本、工作流引擎（BPMN2.0）、自定义API、表单设计器、权限、仪表盘等功能，能帮助企业构建高度复杂核心的数字化系统。如ERP、MES、CRM、PLM、SCM、WMS、项目管理、流程管理等多个应用场景，全面助力企业落地国产化/信息化/数字化转型战略目标。 版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们微信：Informat_5 处理，核实后本网站将在24小时内删除。