初识NestJS：构建你的第一个NestJS应用

# 1. NestJS简介 ## 1.1 什么是NestJS NestJS是一个使用TypeScript开发的渐进式Node.js框架，它结合了OOP（面向对象编程）、FP（函数式编程）和FRP（反应式编程）的元素。NestJS提供了一个基于模块化和可扩展的体系结构，用于构建可维护和可伸缩的服务器端应用。它使用Express作为默认的HTTP服务器，可以无缝集成大量第三方库和工具。 ## 1.2 NestJS的优势和特点 NestJS具有以下几个优势和特点： - 简单易学：NestJS基于类和装饰器的编程模型，与AngularJS类似，使得代码结构清晰、易于理解和维护。 - 可扩展性：NestJS设计的模块化体系结构可轻松扩展应用，通过将代码划分为模块、服务和控制器等组件，实现功能的解耦和复用。 - 强大的依赖注入：NestJS使用依赖注入来管理组件之间的依赖关系，提供了更加灵活和可测试的编程体验。 - 内置支持TypeScript：NestJS原生支持TypeScript，并且利用TypeScript的静态类型检查和编译时的语法检测，提供了更安全、更高效的开发流程。 - 生态系统丰富：NestJS拥有完善的插件和库生态系统，支持各种常用的功能模块，如数据库连接、认证授权、日志记录等。 ## 1.3 NestJS在现代Web开发中的应用 NestJS在现代Web开发中具有广泛的应用场景，特别适用于构建复杂的企业级应用和微服务。它的模块化体系结构和依赖注入特性使得对各个功能模块进行解耦、独立开发和测试成为可能。同时，NestJS的TypeScript支持和强大的开发工具链，使得开发人员能够以高效且安全的方式进行开发。不仅如此，NestJS还可以与前端框架（如Angular、React）结合使用，构建一致性的全栈解决方案。下面是一个简单的示例代码，展示了如何使用NestJS创建一个Hello World的HTTP服务： ```typescript // main.ts import { NestFactory } from '@nestjs/core'; import { AppModule } from './app.module'; async function bootstrap() { const app = await NestFactory.create(AppModule); await app.listen(3000); } bootstrap(); ``` 这段代码中，我们导入`NestFactory`和`AppModule`，使用`NestFactory`的`create`方法创建一个应用实例，然后调用`listen`方法启动HTTP服务，监听3000端口。这只是一个简单的开始，后续章节将详细介绍NestJS的更多特性和用法。以上是关于NestJS的简介部分，下一章节我们将介绍NestJS的准备工作，请继续阅读。 # 2. 准备工作 ### 2.1 安装Node.js和npm 在开始使用NestJS之前，我们需要确保我们的开发环境已经安装了Node.js和npm。 Node.js是一个基于Chrome V8引擎的JavaScript运行时，它允许我们在服务器端运行JavaScript代码。我们可以在Node.js官网（https://nodejs.org）下载最新的稳定版本。 npm是Node.js的包管理器，用于安装和管理项目依赖。它是随同Node.js一起安装的，因此无需单独安装。安装完成后，可以通过在命令行工具中运行以下命令验证安装是否成功： ```shell node --version npm --version ``` 如果成功安装，将会输出相应的版本号。 ### 2.2 创建一个新的NestJS项目完成Node.js和npm的安装后，我们可以使用NestJS的命令行工具（Nest CLI）来创建一个新的NestJS项目。首先，使用npm全局安装Nest CLI： ```shell npm install -g @nestjs/cli ``` 安装完成后，我们就可以使用`nest new`来创建一个新的NestJS项目： ```shell nest new project-name ``` 这将创建一个名为`project-name`的新目录，并在该目录中生成一个基本的NestJS项目结构。 ### 2.3 项目结构和目录解读创建完新项目后，我们来看一下生成的项目结构和目录。 ```plain project-name ├── src │ ├── app.controller.ts │ ├── app.module.ts │ └── main.ts ├── test │ └── app.e2e-spec.ts ├── .gitignore ├── nest-cli.json ├── package.json └── README.md ``` - `src`目录是我们编写代码的主要目录，其中： - `app.controller.ts`是一个示例控制器，我们将在后续章节中对其进行修改和扩展。 - `app.module.ts`是应用的根模块，我们将在其中定义和配置应用的模块和提供者。 - `main.ts`是应用的入口文件，我们将在其中启动应用并监听指定的端口。 - `test`目录包含了一些自动生成的测试文件，在后续章节中我们将使用Jest进行单元测试。 - `.gitignore`文件用于指定需要被Git忽略的文件和目录。 - `nest-cli.json`是Nest CLI的配置文件。 - `package.json`是Node.js项目的配置文件，其中包含了项目的依赖和脚本命令。 - `README.md`是项目的说明文档。在本章中，我们简要介绍了NestJS需要的准备工作，并展示了如何使用Nest CLI创建一个新的NestJS项目。下一章中，我们将着重讨论如何编写第一个NestJS控制器。 # 3. 编写第一个NestJS控制器在这一章中，我们将学习如何编写第一个NestJS控制器，并定义路由和请求方法来处理客户端的请求。 #### 3.1 创建一个简单的控制器首先，我们需要创建一个新的控制器来处理相关的请求。在NestJS中，控制器是处理用户请求并返回响应的关键组件。我们可以使用NestJS CLI命令来创建一个空的控制器： ```bash $ nest generate controller cats ``` 执行上述命令后，NestJS将在src目录下自动生成一个名为`cats.controller.ts`的文件。 #### 3.2 定义路由和请求方法在`cats.controller.ts`文件中，我们可以定义路由和请求方法来处理不同的请求。 ```typescript import { Controller, Get, Post, Put, Delete } from '@nestjs/common'; @Controller('cats') export class CatsController { @Get() findAll(): string { return 'This action returns all cats'; } @Get(':id') findOne(): string { return 'This action returns a specific cat'; } @Post() create(): string { return 'This action creates a new cat'; } @Put(':id') update(): string { return 'This action updates a specific cat'; } @Delete(':id') remove(): string { return 'This action removes a specific cat'; } } ``` 在上述代码中，我们使用装饰器（Decorator）来定义不同的路由和请求方法。`@Controller('cats')`装饰器用于指定控制器的基本URL路径。`@Get()`、`@Post()`、`@Put()`和`@Delete()`分别用于定义相应的GET、POST、PUT和DELETE请求方法。在每个请求方法中，我们可以编写相应的处理逻辑并返回响应。 #### 3.3 处理请求和返回响应现在我们已经定义了路由和请求方法，在控制器中处理请求并返回响应非常简单。我们只需要编写适当的逻辑，并返回一个表示响应的字符串。让我们假设在`CatsController`控制器中处理GET请求的`findOne()`方法，该方法返回一个具体的猫的信息。 ```typescript @Get(':id') findOne(): string { return 'This action returns a specific cat'; } ``` 当客户端向`/cats/1`发送GET请求时，NestJS将调用`findOne()`方法并返回相应的字符串。现在我们已经编写了第一个NestJS控制器，并学会了如何定义路由和请求方法，以及如何处理请求并返回响应。在下一章节中，我们将学习如何使用NestJS服务来进一步构建我们的应用。 # 4. 使用NestJS服务 NestJS中的服务是一个普通的类，使用@Injectable装饰器来注入到控制器或其他服务中。在本章中，我们将学习如何创建和使用NestJS服务，以及服务的生命周期和作用域。 #### 4.1 创建一个服务类在NestJS中，我们可以使用命令行工具快速生成一个新的服务类。运行以下命令来创建一个新的服务： ```bash nest generate service example ``` 这将在项目中的“src”目录下生成一个名为“example.service.ts”的服务文件。一个简单的服务类通常包含一些业务逻辑和数据处理方法，例如： ```typescript // src/example/example.service.ts import { Injectable } from '@nestjs/common'; @Injectable() export class ExampleService { getData(): string { return 'This is the data from the example service'; } } ``` #### 4.2 在控制器中使用服务要在控制器中使用服务，我们需要先将服务注入到控制器中。在控制器的构造函数中添加对服务类的参数声明即可实现依赖注入： ```typescript // src/example/example.controller.ts import { Controller, Get } from '@nestjs/common'; import { ExampleService } from './example.service'; @Controller('example') export class ExampleController { constructor(private readonly exampleService: ExampleService) {} @Get() getData(): string { return this.exampleService.getData(); } } ``` #### 4.3 服务的生命周期和作用域 NestJS服务有不同的生命周期和作用域，可通过在服务类上使用不同的注入器来实现。默认情况下，服务的作用域是“Singleton”，也就是说每个模块中只有一个实例。如果需要控制服务实例的作用域，可以使用“Request”或“Transient”作用域。 - Singleton：全局共享的单例实例。 - Request：每个HTTP请求创建一个新的实例。 - Transient：每次注入都会创建一个新的实例。通过了解NestJS服务的生命周期和作用域，我们可以更好地控制服务的实例化和使用方式，以及避免一些潜在的问题。通过本章的学习，我们已经了解了如何创建和使用NestJS服务，以及控制服务的生命周期和作用域。在下一章中，我们将学习NestJS中的中间件和异常处理。 # 5. 中间件和异常处理 #### 5.1 什么是中间件中间件是NestJS框架中用于处理请求和响应的函数。它们可以在请求到达控制器之前或之后执行预定的操作。中间件提供了一种方便的方式来处理共享的功能和逻辑，例如身份验证、日志记录和错误处理。 #### 5.2 编写和使用中间件在NestJS中，编写中间件非常简单。一个中间件函数可以通过使用`@Middleware()`装饰器来定义。在中间件函数中，我们可以使用`req`和`res`对象来访问请求和响应的属性。下面是一个示例中间件的代码： ```typescript // middleware/logging.middleware.ts import { Injectable, NestMiddleware } from '@nestjs/common'; import { Request, Response, NextFunction } from 'express'; @Injectable() export class LoggingMiddleware implements NestMiddleware { use(req: Request, res: Response, next: NextFunction) { console.log(`Request ${req.method} ${req.url}`); next(); } } ``` 然后，在主应用模块中将该中间件添加到全局中间件或特定路由的中间件队列中： ```typescript // app.module.ts import { Module, NestModule, MiddlewareConsumer } from '@nestjs/common'; import { LoggingMiddleware } from './middleware/logging.middleware'; @Module({ imports: [], controllers: [], providers: [], }) export class AppModule implements NestModule { configure(consumer: MiddlewareConsumer) { consumer .apply(LoggingMiddleware) .forRoutes('*'); // 将中间件应用到所有路由 } } ``` 在上述示例中，我们将`LoggingMiddleware`中间件应用到了所有的路由上。你也可以根据需要将中间件应用于特定的路由。 #### 5.3 处理异常和错误在NestJS中，异常处理是通过使用异常过滤器（Exception Filter）来实现的。异常过滤器负责捕获我们应用中抛出的异常，并以合适的响应方式进行处理。首先，我们需要创建一个自定义的异常过滤器类，并实现`ExceptionFilter`接口的`catch`方法。在`catch`方法中，我们可以检查和处理特定类型的异常。下面是一个简单的异常过滤器的示例代码： ```typescript // filters/http-exception.filter.ts 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, message: exception.message, timestamp: new Date().toISOString(), path: request.url, }); } } ``` 然后，我们需要在控制器类上使用`@UseFilters()`装饰器来指定使用的异常过滤器。你可以在控制器类上指定多个异常过滤器。下面是一个控制器类中使用异常过滤器的示例代码： ```typescript // controllers/app.controller.ts import { Controller, Get, UseFilters } from '@nestjs/common'; import { HttpExceptionFilter } from '../filters/http-exception.filter'; @Controller('app') @UseFilters(HttpExceptionFilter) export class AppController { @Get() index() { throw new Error('An error occurred'); } } ``` 上述示例中的`AppController`控制器在处理`/app`路径的GET请求时会主动抛出一个异常。该异常将会被`HttpExceptionFilter`过滤器捕获并处理。至此，我们已经学习了如何编写和使用中间件以及异常过滤器来实现NestJS中的请求处理和错误处理功能。接下来，我们将学习如何对NestJS应用进行测试。 # 6. 测试NestJS应用 NestJS提供了强大的测试支持，使得开发者能够轻松地编写和运行单元测试。在本章中，我们将介绍如何进行单元测试以及使用Jest测试框架来测试NestJS应用的控制器和服务。 #### 6.1 单元测试简介单元测试是对软件中的最小可测试单元进行测试的过程。在NestJS中，单元测试通常用于测试控制器和服务的功能，以确保它们能够按照预期进行工作。 #### 6.2 使用Jest进行单元测试 [Jest](https://jestjs.io/)是一个由Facebook开发的功能强大的JavaScript测试框架，它被广泛应用于Node.js和React项目中。NestJS框架默认集成了Jest，使得我们可以直接使用Jest进行单元测试。 ```javascript // 示例：使用Jest进行控制器测试 import { Test, TestingModule } from '@nestjs/testing'; import { AppController } from './app.controller'; import { AppService } from './app.service'; describe('AppController', () => { let appController: AppController; beforeEach(async () => { const app: TestingModule = await Test.createTestingModule({ controllers: [AppController], providers: [AppService], }).compile(); appController = app.get<AppController>(AppController); }); it('should return "Hello World!"', () => { expect(appController.getHello()).toBe('Hello World!'); }); }); ``` 在上面的例子中，我们使用Jest创建了一个简单的控制器测试。我们首先创建了一个测试模块，并注入了我们要测试的控制器和服务。然后，我们编写了一个测试用例，验证当调用`getHello`方法时是否能返回预期的结果。 #### 6.3 测试控制器和服务的功能除了上面的示例之外，我们还可以使用Jest来编写和运行更加复杂的控制器和服务的功能测试。通过模拟请求和调用服务的方法，我们能够全面地测试NestJS应用的各个部分，确保其功能的正确性和稳定性。通过本章的学习，读者将能够掌握使用Jest进行单元测试的方法，并能够编写针对NestJS应用的完整测试用例，从而保证应用的质量和可靠性。