Настройка HttpClient

Прежде чем использовать HttpClient в приложении, необходимо настроить его с помощью внедрения зависимостей.

Предоставление HttpClient с помощью внедрения зависимостей

HttpClient предоставляется с помощью вспомогательной функции provideHttpClient, которую большинство приложений добавляет в приложение providers в app.config.ts.

export const appConfig: ApplicationConfig = {
  providers: [provideHttpClient()],
};

Если приложение использует загрузку на основе NgModule, вместо этого можно добавить provideHttpClient в список провайдеров NgModule приложения:

@NgModule({
  providers: [provideHttpClient()],
  // ... other application configuration
})
export class AppModule {}

Затем можно внедрить сервис HttpClient как зависимость в компоненты, сервисы или другие классы:

@Service()
export class ConfigService {
  private http = inject(HttpClient);
  // This service can now make HTTP requests via `this.http`.
}

Настройка возможностей HttpClient

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

withXhr

export const appConfig: ApplicationConfig = {
  providers: [provideHttpClient(withXhr())],
};

По умолчанию HttpClient использует API fetch для выполнения запросов. Возможность withXhr переключает клиент на использование API XMLHttpRequest.

fetch — более современный API, доступный в некоторых средах, где XMLHttpRequest не поддерживается. У него есть несколько ограничений, например отсутствие событий отслеживания хода загрузки.

withInterceptors(...)

withInterceptors настраивает набор функций-перехватчиков, обрабатывающих запросы, выполняемые через HttpClient. Подробнее см. в руководстве по перехватчикам.

withInterceptorsFromDi()

withInterceptorsFromDi добавляет перехватчики старого типа, основанные на классах, в конфигурацию HttpClient. Подробнее см. в руководстве по перехватчикам.

withRequestsMadeViaParent()

По умолчанию при настройке HttpClient с помощью provideHttpClient в заданном инжекторе эта конфигурация переопределяет любую конфигурацию HttpClient, которая может присутствовать в родительском инжекторе.

Если добавить withRequestsMadeViaParent(), HttpClient будет настроен так, чтобы передавать запросы экземпляру HttpClient в родительском инжекторе после прохождения через все настроенные на текущем уровне перехватчики. Это полезно, если нужно добавить перехватчики в дочерний инжектор, продолжая при этом передавать запрос через перехватчики родительского инжектора.

withJsonpSupport()

Подключение withJsonpSupport включает метод .jsonp() в HttpClient, который выполняет GET-запрос с использованием соглашения JSONP для загрузки данных из другого домена.

withXsrfConfiguration(...)

Этот параметр позволяет настраивать встроенные функции безопасности XSRF в HttpClient. Подробнее см. в руководстве по безопасности.

withNoXsrfProtection()

Этот параметр отключает встроенные функции безопасности XSRF в HttpClient. Подробнее см. в руководстве по безопасности.

Конфигурация на основе HttpClientModule

Некоторые приложения могут настраивать HttpClient с помощью старого API на основе NgModule.

В этой таблице перечислены доступные в @angular/common/http модули NgModule и указано, как они соотносятся с приведёнными выше функциями настройки провайдеров.