控制器负责处理传入的请求并将响应返回给客户端。

image.png

控制器的目的是接收对应用程序的特定请求。 路由机制控制哪个控制器接收哪个请求。 通常，每个控制器具有多个路由，并且不同的路由可以执行不同的操作。

为了创建一个基本的控制器，我们使用类和装饰器。 装饰器将类与所需的元数据相关联，并使Nest能够创建路由映射（将请求绑定到相应的控制器）。

路由
在下面的示例中，我们将使用@Controller（）装饰器，它是定义基本控制器所必需的。我们将指定可选的cat路由路径前缀。在@Controller（）装饰器中使用路径前缀可以使我们轻松地对一组相关的路由进行分组，并最大程度地减少重复代码。例如，我们可以选择将一组路由管理为一组，这些路由管理在/ customers下与客户实体的交互。在那种情况下，我们可以在@Controller（）装饰器中指定路径前缀客户，这样我们就不必为文件中的每个路由重复路径的那部分

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

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

可以使用命令创建 controller

nest g controller cats

请求对象

处理程序通常需要访问客户端请求详细信息。 Nest提供对基础平台的请求对象的访问（默认情况下为Express）。我们可以通过在处理程序的签名中添加@Req（）装饰器来指示Nest注入请求对象，从而访问该请求对象。

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

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

可以改用专用的修饰符来获取参数，相关参数介绍如下

上面我们使用 get 方法，下面引用 post 方法

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

@Controller('cats')
export class CatsController {
  @Post()
  create(): string {
    return 'This action adds a new cat';
  }

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

nestjs 还支持其他的方法
@Put(), @Delete(), @Patch(), @Options(), @Head(), @All()

路由通配符
例如，星号用作通配符，并将匹配任何字符组合。

@Get('ab*cd')
findAll() {
  return 'This route uses a wildcard';
}

“ ab * cd”路由路径将匹配abcd，ab_cd，abecd等。字符？，+，*和（）可以在路由路径中使用，并且是其正则表达式对应项的子集。

状态码

请求默认返回200，可以改为其他值

@Post()
@HttpCode(204)
create() {
  return 'This action adds a new cat';
}

Headers

要指定自定义响应头，可以使用@Header（）装饰器

@Post()
@Header('Cache-Control', 'none')
create() {
  return 'This action adds a new cat';
}

重定向

@Get()
@Redirect('https://nestjs.com', 301)

有时需要动态重定向,参数定义

{
  "url": string,
  "statusCode": number
}

例子：

@Get('docs')
@Redirect('https://docs.nestjs.com', 302)
getDocs(@Query('version') version) {
  if (version && version === '5') {
    return { url: 'https://docs.nestjs.com/v5/' };
  }
}

路由参数

@Get(':id')
findOne(@Param() params): string {
  console.log(params.id);
  return `This action returns a #${params.id} cat`;
}

或者如下

@Get(':id')
findOne(@Param('id') id): string {
  return `This action returns a #${id} cat`;
}

Sub-Domain Routing

@Controller装饰器可以采用host选项，以要求传入请求的HTTP主机与某个特定值匹配。

@Controller({ host: 'admin.example.com' })
export class AdminController {
  @Get()
  index(): string {
    return 'Admin page';
  }
}

警告：由于Fastify缺乏对嵌套路由器的支持，因此在使用子域路由时，应使用（默认）Express适配器

与路由路径类似，hosts选项可以使用令牌来捕获主机名中该位置的动态值。下面的@Controller（）装饰器示例中的主机参数令牌演示了此用法。可以使用@HostParam（）装饰器访问以这种方式声明的主机参数，该装饰器应添加到方法签名中。

@Controller({ host: ':account.example.com' })
export class AccountController {
  @Get()
  getInfo(@HostParam('account') account: string) {
    return account;
  }
}

async / await

nestjs 支持async / await

@Get()
async findAll(): Promise<any[]> {
  return [];
}

使用 DTO

这里我们使用DTO（数据传输对象）架构，可以使代码更美观

export class CreateCatDto {
  name: string;
  age: number;
  breed: string;
}

我们使用在控制器里

@Post()
async create(@Body() createCatDto: CreateCatDto) {
  return 'This action adds a new cat';
}

完整的例子

cats.controller.ts

import { Controller, Get, Query, Post, Body, Put, Param, Delete } from '@nestjs/common';
import { CreateCatDto, UpdateCatDto, ListAllEntities } from './dto';

@Controller('cats')
export class CatsController {
  @Post()
  create(@Body() createCatDto: CreateCatDto) {
    return 'This action adds a new cat';
  }

  @Get()
  findAll(@Query() query: ListAllEntities) {
    return `This action returns all cats (limit: ${query.limit} items)`;
  }

  @Get(':id')
  findOne(@Param('id') id: string) {
    return `This action returns a #${id} cat`;
  }

  @Put(':id')
  update(@Param('id') id: string, @Body() updateCatDto: UpdateCatDto) {
    return `This action updates a #${id} cat`;
  }

  @Delete(':id')
  remove(@Param('id') id: string) {
    return `This action removes a #${id} cat`;
  }
}

app.module.ts

import { Module } from '@nestjs/common';
import { CatsController } from './cats/cats.controller';

@Module({
  controllers: [CatsController],
})
export class AppModule {}

使用响应对象

import { Controller, Get, Post, Res, HttpStatus } from '@nestjs/common';
import { Response } from 'express';

@Controller('cats')
export class CatsController {
  @Post()
  create(@Res() res: Response) {
    res.status(HttpStatus.CREATED).send();
  }

  @Get()
  findAll(@Res() res: Response) {
     res.status(HttpStatus.OK).json([]);
  }
}