Angular用 Interceptors 来统一处理 HTTP请求和响应比如加token

Web 开发中,除了数据操作之外,最频繁的就是发起和处理各种 HTTP 请求了,加上 HTTP 请求又是异步的,如果在每个请求中来单独捕获各种常规错误,处理各类自定义错误,那将会有大量的功能类似的代码,或者使用丑陋的方法在每个请求中调用某几个自定义的函数来处理。这两种方法基本都不是靠谱之选。好在 AngularJS 提供了 Interceptors ——拦截战斗机——来对应用内所有的 XHR 请求进行统一处理。

主要功能

Interceptors 有两个处理时机,分别是:

  • 其它程序代码执行 HTTP 请求之后,在实际从浏览器发出请求之前,即处理请求
  • 得到请求的响应之后,在交给其它程序代码处理之前,即处理请求的响应

所以,不难理解它可以用于如下几个方面:

  • 全局处理错误
  • 统一进行身份验证一类的处理
  • 对所有发出去的请求进行预处理
  • 对所有收到的响应进行预处理
  • 做一些增强用户体验的操作,例如显示一个进度条

基本使用

先来看看最基本的使用:

<code>var app = angular.module('app', []);

// 定义一个 Service ,稍等将会把它作为 Interceptors 的处理函数

app.factory('HttpInterceptor', ['$q', HttpInterceptor]);

function HttpInterceptor($q) {
return {
request: function(config){
config.headers = config.headers || {};
if ($localStorage.token) {
config.headers.token = $localStorage.token;
// config.headers['X-Access-Token'] = $localStorage.token;
};
return config || $q.when(config)
return config;
},
requestError: function(err){
return $q.reject(err);
},
response: function(res){
return res;
},
responseError: function(err){
if(-1 === err.status) {
// 远程服务器无响应
} else if(500 === err.status) {
// 处理各类自定义错误
} else if(501 === err.status) {
// ...
}
return $q.reject(err);
}
};
}

// 添加对应的 Interceptors
app.config(['$httpProvider', function($httpProvider){
$httpProvider.interceptors.push(HttpInterceptor);
}]);
/<code>

使用还是比较简单的,但是* 需要注意是拦截的请求只能是通过angular中的$http发送的请求和响应才能被httpInterceptor拦截,ajax发送或其他方式的请求不能够被httpInterceptor拦截! *,所以当使用其他方式发送请求时,在httpInterceptor中不能被拦截的时候要清楚这一点。如果使用ajax发送请求,就需要在ajax中的success和error中单独进行处理

实际的 Interceptor 处理函数中, return 了一个包含四个成员的对象,这四个成员都 不是必须 的,可以按实际情况指定一二,分别如下:

  • request :接收一个参数,它是 $http 中的标准 config 对象,同时也需要返回一个标准 config ,此时可以添加各类身份验证信息,同时也可在此启动进度条
  • requestError :当有多个 Interceptor 的时候, requestError 会在前一个 Interceptor 抛出错误或者执行 $q.reject() 时执行,接收的参数就对应的错误
  • response :接受一个请求对象参数,可以不处理就直接返回,此时也可以将进度条显示为成功完成,当然,如果后端 API 返回自定义错误时,HTTP 的状态码仍然是 200 得话,便在这里处理自定义错误,也可以对返回数据做一些处理,注意要将进度条置为完成
  • responseError :这个是重头戏,即可以处理标准的 Http 错误,如服务器没有响应时,或者 PHP 之类的 CGI 经常出现的 502 一类,还可以处理 HTTP 状态码不是 200 的各类自定义错误

上面四个中,前两个是请求的前置处理,后两个是针对请求的响应的处理。


分享到:


相關文章: