如何通過PHP SDK V2下載指定範圍內的資料 - Object Storage Service

本文介紹如何使用範圍下載方法，協助您高效地擷取檔案中的特定部分資料。

注意事項

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

重要

假設現有大小為1000 Bytes的Object，則指定的正常下載範圍應為0~999。如果指定範圍不在有效區間，會導致Range不生效，響應傳回值為200，並傳送整個Object的內容。請求不合法的樣本及返回說明如下：
- 若指定了Range: bytes=500-2000，此時範圍末端取值不在有效區間，返回整個檔案的內容，且HTTP Code為200。
- 若指定了Range: bytes=1000-2000，此時範圍首端取值不在有效區間，返回整個檔案的內容，且HTTP Code為200。
您可以在請求中增加要求標頭x-oss-range-behavior:standard指定標準行為範圍下載，改變指定範圍不在有效區間時OSS的下載行為。假設現有大小為1000 Bytes的Object：
- 若指定了Range: bytes=500-2000，此時範圍末端取值不在有效區間，返回500~999位元組範圍內容，且HTTP Code為206。
- 若指定了Range: bytes=1000-2000，此時範圍首端取值不在有效區間，返回HTTP Code為416，錯誤碼為InvalidRange。

範例程式碼

以下代碼展示了在請求中增加要求標頭RangeBehavior:standard來指定標準下載行為，下載指定範圍內的檔案資料。

<?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);

// 指定標準下載行為，此處設定為'standard'
$rangeBehavior = 'standard';

// 指定範圍要求標頭，用於擷取對象的部分內容
$rangeHeader = 'bytes=0-10';

// 建立GetObjectRequest對象，用於擷取指定對象的內容
$request = new Oss\Models\GetObjectRequest(
            bucket: $bucket,
            key: $key,
            rangeBehavior: $rangeBehavior,
            rangeHeader: $rangeHeader);

// 執行擷取對象操作
$result = $client->getObject($request);

// 列印擷取結果
// 輸出HTTP狀態代碼、請求ID以及對象的內容
printf(
    'status code:' . $result->statusCode . PHP_EOL . // HTTP狀態代碼，例如200表示成功
    'request id:' . $result->requestId . PHP_EOL . // 請求ID，用於調試或追蹤請求
    'object content:' . $result->body->getContents() . PHP_EOL // 對象的內容
);