URLConnectionベースのHTTPクライアントを設定する

AWS SDK for Java 2.x は、デフォルトの よりも軽量なUrlConnectionHttpClientHTTPクライアントを提供しますApacheHttpClient。UrlConnectionHttpClient は Java URLConnection をベースにしています。

は Apache ベースのHTTPクライアントよりも速くUrlConnectionHttpClientロードされますが、機能が少なくなります。読み取りが速いため、Java AWS Lambda 関数に適したソリューションです。

UrlConnectionHttpClient には、アクセスができる設定可能なオプションがいくつかあります。

UrlConnectionHttpClient へのアクセス

UrlConnectionHttpClient を設定して使用するには、pom.xml ファイル内の url-connection-client Maven アーティファクトへの依存関係を宣言します。

ApacheHttpClient とは異なり、UrlConnectionHttpClient はプロジェクトに自動的に追加されないため、明示的に宣言する必要があります。

次のpom.xmlファイルの例は、HTTPクライアントを使用および設定するために必要な依存関係を示しています。

<dependencyManagement>
   <dependencies>
        <dependency>
            <groupId>software.amazon.awssdk</groupId>
            <artifactId>bom</artifactId>
            <version>2.27.21</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

<!-- other dependencies such as s3 or dynamodb -->

<dependencies>
    <dependency>
        <groupId>software.amazon.awssdk</groupId>
        <artifactId>url-connection-client</artifactId>
    </dependency>
</dependencies>

UrlConnectionHttpClient を使用および設定する

サービスクライアントを構築すると同時に UrlConnectionHttpClient のインスタンスを設定することも、単一インスタンスを複数のサービスクライアント間で共有するように設定することもできます。

どちらの方法でも、UrlConnectionHttpClient.Builder を使用して URLConnectionベースのHTTPクライアントのプロパティを設定します。

ベストプラクティス: UrlConnectionHttpClient インスタンスをサービスクライアント専有にする

UrlConnectionHttpClient のインスタンスを設定する必要がある場合は、専有 UrlConnectionHttpClient インスタンスを構築することをお勧めします。これを行うには、サービスクライアントのビルダーの httpClientBuilder メソッドを使用します。これにより、HTTPクライアントのライフサイクルは によって管理されます。これによりSDK、不要になったUrlConnectionHttpClientインスタンスが閉じられない場合にメモリリークが発生する可能性を回避できます。

次の例では、S3Client を作成して、socketTimeout と proxyConfiguration の値で UrlConnectionHttpClient の埋め込みインスタンス設定します。proxyConfiguration メソッドは、タイプ Consumer<ProxyConfiguration.Builder> の Java Lambda 式を取ります。

インポート

import software.amazon.awssdk.http.SdkHttpClient;
import software.amazon.awssdk.http.urlconnection.UrlConnectionHttpClient;
import java.net.URI;
import java.time.Duration;

コード

// Singleton: Use the s3Client for all requests.
S3Client s3Client = 
    S3Client.builder()
            .httpClientBuilder(UrlConnectionHttpClient.builder()
                    .socketTimeout(Duration.ofMinutes(5))
                    .proxyConfiguration(proxy -> proxy.endpoint(URI.create("http://proxy.mydomain.net:8888"))))
            .credentialsProvider(EnvironmentVariableCredentialsProvider.create())
            .build();

// Perform work with the s3Client.

s3Client.close();   // Requests completed: Close the s3client.

別の方法: UrlConnectionHttpClient インスタンスを共有する

アプリケーションのリソースとメモリの使用量を低く抑えるため、UrlConnectionHttpClient を設定して複数のサービスクライアント間で共有できます。HTTP 接続プールが共有され、リソースの使用量が減少します。

次の例では、2 つのサービスHTTPクライアントで使用される URLConnectionベースのクライアントを設定します。設定された UrlConnectionHttpClient インスタンスは、各ビルダーの httpClient メソッドに渡されます。サービスクライアントとHTTPクライアントが不要になると、コードは明示的に閉じます。コードは最後にHTTPクライアントを閉じます。

インポート

import software.amazon.awssdk.auth.credentials.EnvironmentVariableCredentialsProvider;
import software.amazon.awssdk.awscore.defaultsmode.DefaultsMode;
import software.amazon.awssdk.http.SdkHttpClient;
import software.amazon.awssdk.http.urlconnection.ProxyConfiguration;
import software.amazon.awssdk.http.urlconnection.UrlConnectionHttpClient;
import software.amazon.awssdk.services.dynamodb.DynamoDbClient;
import software.amazon.awssdk.services.s3.S3Client;
import java.net.URI;
import java.time.Duration;

コード

SdkHttpClient urlHttpClient = UrlConnectionHttpClient.create();

// Singletons: Use the s3Client and dynamoDbClient for all requests.
S3Client s3Client = 
    S3Client.builder()
            .httpClient(urlHttpClient)
            .defaultsMode(DefaultsMode.IN_REGION)
            .credentialsProvider(EnvironmentVariableCredentialsProvider.create())
            .build();

DynamoDbClient dynamoDbClient = 
    DynamoDbClient.builder()
                  .httpClient(urlHttpClient)
                  .defaultsMode(DefaultsMode.IN_REGION)
                  .credentialsProvider(EnvironmentVariableCredentialsProvider.create())
                  .build();

// Perform work with the s3Client and dynamoDbClient.

// Requests completed: Close all service clients.
s3Client.close();
dynamoDbClient.close();
urlHttpClient.close();

// The dynamoDbClient uses the UrlConnectionHttpClient
DynamoDbClient dynamoDbClient = DynamoDbClient.builder()
        .httpClient(UrlConnectionHttpClient.create())
        .build();

// The s3Client below uses the ApacheHttpClient at runtime, without specifying it.
// An SdkClientException is thrown with the message that multiple HTTP implementations were found on the classpath.
S3Client s3Client = S3Client.create();

// Perform work with the s3Client and dynamoDbClient.

dynamoDbClient.close();
s3Client.close();

DynamoDbClient dynamoDbClient = DynamoDbClient.builder()
        .httpClient(UrlConnectionHttpClient.create())
        .build();

S3Client s3Client = S3Client.builder()
        .httpClient(ApacheHttpClient.create())    // Explicitly build the ApacheHttpClient.
        .build();

// Perform work with the s3Client and dynamoDbClient.

dynamoDbClient.close();
s3Client.close();

プロキシ設定例

次のコードスニペットは、URL接続HTTPクライアント のプロキシ設定ビルダーを使用します。

SdkHttpClient urlHttpClient = UrlConnectionHttpClient.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 = UrlConnectionHttpClient.builder()
                .proxyConfiguration(ProxyConfiguration.builder()
                        .useSystemPropertyValues(Boolean.FALSE)
                        .build())
                .build();

// Run the application.
// $ java -cp ... App