기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

의 버전 2에서 업그레이드 AWS SDK for PHP

이 주제에서는 의 AWS SDK for PHP 버전 3을 사용하도록 코드를 마이그레이션하는 방법과 새 버전이 의 버전 2와 어떻게 다른지 보여줍니다SDK.

소개

의 버전 3 AWS SDK for PHP 은 의 기능을 개선하고SDK, 2년 이상의 고객 피드백을 통합하고, 종속성을 업그레이드하고, 성능을 개선하고, 최신 PHP 표준을 채택하기 위한 상당한 노력을 나타냅니다.

버전 3의 새 기능

의 버전 3은 AWS SDK for PHP PSR-4 및 PSR-7 표준을 따르며 향후 SemVer 표준을 따릅니다.

기타 새로운 기능은 다음과 같습니다.

분리된 HTTP 계층

비동기 요청

버전 2와의 차이점

프로젝트 종속 항목이 업데이트됨

이 버전에서는 의 종속성이 SDK 변경되었습니다.

이제 리전 및 버전 옵션이 필요합니다.

서비스에 대한 클라이언트를 인스턴스화할 때 'region' 및 'version' 옵션을 지정합니다. 의 버전 2에서 AWS SDK for PHP'version'는 완전히 선택 사항이었고 때로는 선택 사항'region'이었습니다. 버전 3에서는 둘 모두 항상 필요합니다. 이 두 옵션 모두에 대해 명시적으로 설명하면 코딩하려는 API 버전과 AWS 리전을 잠글 수 있습니다. 새 API 버전이 생성되거나 새 AWS 리전을 사용할 수 있게 되면 구성을 명시적으로 업데이트할 준비가 될 때까지 잠재적으로 중단되는 변경 사항으로부터 격리됩니다.

클라이언트 인스턴스화에서 생성자 사용

의 버전 3에서는 클라이언트를 인스턴스화하는 AWS SDK for PHP방식이 변경되었습니다. 버전 2의 factory 메서드 대신 new 키워드를 사용하여 클라이언트를 간단히 인스턴스화할 수 있습니다.

use Aws\DynamoDb\DynamoDbClient;

// Version 2 style
$client = DynamoDbClient::factory([
    'region'  => 'us-east-2'
]);

// Version 3 style
$client = new DynamoDbClient([
    'region'  => 'us-east-2',
    'version' => '2012-08-10'
]);

클라이언트 구성이 변경됨

버전 3의 클라이언트 구성 옵션이 버전 2에서 약간 AWS SDK for PHP 변경되었습니다. 지원되는 모든 옵션에 대한 설명은 AWS SDK for PHP 버전 3의 구성을 참조하세요.

SDK 객체

의 버전 3에서는 Aws\Sdk 객체를 의 대체품으로 AWS SDK for PHP 도입합니다Aws\Common\Aws. Sdk 객체는 클라이언트 팩토리 역할을 하며 여러 클라이언트 간의 공유 구성 옵션을 관리하는 데 사용됩니다.

버전 2의 Aws 클래스는 서비스 로케이터처럼 SDK 작동했지만(항상 클라이언트의 동일한 인스턴스를 반환함), 버전 3의 Sdk 클래스는 클라이언트를 사용할 때마다 클라이언트의 새 인스턴스를 반환합니다.

또한 Sdk 객체는 버전 2와 동일한 구성 파일 형식을 지원하지 않습니다SDK. 이 구성 형식은 Guzzle 3에 특정하며 이제 사용되지 않습니다. 구성은 기본 배열을 사용하여 간단히 수행할 수 있으며 SDK 클래스 사용에 설명되어 있습니다.

일부 API 결과가 변경되었습니다.

가 API 작업 결과를 구문 분석하는 방법에 일관성을 제공하기 위해 Amazon SDK , ElastiCacheAmazon RDS, Amazon Redshift는 이제 일부 API 응답에 대해 추가 래핑 요소를 갖게 됩니다.

예를 들어 버전 3에서 Amazon RDSDescribeEngineDefaultParameters 결과를 호출하면 이제 래핑 “EngineDefaults” 요소가 포함됩니다. 버전 2에는 이 요소가 없습니다.

$client = new Aws\Rds\RdsClient([
    'region'  => 'us-west-1',
    'version' => '2014-09-01'
]);

// Version 2
$result = $client->describeEngineDefaultParameters();
$family = $result['DBParameterGroupFamily'];
$marker = $result['Marker'];

// Version 3
$result = $client->describeEngineDefaultParameters();
$family = $result['EngineDefaults']['DBParameterGroupFamily'];
$marker = $result['EngineDefaults']['Marker'];

이 변경의 영향을 받고 결과 출력에 래핑 요소가 포함되는 작업은 다음과 같습니다(아래 괄호 안에 제공됨).

Enum 클래스 제거됨

AWS SDK for PHP버전 2에 있던 Enum 클래스(예: Aws\S3\Enum\CannedAcl)를 제거했습니다. 열거형은 유효한 파라미터 값의 그룹을 나타내는 상수SDK가 포함된 API의 퍼블릭 내 콘크리트 클래스였습니다. 이러한 열거형은 API 버전에 따라 다르고, 시간이 지남에 따라 변경될 수 있으며, PHP 예약된 단어와 충돌하여 유용하지 않을 수 있으므로 버전 3에서 제거했습니다. 이는 API 버전 3의 데이터 기반 및 버전에 구애받지 않는 특성을 지원합니다.

Enum 객체의 값을 사용하는 대신 리터럴 값을 직접 사용합니다(예: CannedAcl::PUBLIC_READ → 'public-read').

세부 예외 클래스 제거

열거형을 제거한 것과 흡사한 이유로 각 서비스의 네임스페이스에 존재했던 세부 예외 클래스(예: Aws\Rds\Exception\{SpecificError}Exception)를 제거했습니다. 서비스 또는 작업에서 발생하는 예외는 사용되는 API 버전에 따라 달라집니다(버전마다 변경될 수 있음). 또한 버전 2의 세부 예외 클래스가 완성되지 않았으므로 지정된 작업에서 발생될 수 있는 전체 예외 목록이 제공되지 않습니다.

따라서 각 서비스에 대한 근본적인 예외 클래스(예: Aws\Rds\Exception\RdsException)를 파악하여 오류를 처리합니다. 예외의 getAwsErrorCode() 메서드를 사용하여 특정 오류 코드를 확인할 수 있습니다. 이는 다양한 예외 클래스를 포착하는 것과 기능적으로 동일하지만 에 부동 소수점을 추가하지 않고 해당 함수를 제공합니다SDK.

정적 Facade 클래스 제거

의 버전 2에는 Laravel에서 영감을 받은 모호한 기능이 AWS SDK for PHP있어서 Aws 클래스enableFacades()에서 를 호출하여 다양한 서비스 클라이언트에 대한 정적 액세스를 활성화할 수 있었습니다. 이 기능은 PHP 모범 사례에 반하므로 1년 전에 문서화를 중단했습니다. 버전 3에서는 이 기능이 완전히 제거되었습니다. Aws\Sdk 객체에서 클라이언트 객체를 가져온 다음 해당 객체를 정적 클래스가 아닌 객체 인스턴스로 사용합니다.

페이지네이터로 반복기 대체

버전 2에는 * 반복자*라는 기능이 AWS SDK for PHP 있었습니다. 이 기능은 페이지 지정된 결과를 반복하는 데 사용되는 객체입니다. 이와 관련하여 반복기는 각 결과에서 특정 값만 내보내므로 유연성이 부족하다는 불만이 있었습니다. 따라서 결과에 필요한 다른 값이 있는 경우 이벤트 리스너를 통해 검색해야 합니다.

버전 3에서는 반복기가 페이지네이터로 대체되었습니다. 목적은 비슷하지만 페이지네이터는 더 유연합니다. 이는 응답에서 값 대신 결과 객체를 출력하기 때문입니다.

다음 예에서는 버전 2와 버전 3에서 S3 ListObjects 작업에 대한 페이지 지정된 결과를 검색하는 방법을 설명하여 페이지네이터가 반복기와 어떻게 다른지를 보여줍니다.

// Version 2
$objects = $s3Client->getIterator('ListObjects', ['Bucket' => 'amzn-s3-demo-bucket']);
foreach ($objects as $object) {
    echo $object['Key'] . "\n";
}

// Version 3
$results = $s3Client->getPaginator('ListObjects', ['Bucket' => 'amzn-s3-demo-bucket']);
foreach ($results as $result) {
    // You can extract any data that you want from the result.
    foreach ($result['Contents'] as $object) {
        echo $object['Key'] . "\n";
    }
}

패지네이터 객체에는 표현JMESPath식을 사용하여 결과 세트에서 데이터를 더 쉽게 추출할 수 있는 search() 메서드가 있습니다.

$results = $s3Client->getPaginator('ListObjects', ['Bucket' => 'amzn-s3-demo-bucket']);
foreach ($results->search('Contents[].Key') as $key) {
    echo $key . "\n";
}

많은 상위 수준 추상화 변경

일반적으로 많은 상위 수준 추상화(서비스별 헬퍼 객체, 클라이언트와 별개로)가 개선되거나 업데이트되었습니다. 또한 일부는 제거되었습니다.

두 버전의 코드 샘플 비교 SDK

다음 예제에서는 의 버전 3을 사용하는 방법이 버전 2와 다를 AWS SDK for PHP 수 있는 몇 가지 방법을 보여줍니다.

예: Amazon S3 ListObjects Operation

의 버전 2에서 SDK

<?php

require '/path/to/vendor/autoload.php';

use Aws\S3\S3Client;
use Aws\S3\Exception\S3Exception;

$s3 = S3Client::factory([
    'profile' => 'my-credential-profile',
    'region'  => 'us-east-1'
]);

try {
    $result = $s3->listObjects([
        'Bucket' => 'amzn-s3-demo-bucket',
        'Key'    => 'my-object-key'
    ]);

    foreach ($result['Contents'] as $object) {
        echo $object['Key'] . "\n";
    }
} catch (S3Exception $e) {
    echo $e->getMessage() . "\n";
}

의 버전 3에서 SDK

주요 차이점:

<?php

require '/path/to/vendor/autoload.php';

use Aws\S3\S3Client;
use Aws\S3\Exception\S3Exception;

$s3 = new S3Client([
    'profile' => 'my-credential-profile',
    'region'  => 'us-east-1',
    'version' => '2006-03-01'
]);

try {
    $result = $s3->listObjects([
        'Bucket' => 'amzn-s3-demo-bucket',
        'Key'    => 'my-object-key'
    ]);

    foreach ($result['Contents'] as $object) {
        echo $object['Key'] . "\n";
    }
} catch (S3Exception $e) {
    echo $e->getMessage() . "\n";
}

예제: 전역 구성으로 클라이언트 인스턴스화

의 버전 2에서 SDK

<?php return array(
    'includes' => array('_aws'),
    'services' => array(
        'default_settings' => array(
            'params' => array(
                'profile' => 'my_profile',
                'region'  => 'us-east-1'
            )
        ),
        'dynamodb' => array(
            'extends' => 'dynamodb',
            'params' => array(
                'region'  => 'us-west-2'
            )
        ),
    )
);

<?php

require '/path/to/vendor/autoload.php';

use Aws\Common\Aws;

$aws = Aws::factory('path/to/my/config.php');

$sqs = $aws->get('sqs');
// Note: SQS client will be configured for us-east-1.

$dynamodb = $aws->get('dynamodb');
// Note: DynamoDB client will be configured for us-west-2.

의 버전 3에서 SDK

주요 차이점:

<?php

require '/path/to/vendor/autoload.php';

$sdk = new Aws\Sdk([
    'profile' => 'my_profile',
    'region' => 'us-east-1',
    'version' => 'latest',
    'DynamoDb' => [
        'region' => 'us-west-2',
    ],
]);

$sqs = $sdk->createSqs();
// Note: Amazon SQS client will be configured for us-east-1.

$dynamodb = $sdk->createDynamoDb();
// Note: DynamoDB client will be configured for us-west-2.