このトピックでは、OSS SDK for PHP V2 の Downloader モジュールを使用してファイルをダウンロードする方法について説明します。
注
このトピックのサンプルコードでは、中国 (杭州) リージョン (
cn-hangzhou) のパブリックエンドポイントを使用します。同じリージョン内の他の Alibaba Cloud サービスから OSS にアクセスする場合は、内部エンドポイントを使用できます。OSS リージョンとエンドポイントのマッピングの詳細については、「リージョンとエンドポイント」をご参照ください。このトピックでは、環境変数からアクセス資格情報を取得する例を示します。詳細については、「PHP のアクセス資格情報を設定する」をご参照ください。
ファイルをダウンロードするには、
oss:GetObject権限が必要です。詳細については、「RAM ユーザーにカスタム権限を付与する」をご参照ください。
メソッドの定義
Downloader 機能の紹介
OSS SDK for PHP V2 の Downloader モジュールは、基盤となる実装の詳細を抽象化することでファイルダウンロードプロセスを簡素化する高レベルのインターフェイスを提供します。
Downloader モジュールは、範囲のダウンロードを使用してファイルを自動的に複数の小さなシャードに分割して同時ダウンロードを行うため、ダウンロードパフォーマンスが向上します。
Downloader モジュールは、再開可能なダウンロードもサポートしています。ダウンロード中に、完了したシャードの状態が記録されます。ネットワークの中断や予期しないプログラムの終了によってダウンロードが失敗した場合、ブレークポイントレコードファイルを使用して、最後に成功したシャードからダウンロードを再開できます。
次の表に、Downloader モジュールの一般的なメソッドを示します。
final class Downloader
{
...
public function __construct($client, array $args = [])
public function downloadFile(Models\GetObjectRequest $request, string $filepath, array $args = []): Models\DownloadResult
public function downloadTo(Models\GetObjectRequest $request, \Psr\Http\Message\StreamInterface $stream, array $args = []): Models\DownloadResult
}リクエストパラメーター
パラメーター | タイプ | 説明 |
request | GetObjectRequest | オブジェクトダウンロードのリクエストパラメーター。パラメーターは GetObject 操作のパラメーターと同じです。 |
filePath | string | ローカルファイルのパス。 |
args | array | (オプション) 構成オプション。 |
次の表に、args の共通パラメーターを示します。
パラメーター | タイプ | 説明 |
part_size | int | シャードサイズ。デフォルト値は 6 MiB です。 |
parallel_num | int | 同時ダウンロードタスクの数。デフォルト値は 3 です。このパラメーターは、グローバルな同時実行数制限ではなく、単一の呼び出しの同時実行数制限を指定します。 |
use_temp_file | bool | ファイルをダウンロードするときに一時ファイルを使用するかどうかを指定します。デフォルトでは、一時ファイルが使用されます。ファイルはまず一時ファイルにダウンロードされます。ダウンロードが成功すると、一時ファイルはオブジェクトファイルに名前が変更されます。 |
Downloader をインスタンス化するときに、構成オプションを指定してダウンロードの動作をカスタマイズできます。これらのオプションは、Downloader インスタンスを作成するとき、または個々のダウンロード呼び出しごとに適用できます。
Downloader インスタンスの構成パラメーターを設定します:
$d = $client->newDownloader(['part_size' => 10 * 1024 * 1024]); // パートサイズを 10MB に設定各ダウンロードリクエストの構成パラメーターを設定します:
$d->downloadFile( new Oss\Models\GetObjectRequest( bucket: 'bucket', // バケット名 key: 'key' // オブジェクト名 ), filepath: '/local/dir/example', // ローカルファイルパス args: ['part_size' => 10 * 1024 * 1024] // パートサイズを 10MB に設定 );
サンプルコード
次のコードを使用して、バケットからローカルマシンにファイルをダウンロードできます。
<?php
// autoload ファイルをインポートして、依存ライブラリが正しくロードされるようにします。
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], // バケットが配置されているリージョン。(必須)
"endpoint" => ['help' => 'The domain names that other services can use to access OSS.', 'required' => False], // エンドポイント。(オプション)
"bucket" => ['help' => 'The name of the bucket', 'required' => True], // バケットの名前。(必須)
"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 = $options["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); // バケットが配置されているリージョンを設定します。
if (isset($options["endpoint"])) {
$cfg->setEndpoint($options["endpoint"]); // エンドポイントが指定されている場合は、エンドポイントを設定します。
}
// OSS クライアントインスタンスを作成します。
$client = new Oss\Client($cfg);
// ダウンローダーインスタンスを作成します。
$downloader = $client->newDownloader();
// ダウンロードしたコンテンツを保存するローカルファイルパスを定義します。
$filename = "/Users/yourLocalPath/yourFileName"; // ファイルパスの例。
touch($filename); // 空のファイルを作成して、ファイルが存在することを確認します。
// 分割ダウンロード操作を実行します。
$result = $downloader->downloadFile(
new Oss\Models\GetObjectRequest(
bucket: $bucket,
key: $key
),
$filename
);
// ダウンロード結果を出力します。
printf(
'download status code:' . $result->statusCode . PHP_EOL .
'download request id:' . $result->requestId . PHP_EOL .
'download result:' . var_export($result, true) . PHP_EOL
);
シナリオ
関連情報
ダウンローダーの完全な例については、「GitHub の例」をご参照ください。