View a markdown version of this page

設定 Apache 型 HTTP 用戶端 - AWS SDK for Java 2.x

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

設定 Apache 型 HTTP 用戶端

注意

ApacheHttpClient 已棄用,因為 Apache HttpClient 4.x 處於維護模式。使用 Apache HttpClient 5.x 型 Apache5HttpClient。

開發套件的 ApacheHttpClient 是以 Apache HttpClient 4.x 為基礎。

軟體開發套件也提供 UrlConnectionHttpClient,可更快速載入,但功能較少。如需設定 的資訊UrlConnectionHttpClient,請參閱 設定 URLConnection 型 HTTP 用戶端。

若要查看您可用於 的完整組態選項集ApacheHttpClient,請參閱 ApacheHttpClient.Builder 和 ProxyConfiguration.Builder。

存取 ApacheHttpClient

需要的配置

若要使用 ApacheHttpClient,您需要在編譯時在程式apache-client庫上新增相依性。

請參閱下列 Maven pom.xml 檔案的範例來設定 ApacheHttpClient。

<dependencyManagement> <dependencies> <dependency> <groupId>software.amazon.awssdk</groupId> <artifactId>bom</artifactId> <version>2.54.0</version> <type>pom</type> <scope>import</scope> </dependency> </dependencies> </dependencyManagement> <dependencies> <dependency> <groupId>software.amazon.awssdk</groupId> <artifactId>s3</artifactId> </dependency> <!-- By adding the apache-client dependency, ApacheHttpClient will be added to the compile classpath so you can configure it. --> <dependency> <groupId>software.amazon.awssdk</groupId> <artifactId>apache-client</artifactId> </dependency> </dependencies>

使用和設定 ApacheHttpClient

您可以設定 執行個體ApacheHttpClient以及建置服務用戶端,也可以設定單一執行個體以在多個服務用戶端之間共用。

使用任一方法,您可以使用 ApacheHttpClient.Builder來設定 Apache 型 HTTP 用戶端的屬性。

最佳實務:將ApacheHttpClient執行個體專用於服務用戶端

如果您需要設定 的執行個體ApacheHttpClient,我們建議您建置專用ApacheHttpClient執行個體。您可以使用服務用戶端建置器的 httpClientBuilder方法來執行此操作。如此一來,HTTP 用戶端的生命週期由 SDK 管理,這有助於避免在ApacheHttpClient執行個體不再需要時關閉時造成潛在的記憶體流失。

下列範例會建立 ,S3Client並使用 ApacheHttpClientmaxConnections和 connectionTimeout值設定 的內嵌執行個體。HTTP 執行個體是使用 的 httpClientBuilder方法建立。 S3Client.Builder

匯入

import software.amazon.awssdk.http.apache.ApacheHttpClient; import software.amazon.awssdk.services.s3.S3Client; import java.time.Duration;

Code

S3Client s3Client = S3Client // Singleton: Use the s3Client for all requests. .builder() .httpClientBuilder(ApacheHttpClient.builder() .maxConnections(100) .connectionTimeout(Duration.ofSeconds(5)) ).build(); // Perform work with the s3Client. s3Client.close(); // Requests completed: Close all service clients.

替代方法:共用ApacheHttpClient執行個體

為了協助降低應用程式的資源和記憶體用量,您可以設定 ,ApacheHttpClient並在多個服務用戶端之間共用。HTTP 連線集區將共用,這會降低資源用量。

注意

共用ApacheHttpClient執行個體時,您必須在準備好進行處置時將其關閉。當服務用戶端關閉時,軟體開發套件不會關閉執行個體。

下列範例會設定兩個服務用戶端所使用的 Apache 型 HTTP 用戶端。設定的ApacheHttpClient執行個體會傳遞至每個建置器的 httpClient方法。當不再需要服務用戶端和 HTTP 用戶端時,程式碼會明確關閉它們。程式碼最後會關閉 HTTP 用戶端。

匯入

import software.amazon.awssdk.http.SdkHttpClient; import software.amazon.awssdk.http.apache.ApacheHttpClient; import software.amazon.awssdk.services.dynamodb.DynamoDbClient; import software.amazon.awssdk.services.s3.S3Client;

Code

SdkHttpClient apacheHttpClient = ApacheHttpClient.builder() .maxConnections(100).build(); // Singletons: Use the s3Client and dynamoDbClient for all requests. S3Client s3Client = S3Client.builder() .httpClient(apacheHttpClient).build(); DynamoDbClient dynamoDbClient = DynamoDbClient.builder() .httpClient(apacheHttpClient).build(); // Perform work with the s3Client and dynamoDbClient. // Requests completed: Close all service clients. s3Client.close(); dynamoDbClient.close(); apacheHttpClient.close(); // Explicitly close apacheHttpClient.

Proxy 組態範例

下列程式碼片段使用 Apache HTTP 用戶端的代理組態建置器。

SdkHttpClient apacheHttpClient = ApacheHttpClient.builder() .proxyConfiguration(ProxyConfiguration.builder() .endpoint(URI.create("http://example.com:1234")) .username("username") .password("password") .addNonProxyHost("localhost") .addNonProxyHost("host.example.com") .build()) .build();

代理組態的同等 Java 系統屬性會顯示在下列命令列程式碼片段中。

$ java -Dhttp.proxyHost=example.com -Dhttp.proxyPort=1234 -Dhttp.proxyUser=username \ -Dhttp.proxyPassword=password -Dhttp.nonProxyHosts=localhost|host.example.com -cp ... App

使用環境變數的同等設定為:

// Set the following environment variables. // $ export HTTP_PROXY="http://username:password@example.com:1234" // $ export NO_PROXY="localhost|host.example.com" // Set the 'useSystemPropertyValues' to false on the proxy configuration. SdkHttpClient apacheHttpClient = ApacheHttpClient.builder() .proxyConfiguration(ProxyConfiguration.builder() .useSystemPropertyValues(Boolean.FALSE) .build()) .build(); // Run the application. // $ java -cp ... App
注意

Apache HTTP 用戶端目前不支援 HTTPS 代理系統屬性或 HTTPS_PROXY 環境變數。