NestJS 详细介绍及使用示例

如果觉得不错欢迎点赞、关注、转发、收藏，您的支持是我最大的动力，谢谢！

一、NestJS 是什么？

NestJS 是一个基于 TypeScript 的渐进式 Node.js 框架，用于构建高效、可扩展的服务器端应用程序。它结合了 面向对象编程（OOP）、函数式编程（FP） 和 函数式响应式编程（FRP） 的理念，并借鉴了 Angular 的模块化设计，提供开箱即用的企业级应用架构。

核心特点：

• 模块化：通过 @Module 装饰器组织代码。
• 依赖注入（DI）：自动管理类之间的依赖关系。
• TypeScript 优先：原生支持类型安全。
• 兼容 Express/Fastify：底层可切换 HTTP 引擎。
• 丰富的生态系统：集成 TypeORM、GraphQL、WebSocket、微服务等。

二、核心概念

1.模块（Module）

• 代码组织的基本单元，通过 @Module 装饰器定义。
• 每个模块可以包含控制器、服务、其他模块的依赖。

2.控制器（Controller）

• 处理 HTTP 请求，通过 @Controller 装饰器定义。
• 路由方法使用 @Get()、@Post() 等装饰器。

3.服务（Service）

• 封装业务逻辑，通过 @Injectable() 装饰器定义。
• 通过依赖注入（DI）在控制器或其他服务中使用。

4.中间件（Middleware）

• 处理请求和响应的中间逻辑（如日志、鉴权）。

5.管道（Pipe）

• 数据验证和转换（如校验请求参数）。

6.守卫（Guard）

• 路由守卫，用于权限控制（如 JWT 鉴权）。

7.拦截器（Interceptor）

• 在请求处理前后插入逻辑（如统一响应格式）。

三、快速入门示例

1. 安装 NestJS CLI

npm install -g @nestjs/cli

2. 创建新项目

nest new my-nest-app
cd my-nest-app
npm run start:dev

3. 核心代码示例

3.1 模块定义（app.module.ts）

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

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

3.2 控制器（app.controller.ts）

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

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

  @Get()
  getHello(): string {
    return this.appService.getHello();
  }

  @Get('user/:id')
  getUser(@Param('id') id: string): string {
    return `User ID: ${id}`;
  }
}

3.3 服务（app.service.ts）

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

@Injectable()
export class AppService {
  getHello(): string {
    return 'Hello NestJS!';
  }
}

4. 运行与测试

• 启动开发服务器：
• npm run start:dev
• 访问 http://localhost:3000，输出 Hello NestJS!。
• 访问 http://localhost:3000/user/123，输出 User ID: 123。

四、进阶示例：RESTful API（用户管理）

1. 创建用户模块

nest generate module users
nest generate controller users
nest generate service users

2. 用户服务（users.service.ts）

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

interface User {
  id: number;
  name: string;
}

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

  findAll(): User[] {
    return this.users;
  }

  create(user: User): User {
    this.users.push(user);
    return user;
  }
}

3. 用户控制器（users.controller.ts）

import { Controller, Get, Post, Body } from '@nestjs/common';
import { UsersService } from './users.service';
import { User } from './interfaces/user.interface';

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

  @Get()
  findAll(): User[] {
    return this.usersService.findAll();
  }

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

4. 用户模块（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 {}

5. 测试 API

获取所有用户：

curl http://localhost:3000/users

创建用户：

curl -X POST -H "Content-Type: application/json" -d '{"id":1,"name":"Alice"}' http://localhost:3000/users

五、常用功能扩展

1. 数据验证（使用class-validator）

import { IsString, IsInt } from 'class-validator';

export class CreateUserDto {
  @IsInt()
  id: number;

  @IsString()
  name: string;
}

// 在控制器中使用：
@Post()
create(@Body() createUserDto: CreateUserDto) {
  return this.usersService.create(createUserDto);
}

2. 全局异常过滤（统一错误响应）

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

@Catch()
export class AllExceptionsFilter implements ExceptionFilter {
  catch(exception: Error, host: ArgumentsHost) {
    const response = host.switchToHttp().getResponse();
    response.status(500).json({
      message: 'Internal Server Error',
    });
  }
}

// 在 main.ts 中注册：
app.useGlobalFilters(new AllExceptionsFilter());

3. 集成数据库（TypeORM）

// 安装依赖
npm install @nestjs/typeorm typeorm mysql2

// 配置数据库连接（app.module.ts）
import { TypeOrmModule } from '@nestjs/typeorm';

@Module({
  imports: [
    TypeOrmModule.forRoot({
      type: 'mysql',
      host: 'localhost',
      port: 3306,
      username: 'root',
      password: 'root',
      database: 'test',
      entities: [User],
      synchronize: true,
    }),
    UsersModule,
  ],
})
export class AppModule {}

六、总结

NestJS 通过模块化、依赖注入和 TypeScript 支持，为构建企业级 Node.js 应用提供了强大的基础设施。无论是简单的 REST API 还是复杂的微服务架构，NestJS 都能提供清晰的代码组织和可维护性。通过结合 Express/Fastify 生态和丰富的官方库，开发者可以快速实现功能需求。