AWS SDK for Java 移行ツール

AWS SDK for Java は、SDK for Java 1.x (V1) コードの 2.x (V2) への移行を自動化するのに役立つ移行ツールを提供します。このツールは、オープンソースのソースコードリファクタリングツールである OpenRewrite を使用して移行を実行します。OpenRewrite はコード変更ルール (「受信」と呼ばれる) を使用して、ソースコードを V1 から V2 の構文とパターンに自動的に更新します。

このツールは、SDK サービスクライアントと S3 Transfer Manager の高レベルライブラリのコード変更ルールをサポートしています。V1 のから VV2 の DynamoDB 拡張クライアント APIs など、他の高レベル API のコード変更ルールはサポートされていません。 DynamoDBMapper DynamoDB

制限の詳細については、このページの最後にある「」を参照してください。手動移行ステップでサポートされていない一般的なコードパターンの詳細な例については、「サポートされていないコードパターン」を参照してください。

移行ツールを使用する

Maven プロジェクトの移行

OpenRewrite Maven プラグインツールを使用して SDK for Java 1.x Maven ベースのプロジェクトを移行するには、次の手順に従います。

Maven プロジェクトのルートディレクトリに移動します。

ターミナル (コマンドライン) ウィンドウを開き、Maven ベースのアプリケーションのルートディレクトリに移動します。

プラグインの rewrite-maven-plugin コマンドを実行する

2 つのモード (Maven 目標) から選択できます。 dryRunとですrun。

dryRun モード

dryRun モードでは、プラグインはコンソール出力に差分ログを生成し、 target/rewriteフォルダrewrite.patchにという名前のパッチファイルを生成します。このモードでは、ソースコードファイルに変更が行われないため、行われる変更をプレビューできます。

次の例は、プラグインを dryRun モードで呼び出す方法を示しています。


mvn org.openrewrite.maven:rewrite-maven-plugin:<rewrite-plugin-version>*:dryRun \
  -Drewrite.recipeArtifactCoordinates=software.amazon.awssdk:v2-migration:<sdkversion>** \
  -Drewrite.activeRecipes=software.amazon.awssdk.v2migration.AwsSdkJavaV1ToV2

*<rewrite-plugin-version> を、このテストファイルに表示されるrewriteMavenPluginVersion値に置き換えます。

**<sdkversion> を 2.x SDK バージョンに置き換えます。Maven Central にアクセスして、最新バージョンを確認します。

重要

他のバージョンが機能しない可能性があるため、テストファイルrewrite-maven-pluginに表示されるのバージョンを使用してください。

dryRun モードからのコンソール出力は次の出力のようになります。


[WARNING] These recipes would make changes to project/src/test/resources/maven/before/pom.xml:
[WARNING]     software.amazon.awssdk.v2migration.AwsSdkJavaV1ToV2
[WARNING]         software.amazon.awssdk.v2migration.UpgradeSdkDependencies
[WARNING]             org.openrewrite.java.dependencies.AddDependency: {groupId=software.amazon.awssdk, artifactId=apache-client, version=2.27.0, onlyIfUsing=com.amazonaws.ClientConfiguration}
[WARNING]             org.openrewrite.java.dependencies.AddDependency: {groupId=software.amazon.awssdk, artifactId=netty-nio-client, version=2.27.0, onlyIfUsing=com.amazonaws.ClientConfiguration}
[WARNING]             org.openrewrite.java.dependencies.ChangeDependency: {oldGroupId=com.amazonaws, oldArtifactId=aws-java-sdk-bom, newGroupId=software.amazon.awssdk, newArtifactId=bom, newVersion=2.27.0}
[WARNING]             org.openrewrite.java.dependencies.ChangeDependency: {oldGroupId=com.amazonaws, oldArtifactId=aws-java-sdk-s3, newGroupId=software.amazon.awssdk, newArtifactId=s3, newVersion=2.27.0}
[WARNING]             org.openrewrite.java.dependencies.ChangeDependency: {oldGroupId=com.amazonaws, oldArtifactId=aws-java-sdk-sqs, newGroupId=software.amazon.awssdk, newArtifactId=sqs, newVersion=2.27.0}
[WARNING] These recipes would make changes to project/src/test/resources/maven/before/src/main/java/foo/bar/Application.java:
[WARNING]     software.amazon.awssdk.v2migration.AwsSdkJavaV1ToV2
[WARNING]         software.amazon.awssdk.v2migration.S3GetObjectConstructorToFluent
[WARNING]             software.amazon.awssdk.v2migration.ConstructorToFluent
[WARNING]         software.amazon.awssdk.v2migration.S3StreamingResponseToV2
[WARNING]         software.amazon.awssdk.v2migration.ChangeSdkType
[WARNING]         software.amazon.awssdk.v2migration.ChangeSdkCoreTypes
[WARNING]             software.amazon.awssdk.v2migration.ChangeExceptionTypes
[WARNING]                 org.openrewrite.java.ChangeType: {oldFullyQualifiedTypeName=com.amazonaws.AmazonClientException, newFullyQualifiedTypeName=software.amazon.awssdk.core.exception.SdkException}
[WARNING]                 org.openrewrite.java.ChangeMethodName: {methodPattern=com.amazonaws.AmazonServiceException getRequestId(), newMethodName=requestId}
[WARNING]                 org.openrewrite.java.ChangeMethodName: {methodPattern=com.amazonaws.AmazonServiceException getErrorCode(), newMethodName=awsErrorDetails().errorCode}
[WARNING]                 org.openrewrite.java.ChangeMethodName: {methodPattern=com.amazonaws.AmazonServiceException getServiceName(), newMethodName=awsErrorDetails().serviceName}
[WARNING]                 org.openrewrite.java.ChangeMethodName: {methodPattern=com.amazonaws.AmazonServiceException getErrorMessage(), newMethodName=awsErrorDetails().errorMessage}
[WARNING]                 org.openrewrite.java.ChangeMethodName: {methodPattern=com.amazonaws.AmazonServiceException getRawResponse(), newMethodName=awsErrorDetails().rawResponse().asByteArray}
[WARNING]                 org.openrewrite.java.ChangeMethodName: {methodPattern=com.amazonaws.AmazonServiceException getRawResponseContent(), newMethodName=awsErrorDetails().rawResponse().asUtf8String}
[WARNING]                 org.openrewrite.java.ChangeType: {oldFullyQualifiedTypeName=com.amazonaws.AmazonServiceException, newFullyQualifiedTypeName=software.amazon.awssdk.awscore.exception.AwsServiceException}
[WARNING]         software.amazon.awssdk.v2migration.NewClassToBuilderPattern
[WARNING]             software.amazon.awssdk.v2migration.NewClassToBuilder
[WARNING]             software.amazon.awssdk.v2migration.V1SetterToV2
[WARNING]         software.amazon.awssdk.v2migration.V1GetterToV2
...
[WARNING]         software.amazon.awssdk.v2migration.V1BuilderVariationsToV2Builder
[WARNING]         software.amazon.awssdk.v2migration.NewClassToBuilderPattern
[WARNING]             software.amazon.awssdk.v2migration.NewClassToBuilder
[WARNING]             software.amazon.awssdk.v2migration.V1SetterToV2
[WARNING]         software.amazon.awssdk.v2migration.HttpSettingsToHttpClient
[WARNING]         software.amazon.awssdk.v2migration.WrapSdkClientBuilderRegionStr
[WARNING] Patch file available:
[WARNING]     project/src/test/resources/maven/before/target/rewrite/rewrite.patch
[WARNING] Estimate time saved: 20m
[WARNING] Run 'mvn rewrite:run' to apply the recipes.

run モード

プラグインをrunモードで実行すると、ディスク上のソースコードが変更され、変更が適用されます。コマンドを実行する前に、ソースコードのバックアップがあることを確認してください。

次の例は、プラグインを run モードで呼び出す方法を示しています。


mvn org.openrewrite.maven:rewrite-maven-plugin:<rewrite-plugin-version>*:run \
  -Drewrite.recipeArtifactCoordinates=software.amazon.awssdk:v2-migration:<sdkversion>** \
  -Drewrite.activeRecipes=software.amazon.awssdk.v2migration.AwsSdkJavaV1ToV2

* <rewrite-plugin-version> を、このテストファイルに表示されるに置き換えrewriteMavenPluginVersionvalueます。

**<sdkversion> を 2.x SDK バージョンに置き換えます。Maven Central にアクセスして、最新バージョンを確認します。

コマンドを実行したら、アプリケーションをコンパイルし、テストを実行して変更を検証します。

Gradle プロジェクトの移行

OpenRewrite Gradle プラグインツールを使用して SDK for Java 1.x Gradle ベースのプロジェクトを移行するには、次の手順に従います。

Gradle プロジェクトのルートディレクトリに移動します。

ターミナル (コマンドライン) ウィンドウを開き、Gradle ベースのアプリケーションのルートディレクトリに移動します。

Gradle init スクリプトを作成する

ディレクトリに次の内容のinit.gradleファイルを作成します。


initscript {
    repositories {
        maven { url "https://plugins.gradle.org/m2" }
    }
    dependencies {
        classpath("org.openrewrite:plugin:<rewrite-plugin-version>*")
    }
}

rootProject {
    plugins.apply(org.openrewrite.gradle.RewritePlugin)
    dependencies {
        rewrite("software.amazon.awssdk:v2-migration:latest.release")
    }

    afterEvaluate {
        if (repositories.isEmpty()) {
            repositories {
                mavenCentral()
            }
        }
    }
}

* <rewrite-plugin-version> を、このテストファイルに表示されるバージョンに置き換えます。

rewrite コマンドの実行

Maven プラグインと同様に、Gradle プラグインを dryRunまたは runモードで実行できます。

dryRun モード

次の例は、プラグインを dryRun モードで呼び出す方法を示しています。
```
gradle rewriteDryRun --init-script init.gradle \
  -Drewrite.activeRecipes=software.amazon.awssdk.v2migration.AwsSdkJavaV1ToV2
```
run モード

次の例は、プラグインを run モードで呼び出す方法を示しています。
```
gradle rewriteRun --init-script init.gradle \
  -Drewrite.activeRecipes=software.amazon.awssdk.v2migration.AwsSdkJavaV1ToV2
```

現在の制限事項

移行では、ほとんどの V1 コードを V2 に相当するに更新するコード変更ルールでアップグレードしますが、一部のクラスとメソッドは対象外です。これらのクラスとメソッドについては、step-by-stepの手順に従ってコードを手動で移行します。

サポートされていないコード変更ルールによっては、移行ツールで次の文字で始まるコメントが追加される場合があります。


/*AWS SDK for Java v2 migration: Transform for ...

コメントに従って、ツールはメソッドまたはクラスの V2 バージョンの汎用スタブを出力します。たとえば、次の出力では、移行ツールが V1 S3 クライアントの setBucketLifecycleConfigurationメソッドの移行を試みました。


/*AWS SDK for Java v2 migration: Transform for setBucketLifecycleConfiguration method not supported. 
Please manually migrate your code by using builder pattern, update from BucketLifecycleConfiguration.Rule 
to LifecycleRule, StorageClass to TransitionStorageClass, and adjust imports and names.*/
s3.putBucketLifecycleConfiguration(
        PutBucketLifecycleConfigurationRequest.builder()
            .bucket(bucketName)
            .lifecycleConfiguration(BucketLifecycleConfiguration.builder()
                .build())
            .build());

以下のリストのリンクをクリックすると、コードを手動で移行するのに役立つ移行情報が表示されます。

のバージョン 1 とバージョン 2 の S3 クライアントの違い AWS SDK for Java
S3 Transfer Manager (TransferManager)
DynamoDB オブジェクトマッピング (DynamoDBMapper)
EC2 メタデータユーティリティ (EC2MetadataUtils)
ウェーター (AmazonDynamoDBWaiters)
IAM Policy Builder (ポリシー）
CloudFront 事前署名 (CloudFrontUrlSigner、CloudFrontCookieSigner)
S3 イベント通知 (S3EventNotification)
SDK メトリクスの公開 (1.x ドキュメント、2.x ドキュメント）
サポートされていないコードパターン – 手動移行を必要とする一般的なコードパターンの詳細な例

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

移行方法

サポートされていないコードパターン