参数装饰器

Request

处理程序有时需要访问客户端的请求细节。Http-Typedi 提供了对底层平台请求对象（request）的访问方式。我们可以在处理函数的签名中使用 @Req() or @Request() 装饰器，指示 Http-Typedi 将请求对象注入处理程序。

demo.controller.ts

import { Controller, PostMapping, Req } from 'http-typedi'
import { DemoService } from './demo.service'
import { DemoReq, DemoRes } from './interfaces/demo.interface'

@Controller('demo')
export class DemoController {
  constructor(private demoService: DemoService) {}

  @PostMapping('updateDetail')
  async updateDemoDetail(@Req() demo: DemoReq): ServerRes<DemoRes> {
    return this.demoService.updateDemoDetail(demo)
  }
}

@Request() / @Req()会返回RequestConfig这个接口，就像下面这样

interface RequestConfig<R = unknown> {
  url?: string
  method?: 'GET' | 'HEAD' | 'POST' | 'DELETE' | 'OPTIONS' | 'PUT'
  headers?: Record<string, any>
  params?: R
  data?: R
  timeout?: number
  timeoutCallback?(): void
}

Request 对象代表 HTTP 请求，并具有查询字符串，请求参数参数，HTTP 标头（HTTP header） 和 正文（HTTP body）的属性。在多数情况下，不必手动获取它们。 我们可以使用专用的装饰器，比如开箱即用的 @Body() 或 @Param() 或 @Headers()。

Body

使用@Body()装饰器之后，会将RequestConfig这个接口的data属性提取出来，就像下面这样

@PostMapping('updateDetail')
async updateDemoDetail(@Body() demo: DemoReq): ServerRes<DemoRes> {
  return this.demoService.updateDemoDetail(demo)
}

Headers

使用@Headers()装饰器之后，会将RequestConfig这个接口的headers属性提取出来，就像下面这样

@PostMapping('updateDetail')
async updateDemoDetail(@Headers() demo: DemoReq): ServerRes<DemoRes> {
  return this.demoService.updateDemoDetail(demo)
}

Param

使用@Param()装饰器之后，会将RequestConfig这个接口的params属性提取出来，就像下面这样

@GetMapping('updateDetail')
async updateDemoDetail(@Param() demo: DemoReq): ServerRes<DemoRes> {
  return this.demoService.updateDemoDetail(demo)
}

上述使用方式是直接提取HTTP请求的一些细节参数，其实还可以通过传入的token再次提取指定参数，也可以绑定上管道(自定义管道)进行过滤，下面我们来看一个例子：

import { Controller, PostMapping, GetMapping, Body } from 'http-typedi'
import { DemoService } from './demo.service'
import { DemoReq, DemoRes } from './interfaces/demo.interface'

@Controller('demo')
export class DemoController {
  constructor(private demoService: DemoService) {}

  @PostMapping('updateDetail')
  async updateDemoDetail(@Body('id') demo: DemoReq): ServerRes<DemoRes> {
    return this.demoService.updateDemoDetail(demo)
  }

  @GetMapping('getdetail')
  async getDemoDetail(@Param('id', new DefaultValuePipe(1)) demo: DemoReq): ServerRes<DemoRes> {
    return this.demoService.getDemoDetail(demo)
  }
}

我们先说updateDemoDetail这个路由使用@Body装饰器传递了一个id参数，那么Http-Typedi就会根据传入的这个参数当作token去通过@Body装饰器返回的data参数中去匹配参数名为id键。并返回对应的value。@Req、@Request、@Param、@Headers都支持此用法。

getDemoDetail我们使用@Param装饰器传递了一个id参数，并且还传入了第二个参数，默认第一个参数为token，剩余的参数为pipes，pipes会被http-typedi统一收集起来，这里我们使用了Http-typedi的管道pipes。上面通过传入的id这个参数当作token去通过@Body装饰器返回的data参数中去匹配参数名为id键，如果没找到。则使用DefaultValuePipe传入的value当作value返回。类似于JavaScript函数形参默认值的写法。