Angular 從入坑到挖坑 - HTTP 請求概覽

時間 2020-03-23

標籤 angular http 請求概覽欄目 AngularJS 简体版

原文原文鏈接

Overview

angular 入坑記錄的筆記第四篇，介紹在 angular 中如何經過 HttpClient 類發起 http 請求，從而完成與後端的數據交互。css

對應官方文檔地址：html

Angular HttpClient

配套代碼地址：angular-practice/src/http-guide前端

Knowledge Graph

Step by Step

與後端進行數據交互

前置工做

在前端項目與後端進行數據交互時，絕大多數都是經過 HTTP 協議進行的，現代瀏覽器支持兩種方式向後端發起 HTTP 請求：XMLHttpRequest 和 fetchjquery

在之前的項目中，一般使用 jquery 的簡化版 ajax 請求向後端請求數據，歸根到底最終仍是經過 XMLHttpRequest 與後端進行數據交互git

在 Angular 中，爲了簡化 XMLHttpRequest 的使用，框架提供了 HttpClient 類來封裝 HTTP API，用來實現前端與後端的數據交互。程序員

在使用以前，首先須要在應用的根模塊中，引入 HttpClientModule 模塊，並添加到 imports 數組中github

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';

import { AppRoutingModule } from './app-routing.module';
import { AppComponent } from './app.component';

// 添加對於 HttpClientModule 模塊的引用
import { HttpClientModule } from '@angular/common/http';

@NgModule({
  declarations: [
    AppComponent
  ],
  imports: [
    BrowserModule,
    AppRoutingModule,
    HttpClientModule // 添加到根應用模塊中
  ],
  providers: [],
  bootstrap: [AppComponent]
})
export class AppModule { }
複製代碼

在須要使用到的地方，引入 HttpClient 類，而後經過依賴注入的方式注入到應用類中ajax

在一般狀況下，咱們須要將與後端進行交互的行爲封裝成服務，在這個服務中完成對於獲取到的數據的處理，以後再注入到須要使用該服務的組件中，從而確保組件中僅僅包含的是必要的業務邏輯行爲typescript

import { Injectable } from '@angular/core';

// 引入 HttpClient 類
import { HttpClient } from '@angular/common/http';

@Injectable({
  providedIn: 'root'
})
export class AntiMotivationalQuotesServicesService {

  // 經過構造函數注入的方式依賴注入到使用的類中
  constructor(private http: HttpClient) { }
}
複製代碼

import { Component, OnInit } from '@angular/core';

// 引入服務
import { AntiMotivationalQuotesServicesService } from './../services/anti-motivational-quotes-services.service';

@Component({
  selector: 'app-anti-motivational-quotes',
  templateUrl: './anti-motivational-quotes.component.html',
  styleUrls: ['./anti-motivational-quotes.component.scss']
})
export class AntiMotivationalQuotesComponent implements OnInit {

  // 經過構造函數注入的方式使用服務
  constructor(private services: AntiMotivationalQuotesServicesService) { }

  ngOnInit(): void {
  }

}
複製代碼

從服務端獲取數據

這裏使用到的後端接口是掘金上一位朋友開發的毒雞湯接口（api.tryto.cn/djt/text），全部權歸屬於小鹹魚丶編程

經過使用 postman 進行接口調用能夠發現，接口返回的響應信息以下

在項目中建立一個接口，按照後端返回的數據信息進行屬性的定義，用來映射請求的響應信息（Angular 只能將請求響應對象轉換成接口類型，不能自動轉換成類實例）

ng g interface interfaces/get-quotes-response-model
複製代碼

export interface GetQuotesResponseModel {
  /** * 接口響應碼 */
  code: number;
  /** * 響應信息 */
  msg: string;
  /** * 響應數據 */
  data: ResponseData;
  /** * 響應時間 */
  time: number;
}

/** * 接口響應的內容信息 */
interface ResponseData {
  /** * 毒雞湯 */
  content: string;
  /** * 熱度 */
  hots: number;
}
複製代碼

在服務中，引入請求響應對象的接口定義，而後設定 get 請求的響應對象爲 GetQuotesResponseModel，以後在使用時就能夠以一種結構化數據的方式獲取請求返回的數據信息

import { Injectable } from '@angular/core';
import { Observable } from 'rxjs';

// 引入 HttpClient 類
import { HttpClient } from '@angular/common/http';

// 引入接口響應類
import { GetQuotesResponseModel } from '../interfaces/get-quotes-response-model';

@Injectable({
  providedIn: 'root'
})
export class AntiMotivationalQuotesServicesService {

  // 經過構造函數注入的方式依賴注入到使用的類中
  constructor(private http: HttpClient) { }

  /** * 經過 get 請求獲取毒雞湯信息 */
  getAntiMotivationalQuotes(): Observable<GetQuotesResponseModel> {
    const url = 'https://api.tryto.cn/djt/text';
    return this.http.get<GetQuotesResponseModel>(url);
  }
}
複製代碼

在組件中，經過調用注入的服務類完成接口數據的獲取，由於是以一種結構化對象的形式獲取到接口返回的數據，所以這裏能夠直接經過對象屬性獲取到指定的屬性信息

import { Component, OnInit } from '@angular/core';

// 引入服務
import { AntiMotivationalQuotesServicesService } from './../services/anti-motivational-quotes-services.service';

// 引入接口響應對象
import { GetQuotesResponseModel } from '../interfaces/get-quotes-response-model';

@Component({
  selector: 'app-anti-motivational-quotes',
  templateUrl: './anti-motivational-quotes.component.html',
  styleUrls: ['./anti-motivational-quotes.component.scss']
})
export class AntiMotivationalQuotesComponent implements OnInit {

  public quoteResponse: GetQuotesResponseModel;

  // 經過構造函數注入的方式使用服務
  constructor(private services: AntiMotivationalQuotesServicesService) { }

  ngOnInit(): void {
  }

  /** * 獲取毒雞湯 */
  getQuotes() {
    this.services.getAntiMotivationalQuotes().subscribe((response: GetQuotesResponseModel) => {
      this.quoteResponse = response;
    });
  }
}
複製代碼

由於最終須要的信息是接口返回的響應信息對象中的一個屬性，所以這裏須要使用安全導航運算符（?）來確保模板的渲染不會由於空指針錯誤而中斷

<p>
  <button (click)="getQuotes()">獲取毒雞湯</button>
</p>
<p>
  接口返回信息: {{quoteResponse | json}}
</p>
<i>
  毒雞湯：{{quoteResponse?.data?.content}}
</i>
複製代碼

在執行服務中的方法時，有時會存在沒有回調函數的狀況，此時也必須執行 subscribe 方法，不然服務中的 HTTP 請求是沒有真正發起的

服務中的 getAntiMotivationalQuotes 只能獲取到接口返回的 body 裏面的信息，某些狀況下須要獲取到完整的響應信息，此時須要經過 observe 參數來告訴 HttpClient 此方法須要返回完整的響應信息

import { Injectable } from '@angular/core';
import { Observable } from 'rxjs';

// 引入 HttpClient 類
import { HttpClient, HttpResponse } from '@angular/common/http';

// 引入接口響應類
import { GetQuotesResponseModel } from '../interfaces/get-quotes-response-model';

@Injectable({
  providedIn: 'root'
})
export class AntiMotivationalQuotesServicesService {

  // 經過構造函數注入的方式依賴注入到使用的類中
  constructor(private http: HttpClient) { }

  /** * 獲取完整的接口請求信息 */
  getAntiMotivationalQuotesResponse(): Observable<HttpResponse<GetQuotesResponseModel>> {
    const url = 'https://api.tryto.cn/djt/text';
    return this.http.get<GetQuotesResponseModel>(url, { observe: 'response' });
  }
}
複製代碼

import { HttpResponse } from '@angular/common/http';
import { Component, OnInit } from '@angular/core';

// 引入服務
import { AntiMotivationalQuotesServicesService } from './../services/anti-motivational-quotes-services.service';

// 引入接口響應對象
import { GetQuotesResponseModel } from '../interfaces/get-quotes-response-model';

@Component({
  selector: 'app-anti-motivational-quotes',
  templateUrl: './anti-motivational-quotes.component.html',
  styleUrls: ['./anti-motivational-quotes.component.scss']
})
export class AntiMotivationalQuotesComponent implements OnInit {

  public quoteResponseInfo: HttpResponse<GetQuotesResponseModel>;

  // 經過構造函數注入的方式使用服務
  constructor(private services: AntiMotivationalQuotesServicesService) { }

  ngOnInit(): void {
  }

  /** * 獲取毒雞湯接口完整的請求信息 */
  getQuotesResponse() {
    this.services.getAntiMotivationalQuotesResponse().subscribe((response: HttpResponse<GetQuotesResponseModel>) => {
      this.quoteResponseInfo = response;
    });
  }
}
複製代碼

HttpClient 默認的返回信息格式都是 json 對象，在後端接口返回的並非 json 對象的狀況下，須要手動的設置響應類型（text、blob、arraybuffer...）

import { Injectable } from '@angular/core';
import { Observable } from 'rxjs';

// 引入 HttpClient 類
import { HttpClient, HttpResponse } from '@angular/common/http';

// 引入接口響應類
import { GetQuotesResponseModel } from '../interfaces/get-quotes-response-model';

@Injectable({
  providedIn: 'root'
})
export class AntiMotivationalQuotesServicesService {

  // 經過構造函數注入的方式依賴注入到使用的類中
  constructor(private http: HttpClient) { }
  
  /** * 獲取響應類型非 json 對象的信息 */
  getYuiterSitemap(): Observable<string> {
    const url = 'https://yuiter.com/sitemap.xml';
    return this.http.get(url, { responseType: 'text' });
  }
}
複製代碼

提交數據到服務端

在同後端接口進行交互時，獲取數據通常用的是 get 請求，而當進行數據新增、更新、刪除時則會使用 post、put、delete 這三個 HTTP 謂詞

在毒雞湯這個接口中，可使用 post 方式調用 api.tryto.cn/djt/submit 進行毒雞湯的提交

根據 postman 的調用示例，在服務中定義一個方法用來提交毒雞湯信息，這裏的 SetQuotesResponseModel 爲接口返回的響應對象

import { Injectable } from '@angular/core';
import { Observable } from 'rxjs';

// 引入 HttpClient 類
import { HttpClient, HttpResponse } from '@angular/common/http';

// 引入接口響應類
import { SetQuotesResponseModel } from '../interfaces/set-quotes-response-model';

@Injectable({
  providedIn: 'root'
})
export class AntiMotivationalQuotesServicesService {

  // 經過構造函數注入的方式依賴注入到使用的類中
  constructor(private http: HttpClient) { }

  /** * 提交毒雞湯信息 * @param content 毒雞湯 */
  submitAntiMotivationalQuote(content: string): Observable<SetQuotesResponseModel> {
    const url = 'https://api.tryto.cn/djt/submit';
    return this.http.post<SetQuotesResponseModel>(url, {
      content
    });
  }
}
複製代碼

由於這裏是以默認的表單提交的方式進行的數據提交，當後端須要修改請求的 body 格式時，則須要咱們修改請求的 MIME 類型

當須要更改請求的 MIME 類型或是須要添加受權訪問的 token 信息這一類的操做時，須要在使用 HttpClient 提供的請求方法時添加上 HTTP 請求頭配置信息

import { Injectable } from '@angular/core';
import { Observable } from 'rxjs';

// 引入 HttpClient 類
import { HttpClient, HttpResponse, HttpHeaders } from '@angular/common/http';

@Injectable({
  providedIn: 'root'
})
export class AntiMotivationalQuotesServicesService {

  // 經過構造函數注入的方式依賴注入到使用的類中
  constructor(private http: HttpClient) { }

  public httpOptions = {
    headers: new HttpHeaders({
      'Content-Type': 'application/json',
      'Authorization': 'token'
    })
  };

  /** * 修改請求頭信息 */
  submitWithOptions() {
    const url = '';
    return this.http.post(url, {
      data: ''
    }, this.httpOptions);
  }
}
複製代碼

捕獲錯誤信息

獲取錯誤信息

在涉及到先後端交互的過程當中，不可避免會出現各類情況，在出現錯誤時，能夠在 subscribe 方法中，添加第二個回調方法來獲取錯誤信息

getQuotes() {
    this.services.getAntiMotivationalQuotes().subscribe((response: GetQuotesResponseModel) => {
      this.quoteResponse = response;
    }, error => {
      console.error(error);
    });
}
複製代碼

在處理錯誤信息的回調方法中，方法返回了一個 HttpErrorResponse 對象來描述錯誤信息

由於這裏的錯誤更可能是服務在與後端進行通訊產生的錯誤，所以對於錯誤信息的捕獲和處理更應該放到服務中進行，而在組件處僅顯示錯誤提示

在服務中定義一個錯誤處理器，用來處理與後端請求中發生的錯誤

import { Injectable } from '@angular/core';
import { Observable, throwError } from 'rxjs';
import { catchError, retry } from 'rxjs/operators';

// 引入 HttpClient 類
import { HttpClient, HttpResponse, HttpHeaders, HttpErrorResponse } from '@angular/common/http';

@Injectable({
  providedIn: 'root'
})
export class AntiMotivationalQuotesServicesService {

  // 經過構造函數注入的方式依賴注入到使用的類中
  constructor(private http: HttpClient) { }

  /** * 經過 get 請求獲取毒雞湯信息 */
  getAntiMotivationalQuotes(): Observable<GetQuotesResponseModel> {
    const url = 'https://api.tryto.cn/djt/text32';
    return this.http.get<GetQuotesResponseModel>(url)
      .pipe(
        catchError(this.handleError)
      );
  }

  /** * 錯誤信息捕獲處理 * @param error 錯誤信息 */
  private handleError(error: HttpErrorResponse) {

    if (error.error instanceof ErrorEvent) {
      // 客戶端自己引發的錯誤信息
      console.error(`客戶端錯誤：${error.error.message}`);
    } else {
      // 服務端返回的錯誤信息
      console.error(`服務端錯誤：HTTP 狀態碼：${error.status} \n\r 錯誤信息：${JSON.stringify(error.error)}`);
    }

    // 反饋給用戶的錯誤信息（用於組件中使用 error 回調時的錯誤提示）
    return throwError('很差的事情發生了，畢竟咱們都有不順利的時候。。。');
  }
}
複製代碼

當請求發生錯誤時，經過在 HttpClient 方法返回的 Observable 對象中使用 pipe 管道將錯誤傳遞給自定義的錯誤處理器，從而完成捕獲錯誤信息的後續操做

請求重試

某些狀況下存在由於特殊緣由致使短期的請求失敗，這時能夠在 pipe 管道中，當請求失敗後，使用 retry 方法進行屢次的請求重試，在進行了屢次重試後仍是沒法進行數據通訊後，則進行錯誤捕獲

getAntiMotivationalQuotes(): Observable<GetQuotesResponseModel> {
    const url = 'https://api.tryto.cn/djt/text32';
    return this.http.get<GetQuotesResponseModel>(url)
      .pipe(
        retry(3), // 重試三次
        catchError(this.handleError) // 捕獲錯誤信息
      );
}
複製代碼

請求和響應攔截

在向服務器發起請求時，通常是須要咱們在請求頭中添加上受權的 token 信息，與其當後端接口返回咱們無權訪問時再來處理，是否是能夠在發起請求前去進行攔截判斷，若是不包含 token 信息，則將容許訪問的 token 信息添加到請求中

一樣的，當已經定義好後端返回什麼信息表明請求出錯 or 直接根據後端返回的請求狀態碼判斷請求出錯時，徹底能夠經過對接口返回的響應進行攔截，直接攔截掉請求出錯的狀況，從而不須要在後續的業務邏輯代碼中再進行判斷請求是否成功

自定義攔截器

在 Angular 中能夠新建一個繼承於 HttpInterceptor 接口的攔截器類，經過實現 intercept 方法來對請求進行攔截處理

與 ASP.NET Core 中的中間件類似，咱們能夠在請求中添加多個的攔截器，構成一個攔截器鏈。當一個攔截器已經處理完成時，須要經過 next 對象將 HTTP 請求傳遞到下一個攔截器，不然，整個請求將會中斷。若是當前的攔截器已是整個攔截器鏈的最後一個，則會將請求發送到後端接口

import { HttpInterceptor, HttpRequest, HttpHandler, HttpEvent, HttpResponse } from '@angular/common/http';
import { Observable } from 'rxjs/internal/Observable';
import { Injectable } from '@angular/core';
import { tap, finalize } from 'rxjs/operators';

/** * 經過添加 Injectable 特性，代表能夠經過依賴注入的方式進行建立 */
@Injectable()
export class LoggingInterceptor implements HttpInterceptor {
  /** * 請求攔截 * @param req http 請求 * @param next 下一個攔截器 */
  intercept(req: HttpRequest<any>, next: HttpHandler): Observable<HttpEvent<any>> {

    // 開始時間
    const started = Date.now();

    let msg: string;

    // 將 http 請求信息傳遞給下一個攔截器
    return next.handle(req)
      .pipe(
        tap(
          // 捕獲當前請求是否成功 or 失敗

          // 一、經過判斷響應的類型是否爲 HttpResponse 來判斷請求是否成功
          event => msg = event instanceof HttpResponse ? '請求成功' : '請求失敗',

          // 二、若是存在了 error 回調，則請求失敗
          error => msg = '請求失敗'
        ), finalize(() => {
          const elapsed = Date.now() - started;
          console.log(`請求方式：${req.method} 請求地址：${req.urlWithParams} 響應耗時：${elapsed} ms 請求結果：${msg}`);
        }));
  }
}
複製代碼

當定義好攔截器後，與其它的自定義服務同樣，咱們須要添加到根模塊的 providers 中，由於可能會存在定義多個攔截器的狀況，這裏能夠經過定義一個 typescript 文件用來導出咱們須要添加的攔截器信息

由於會存在定義多個攔截器的狀況，因此這裏須要指定 multi 屬性爲 true

import { HTTP_INTERCEPTORS } from '@angular/common/http';

// 須要添加的攔截器
import { LoggingInterceptor } from './logging-interceptor';

// 返回的攔截器數組
export const HttpInterceptorProviders = [
  { provide: HTTP_INTERCEPTORS, useClass: LoggingInterceptor, multi: true }
];
複製代碼

因爲攔截器具備將發送到服務端的 HTTP 請求進行監視、轉化，以及攔截請求的響應信息的雙重效果，所以當咱們註冊了多個攔截器時，在發送請求時會按照咱們添加的順序進行執行，而在接受到請求響應時，則是按照反過來的順序進行執行

獲取到導出的攔截器信息，就能夠在根模塊中去導入須要註冊的攔截器

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { FormsModule } from '@angular/forms';

import { AppRoutingModule } from './app-routing.module';
import { AppComponent } from './app.component';

// 添加自定義攔截器
import { HttpInterceptorProviders } from './http-interceptors/http-interceptor-providers';

@NgModule({
  declarations: [
    AppComponent,
    AntiMotivationalQuotesComponent
  ],
  imports: [
    BrowserModule,
    AppRoutingModule,
    FormsModule,
    HttpClientModule // 添加到根應用模塊中
  ],
  providers: [
    HttpInterceptorProviders
  ],
  bootstrap: [AppComponent]
})
export class AppModule { }
複製代碼

修改請求信息

因爲一個請求可能會存在重試發起的狀況，爲了確保屢次發起請求時的請求信息的不變性，對於 HttpRequest 和 HttpResponse 咱們是不能夠修改原始的對象屬性值的

當咱們須要對請求進行修改時，例如在請求的 header 中添加上 token 信息，此時咱們須要先克隆一個原始的請求對象，在這個克隆後的請求上進行操做，最終將這個克隆後的請求傳遞給下一個攔截器

import { HttpInterceptor, HttpRequest, HttpHandler, HttpEvent, HttpResponse } from '@angular/common/http';
import { Observable } from 'rxjs/internal/Observable';
import { Injectable } from '@angular/core';
import { tap, finalize } from 'rxjs/operators';

/** * 經過添加 Injectable 特性，代表能夠經過依賴注入的方式進行建立 */
@Injectable()
export class LoggingInterceptor implements HttpInterceptor {
  /** * 請求攔截 * @param req http 請求 * @param next 下一個攔截器 */
  intercept(req: HttpRequest<any>, next: HttpHandler): Observable<HttpEvent<any>> {

    // 開始時間
    const started = Date.now();

    let msg: string;

    // 打印原始的請求信息
    console.log(`原始的請求信息：${JSON.stringify(req.headers)}`);

    // 獲取請求中的 token 信息
    const token = req.headers.get('Authorization') || '';

    // 克隆請求信息
    const authReq = req.clone({
      headers: token === '' ? req.headers.set('Authorization', '123456') : req.headers
    });

    // 打印修改後的請求信息
    console.log(`克隆後的請求信息：${JSON.stringify(authReq.headers)}`);

    // 將克隆後的 http 請求信息傳遞給下一個攔截器
    return next.handle(authReq)
      .pipe(
        tap(
          // 捕獲當前請求是否成功 or 失敗

          // 一、經過判斷響應的類型是否爲 HttpResponse 來判斷請求是否成功
          event => msg = event instanceof HttpResponse ? '請求成功' : '請求失敗',

          // 二、若是存在了 error 回調，則請求失敗
          error => msg = '請求失敗'
        ), finalize(() => {
          const elapsed = Date.now() - started;
          console.log(`請求方式：${req.method} 請求地址：${req.urlWithParams} 響應耗時：${elapsed} ms 請求結果：${msg}`);
        }));
  }
}
複製代碼

佔坑

        做者：墨墨墨墨小宇
        我的簡介：96年生人，出生於安徽某四線城市，畢業於Top 10000000 院校。.NET程序員，槍手死忠，喵星人。於2016年12月開始.NET程序員生涯，微軟.NET技術的堅決堅持者，立志成爲雲養貓的少年中面向谷歌編程最厲害的.NET程序員。
        我的博客：yuiter.com
        博客園博客：www.cnblogs.com/danvic712