Поиск по сайту:

Введение в HttpClient Angular

Angular 4.3 предлагает новый, более простой способ обработки http-запросов с помощью библиотеки HttpClient. Он доступен под новым именем, чтобы избежать критических изменений в текущей библиотеке Http. HttpClient также предоставляет нам расширенные функции, такие как возможность прослушивания событий выполнения и перехватчиков для отслеживания или изменения запросов или ответов.

Убедитесь, что вы используете Angular 4.3 или выше, чтобы попробовать HttpClient.

Монтаж

Во-первых, вам нужно импортировать HttpClientModule из @angular/common/http в модуль вашего приложения:

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

import { AppComponent } from './app.component';

Затем вы можете использовать HttpClient как обычно:

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

import { HttpClient } from '@angular/common/http';
@Injectable()
export class DataService {
  constructor(private http: HttpClient) {}

Основное использование

Выполнение базовых запросов GET, POST, PUT, PATCH или DELETE очень похоже на то, к чему вы привыкли со старым Http API. Одним из основных отличий является то, что по умолчанию ожидается ответ JSON, поэтому больше нет необходимости явно анализировать ответ JSON.

Вот пример GET-запроса:

// ...

constructor(private http: HttpClient) {}

getData() {
  this.http.get(this.url).subscribe(res => {
    this.posts = res;
  });
}

Если вы ожидаете в качестве ответа что-то другое, кроме JSON, вы можете указать ожидаемый тип ответа, используя объект с ключом responseType:

getData() {
  this.http.get(this.url, { responseType: 'text' }).subscribe(res => {
    this.data = res;
  });
}

Вы также можете определить интерфейс для формы ответа и проверить тип по этому интерфейсу:

interface Post {
  title: string;
  body: string;
};

// ...

constructor(private http: HttpClient) {}

getData() {
  this.http.get<Post>(this.url).subscribe(res => {
    this.postTitle = res.title;
  });
}

По умолчанию HttpClient возвращает текст ответа. Вы можете передать объект с помощью ключа observe со значением ‘response’, чтобы получить полный ответ. Это может быть полезно для проверки определенных заголовков:

getData() {
  this.http.get<Post>(this.url, { observe: 'response' }).subscribe(res => {
    this.powered = res.headers.get('X-Powered-By');
    this.postTitle = res.body.title;
  });
}

Публиковать, ставить и исправлять запросы

Сделать запрос POST, PUT или PATCH так же просто:

postData() {
  this.http.post(this.url, this.payload).subscribe();
}

Обратите внимание, что нам все еще нужно подписаться, чтобы запрос был сделан. Без вызова подписки запрос будет холодным. Очевидно, вы, вероятно, захотите обработать любой ответ или ошибку:

postData() {
  this.http.post(this.url, this.payload).subscribe(
    res => {
      console.log(res);
    },
    (err: HttpErrorResponse) => {
      console.log(err.error);
      console.log(err.name);
      console.log(err.message);
      console.log(err.status);
    }
  );
}

Ошибка запроса имеет тип HttpErrorResponse и содержит, среди прочего, имя ошибки, сообщение об ошибке и состояние сервера.

Параметры для передачи заголовков или параметров запроса также могут быть добавлены в запрос POST, PUT или PATCH с помощью ключей headers или params в объекте, передаваемом в качестве третьего. аргумент:

updatePost() {
  this.http
    .put(this.url, this.payload, {
      params: new HttpParams().set('id', '56784'),
      headers: new HttpHeaders().set('Authorization', 'some-token')
    })
    .subscribe(...);
}

Обратите внимание на использование классов HttpParams и HttpHeaders. Вам также нужно будет импортировать их из @angular/common/http.

События прогресса

Отличным новым свойством HttpClient является возможность прослушивания событий выполнения. Это можно сделать для любого типа запроса, и в течение жизненного цикла события запроса будет доступна различная информация. Вот полный пример с запросом GET:

import { Injectable } from '@angular/core';
import {
  HttpClient,
  HttpRequest,
  HttpEvent,
  HttpEventType
} from '@angular/common/http';

@Injectable()
export class DataService {
  url = '/some/api';

  constructor(private http: HttpClient) {}

  getData() {
    const req = new HttpRequest('GET', this.url, {
      reportProgress: true
    });

    this.http.request(req).subscribe((event: HttpEvent<any>) => {
      switch (event.type) {
        case HttpEventType.Sent:
          console.log('Request sent!');
          break;
        case HttpEventType.ResponseHeader:
          console.log('Response header received!');
          break;
        case HttpEventType.DownloadProgress:
          const kbLoaded = Math.round(event.loaded / 1024);
          console.log(`Download in progress! ${ kbLoaded }Kb loaded`);
          break;
        case HttpEventType.Response:
          console.log('😺 Done!', event.body);
      }
    });
  }
}

  • Сначала нам нужно создать объект запроса, создав экземпляр класса HttpRequest и используя параметр reportProgress.
  • Затем мы подписываемся на наш объект запроса, чтобы инициировать запрос и прослушивать различные типы событий в течение срока действия запроса. Мы можем реагировать соответствующим образом в зависимости от типа события. Доступные типы событий: Sent, UploadProgress, ResponseHeader, DownloadProgress, Response и Пользователь.
  • В приведенном выше примере мы получаем объем загруженных данных из ответа GET, а в случае чего-то вроде запроса POST или PUT мы также можем получить процент полезной нагрузки, загруженной с помощью чего-то вроде 100 * event.loaded/event.total. Это упрощает показ пользователю индикатора выполнения.

🤓 В этом посте рассмотрены основы HttpClient, а в следующем будет рассмотрено использование перехватчиков, ключевой функции HttpClient. Вы также можете перейти к официальной документации, чтобы получить более подробную информацию.