本文介紹如何使用PHP SDK V2的UploadPartCopy方法,將源Bucket中的多個分區檔案拷貝到同一地區下相同或不同目標Bucket中,然後合并成一個完整的檔案對象。
注意事項
本文範例程式碼以華東1(杭州)的地區ID
cn-hangzhou為例,預設使用外網Endpoint,如果您希望通過與OSS同地區的其他阿里雲產品訪問OSS,請使用內網Endpoint。關於OSS支援的Region與Endpoint的對應關係,請參見OSS地區和訪問網域名稱。要進行拷貝檔案,您必須擁有源檔案的讀許可權及目標Bucket的讀寫權限。
不支援跨地區拷貝。例如不能將華東1(杭州)地區儲存空間中的檔案拷貝到華北1(青島)地區。
拷貝檔案時,您需要確保源Bucket和目標Bucket均未設定合規保留原則,否則報錯The object you specified is immutable.。
本文以從環境變數讀取存取憑證為例。更多配置訪問憑證的樣本,請參見PHP配置訪問憑證。
範例程式碼
您可以使用以下代碼將多個分區檔案從源儲存空間拷貝到目標儲存空間,然後合并成完整的檔案對象。
<?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-bucket" => ['help' => 'The name of the source bucket', 'required' => False], // 源Bucket名稱(可選)
"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
}
// 設定預設訪問網域名稱
$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);
// 確定源Bucket名稱
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; // 分區大小,單位為位元組(此處設定為64MB)
$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);
// 設定源Bucket名稱(如果提供了源Bucket)
if (!empty($options["src-bucket"])) {
$partRequest->sourceBucket = $options["src-bucket"];
}
// 設定來源物件名稱
$partRequest->sourceKey = $srcKey;
// 執行分區複製操作
$partResult = $client->uploadPartCopy($partRequest);
// 建立分區資訊並添加到分區列表
$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樣本。