栈记
Nest

控制器 Controller

路由前缀、请求方法装饰器与参数装饰器

Controller

使用 @Controller() 装饰一个控制器类,可以传入一个字符串作为路由的前缀;

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

@Controller('users')
export class UsersController {}

在该控制值下的路由都将以 /users 作为前缀。

请求方法

在 nest 中,提供了所有的 HTTP 请求方法装饰器,均接收一个字符串参数,作为路由的路径与 Controller 中的前缀组合成完整的路由路径。

关于动态路由参数,可以在路径中使用 :param 的形式来定义动态参数。

值得注意的是除了 Post 请求的返回码是 201 除外,其余类型的请求统一返回 200,也可以通过 @HttpCode 装饰器进行修改;

import {
  Get,
  Post,
  Patch,
  Put,
  Options,
  Delete,
  Head,
  All, // 适用于所有请求方法
  HttpCode,
} from '@nestjs/common';

@Controller('users')
export class UsersController {
  @Get(':id')
  findOne() {
    // GET /users/:id
  }

  @Post()
  @HttpCode(200)
  create() {
    // POST /users
  }
}

请求对象

通过一系列的装饰器也可以获取客户端请求对象中的数据

装饰器说明
@Req() | @Request获取原生请求对象,如果指定类型需要安装 @types/express 脚手架也内置了
@Res() | @Response获取原生响应对象,如果指定类型需要安装 @types/express 脚手架也内置了
@Next()next 函数
@Session()req.session
@Param(key?: string)获取路由参数,不传递则获取所有
@Query(key?: string)获取查询参数,不传递则获取所有
@Body(key?: string)获取请求体参数,不传递则获取所有
@Headers(key?: string)获取请求头参数,不传递则获取所有
@Ip()获取客户端 IP 地址
@HostParam(key?: string)req.hosts

当在 Controller 中使用 @Res() 或者 @Response() 时,必须使用 res.send() 或者 res.json() 显示的返回响应对象,否则服务器会挂起等不到任何返回内容。

如果一定要使用 @Res() 或者 @Response(),可以通过 passthrough 选项来允许继续使用框架的响应处理;

完整示例如下

import {
  Controller,
  Get,
  Param,
  Query,
  Headers,
  Body,
  Ip,
  HostParam,
  Res,
} from '@nestjs/common';
import type { Response } from 'express';

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

@Controller()
export class AppController {
  @Get(':id/:name')
  getParam(@Param('id') id: string, @Param() params: User): string {
    console.log(typeof id);
    return `param -> id: ${id}, name: ${JSON.stringify(params)}`;
  }

  @Get()
  getQuery(@Query('id') id: string, @Query() query: User): string {
    console.log(typeof id);
    return `query -> id: ${id}, name: ${JSON.stringify(query)}`;
  }

  @Get('headers')
  getHeaders(
    @Headers('') headers: Record<string, string>,
    @Headers('user-agent') userAgent: string,
  ): string {
    return `headers -> ${userAgent} ${JSON.stringify(headers)}`;
  }

  @Get('body')
  getBody(@Body() body: Record<string, any>): string {
    console.log(typeof body); // object
    return `body -> ${JSON.stringify(body)}`;
  }

  @Get('ip')
  getIp(@Ip() ip: string): string {
    return `ip -> ${ip}`;
  }

  @Get('host')
  getHostParam(
    @HostParam('subdomain') subdomain: string,
    @HostParam() host: Record<string, any>,
  ): string {
    console.log(host);
    return `host param -> ${subdomain} \n ${JSON.stringify(host)}`;
  }

  @Get('res')
  getResponse(@Res() res: Response): void {
    res.status(200).json({ message: 'Hello World' });
  }
}

数组类型 query 参数

对于数组类型的 query 参数由于传递的情况不同,可以确认的是,内部都会处理成数组,但是数组内的类型不能得到保证;

比如 ?ids=1&ids=2 或者 ids=[1,2,3] 明确的是 ids[]=1&ids[]=2 得到的是 undefined。

处理这种复杂的情况可以在 main.ts 中进行处理;

import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
import { NestExpressApplication } from '@nestjs/platform-express';

async function bootstrap() {
  const app = NestFactory.create<NestExpressApplication>(AppModule);
  app.set('query parser', 'extended'); // 处理复杂的 query 参数
  await app.listen(process.env.PORT ?? 3000);
}
bootstrap();

FormData 参数

基于 www-form-urlencoded 的参数可以直接被处理,如果需要上传文件使用 multipart/form-data 需要安装 nestjs-form-data 进行处理;

npm install nestjs-form-data
// module.ts
import { Module } from '@nestjs/common';
import { NestjsFormDataModule } from 'nestjs-form-data';
import { AppController } from './app.controller';

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

// controller.ts
import { Controller, Post } from '@nestjs/common';
import { FormDataRequest } from 'nestjs-form-data';

@Controller()
export class AppController {
  @Post('upload')
  @FormDataRequest()
  uploadFile(@Body() body: Record<string, any>): string {
    // 文件数据包括 名称、类型、大小、以及文件内容的 buffer
    console.log(body);
  } 
}

重定向

通过 Redirect() 装饰器实现重定向功能;

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

@Controller()
export class AppController {
  @Get('redirect')
  @Redirect('https://www.nestjs.com', 302)
  redirect() {
    //
  }
}

On this page