PHP簡單下載 - Object Storage Service

本文介紹如何通過簡單下載方法將儲存空間（Bucket）中的檔案（Object）下載到本地，此方法操作簡便，適合快速將雲端儲存的檔案下載到本地。

注意事項

本文範例程式碼以華東1（杭州）的地區IDcn-hangzhou為例，預設使用外網Endpoint，如果您希望通過與OSS同地區的其他阿里雲產品訪問OSS，請使用內網Endpoint。關於OSS支援的Region與Endpoint的對應關係，請參見OSS地區和訪問網域名稱。
要將檔案下載到本地，您必須有oss:GetObject許可權。具體操作，請參見為RAM使用者授予自訂的權限原則。
本文以從環境變數讀取存取憑證為例。更多配置訪問憑證的樣本，請參見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], // 對象名稱（必填）
];

// 將參數描述轉換為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);

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

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

// 定義要儲存的本地檔案路徑
$localFilePath = 'path/to/local/file.txt'; // 請替換為實際的檔案路徑

// 將內容寫入本地檔案
file_put_contents( $localFilePath, $result->body->getContents());

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

常見使用情境

根據限定條件下載

當從Bucket中下載單個檔案（Object）時，您可以指定基於檔案最後修改時間或ETag（檔案內容標識符）的條件限制。只有當這些條件得到滿足時才會執行下載操作；如果不滿足，則會返回錯誤並且不會觸發下載。利用限定條件下載不僅可以減少不必要的網路傳輸和資源消耗，還能提高下載效率。

OSS支援的限定條件如下：

說明

If-Modified-Since和If-Unmodified-Since可以同時存在。If-Match和If-None-Match也可以同時存在。
您可以通過ossClient.getObjectMeta方法擷取ETag。

參數	描述
IfModifiedSince	如果指定的時間早於實際修改時間，則正常傳輸檔案，否則返回錯誤（304 Not modified）。
IfUnmodifiedSince	如果指定的時間等於或者晚於檔案實際修改時間，則正常傳輸檔案，否則返回錯誤（412 Precondition failed）。
IfMatch	如果指定的ETag和OSS檔案的ETag匹配，則正常傳輸檔案，否則返回錯誤（412 Precondition failed）。
IfNoneMatch	如果指定的ETag和OSS檔案的ETag不匹配，則正常傳輸檔案，否則返回錯誤（304 Not modified）。

以下範例程式碼展示了如何使用限定條件下載。

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

// 假設Object最後修改時間為2024年10月21日18:43:02，則填寫的UTC早於該時間時，將滿足IfModifiedSince的限定條件，並觸發下載行為
$ifModifiedSince = "Sun, 21 Oct 2024 18:43:02 GMT";

// 假設ETag為e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855，則填寫的ETag與Object的ETag值相等時，將滿足IfMatch的限定條件，並觸發下載行為
$etag = "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855";

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

// 執行擷取對象操作
$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 // 對象的內容
);

流式下載

以下代碼展示了在調用GetObject請求時，設定stream參數支援流式下載。

<?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";
        exit(1); // 如果必填參數缺失，則退出程式
    }
}

// 從解析的參數中提取值
$region = $options["region"]; // Bucket 所在的地區
$bucket = $options["bucket"]; // Bucket 名稱
$key = $options["key"];       // 對象名稱

// 使用 EnvironmentVariableCredentialsProvider 從環境變數中載入訪問憑證
// 確保環境變數 ALIBABA_CLOUD_ACCESS_KEY_ID 和 ALIBABA_CLOUD_ACCESS_KEY_SECRET 已正確設定
$credentialsProvider = new Oss\Credentials\EnvironmentVariableCredentialsProvider();

// 載入 SDK 的預設配置
$cfg = Oss\Config::loadDefault();
$cfg->setCredentialsProvider($credentialsProvider); // 設定憑證提供者
$cfg->setRegion($region); // 設定 Bucket 所在的地區

// 如果命令列提供了 endpoint 參數，則使用指定的訪問網域名稱
if (isset($options["endpoint"])) {
    $cfg->setEndpoint($options["endpoint"]);
}

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

// 建立 GetObjectRequest 對象，指定 Bucket 和對象 Key
$request = new Oss\Models\GetObjectRequest(bucket: $bucket, key: $key);

// 調用 getObject 方法下載對象，設定 stream 選項為 true，以便以流的方式處理大檔案
$result = $client->getObject(request: $request, args: ['request_options' => ['stream' => true]]);

// 擷取流對象
$stream = $result->body;

// 讀取流內容（分塊處理）
while (!$stream->eof()) { // 檢查流是否已結束
    echo $stream->read(1024); // 每次讀取 1KB 資料並輸出
}

下載檔案時顯示進度

以下代碼展示了在調用GetObject請求時，設定顯示下載進度。

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

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

# 設定進度回呼函數，用於顯示下載的進度資訊
$request->progressFn = static function (int $increment, int $transferred, int $total) {
    echo sprintf("已經下載：%d" . PHP_EOL, $transferred);
    echo sprintf("本次下載：%d" . PHP_EOL, $increment);
    echo sprintf("資料總共：%d" . PHP_EOL, $total);
    echo '-------------------------------------------' . PHP_EOL;
};

// 執行擷取對象操作
$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 // 對象的內容
);

Object Storage Service：簡單下載（PHP SDK V2）