如何PHP SDK V2設定、擷取檔案中繼資料 - Object Storage Service

本文介紹如何使用OSS PHP SDK設定和擷取檔案中繼資料。

注意事項

本文範例程式碼以華東1（杭州）的地區IDcn-hangzhou為例，預設使用外網Endpoint，如果您希望通過與OSS同地區的其他阿里雲產品訪問OSS，請使用內網Endpoint。關於OSS支援的Region與Endpoint的對應關係，請參見OSS地區和訪問網域名稱。
要設定檔案中繼資料，您必須具有oss:PutObject許可權；要擷取檔案中繼資料，您必須具有oss:GetObject許可權。具體操作，請參見為RAM使用者授予自訂的權限原則。

上傳檔案時設定中繼資料

以下代碼使用上傳檔案（PutObject）為例設定中繼資料，包括設定檔案到期時間、設定檔案為公用讀取、設定自訂中繼資料來標識檔案的用途或屬性等。其他上傳類對象介面都支援設定中繼資料，且設定方式與PutObject方法一致。

<?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], // 對象名稱（必填）
    "file" => ['help' => 'Local path to the file you want to upload.', '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"];       // 對象名稱
$file = $options["file"];     // 本地檔案路徑

// 載入環境變數中的憑證資訊
// 使用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);

// 檢查檔案是否存在
if (!file_exists($file)) {
    echo "Error: The specified file does not exist." . PHP_EOL; // 如果檔案不存在，輸出錯誤資訊並退出
    exit(1);
}

// 開啟檔案並準備上傳
// 使用fopen以唯讀模式開啟檔案，並通過Utils::streamFor將檔案內容轉換為流
$body = Oss\Utils::streamFor(fopen($file, 'r'));

// 建立PutObjectRequest對象，用於上傳檔案
$request = new Oss\Models\PutObjectRequest(
            bucket: $bucket,
            key: $key,
            metadata: [ 'Author' => 'alibaba oss sdk',
                        'Date' => '2024-07-01']); // 設定中繼資料資訊

$request->body = $body; // 佈建要求體為檔案流

// 執行上傳操作
$result = $client->putObject($request);

// 列印上傳結果
// 輸出HTTP狀態代碼、請求ID和ETag，用於驗證上傳是否成功
printf(
    'status code:' . $result->statusCode . PHP_EOL . // HTTP狀態代碼，例如200表示成功
    'request id:' . $result->requestId . PHP_EOL .   // 請求ID，用於調試或追蹤請求
    'etag:' . $result->etag . PHP_EOL               // 對象的ETag，用於標識對象的唯一性
);

擷取檔案中繼資料

使用HeadObject方法擷取對象的所有中繼資料

您可以通過以下代碼使用HeadObject方法擷取指定Object的所有中繼資料。

<?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], // 對象名稱（必填）
];

// 將參數描述轉換為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"];       // 對象名稱

// 載入環境變數中的憑證資訊
// 使用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);

// 建立HeadObjectRequest對象，用於擷取對象的中繼資料資訊
$request = new Oss\Models\HeadObjectRequest($bucket, $key);

// 執行擷取對象中繼資料的操作
$result = $client->headObject($request);

// 列印擷取中繼資料的結果
printf(
    'status code:' . $result->statusCode . PHP_EOL . // HTTP狀態代碼，例如200表示成功
    'request id:' . $result->requestId . PHP_EOL .   // 請求ID，用於調試或追蹤請求
    'result:' . var_export($result, true) . PHP_EOL  // 擷取到的中繼資料詳細結果
);

使用GetObjectMeta方法擷取對象的部分中繼資料

說明

使用GetObjectMeta方法僅可以擷取部分的對象中繼資料，包括：返回內容的長度（ContentLength）、實體標籤（ETag）、返回的對象最後一次被修改的時間（LastModified）、對象最後一次被訪問的時間（LastAccessTime）、對象的版本ID（VersionId）、對象的 64 位元 CRC 值（HashCRC64）。

您可以通過以下代碼使用GetObjectMeta方法擷取指定對象的部分中繼資料。

<?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], // 對象名稱（必填）
];

// 將參數描述轉換為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"];       // 對象名稱

// 載入環境變數中的憑證資訊
// 使用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);

// 建立GetObjectMetaRequest對象，用於擷取對象的中繼資料資訊
$request = new Oss\Models\GetObjectMetaRequest($bucket, $key);

// 執行擷取對象中繼資料的操作
$result = $client->getObjectMeta($request);

// 列印擷取中繼資料的結果
printf(
    'status code:' . $result->statusCode . PHP_EOL . // HTTP狀態代碼，例如200表示成功
    'request id:' . $result->requestId . PHP_EOL .   // 請求ID，用於調試或追蹤請求
    'result:' . var_export($result, true) . PHP_EOL  // 擷取到的中繼資料詳細結果
);

修改已有檔案的中繼資料

使用CopyObject方法修改對象中繼資料

您可以通過以下代碼使用CopyObject方法拷貝來源物件時設定目標對象的中繼資料。

<?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
}

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

// 建立CopyObjectRequest對象，用於複製對象
$request = new Oss\Models\CopyObjectRequest(
            bucket: $bucket,
            key: $key,
            metadata: [ 'x-oss-meta-tag1' => 'value1',
            'x-oss-meta-tag2' => 'value2'],
            metadataDirective: 'Replace');

if (!empty($options["src-bucket"])) {
    $request->sourceBucket = $options["src-bucket"]; // 如果提供了源Bucket名稱，則設定sourceBucket
}
$request->sourceKey = $srcKey; // 設定來源物件名稱

// 執行複製對象操作
$result = $client->copyObject($request);

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

使用拷貝管理器Copier.Copy方法修改對象中繼資料

您可以通過以下代碼使用拷貝管理器Copier.Copy方法拷貝來源物件時設定目標對象的中繼資料，包括使用新的中繼資料替換原來的中繼資料，清除原來的中繼資料或者更新指定的部分中繼資料，在拷貝對象完成後可以選擇是否刪除來源物件。

<?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-metadata-and-tagging-$key"; // 目標對象名稱
$copyRequest = new Oss\Models\CopyObjectRequest(
    bucket: $bucket,
    key: $dstKey,
    sourceBucket: $bucket,
    sourceKey: $srcKey
);
$copyRequest->metadataDirective = 'REPLACE'; // 替換中繼資料
$copyRequest->metadata = ['test1' => 'val1', 'test2' => 'value2']; // 自訂中繼資料
$result = $copier->copy(
    request: $copyRequest,
);
printf(
    'status code:' . $result->statusCode . PHP_EOL . // HTTP狀態代碼
    'request id:' . $result->requestId . PHP_EOL     // 請求ID
);