NestJS最佳实践和高级技巧

NestJS 凭借其强大的框架特性，迅速成为构建可扩展、易于维护的 Node.js 应用的理想选择。其模块化架构、依赖注入系统以及对 TypeScript 的支持，使其成为开发复杂后端系统的绝佳选择。在本篇博文中，我们将探讨一些使用 NestJS 的最佳实践和高级技巧，以确保您的项目结构良好、性能卓越且易于维护。

设置 NestJS 项目
模块化架构，包含模块和服务
依赖注入和提供程序
控制器和路由
数据验证和DTO
错误处理和日志记录
身份验证和授权
使用 Jest 进行测试
性能优化
部署和持续集成

设置 NestJS 项目
要启动一个新的 NestJS 项目，您可以使用 Nest CLI：

首先在本地计算机上全局安装 NestJS CLI，并创建一个新项目。

$ npm install -g @nestjs/cli
$ nest new project-name

这将创建一个包含默认应用程序模块的基本项目结构。

NestJS 鼓励使用
模块化架构来保持代码库的组织性。模块封装相关组件，服务处理业务逻辑。以下是一个创建模块和服务的示例：

// users.module.ts
import { Module } from '@nestjs/common';
import { UsersController } from './users.controller';
import { UsersService } from './users.service';

@Module({
  controllers: [UsersController],
  providers: [UsersService],
})
export class UsersModule {}

// users.service.ts
import { Injectable } from '@nestjs/common';

@Injectable()
export class UsersService {
  private users = [];

  create(user) {
    this.users.push(user);
  }

  findAll() {
    return this.users;
  }
}

NestJS 使用依赖注入
来管理组件依赖关系。提供者是 NestJS 应用程序的构建模块，可以注入到其他组件（例如控制器和服务）中。

// users.controller.ts
import { Controller, Post, Body } from '@nestjs/common';
import { UsersService } from './users.service';

@Controller('users')
export class UsersController {
  constructor(private readonly usersService: UsersService) {}

  @Post()
  create(@Body() user) {
    this.usersService.create(user);
  }
}

控制器和路由
控制器定义路由和请求处理。它们接收传入的请求，处理请求，并返回响应。

// users.controller.ts
import { Controller, Get } from '@nestjs/common';
import { UsersService } from './users.service';

@Controller('users')
export class UsersController {
  constructor(private readonly usersService: UsersService) {}

  @Get()
  findAll() {
    return this.usersService.findAll();
  }
}

** 数据验证和 DTO **
使用数据传输对象 (DTO) 有助于验证传入数据并确保类型安全。

// create-user.dto.ts
export class CreateUserDto {
  readonly name: string;
  readonly age: number;
  readonly email: string;
}

// users.controller.ts
import { Controller, Post, Body } from '@nestjs/common';
import { UsersService } from './users.service';
import { CreateUserDto } from './create-user.dto';

@Controller('users')
export class UsersController {
  // ...

  @Post()
  create(@Body() createUserDto: CreateUserDto) {
    this.usersService.create(createUserDto);
  }
}

错误处理和日志记录：
实现全局异常过滤器以实现一致的错误处理，并使用日志记录进行更好的调试。

// http-exception.filter.ts
import { ExceptionFilter, Catch, ArgumentsHost, HttpException } from '@nestjs/common';

@Catch(HttpException)
export class HttpExceptionFilter implements ExceptionFilter {
  catch(exception: HttpException, host: ArgumentsHost) {
    // Handle exception and log details
  }
}

身份验证和授权
使用保护措施和策略实现身份验证和授权，以确保只有授权用户才能访问控制器。

// auth.guard.ts
import { Injectable, CanActivate, ExecutionContext } from '@nestjs/common';

@Injectable()
export class AuthGuard implements CanActivate {
  canActivate(context: ExecutionContext) {
    // Implement authentication logic
    return true;
  }
}

NestJS 支持使用 Jest 进行测试
。您可以为服务、控制器等编写单元测试。

// users.service.spec.ts
import { Test, TestingModule } from '@nestjs/testing';
import { UsersService } from './users.service';

describe('UsersService', () => {
  let service: UsersService;

  beforeEach(async () => {
    const module: TestingModule = await Test.createTestingModule({
      providers: [UsersService],
    }).compile();

    service = module.get<UsersService>(UsersService);
  });

  it('should be defined', () => {
    expect(service).toBeDefined();
  });
});

性能优化
对于确保您的 NestJS 应用程序流畅高效地运行至关重要。通过遵循以下技巧，您可以提升应用程序的速度、响应能力和可扩展性。

实现缓存机制，将频繁访问的数据存储在内存中，减少重复从数据库获取数据的需要。cache-manager 包可以与 NestJS 无缝集成，用于管理缓存。

$ npm install cache-manager @nestjs/cache

import { CacheModule, Module } from '@nestjs/common';
import { AppController } from './app.controller';
import { AppService } from './app.service';

@Module({
  imports: [CacheModule.register()],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {}

import { CacheInterceptor, CacheTTL, Controller, Get, UseInterceptors } from '@nestjs/common';
import { AppService } from './app.service';

@Controller()
export class AppController {
  constructor(private readonly appService: AppService) {}

  @Get('data')
  @UseInterceptors(CacheInterceptor)
  @CacheTTL(10) // Cache for 10 seconds
  getData() {
    return this.appService.getData();
  }
}

部署和持续集成

部署 NestJS 应用程序并建立强大的持续集成 (CI) 流水线是软件开发生命周期中的关键步骤。这些流程确保您的应用程序能够可靠部署、经过全面测试并能无缝扩展。以下是如何高效部署和管理 NestJS 应用程序的方法。

Dockerfile 示例：

FROM node:14

WORKDIR /app

COPY package*.json ./

RUN npm install

COPY . .

EXPOSE 3000

CMD ["npm", "run", "start:prod"]

对于多容器应用程序，请使用 Docker Compose 来定义和管理应用程序的服务及依赖项。

version: '3'
services:
  app:
    build:
      context: .
      dockerfile: Dockerfile
    ports:
      - '3000:3000'

设置持续集成 (CI) 可确保每次将更改推送到版本控制仓库时，应用程序都会自动构建、测试和部署。Jenkins、Travis CI、CircleCI 和 GitLab CI/CD 等工具可以帮助简化此流程。

.gitlab-ci.yml 配置示例：

stages:
  - build
  - test
  - deploy

build:
  stage: build
  script:
    - npm install
    - npm run build

test:
  stage: test
  script:
    - npm run test

deploy:
  stage: deploy
  script:
    - npm install -g @nestjs/cli
    - nest build
    - docker build -t my-nest-app .
    - docker login -u $DOCKER_USERNAME -p $DOCKER_PASSWORD
    - docker push my-nest-app

遵循这些最佳实践和高级技巧，您可以使用 NestJS 创建健壮且易于维护的应用程序。其模块化架构、依赖注入系统以及对 TypeScript 的支持，使您能够轻松构建可扩展且高效的后端系统。

请记住，每个项目都有其独特的需求，因此请根据实际情况调整这些技巧。为了充分利用这个强大的框架，请及时关注 NestJS 文档和快速发展的 Node.js 生态系统。祝您编码愉快！

让我们联系

LinkedIn | GitHub | Twitter |

文章来源：https://dev.to/drborne/best-nestjs-practices-and-advanced-techniques-9m0

菜单

分享

NestJS最佳实践和高级技巧

NestJS最佳实践和高级技巧

系统设计面试中的 19 种微服务模式

使用 React 和 AWS Amplify 实现无服务器架构第三部分：跟踪应用使用情况

模型-视图-控制器（MVC）模式到底是什么？DEV 全球项目展示挑战赛，由 Mux 主办：快来展示你的项目吧！

我在两年内从 PHP 开发人员晋升为高级 C#/.NET 开发人员。

了解 Docker：第 12 部分 – 传递构建参数

Yarn 和第三方 NPM 客户端的黑暗未来 DEV 的全球展示与讲述挑战赛，由 Mux 呈现：展示你的项目！

CSS DEV 的全球展示挑战赛“响应式字体”由 Mux 呈现：展示你的项目！

我是如何以学生开发者的身份免费获得 Tabnine Pro 的，你也可以！

五大顶级JS框架

从 Rector PHP 开始：利用自动化改进您的 PHP 代码