設定可能なHTTPクライアント
概要
Rapid SDKは、基礎となるHTTPクライアントを使用してAPIコールを実行します。開発者がHTTPクライアントを SDKが使用する独自のHTTPクライアントを渡すために使用できるビルダーが提供されています。このビルダーを使用すると、独自の設定でHTTPクライアントを構築してSDKに渡したり、アプリケーションで既に使用しているクライアントを渡したりすることができます。
注意
この機能は、rapid-sdk v5.3.1以降で利用可能です。
HTTPクライアントの設定とデフォルト・クライアントの使用
提供されているデフォルトのクライアントを使用するのが、SDKを使い始める最も簡単な方法です。しかし 独自のHTTPクライアントを設定すると、以下のような利点があります：
- 最適化: Fine-tune接続プール、タイムアウト、再試行など、クライアントのパフォーマンスを向上させます。
- 統合： アプリケーション内ですでに設定され、テストされている既存のHTTPクライアントを使用します。
そのため、SDKを最適化してパフォーマンスを向上させたい場合や、既存のHTTPクライアントと統合したい場合は、独自のHTTPクライアントを設定する必要があります。 独自のHTTPクライアントを設定するのがよいでしょう。
HTTPクライアントの設定方法
HTTPクライアントを設定するには、OkHttpClient のインスタンスを作成し、RapidClient ビルダーに渡す必要があります。
1.OkHttpClient のインスタンスを作成します。既存のインスタンスを使用することも、新しいインスタンスを作成することもできます。
例 :
OkHttpClient customClient = new OkHttpClient.Builder()
.connectTimeout(30, TimeUnit.SECONDS)
.readTimeout(30, TimeUnit.SECONDS)
.writeTimeout(30, TimeUnit.SECONDS)
.build();OkHttpClientの設定については、OkHttpドキュメント をご参照ください。
2.OkHttpClient インスタンスをRapidClient ビルダーbuilderWithHttpClient に渡します。
例 :
RapidClient rapidClient = RapidClient.builderWithHttpClient()
.okHttpClient(customClient)
.key("YOUR_API_KEY")
.secret("YOUR_API_SECRET")
.build();3.設定されたrapidClient を使用して、通常通りAPI呼び出しを行います。
例 :
GetAvailabilityOperationParams getAvailabilityOperationParams = GetAvailabilityOperationParams.builder()
.checkin("YYYY-MM-DD")
.checkout("YYYY-MM-DD")
.currency("USD")
.language("en_US")
/* ... */
.build();
GetAvailabilityOperation operation = new GetAvailabilityOperation(params);
Response<List<Property>> response = rapidClient.execute(operation);