HttpClient の設定

HttpClient をアプリケーションで使用するには、まず 依存性の注入 を使って設定する必要があります。

依存性の注入による HttpClient の提供

HttpClient は provideHttpClient ヘルパー関数を使って提供されます。ほとんどのアプリケーションは、app.config.ts のアプリケーション providers にこれを含めます。

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

アプリケーションがNgModuleベースのブートストラップを使用している場合は、アプリケーションのNgModuleのプロバイダーに provideHttpClient を含めることができます。

      
@NgModule({  providers: [    provideHttpClient(),  ],  // ...その他のアプリケーション設定})export class AppModule {}
    

その後、HttpClient サービスを、コンポーネント、サービス、またはその他のクラスの依存関係として注入できます。

      
@Injectable({providedIn: 'root'})export class ConfigService {  constructor(private http: HttpClient) {    // このサービスは、`this.http` を介して HTTP リクエストを実行できるようになりました。  }}
    

HttpClient の機能の設定

provideHttpClient は、クライアントのさまざまな側面の動作を有効化または設定するための、オプションの機能設定のリストを受け取ります。このセクションでは、オプションの機能とその使用方法について詳しく説明します。

withFetch

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

デフォルトでは、HttpClient は XMLHttpRequest APIを使ってリクエストを行います。withFetch 機能は、クライアントを fetch APIを代わりに使うように切り替えます。

fetch はより新しいAPIであり、XMLHttpRequest がサポートされていないいくつかの環境で使用できます。アップロードの進行状況イベントを生成しないなど、いくつかの制限があります。

withInterceptors(...)

withInterceptors は、HttpClient を介して行われたリクエストを処理する、インターセプター関数のセットを設定します。詳細については、インターセプターガイド を参照してください。

withInterceptorsFromDi()

withInterceptorsFromDi は、HttpClient 設定に、古いスタイルのクラスベースのインターセプターを含めます。詳細については、インターセプターガイド を参照してください。

withRequestsMadeViaParent()

デフォルトでは、provideHttpClient を使って特定のインジェクター内で HttpClient を設定すると、この設定は、親インジェクターに存在する可能性のある HttpClient の設定を上書きします。

withRequestsMadeViaParent() を追加すると、HttpClient は、このレベルで設定されたインターセプターを通過した後、親インジェクターの HttpClient インスタンスにリクエストを渡すように設定されます。これは、親インジェクターのインターセプターも通過しながら、子インジェクターにインターセプターを追加したい場合に役立ちます。

withJsonpSupport()

withJsonpSupport を含めると、HttpClient の .jsonp() メソッドが有効になり、JSONP 規約 を介してGETリクエストを行い、データのクロスドメインロードを行います。

withXsrfConfiguration(...)

このオプションを含めると、HttpClient の組み込みのXSRFセキュリティ機能をカスタマイズできます。詳細については、セキュリティガイド を参照してください。

withNoXsrfProtection()

このオプションを含めると、HttpClient の組み込みのXSRFセキュリティ機能が無効になります。詳細については、セキュリティガイド を参照してください。

HttpClientModule ベースの設定

一部のアプリケーションでは、NgModuleベースの古いAPIを使って HttpClient を設定している場合があります。

この表は、@angular/common/http から使用できるNgModuleと、上記のプロバイダー設定関数との関係を示しています。