你可知 Nest 装饰器?

58 阅读2分钟

Nest 通过 @Module声明模块

image.png

@Controller、@Injectable 分别声明其中的 controller 和 provider

image.png

image.png

注入的方式可以是构造器注入

image.png

或者属性注入

image.png

可以通过 useFactory、useValue 等方式声明 provider

image.png

image.png

image.png

注入的依赖如果没有,创建对象时会报错,可以使用 @Optional 变成可选

image.png

如果模块被多处使用, 用 @Global 声明为全局的

image.png

@Catch 来指定处理异常

image.png

@UseFilters 应用到 handler

image.png

image.png

interceptor、guard、pipe 也是这样用,之前有见过

image.png

pipe 更多还是单独在某个参数的位置应用

image.png

@Query 是取 url 后的 ?bbb=sss,而 @Param 是取路径中的参数,比如 /xxx/123 中的 123 image.png

@Post 请求,可以通过 @Body 取到 body 部分

image.png

image.png

image.png

image.png

除了 @Get、@Post 外,还可以用 @Put、@Delete、@Patch、@Options、@Head 装饰器分别接受 put、delete、patch、options、head 请求

handler 和 class 可以通过 @SetMetadata 指定 metadata

image.png

image.png

在 guard 或者 interceptor 里取出来

image.png

image.png

@Headers 装饰器取某个请求头 或者全部请求头

image.png

image.png

image.png

@Ip 拿到请求的 ip , @Session 拿到 session 对象

image.png

session 需要安装一个 express 中间件

npm install express-session

image.png

image.png

image.png

image.png

后续请求会带着

image.png

@HostParam 用于取域名部分的参数

nest g controller aaa --no-spec --flat

image.png

image.png

可以拿到 host

image.png

image.png

前面取的这些都是 request 里的属性,可以直接注入 request 对象

image.png

@Redirect 装饰器来指定路由重定向的 url

image.png

总结常用的装饰器

  • @Module: 声明 Nest 模块
  • @Controller:声明模块里的 controller
  • @Injectable:声明模块里可以注入的 provider
  • @Inject:通过 token 手动指定注入的 provider,token 可以是 class 或者 string
  • @Optional:声明注入的 provider 是可选的,可以为空
  • @Global:声明全局模块
  • @Catch:声明 exception filter 处理的 exception 类型
  • @UseFilters:路由级别使用 exception filter
  • @UsePipes:路由级别使用 pipe
  • @UseInterceptors:路由级别使用 interceptor
  • @SetMetadata:在 class 或者 handler 上添加 metadata
  • @Get、@Post、@Put、@Delete、@Patch、@Options、@Head:声明 get、post、put、delete、patch、options、head 的请求方式
  • @Param:取出 url 中的参数,比如 /aaa/:id 中的 id
  • @Query: 取出 query 部分的参数,比如 /aaa?name=xx 中的 name
  • @Body:取出请求 body,通过 dto class 来接收
  • @Headers:取出某个或全部请求头
  • @Session:取出 session 对象,需要启用 express-session 中间件
  • @HostParm: 取出 host 里的参数
  • @Req、@Request:注入 request 对象
  • @Res、@Response:注入 response 对象,一旦注入了这个 Nest 就不会把返回值作为响应了,除非指定 passthrough 为true
  • @Next:注入调用下一个 handler 的 next 方法
  • @HttpCode: 修改响应的状态码
  • @Header:修改响应头
  • @Redirect:指定重定向的 url
  • @Render:指定渲染用的模版引擎