本篇文章帶大家了解一下angular中的HttpClientModule模塊,介紹一下請(qǐng)求方法、請(qǐng)求參數(shù)、響應(yīng)內(nèi)容、攔截器、Angular Proxy等相關(guān)知識(shí),希望對(duì)大家有所幫助!
該模塊用于發(fā)送 Http
請(qǐng)求,用于發(fā)送請(qǐng)求的方法都返回 Observable
對(duì)象。
1、快速開始
1)、引入 HttpClientModule 模塊
// app.module.ts import { httpClientModule } from '@angular/common/http'; imports: [ httpClientModule ]
2)、注入 HttpClient 服務(wù)實(shí)例對(duì)象,用于發(fā)送請(qǐng)求
// app.component.ts import { HttpClient } from '@angular/common/http'; export class AppComponent { constructor(private http: HttpClient) {} }
3)、發(fā)送請(qǐng)求
import { HttpClient } from "@angular/common/http" export class AppComponent implements OnInit { constructor(private http: HttpClient) {} ngOnInit() { this.getUsers().subscribe(console.log) } getUsers() { return this.http.get("https://jsonplaceholder.typicode.com/users") } }
2、請(qǐng)求方法
this.http.get(url [, options]); this.http.post(url, data [, options]); this.http.delete(url [, options]); this.http.put(url, data [, options]);
this.http.get<Post[]>('/getAllPosts') .subscribe(response => console.log(response))
3、請(qǐng)求參數(shù)
1、HttpParams 類
export declare class HttpParams { constructor(options?: HttpParamsOptions); has(param: string): boolean; get(param: string): string | null; getAll(param: string): string[] | null; keys(): string[]; append(param: string, value: string): HttpParams; set(param: string, value: string): HttpParams; delete(param: string, value?: string): HttpParams; toString(): string; }
2、HttpParamsOptions 接口
declare interface HttpParamsOptions { fromString?: string; fromObject?: { [param: string]: string | ReadonlyArray<string>; }; encoder?: HttpParameterCodec; }
3、使用示例
import { HttpParams } from '@angular/common/http'; let params = new HttpParams({ fromObject: {name: "zhangsan", age: "20"}}) params = params.append("sex", "male") let params = new HttpParams({ fromString: "name=zhangsan&age=20"})
4、請(qǐng)求頭
請(qǐng)求頭字段的創(chuàng)建需要使用 HttpHeaders 類,在類實(shí)例對(duì)象下面有各種操作請(qǐng)求頭的方法。
export declare class HttpHeaders { constructor(headers?: string | { [name: string]: string | string[]; }); has(name: string): boolean; get(name: string): string | null; keys(): string[]; getAll(name: string): string[] | null; append(name: string, value: string | string[]): HttpHeaders; set(name: string, value: string | string[]): HttpHeaders; delete(name: string, value?: string | string[]): HttpHeaders; }
let headers = new HttpHeaders({ test: "Hello" })
5、響應(yīng)內(nèi)容
declare type HttpObserve = 'body' | 'response'; // response 讀取完整響應(yīng)體 // body 讀取服務(wù)器端返回的數(shù)據(jù)
this.http.get( "https://jsonplaceholder.typicode.com/users", { observe: "body" } ).subscribe(console.log)
6、攔截器
攔截器是 Angular 應(yīng)用中全局捕獲和修改 HTTP 請(qǐng)求和響應(yīng)的方式。(Token、Error)
攔截器將只攔截使用 HttpClientModule 模塊發(fā)出的請(qǐng)求。
ng g interceptor <name>
6.1 請(qǐng)求攔截
@Injectable() export class AuthInterceptor implements HttpInterceptor { constructor() {} // 攔截方法 intercept( // unknown 指定請(qǐng)求體 (body) 的類型 request: HttpRequest<unknown>, next: HttpHandler // unknown 指定響應(yīng)內(nèi)容 (body) 的類型 ): Observable<HttpEvent<unknown>> { // 克隆并修改請(qǐng)求頭 const req = request.clone({ setHeaders: { Authorization: "Bearer xxxxxxx" } }) // 通過回調(diào)函數(shù)將修改后的請(qǐng)求頭回傳給應(yīng)用 return next.handle(req) } }
6.2 響應(yīng)攔截
@Injectable() export class AuthInterceptor implements HttpInterceptor { constructor() {} // 攔截方法 intercept( request: HttpRequest<unknown>, next: HttpHandler ): Observable<any> { return next.handle(request).pipe( retry(2), catchError((error: HttpErrorResponse) => throwError(error)) ) } }
6.3 攔截器注入
import { AuthInterceptor } from "./auth.interceptor" import { HTTP_INTERCEPTORS } from "@angular/common/http" @NgModule({ providers: [ { provide: HTTP_INTERCEPTORS, useClass: AuthInterceptor, multi: true } ] })
7、Angular Proxy
1、在項(xiàng)目的根目錄下創(chuàng)建 proxy.conf.json 文件并加入如下代碼
{ "/api/*": { "target": "http://localhost:3070", "secure": false, "changeOrigin": true } }
/api/*:在應(yīng)用中發(fā)出的以 /api 開頭的請(qǐng)求走此代理
target:服務(wù)器端 URL
secure:如果服務(wù)器端 URL 的協(xié)議是 https,此項(xiàng)需要為 true
changeOrigin:如果服務(wù)器端不是 localhost, 此項(xiàng)需要為 true
2、指定 proxy 配置文件 (方式一)
"scripts": { "start": "ng serve --proxy-config proxy.conf.json", }
3、指定 proxy 配置文件 (方式二)
"serve": { "options": { "proxyConfig": "proxy.conf.json" }, }
該模塊用于發(fā)送 Http
請(qǐng)求,用于發(fā)送請(qǐng)求的方法都返回 Observable
對(duì)象。