Object Storage Service：檔案拷貝管理器（PHP SDK V2）

注意事項

• 本文範例程式碼以華東1（杭州）的地區IDcn-hangzhou為例，預設使用外網Endpoint，如果您希望通過與OSS同地區的其他阿里雲產品訪問OSS，請使用內網Endpoint。關於OSS支援的Region與Endpoint的對應關係，請參見OSS地區和訪問網域名稱。

• 要進行拷貝檔案，您必須擁有源檔案的讀許可權及目標Bucket的讀寫權限。

• 不支援跨地區拷貝。例如不能將華東1（杭州）地區儲存空間中的檔案拷貝到華北1（青島）地區。

• 拷貝檔案時，您需要確保源Bucket和目標Bucket均未設定合規保留原則，否則報錯The object you specified is immutable.。

• 本文以從環境變數讀取存取憑證為例。更多配置訪問憑證的樣本，請參見PHP配置訪問憑證。

方法定義

拷貝管理器介紹

當需要將對象從儲存空間複製到另外一個儲存空間，或者修改對象的屬性時，您可以通過拷貝介面或者分區拷貝介面來完成這個操作。這兩個介面有其適用的情境，例如：

• 拷貝介面（CopyObject）只適合拷貝 5GiB 以下的對象；

• 分區拷貝介面（UploadPartCopy）支援拷貝大於5GiB 的對象，但不支援中繼資料指令（x-oss-metadata-directive）和標籤指令（x-oss-tagging-directive）參數，拷貝時需要主動設定需要複製的中繼資料和標籤。

PHP SDK V2新增拷貝管理器Copier提供了通用的拷貝介面，隱藏了介面的差異和實現細節，可根據拷貝的請求參數自動選擇合適的介面複製對象。Copier的常用方法定義如下：

final class Copier
{
    ...
    public function __construct($client, array $args = [])

    public function copy(Models\CopyObjectRequest $request, array $args = []): Models\CopyResult
}

請求參數列表

其中，CopyObjectRequest的常用參數列舉如下：

args的常用參數列舉如下：

當使用Copier執行個體化執行個體時，您可以指定多個配置選項來自訂對象的下載行為。也可以在每次調用下載介面時，指定多個配置選項來自訂每次下載對象的行為。

• 設定Copier的配置參數：

  $c = $client->newCopier(['part_size' => 100 * 1024 * 1024]);

• 設定每次下載請求的配置參數：

  $c->copy(
      new Oss\Models\CopyObjectRequest(
          bucket: 'bucket',
          key: 'key',
          sourceBucket: 'src-bucket',
          sourceKey: 'src-key',
      ),
      args: ['part_size' => 100 * 1024 * 1024]
  );

範例程式碼

您可以使用以下代碼將對象從源儲存空間拷貝到目標儲存空間，預設會複製來源物件中繼資料和標籤。

<?php

// 引入自動負載檔案，確保依賴庫能夠正確載入
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], // Bucket所在的地區（必填）
    "endpoint" => ['help' => 'The domain names that other services can use to access OSS.', 'required' => False], // 訪問網域名稱（可選）
    "bucket" => ['help' => 'The name of the bucket', 'required' => True], // Bucket名稱（必填）
    "key" => ['help' => 'The name of the object', 'required' => True], // 目標對象名稱（必填）
    "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所在的地區
$bucket = $options["bucket"]; // 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); // 設定Bucket所在的地區
if (isset($options["endpoint"])) {
    $cfg->setEndpoint($options["endpoint"]); // 如果提供了訪問網域名稱，則設定endpoint
}

// 建立OSS用戶端執行個體
$client = new Oss\Client($cfg);

// 建立Copier執行個體，用於執行複製操作
$copier = $client->newCopier();

$dstKey = "multipart-copy-replace-empty-metadata-and-tagging-$key"; // 目標對象名稱
$copyRequest = new Oss\Models\CopyObjectRequest(
    bucket: $bucket,
    key: $dstKey,
    sourceBucket: $bucket,
    sourceKey: $srcKey
);
$copyRequest->metadataDirective = 'REPLACE'; // 替換中繼資料
$copyRequest->taggingDirective = 'REPLACE';  // 替換標籤
$result = $copier->copy(request: $copyRequest);

printf(
    'status code:' . $result->statusCode . PHP_EOL . // HTTP狀態代碼，例如200表示成功
    'request id:' . $result->requestId . PHP_EOL     // 請求ID，用於調試或追蹤請求
);

常見使用情境

<?php

// 引入自動負載檔案，確保依賴庫能夠正確載入
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], // Bucket所在的地區（必填）
    "endpoint" => ['help' => 'The domain names that other services can use to access OSS.', 'required' => False], // 訪問網域名稱（可選）
    "bucket" => ['help' => 'The name of the bucket', 'required' => True], // Bucket名稱（必填）
    "key" => ['help' => 'The name of the object', 'required' => True], // 目標對象名稱（必填）
    "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所在的地區
$bucket = $options["bucket"]; // 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); // 設定Bucket所在的地區
if (isset($options["endpoint"])) {
    $cfg->setEndpoint($options["endpoint"]); // 如果提供了訪問網域名稱，則設定endpoint
}

// 建立OSS用戶端執行個體
$client = new Oss\Client($cfg);

// 建立Copier執行個體，用於執行複製操作
$copier = $client->newCopier();

// Case 1: 空中繼資料和標籤的多部分複製
$dstKey = "multipart-copy-replace-empty-metadata-and-tagging-$key"; // 目標對象名稱
$copyRequest = new Oss\Models\CopyObjectRequest(
    bucket: $bucket,
    key: $dstKey,
    sourceBucket: $bucket,
    sourceKey: $srcKey
);
$copyRequest->metadataDirective = 'REPLACE'; // 替換中繼資料
$copyRequest->taggingDirective = 'REPLACE';  // 替換標籤
$result = $copier->copy(
    request: $copyRequest,
    args: [
        'part_size' => 1 * 1024 * 1024, //指定分區大小為1MB
        'parallel_num' => 5    // 指定拷貝任務的並發數為5
    ]
);
printf(
    'status code:' . $result->statusCode . PHP_EOL . // HTTP狀態代碼，例如200表示成功
    'request id:' . $result->requestId . PHP_EOL     // 請求ID，用於調試或追蹤請求
);

相關文檔

• 關於拷貝管理器的完整樣本，請參見GitHub樣本。