AWS SDK for Java 마이그레이션 도구

는 SDK for Java 1.x(V1) 코드를 2.x(V2)로 마이그레이션하는 작업을 자동화하는 데 도움이 되는 마이그레이션 도구를 AWS SDK for Java 제공합니다. 이 도구는 오픈 소스, 소스 코드 리팩터링 도구인 OpenRewrite를 사용하여 마이그레이션을 수행합니다. OpenRewrite는 코드 수정 규칙(“레시피”)을 사용하여 소스 코드를 V1에서 V2 구문 및 패턴으로 자동으로 업데이트합니다.

이 도구는 SDK 서비스 클라이언트 및 S3 Transfer Manager 상위 수준 라이브러리에 대한 코드 수정 규칙을 지원합니다. V1에서 V2DynamoDBMapper로의 DynamoDB 향상된 클라이언트 APIs와 같은 다른 상위 수준 API에 대한 코드 수정 규칙은 지원되지 않습니다. DynamoDB

제한 사항에 대한 자세한 내용은 이 페이지의 끝을 참조하세요. 수동 마이그레이션 단계가 있는 지원되지 않는 일반적인 코드 패턴의 자세한 예는 지원되지 않는 코드 패턴을 참조하세요.

마이그레이션 도구 사용

Maven 프로젝트 마이그레이션

아래 지침에 따라 OpenRewrite Maven 플러그인 도구를 사용하여 SDK for Java 1.x Maven 기반 프로젝트를 마이그레이션합니다.

Maven 프로젝트의 루트 디렉터리로 이동합니다.

터미널(명령줄) 창을 열고 Maven 기반 애플리케이션의 루트 디렉터리로 이동합니다.

플러그인의 rewrite-maven-plugin 명령 실행

dryRun 및의 두 가지 모드(Maven 목표) 중에서 선택할 수 있습니다run.

dryRun 모드

dryRun 모드에서 플러그인은 콘솔 출력에 diff 로그를 생성하고 rewrite.patch target/rewrite 폴더에 라는 패치 파일을 생성합니다. 이 모드를 사용하면 소스 코드 파일을 변경하지 않으므로 변경되는 내용을 미리 볼 수 있습니다.

다음 예제에서는 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 플러그인과 마찬가지로 dryRun 또는 run 모드에서 Gradle 플러그인을 실행할 수 있습니다.

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
```

현재 제한 사항

마이그레이션은 V2에 상응하는 로 업데이트되는 코드 수정 규칙을 통해 대부분의 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)
Waiters(AmazonDynamoDBWaiters)
IAM 정책 빌더(정책)
CloudFront 사전 서명(CloudFrontUrlSigner, CloudFrontCookieSigner)
S3 이벤트 알림(S3EventNotification)
SDK 지표 게시(1.x 설명서, 2.x 설명서)
지원되지 않는 코드 패턴 - 수동 마이그레이션이 필요한 일반적인 코드 패턴의 세부 예제

javascript가 브라우저에서 비활성화되거나 사용이 불가합니다.

AWS 설명서를 사용하려면 Javascript가 활성화되어야 합니다. 지침을 보려면 브라우저의 도움말 페이지를 참조하십시오.

문서 규칙

마이그레이션 방법

지원되지 않는 코드 패턴