PHP范围下载

本文介绍如何使用范围下载方法,帮助您高效地获取文件中的特定部分数据。

注意事项

  • 本文示例代码以华东1(杭州)的地域IDcn-hangzhou为例,默认使用外网Endpoint,如果您希望通过与OSS同地域的其他阿里云产品访问OSS,请使用内网Endpoint。关于OSS支持的RegionEndpoint的对应关系,请参见OSS地域和访问域名

  • 要使用范围下载,您必须有oss:GetObject权限。具体操作,请参见RAM用户授权自定义的权限策略

重要
  • 假设现有大小为1000 BytesObject,则指定的正常下载范围应为0~999。如果指定范围不在有效区间,会导致Range不生效,响应返回值为200,并传送整个Object的内容。请求不合法的示例及返回说明如下:

    • 若指定了Range: bytes=500-2000,此时范围末端取值不在有效区间,返回整个文件的内容,且HTTP Code200。

    • 若指定了Range: bytes=1000-2000,此时范围首端取值不在有效区间,返回整个文件的内容,且HTTP Code200。

  • 您可以在请求中增加请求头x-oss-range-behavior:standard指定标准行为范围下载,改变指定范围不在有效区间时OSS的下载行为。假设现有大小为1000 BytesObject:

    • 若指定了Range: bytes=500-2000,此时范围末端取值不在有效区间,返回500~999字节范围内容,且HTTP Code206。

    • 若指定了Range: bytes=1000-2000,此时范围首端取值不在有效区间,返回HTTP Code416,错误码为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 // 对象的内容
);