全部產品
Search
文件中心

Object Storage Service:PHP拷貝檔案

更新時間:Nov 02, 2024

本文介紹如何將源儲存空間(Bucket)中的檔案(Object)拷貝到同一地區下相同或不同目標Bucket。

注意事項

  • 本文以華東1(杭州)外網Endpoint為例。如果您希望通過與OSS同地區的其他阿里雲產品訪問OSS,請使用內網Endpoint。關於OSS支援的Region與Endpoint的對應關係,請參見OSS地區和訪問網域名稱

  • 本文以OSS網域名稱建立OSSClient為例。如果您希望通過自訂網域名、STS等方式建立OSSClient,請參見建立OssClient

  • 通過RAM使用者執行拷貝操作時,您必須有源Object的讀許可權(oss:GetObject)及目標Bucket的讀寫權限(oss:PutObjectoss:GetObject)。有關為RAM使用者授權自訂權限原則的具體步驟,請參見RAM Policy常見樣本

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

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

拷貝小檔案

通過$ossClient->copyObject方法拷貝小於1 GB檔案的範例程式碼如下:

<?php
if (is_file(__DIR__ . '/../autoload.php')) {
    require_once __DIR__ . '/../autoload.php';
}
if (is_file(__DIR__ . '/../vendor/autoload.php')) {
    require_once __DIR__ . '/../vendor/autoload.php';
}

use OSS\Credentials\EnvironmentVariableCredentialsProvider;
use OSS\OssClient;
use OSS\CoreOssException;

// 從環境變數中擷取訪問憑證。運行本程式碼範例之前,請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。 
$provider = new EnvironmentVariableCredentialsProvider();
// Endpoint以華東1(杭州)為例,其它Region請按實際情況填寫。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// 填寫源Bucket名稱,例如srcexamplebucket。
$from_bucket = "srcexamplebucket";
// 填寫源Object的完整路徑。Object完整路徑中不能包含Bucket名稱,例如srcdir/exampleobject.txt。
$from_object = "srcdir/exampleobject.txt";
// 填寫與源Bucket處於同一地區的目標Bucket名稱,例如destexamplebucket。
// 當在同一個Bucket內拷貝檔案時,請確保源Bucket名稱和目標Bucket名稱相同。
$to_bucket = "destexamplebucket";
// 填寫目標Object的完整路徑。Object完整路徑中不能包含Bucket名稱,例如destdir/exampleobject.txt。
$to_object = "destdir/exampleobject.txt";

$options = array(
    'headers'=>array(
      // 指定CopyObject操作時是否覆蓋同名目標Object。此處設定為true,表示禁止覆蓋同名Object。
      // 'x-oss-forbid-overwrite' => 'true',
      // 如果源Object的ETag值和您提供的ETag相等,則執行拷貝操作,並返回200 OK。
      // 'x-oss-copy-source-if-match' => '5B3C1A2E053D763E1B002CC****',
      // 如果源Object的ETag值和您提供的ETag不相等,則執行拷貝操作,並返回200 OK。
      // 'x-oss-copy-source-if-none-match' => '5B3C1A2E053D763E1B002CC****',
      // 如果指定的時間等於或者晚於檔案實際修改時間,則正常拷貝檔案,並返回200 OK。
      // 'x-oss-copy-source-if-unmodified-since' => gmdate('2021-12-09T07:01:56.000Z'),
      // 如果指定的時間早於檔案實際修改時間,則正常拷貝檔案,並返回200 OK。
      // 'x-oss-copy-source-if-modified-since' => gmdate('2021-12-09T07:01:56.000Z'),
      // 指定設定目標Object中繼資料的方式。此處設定為COPY,表示複製源Object的中繼資料到目標Object。
      // 'x-oss-metadata-directive' => 'COPY',
      // 指定OSS建立目標Object時使用的伺服器端密碼編譯演算法。
      // 'x-oss-server-side-encryption' => 'KMS',
      // 表示KMS託管的使用者主要金鑰,該參數僅在x-oss-server-side-encryption為KMS時有效。
      // 'x-oss-server-side-encryption-key-id' => '9468da86-3509-4f8d-a61e-6eab****',
      // 指定OSS建立目標Object時的存取權限。此處設定為private,表示只有Object的擁有者和授權使用者有該Object的讀寫權限,其他使用者沒有許可權操作該Object。
      // 'x-oss-object-acl' => 'private',
      // 指定Object的儲存類型。此處設定為Standard,表示標準儲存類型。
      // 'x-oss-storage-class' => 'Standard',
      // 指定Object的對象標籤,可同時設定多個標籤。
      // 'x-oss-tagging' => 'k1=v1&k2=v2&k3=v3',
      // 指定設定目標Object對象標籤的方式。此處設定為COPY,表示複製源Object的對象標籤到目標Object。
      // 'x-oss-tagging-directive' => 'COPY',
    ),
);

try{
    $config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
    $ossClient = new OssClient($config);

    $ossClient->copyObject($from_bucket, $from_object, $to_bucket, $to_object);
} catch(OssException $e) {
    printf(__FUNCTION__ . ": FAILED\n");
    printf($e->getMessage() . "\n");
    return;
}
print(__FUNCTION__ . ": OK" . "\n");            

拷貝大檔案

對於大於1 GB的檔案,需要使用分區拷貝(UploadPartCopy)。分區拷貝分為三步:

  1. 通過$ossClient->initiateMultipartUpload初始化分區拷貝任務。

  2. 通過$ossClient->uploadPartCopy進行分區拷貝。除最後一個分區外,其它分區都要大於100 KB。

  3. 通過$ossClient->completeMultipartUpload提交分區拷貝任務。

以下代碼用於分區拷貝:

<?php
if (is_file(__DIR__ . '/../autoload.php')) {
    require_once __DIR__ . '/../autoload.php';
}
if (is_file(__DIR__ . '/../vendor/autoload.php')) {
    require_once __DIR__ . '/../vendor/autoload.php';
}

use OSS\Credentials\EnvironmentVariableCredentialsProvider;
use OSS\OssClient;
use OSS\CoreOssException;

// 從環境變數中擷取訪問憑證。運行本程式碼範例之前,請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。 
$provider = new EnvironmentVariableCredentialsProvider();
// Endpoint以杭州為例,其它Region請按實際情況填寫。
$endpoint = "http://oss-cn-hangzhou.aliyuncs.com";
// 填寫源Bucket名稱。
$from_bucket = "yourSrcBucketName";
// 填寫源Object的完整路徑。Object完整路徑中不能包含Bucket名稱,例如srcdir/exampleobject.txt。
$from_object = "yourSrcObjectName";
// 填寫與源Bucket處於同一地區的目標Bucket名稱。
$to_bucket = "yourDestBucketName";
// 填寫目標Object的完整路徑。Object完整路徑中不能包含Bucket名稱,例如destdir/exampleobject.txt。
$to_object = 'yourDestObjectName';

// 根據實際情況設定分區大小,單位為位元組。
$part_size = 256*1024*1024;

try{
    $config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
    $ossClient = new OssClient($config);

    $objectMeta = $ossClient->getObjectMeta($from_bucket, $from_object);

    $length = $objectMeta['content-length'] + 0;

    // 初始化分區拷貝任務。
    $upload_id = $ossClient->initiateMultipartUpload($to_bucket, $to_object);

    // 分區拷貝。
    $pieces = $ossClient->generateMultiuploadParts($length, $part_size);
    $response_upload_part = array();
    $copyId = 1;
    $upload_position = 0;

    foreach ($pieces as $i => $piece) {
        $from_pos = $upload_position + (integer)$piece['seekTo'];
        $to_pos = (integer)$piece['length'] + $from_pos - 1;
        $up_options = array(
            'start' => $from_pos,
            'end' => $to_pos,
              'headers'=>array(
                // 如果源Object的ETag值和您提供的ETag相等,則執行拷貝操作,並返回200 OK。
                // 'x-oss-copy-source-if-match' => '5B3C1A2E053D763E1B002CC****',
                // 如果源Object的ETag值和您提供的ETag不相等,則執行拷貝操作,並返回200 OK。
                // 'x-oss-copy-source-if-none-match' => '5B3C1A2E053D763E1B002CC****',
                // 如果指定的時間等於或者晚於檔案實際修改時間,則正常拷貝檔案,並返回200 OK。
                // 'x-oss-copy-source-if-unmodified-since' => gmdate('2021-12-09T07:01:56.000Z'),
                // 如果指定的時間早於檔案實際修改時間,則正常拷貝檔案,並返回200 OK。
                // 'x-oss-copy-source-if-modified-since' => gmdate('2021-12-09T07:01:56.000Z'),
          ),
        );
        $response_upload_part[] = $ossClient->uploadPartCopy( $from_bucket, $from_object, $to_bucket, $to_object, $copyId, $upload_id, $up_options);
        $copyId = $copyId + 1;
    }

    // 完成分區拷貝。
    $upload_parts = array();
    foreach ($response_upload_part as $i => $etag) {
        $upload_parts[] = array(
            'PartNumber' => ($i + 1),
            'ETag' => $etag,
        );
    }
    $result = $ossClient->completeMultipartUpload($to_bucket, $to_object, $upload_id, $upload_parts);
} catch(OssException $e) {
    printf(__FUNCTION__ . ": FAILED\n");
    printf($e->getMessage() . "\n");
    return;
}
print(__FUNCTION__ . ": OK" . "\n");

相關文檔

  • 拷貝小檔案

    • 關於拷貝小檔案的完整範例程式碼,請參見GitHub樣本

    • 關於拷貝小檔案的API介面說明,請參見CopyObject

  • 拷貝大檔案

    • 關於拷貝大檔案的完整範例程式碼,請參見GitHub樣本

    • 關於拷貝大檔案的API介面說明,請參見UploadPartCopy