Controllers（控制器）

控制器负责处理传入的请求并返回对客户的响应。 alt text

控制器的目的是接收该应用程序的特定请求.路由机制控制哪个控制器接受哪个请求，每个控制器都有多个路由，不同的路由可以执行不同的操作。为了创建基本控制器，我们使用类和装饰器（decorators）。基于元数据的装饰器与类做关联，创建一个Nest的路由映射图。（绑定请求到对应的控制器上）。

TIP

如果你想快速的创建一个使用内置验证器（validation）的CRUD应用，你可以使用NEST CLI生成器的能力。 nest g resource [name].

Routing（路由）

下面的例子中，我们会使用@Controller()装饰符，它被用来定义一个Controller（控制器）。我们将指定一个前缀是cats的路由。这种形式可以让我们快速的对路由进行分组，同时降低代码重复。

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

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

使用CLI快速创建一个Controller

nest g controller [name]

在上面的示例中，当向此终端发出get请求时，则会请求到用户预先定义的findAll方法。这个方法会返回status code（状态码）为200的相关的响应，在这里就是一个字符串。这是如何发生的？为了解释，我们首先介绍Nest采用两种不同选择来操纵响应的概念：

Standard 标准式 这种模式下，当一个handler（处理器）内部返回一个JS对象或者数组，将自动将其转换为JSON。当返回JS的原生类型（String Number Boolean etc...）,Nest不会做任何处理。
此外StatusCode一般都是200，除了POST请求使用201。我们可以改变这个行为通过@HttpCode()装饰器。
Library-specific 具体库模式 我们可以使用具体的库的（eg,Express）响应对象。可以在handler的签名上使用@Res()装饰器 (e.g., findAll(@Res() response)).通过这种形式你可以使用被那个对象暴露的原生的响应处理方法。比如在Express中，你可这么写response.status(200).send().

WARNING

当你使用@Res @Next装饰符的时候，NEST就认为你使用library-specific mode.此时standard mode就被禁用了。如果要同时使用这两种模式（比如通过注入对象只是去设置Cookie/headers,但是剩下的工作仍然交给框架）你必须设置passthrough为true. @Res({ passthrough: true })

Request object （请求对象）

handler通常需要访client请求数据。通常我们使用@Req()装饰器。

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';
  }
}

TIP

为了发挥express的类型优势，需要安装@types/express package。

Request object不仅代表了HTTP请求而且有request query string, parameters, HTTP headers, 和 body (read more here)这么多属性。一般情况下不需要你手动去获取他们。我们可以直接使用独立的装饰器比如@Body() or @Query() 下面是一些常用的装饰器列表 alt text

为了兼容多基础平台(eg. express and fastify),Nest提供了@Res @Response() 装饰符@Res是@Response的别名。这两个都可以直接暴露原生的response对象。当使用原生对象的时候，你应该同时导入其TS类型，以发挥类型优势。注意当你在一个方法中注入@Res或@Response时，此时该Handler就变成了Library-specific mode，所以需要你去管理你自己的response.

Resources

之前，我们已经定义了一个endpoint去获取resource(get route). 一般情况下我们也想提供一个创建新records的endpoint.对于这种需求，我们创建一个post的handler

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';
  }
}

我们很容易就能做到这些事。Nest提供了很多注解。@Get(), @Post(), @Put(), @Delete(), @Patch(), @Options(), and @Head()另外@All注解定义了一个可以处理他们所有情况的能力。

Route wildcards (路由通配符)

基于路由的模式也是支持的。例如*通配符将匹配如何字符

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

“abcd”路径路径将与abcd，ab_cd，abecd等匹配。字符?, +, *,()都能被使用。（The characters ?, +,, and () may be used in a route path, and are subsets of their regular expression counterparts）。连字符 - 和点. 是通过基于字符串的路径来解释的。

WARNING

路由中间的通配符只被express支持

Status code

默认情况下的状态码都是200。除了POST请求是201.我们可以使用@HttpCode来改变这个行为

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

TIP

Import HttpCode from the @nestjs/common package.

一般来说status code是取决于各种因素的，不能是静态的。这种情况下你可以使用library-specific mode,注入response对象(inject using @Res()) ,或者万一异常了，抛出异常。

Headers

指定一个自定的响应头。可以使用@Header() decorator或者res.header()

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

TIP

Import Header from the @nestjs/common package.

Redirection

使用@Redirect做重定向或者call res.redirect() directly@Redirect有两个参数，一个是URL，另一个是statusCode。且都是可选的。默认的状态码是302.

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

TIP

有可能你想动态设置http code和redirect url。你只需返回一个遵守HttpRedirectResponse接口的对象即可。返回的值将会重写@Redirect()里的参数。


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

Route parameters 路由参数

如果你要接受客户端的参数(e.g., GET /cats/1 去获取id 1),我们可以使用如下方式在@Get装饰符中的id可以在params中访问。

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

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

Sub-Domain Routing

@Controller可以设置一个host参数来要求客户端请求所携带的host和具体的值匹配。

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

WARNING

Since Fastify lacks support for nested routers, when using sub-domain routing, the (default) Express adapter should be used instead.

Scopes

对于来自不同编程语言背景的人而言,在Nest中可能有一些意外。Nest中所有的东西都是在incoming requests中被共享的。

Controllers（控制器） ​

Routing（路由） ​

Request object （请求对象） ​

Resources ​

Route wildcards (路由通配符) ​

Status code ​

Headers ​

Redirection ​

Route parameters 路由参数 ​

Sub-Domain Routing ​

Scopes ​

Controllers（控制器）

Routing（路由）

Request object （请求对象）

Resources

Route wildcards (路由通配符)

Status code

Headers

Redirection

Route parameters 路由参数

Sub-Domain Routing

Scopes