2017-03-22 20:13:24 -04:00
|
|
|
|
/**
|
|
|
|
|
* @license
|
|
|
|
|
* Copyright Google Inc. All Rights Reserved.
|
|
|
|
|
*
|
|
|
|
|
* Use of this source code is governed by an MIT-style license that can be
|
|
|
|
|
* found in the LICENSE file at https://angular.io/license
|
|
|
|
|
*/
|
|
|
|
|
|
2017-07-13 20:22:02 -04:00
|
|
|
|
import {Injectable, InjectionToken} from '@angular/core';
|
2018-02-27 17:06:06 -05:00
|
|
|
|
import {Observable} from 'rxjs';
|
2017-03-22 20:13:24 -04:00
|
|
|
|
|
|
|
|
|
import {HttpHandler} from './backend';
|
|
|
|
|
import {HttpRequest} from './request';
|
2017-07-14 06:55:45 -04:00
|
|
|
|
import {HttpEvent} from './response';
|
2017-03-22 20:13:24 -04:00
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Intercepts `HttpRequest` and handles them.
|
|
|
|
|
*
|
2018-09-04 01:33:50 -04:00
|
|
|
|
* 拦截 `HttpRequest` 并处理它们。
|
|
|
|
|
*
|
2017-03-22 20:13:24 -04:00
|
|
|
|
* Most interceptors will transform the outgoing request before passing it to the
|
|
|
|
|
* next interceptor in the chain, by calling `next.handle(transformedReq)`.
|
|
|
|
|
*
|
2018-09-04 01:33:50 -04:00
|
|
|
|
* 大多数拦截器都会在外发的请求由 `next.handle(transformedReq)` 发给拦截器链中的下一个拦截器之前,对该请求进行转换。
|
|
|
|
|
*
|
2017-03-22 20:13:24 -04:00
|
|
|
|
* In rare cases, interceptors may wish to completely handle a request themselves,
|
|
|
|
|
* and not delegate to the remainder of the chain. This behavior is allowed.
|
|
|
|
|
*
|
2018-09-04 01:33:50 -04:00
|
|
|
|
* 极少量情况下,拦截器也可能希望自己完全处理一个请求,而不再委托给拦截器链中的其它部分。这种行为也是允许的。
|
2018-04-05 17:31:44 -04:00
|
|
|
|
*
|
2018-10-19 10:06:08 -04:00
|
|
|
|
* @publicApi
|
2017-03-22 20:13:24 -04:00
|
|
|
|
*/
|
|
|
|
|
export interface HttpInterceptor {
|
|
|
|
|
/**
|
|
|
|
|
* Intercept an outgoing `HttpRequest` and optionally transform it or the
|
|
|
|
|
* response.
|
|
|
|
|
*
|
2018-09-04 01:33:50 -04:00
|
|
|
|
* 拦截外发的 `HttpRequest`,并(可选的)转换它或转换响应对象。
|
|
|
|
|
*
|
2017-03-22 20:13:24 -04:00
|
|
|
|
* Typically an interceptor will transform the outgoing request before returning
|
|
|
|
|
* `next.handle(transformedReq)`. An interceptor may choose to transform the
|
|
|
|
|
* response event stream as well, by applying additional Rx operators on the stream
|
|
|
|
|
* returned by `next.handle()`.
|
|
|
|
|
*
|
2018-09-04 01:33:50 -04:00
|
|
|
|
* 通常,拦截器将会在返回 `next.handle(transformedReq)` 之前转换外发请求。
|
|
|
|
|
* 选择器也可以选择通过在 `next.handle()` 返回的流上应用 Rx 操作符(operator)来转换响应事件流。
|
|
|
|
|
*
|
2017-03-22 20:13:24 -04:00
|
|
|
|
* More rarely, an interceptor may choose to completely handle the request itself,
|
|
|
|
|
* and compose a new event stream instead of invoking `next.handle()`. This is
|
|
|
|
|
* acceptable behavior, but keep in mind further interceptors will be skipped entirely.
|
|
|
|
|
*
|
2018-09-04 01:33:50 -04:00
|
|
|
|
* 更罕见的情况下,拦截器可以选择完全由自己处理该请求,并合成新的事件流而不是调用 `next.handle()`。
|
|
|
|
|
* 这种方式也是可以接受的,不过要记住这样做会完全忽略所有的后续拦截器。
|
|
|
|
|
*
|
2017-03-22 20:13:24 -04:00
|
|
|
|
* It is also rare but valid for an interceptor to return multiple responses on the
|
|
|
|
|
* event stream for a single request.
|
2018-09-04 01:33:50 -04:00
|
|
|
|
*
|
|
|
|
|
* 另一种同样罕见但是有用的拦截器,会为单个请求在事件流上给出多个响应对象。
|
2017-03-22 20:13:24 -04:00
|
|
|
|
*/
|
|
|
|
|
intercept(req: HttpRequest<any>, next: HttpHandler): Observable<HttpEvent<any>>;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* `HttpHandler` which applies an `HttpInterceptor` to an `HttpRequest`.
|
|
|
|
|
*
|
2018-09-04 01:33:50 -04:00
|
|
|
|
* `HttpHandler` 会把 `HttpInterceptor` 应用到 `HttpRequest` 上。
|
2017-03-22 20:13:24 -04:00
|
|
|
|
*/
|
|
|
|
|
export class HttpInterceptorHandler implements HttpHandler {
|
|
|
|
|
constructor(private next: HttpHandler, private interceptor: HttpInterceptor) {}
|
|
|
|
|
|
|
|
|
|
handle(req: HttpRequest<any>): Observable<HttpEvent<any>> {
|
|
|
|
|
return this.interceptor.intercept(req, this.next);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* A multi-provider token which represents the array of `HttpInterceptor`s that
|
|
|
|
|
* are registered.
|
|
|
|
|
*
|
2018-04-05 17:31:44 -04:00
|
|
|
|
*
|
2018-09-04 01:33:50 -04:00
|
|
|
|
* 一个多重提供商(multi-provider)令牌,它代表所有已注册的 `HttpInterceptor` 构成的数组。
|
|
|
|
|
*
|
2018-10-19 10:06:08 -04:00
|
|
|
|
* @publicApi
|
2017-03-22 20:13:24 -04:00
|
|
|
|
*/
|
|
|
|
|
export const HTTP_INTERCEPTORS = new InjectionToken<HttpInterceptor[]>('HTTP_INTERCEPTORS');
|
2017-07-13 20:22:02 -04:00
|
|
|
|
|
|
|
|
|
@Injectable()
|
|
|
|
|
export class NoopInterceptor implements HttpInterceptor {
|
|
|
|
|
intercept(req: HttpRequest<any>, next: HttpHandler): Observable<HttpEvent<any>> {
|
|
|
|
|
return next.handle(req);
|
|
|
|
|
}
|
|
|
|
|
}
|