Object Storage Service:マルチパートコピー (PHP SDK V2)

注意事項

• このトピックのサンプルコードでは、中国 (杭州) リージョン (cn-hangzhou) を例として使用します。デフォルトでは、パブリックエンドポイントを使用してバケット内のリソースにアクセスします。同じリージョン内の他の Alibaba Cloud サービスからバケット内のリソースにアクセスする場合は、内部エンドポイントを使用できます。OSS がサポートするリージョンとエンドポイントの詳細については、「OSS のリージョンとエンドポイント」をご参照ください。

• オブジェクトをコピーするには、ソースオブジェクトに対する読み取り権限と、宛先バケットに対する読み取りおよび書き込み権限が必要です。

• リージョン間のコピーはサポートされていません。たとえば、中国 (杭州) リージョンのバケットから中国 (青島) リージョンのバケットにオブジェクトをコピーすることはできません。

• オブジェクトをコピーするときは、ソースバケットまたは宛先バケットにリテンションポリシーが設定されていないことを確認してください。設定されている場合、The object you specified is immutable. エラーが報告されます。

• このトピックでは、環境変数からアクセス資格情報を取得する方法の例を示します。アクセス資格情報を設定する方法の他の例については、「PHP のアクセス資格情報を設定する」をご参照ください。

サンプルコード

次のコードを使用して、ソースオブジェクトから宛先バケットに複数のパートをコピーし、それらを結合して完全なオブジェクトにすることができます。

<?php

// autoload ファイルをインクルードして、依存ライブラリがロードされるようにします。
require_once __DIR__ . '/../vendor/autoload.php';

use AlibabaCloud\Oss\V2 as Oss;

// コマンドライン引数の説明を定義します。
$optsdesc = [
    "region" => ['help' => 'The region in which the bucket is located.', 'required' => True], // バケットが配置されているリージョン。(必須)
    "endpoint" => ['help' => 'The domain names that other services can use to access OSS.', 'required' => False], // エンドポイント。(オプション)
    "bucket" => ['help' => 'The name of the bucket', 'required' => True], // 宛先バケットの名前。(必須)
    "key" => ['help' => 'The name of the object', 'required' => True], // 宛先オブジェクトの名前。(必須)
    "src-bucket" => ['help' => 'The name of the source bucket', 'required' => False], // ソースバケットの名前。(オプション)
    "src-key" => ['help' => 'The name of the source object', 'required' => True], // ソースオブジェクトの名前。(必須)
];

// 引数の説明を getopt で必要なロングオプション形式に変換します。
// 各引数の後にコロン ":" を追加して、引数に値が必要であることを示します。
$longopts = \array_map(function ($key) {
    return "$key:";
}, array_keys($optsdesc));

// コマンドライン引数を解析します。
$options = getopt("", $longopts);

// 必須の引数が存在することを確認します。
foreach ($optsdesc as $key => $value) {
    if ($value['required'] === True && empty($options[$key])) {
        $help = $value['help']; // 引数のヘルプ情報を取得します。
        echo "Error: the following arguments are required: --$key, $help" . PHP_EOL;
        exit(1); // 必須の引数が欠落している場合は、プログラムを終了します。
    }
}

// 解析された引数から値を抽出します。
$region = $options["region"]; // バケットが配置されているリージョン。
$bucket = $options["bucket"]; // 宛先バケットの名前。
$key = $options["key"];       // 宛先オブジェクトの名前。
$srcKey = $options["src-key"]; // ソースオブジェクトの名前。

// 環境変数から資格情報情報をロードします。
// EnvironmentVariableCredentialsProvider を使用して、環境変数から Access Key ID と Access Key Secret を読み取ります。
$credentialsProvider = new Oss\Credentials\EnvironmentVariableCredentialsProvider();

// SDK のデフォルト構成を使用します。
$cfg = Oss\Config::loadDefault();
$cfg->setCredentialsProvider($credentialsProvider); // 資格情報プロバイダーを設定します。
$cfg->setRegion($region); // バケットが配置されているリージョンを設定します。
if (isset($options["endpoint"])) {
    $cfg->setEndpoint($options["endpoint"]); // エンドポイントが指定されている場合は、エンドポイントを設定します。
}
// デフォルトのエンドポイントを設定します。
$cfg->setEndpoint('http://oss-cn-hangzhou.aliyuncs.com');

// OSS クライアントインスタンスを作成します。
$client = new Oss\Client($cfg);

// マルチパートアップロードタスクを初期化します。
$initRequest = new Oss\Models\InitiateMultipartUploadRequest(bucket: $bucket, key: $key);
$initResult = $client->initiateMultipartUpload($initRequest);

// ソースバケットの名前を決定します。
if (!empty($options["src-bucket"])) {
    $sourceBucket = $options["src-bucket"];
} else {
    $sourceBucket = $bucket;
}

// ソースオブジェクトのメタデータを取得します。
$headResult = $client->headObject(new Oss\Models\HeadObjectRequest(
    bucket: $sourceBucket,
    key: $srcKey
));

// ソースオブジェクトのサイズを取得します。
$length = $headResult->contentLength;

// パートサイズを定義し、パート数を計算します。
$partSize = 64 * 1024 * 1024; // パートサイズ (バイト単位)。この例では、パートサイズは 64 MB に設定されています。
$partsNum = intdiv(num1: $length, num2: $partSize) + intval(1); // パート数を計算し、切り上げます。

// パートリストを初期化します。
$parts = array();

// 各パートを走査し、パートコピー操作を実行します。
for ($i = 1; $i <= $partsNum; $i++) {
    $partRequest = new Oss\Models\UploadPartCopyRequest(
        bucket: $bucket,
        key: $key,
        partNumber: $i,
        uploadId: $initResult->uploadId
    );

    // パートの範囲を設定します。
    $partRequest->sourceRange = getPartRange(totalSize: $length, partSize: $partSize, partNumber: $i);

    // ソースバケットの名前を設定します (ソースバケットが指定されている場合)。
    if (!empty($options["src-bucket"])) {
        $partRequest->sourceBucket = $options["src-bucket"];
    }

    // ソースオブジェクトの名前を設定します。
    $partRequest->sourceKey = $srcKey;

    // パートコピー操作を実行します。
    $partResult = $client->uploadPartCopy($partRequest);

    // UploadPart オブジェクトを作成し、パート配列に追加します。
    $part = new Oss\Models\UploadPart(
        partNumber: $i,
        etag: $partResult->etag,
    );
    array_push($parts, $part);
}

// マルチパートアップロードタスクを完了します。
$comResult = $client->completeMultipartUpload(
    new Oss\Models\CompleteMultipartUploadRequest(
        bucket: $bucket,
        key: $key,
        uploadId: $initResult->uploadId,
        completeMultipartUpload: new Oss\Models\CompleteMultipartUpload(
            parts: $parts
        ),
    )
);

// 完了したマルチパートアップロードの結果を出力します。
printf(
    'status code:' . $comResult->statusCode . PHP_EOL . // HTTP ステータスコード。たとえば、200 は成功を示します。
    'request id:' . $comResult->requestId . PHP_EOL .   // リクエスト ID。リクエストのデバッグまたはトレースに使用されます。
    'result:' . var_export($comResult, true) . PHP_EOL  // 完了したマルチパートアップロードの詳細な結果。
);

/**
 * パートのバイト範囲を取得します。
 *
 * @param int $totalSize オブジェクトの合計サイズ。
 * @param int $partSize パートサイズ。
 * @param int $partNumber 現在のパートの番号。
 * @return string パートのバイト範囲文字列。
 */
function getPartRange(int $totalSize, int $partSize, int $partNumber): string
{
    $start = ($partNumber - 1) * $partSize; // パートの開始位置を計算します。
    $end = min($partNumber * $partSize - 1, $totalSize - 1); // パートの終了位置を計算します。
    return sprintf('bytes %d-%d', $start, $end); // 文字列をバイト範囲としてフォーマットします。
}

関連ドキュメント

• マルチパートコピーの完全なサンプルコードについては、「Github サンプル」をご参照ください。