在angular中的网络请求拦截器

为什么要新建请求拦截器?

在开发中,要对请求的网络状态进行统一管理,比如一些需要全局处理的请求加添加或者过滤相应的参数,就可以在拦截器中做相应的操作,对状态码的监控做出相应的操作,对网络请求做用户身份的验证等等。在VUE中请求方面的封装都是基于axios插件,一样的有网络请求拦截器,只不过angular是拦截器是自身的功能,不需要借助第三方插件

通过angular-cli中命令创建interceptor拦截器

    ng g interceptor net/interceptor

此时在net文件目录下就新建了一个interceptor.interceptor.ts文件

提供这个拦截器

这个 Interceptor 就是一个由 Angular 依赖注入 (DI)系统管理的服务。 像其它服务一样,你也必须先提供这个拦截器类,应用才能使用它。

由于拦截器是 HttpClient服务的(可选)依赖,所以你必须在提供 HttpClient的同一个(或其各级父注入器)注入器中提供这些拦截器。 那些在 DI 创建完 HttpClient 之后再提供的拦截器将会被忽略。

由于在 AppModule 中导入了 HttpClientModule,导致本应用在其根注入器中提供了 HttpClient。所以你也同样要在 AppModule 中提供这些拦截器。

在从 @angular/common/[http](https://angular.cn/api/common/http) 中导入了 HTTP_INTERCEPTORS 注入令牌之后,编写如下的 Interceptor 提供者注册语句:

注意 multi: true 选项。 这个必须的选项会告诉 Angular ,HTTP_INTERCEPTORS 是一个多重提供者的令牌,表示它会注入一个多值的数组,而不是单一的值。

也可以直接把这个提供者添加到 AppModule 中的提供者数组中,不过那样会非常啰嗦。况且,你将来还会用这种方式创建更多的拦截器并提供它。

创建的文件内容如下

import { Injectable } from '@angular/core';
import {
  HttpRequest,
  HttpHandler,
  HttpEvent,
  HttpInterceptor,
} from '@angular/common/http';
import { Observable, of } from 'rxjs';

@Injectable()
export class InterceptorInterceptor implements HttpInterceptor {

  constructor() {}

  intercept(req: HttpRequest<any>, next: HttpHandler): Observable<HttpEvent<any>> {
    return next.handle(req)
  }
}

intercept 方法会把请求转换成一个最终返回 HTTP 响应体的 Observable。 在这个场景中,每个拦截器都完全能自己处理这个请求。
假如我们要对请求地址做统一处理,或者是对请求体模式的修改,我们可以调用 req.clone({})方式,完全复制一份请求体,这是req参数是一个HttpRequest对象,我们来看下这个对象里面又啥请求提内容,打印看看

image.png

我们发现这个对象是我们要请求的一些参数,例如header,url,method,等等,假如我们要修改请求前的地址我们可以如下设置

 intercept(res: HttpRequest<any>, next: HttpHandler): Observable<HttpEvent<any>> {
     let newReq=req.clone({
         url:`api/${req.url}`,
     })
    return next.handle(newReq)
  }

默认不需要改的参数,我们不许添加,只需要添加要改的参数,可以查看官方文档关于(HttpRequest)[https://angular.cn/api/common/http/HttpRequest
]类的参数用法

image.png

统一捕捉请求结果

因为intercept方法返回的是一个Observable流对象,基本的错误状态码返回结果需要做处理,我们要进行拦截处理,还有是正常接口返回,特殊status状态码为200,但是后台又自定义code参数返回的信息进行相应操作的,,我们可以新建一个handleData方法来做这个接口返回的统一处理

首先来看看错误的状态码返回时的捕捉

我在后台返回了一个错误的状状态码

router.post('/auth', function(req, res, next) {
  res.status(400).send('Bad Request')
});

然后拦截器中方需要这样如下配置

 intercept(req: HttpRequest<any>, next: HttpHandler): Observable<HttpEvent<any>> {
    return next.handle(req).pipe(
      catchError((err:HttpErrorResponse)=>this.handleData(err))
    )
  }

  private handleData(req:HttpErrorResponse){
       console.log(req);
       return of(req)
  }

此时我们访问这个报400的接口看会捕捉到什么


image.png

我们再来说说以上配置具体参数,因为我们捕获的是一个HttpResponse对象所以,调用handleData方法传过来的是一个httpRespose类,最后为啥要retrue of(req) ,因为我们的 intercept() 方法定义函数时会返回一个Observable流,所以我们需要返回,并且需要用of()流方法发出我们的返回值。
我们的打印那里已经捕捉了具体的status,以及具体的返回参数此时,假如我要在此处判断status做一个弹框处理

  private handleData(res: HttpErrorResponse): Observable<any> {
    console.log(res);
    switch (res.status) {
      case 400:
         this.$commom.error(res.error)
        break;
      default:
    }
    return of(res)
  }

此时遇到状态码为400的时候就会弹出错误提示框,或者在default中不管是什么错误状态码都弹框,这种拦截比较好处理,,还有一种接口类型是大部分的接口状态码返回都是200,然后在返回参数里加code区分,这种就比较难处理了,此时我们需要修改下拦截器代码


image.png
image.png
   intercept(req: HttpRequest<any>, next: HttpHandler): Observable<HttpEvent<any>> {
    return next.handle(req).pipe(
       tap((event:any)=>{
          if(event instanceof HttpResponseBase) this.handleData(event);
           return of(event)
       }),
      catchError((err:HttpErrorResponse)=> this.handleData(err))
    )
  }

  private handleData(res: HttpResponseBase): Observable<any> {
    console.log(res);
    let body=(res as any).body;
    if(body.code != 200){
       this.$commom.error(body.message);  
    }
    return of(res)
  }

这个handleData方法是错误函数,所以它的形参是HttpErrorResponse,但是我们的请求成功也需要拦截做些处理,所以这里的形参只能写HttpResponseBase,HttpResponseBase是HttpErrorResponse和HttpResponse的父类,我们可以打印下status为200和status为其他状态码,拦截返回的显示


image.png

成功与错误状态码接口返回的参数是不一样的,所以我们handleData方法的i形参用HttpResponseBase
针对返回参数的不同,我们需要改动一下代码

import { Injectable } from '@angular/core';
import {
  HttpRequest,
  HttpHandler,
  HttpEvent,
  HttpInterceptor,
  HttpResponse,
  HttpErrorResponse,
} from '@angular/common/http';
import { merge, Observable, of } from 'rxjs';
import { catchError, tap } from 'rxjs/operators'
import { CommonService } from '../services/common.service';
import { HttpResponseBase } from '@angular/common/http';
@Injectable()
export class InterceptorInterceptor implements HttpInterceptor {

  constructor(private $commom: CommonService) { }

  intercept(req: HttpRequest<any>, next: HttpHandler): Observable<HttpEvent<any>> {
    return next.handle(req).pipe(
      tap((event: any) => {
        if (event instanceof HttpResponseBase) this.handleData(event);
        return of(event)
      }),
      catchError((err: HttpErrorResponse) => this.handleData(err))
    )
  }

  private handleData(res: HttpResponseBase): Observable<any> {
    console.log(res);
    if (res instanceof HttpResponse) {
      let body = (res as any).body;
      if (body.code != 200) {
        this.$commom.error(body.message);
      }
      if (body.code === 1003) {
          /**todo  =>  jump()*/
      }
    }
    if (res instanceof HttpErrorResponse) {
      this.$commom.error(res.error);
    }
    return of(res)
  }
}

image.png
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,293评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,604评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,958评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,729评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,719评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,630评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,000评论 3 397
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,665评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,909评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,646评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,726评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,400评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,986评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,959评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,197评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,996评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,481评论 2 342

推荐阅读更多精彩内容