Nest - Rx.js在http请求中的应用

title: Nest中的Http请求

Nest 底层使用的 Http 模块为 axios,又使用了 rxjs 添加了流程控制。

下面我们会介绍一些 Http 请求中通常碰到的一些场景。

city 接口返回值:

{
    result: true,
    data: [
      {
        id: 'a',
        val: '上海',
      },
      {
        id: 'b',
        val: '苏州',
      },
      {
        id: 'c',
        val: '南京',
      },
    ]
}

position 接口返回值:

{
    result: true,
    data: [
      {
        value: 'a',
        label: '经理',
        location: {
          city: '北京',
        },
      },
      {
        value: 'b',
        label: '员工',
        location: {
          city: '上海',
        },
      },
    ]
}

发送 city 请求

import { Controller, Get, HttpService } from '@nestjs/common';
import { Observable } from 'rxjs';
import { map } from 'rxjs/operators';

interface ICity {
  id: string;
  val: string;
}

interface IReturn {
  result: boolean;
  data: ICity[];
}

@Controller()
export class AppController {
  constructor(private readonly httpService: HttpService) {}

  @Get('/city')
  city(): Observable<IReturn> {
    return this.httpService.get('/example/city').pipe(
      map(res => res.data)
    );
  }
}

知识点:

1. map 是 rxjs 里面的一个操作符，官方解释为对源 observable 的每个值应用投射函数。
   实际就是传入一个函数，对返回值进行修改。
2. map 里面的 res 并不是 city 接口的返回值，而且 axios 请求的返回体。里面的 data 才是真正的接口返回值,部分打印片段:

{
  status: 200,
  statusText: 'OK',
  headers: {
    'x-powered-by': 'Express',
    'access-control-allow-origin': '*',
    'content-type': 'application/json; charset=utf-8',
    'content-length': '136',
    etag: 'W/"88-FSoOKRSwMXq6BELiU+RK55SLx/8"',
    date: 'Wed, 28 Apr 2021 09:41:52 GMT',
    connection: 'close'
  },
  config: {
    url: '/example/city',
    method: 'get',
    headers: {
      Accept: 'application/json, text/plain, */*',
      'User-Agent': 'axios/0.19.2'
    },
    baseURL: 'http://127.0.0.1:3001',
    transformRequest: [ [
    ....
  },
  data: {
    result: true,
    data: [ [Object], [Object], [Object] ],
    time: '2021-04-28T09:41:52.821Z'
  }
}

并发请求 city 和 position 接口并返回

  @Get('/forkJoin')
  combine() {
    const cityAjax = this.httpService.get('/example/city').pipe(
      map(res => res.data),
      catchError(e => {
        throw new HttpException(`city请求错误`, 400);
      }),
    );
    const positionAjax = this.httpService.get('/example/position').pipe(
      map(res => res.data),
      catchError(e => {
        throw new HttpException(`position请求错误`, 400);
      }),
    );
    return forkJoin([cityAjax, positionAjax]).pipe(
      map(res => {
        return ['city', 'position'].map((key, index) => {
          if (res[index].result === false)
            throw new HttpException(`${key}请求错误`, 400);
          return {
            key,
            data: res[index].data,
          };
        });
      }),
    );
  }

知识点:

1. forkJoin的用法类似 promise.all
2. 定义 ajax 请求时 catchError 捕获的错误是 http 请求的错误，也就是 http statusCode 非 200 时的报错，
   对于自定义错误，我们则需要在 pipe(map)的返回值里面判断并且抛错

有顺序依赖的多个请求

先请求 city，拿到它的返回值，再请求 position

  @Get('/mergeMap')
  mergeMap() {
    return this.httpService
      .get('/example/city')
      .pipe(
        map(res => res.data),
        catchError(e => {
          throw new HttpException('city请求错误', 400);
        }),
      )
      .pipe(
        mergeMap(cityRes => {
          if (cityRes.result === false)
            throw new HttpException(`city请求错误`, 400);
          return this.httpService.get('/example/position', { params: {} });
        }),
      )
      .pipe(
        map(res => res.data),
        catchError(e => {
          throw new HttpException('position请求错误', 400);
        }),
      );
  }

知识点:

1. mergeMap 的用法