全部产品
Search

搜索本产品

    对象存储 OSS：PHP拷贝文件

    文档中心

    对象存储 OSS：PHP拷贝文件

    更新时间：Nov 01, 2024

    本文介绍如何将源存储空间（Bucket）中的文件（Object）拷贝到同一地域下相同或不同目标Bucket。

    注意事项

    • 本文以华东1（杭州）外网Endpoint为例。如果您希望通过与OSS同地域的其他阿里云产品访问OSS，请使用内网Endpoint。关于OSS支持的Region与Endpoint的对应关系，请参见OSS访问域名、数据中心、开放端口。

    • 本文以OSS域名新建OSSClient为例。如果您希望通过自定义域名、STS等方式新建OSSClient，请参见新建OssClient。

    • 通过RAM用户执行拷贝操作时，您必须有源Object的读权限（oss:GetObject）及目标Bucket的读写权限（oss:PutObject和oss:GetObject）。有关为RAM用户授权自定义权限策略的具体步骤，请参见RAM Policy常见示例。

    • 拷贝文件时，您需要确保源Bucket和目标Bucket均未设置合规保留策略，否则报错The object you specified is immutable.。

    • 不支持跨地域拷贝。例如不能将华东1（杭州）地域存储空间中的文件拷贝到华北1（青岛）地域。

    拷贝小文件

    通过$ossClient->copyObject方法拷贝小于1 GB文件的示例代码如下：

    <?php
if (is_file(__DIR__ . '/../autoload.php')) {
    require_once __DIR__ . '/../autoload.php';
}
if (is_file(__DIR__ . '/../vendor/autoload.php')) {
    require_once __DIR__ . '/../vendor/autoload.php';
}

use OSS\Credentials\EnvironmentVariableCredentialsProvider;
use OSS\OssClient;
use OSS\CoreOssException;

// 从环境变量中获取访问凭证。运行本代码示例之前，请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。 
$provider = new EnvironmentVariableCredentialsProvider();
// Endpoint以华东1（杭州）为例，其它Region请按实际情况填写。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// 填写源Bucket名称，例如srcexamplebucket。
$from_bucket = "srcexamplebucket";
// 填写源Object的完整路径。Object完整路径中不能包含Bucket名称，例如srcdir/exampleobject.txt。
$from_object = "srcdir/exampleobject.txt";
// 填写与源Bucket处于同一地域的目标Bucket名称，例如destexamplebucket。
// 当在同一个Bucket内拷贝文件时，请确保源Bucket名称和目标Bucket名称相同。
$to_bucket = "destexamplebucket";
// 填写目标Object的完整路径。Object完整路径中不能包含Bucket名称，例如destdir/exampleobject.txt。
$to_object = "destdir/exampleobject.txt";

$options = array(
    'headers'=>array(
      // 指定CopyObject操作时是否覆盖同名目标Object。此处设置为true，表示禁止覆盖同名Object。
      // 'x-oss-forbid-overwrite' => 'true',
      // 如果源Object的ETag值和您提供的ETag相等，则执行拷贝操作，并返回200 OK。
      // 'x-oss-copy-source-if-match' => '5B3C1A2E053D763E1B002CC****',
      // 如果源Object的ETag值和您提供的ETag不相等，则执行拷贝操作，并返回200 OK。
      // 'x-oss-copy-source-if-none-match' => '5B3C1A2E053D763E1B002CC****',
      // 如果指定的时间等于或者晚于文件实际修改时间，则正常拷贝文件，并返回200 OK。
      // 'x-oss-copy-source-if-unmodified-since' => gmdate('2021-12-09T07:01:56.000Z'),
      // 如果指定的时间早于文件实际修改时间，则正常拷贝文件，并返回200 OK。
      // 'x-oss-copy-source-if-modified-since' => gmdate('2021-12-09T07:01:56.000Z'),
      // 指定设置目标Object元数据的方式。此处设置为COPY，表示复制源Object的元数据到目标Object。
      // 'x-oss-metadata-directive' => 'COPY',
      // 指定OSS创建目标Object时使用的服务器端加密算法。
      // 'x-oss-server-side-encryption' => 'KMS',
      // 表示KMS托管的用户主密钥，该参数仅在x-oss-server-side-encryption为KMS时有效。
      // 'x-oss-server-side-encryption-key-id' => '9468da86-3509-4f8d-a61e-6eab****',
      // 指定OSS创建目标Object时的访问权限。此处设置为private，表示只有Object的拥有者和授权用户有该Object的读写权限，其他用户没有权限操作该Object。
      // 'x-oss-object-acl' => 'private',
      // 指定Object的存储类型。此处设置为Standard，表示标准存储类型。
      // 'x-oss-storage-class' => 'Standard',
      // 指定Object的对象标签，可同时设置多个标签。
      // 'x-oss-tagging' => 'k1=v1&k2=v2&k3=v3',
      // 指定设置目标Object对象标签的方式。此处设置为COPY，表示复制源Object的对象标签到目标Object。
      // 'x-oss-tagging-directive' => 'COPY',
    ),
);

try{
    $config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
    $ossClient = new OssClient($config);

    $ossClient->copyObject($from_bucket, $from_object, $to_bucket, $to_object);
} catch(OssException $e) {
    printf(__FUNCTION__ . ": FAILED\n");
    printf($e->getMessage() . "\n");
    return;
}
print(__FUNCTION__ . ": OK" . "\n");

    拷贝大文件

    对于大于1 GB的文件，需要使用分片拷贝（UploadPartCopy）。分片拷贝分为三步：

    1. 通过$ossClient->initiateMultipartUpload初始化分片拷贝任务。

    2. 通过$ossClient->uploadPartCopy进行分片拷贝。除最后一个分片外，其它分片都要大于100 KB。

    3. 通过$ossClient->completeMultipartUpload提交分片拷贝任务。

    以下代码用于分片拷贝：

    <?php
if (is_file(__DIR__ . '/../autoload.php')) {
    require_once __DIR__ . '/../autoload.php';
}
if (is_file(__DIR__ . '/../vendor/autoload.php')) {
    require_once __DIR__ . '/../vendor/autoload.php';
}

use OSS\Credentials\EnvironmentVariableCredentialsProvider;
use OSS\OssClient;
use OSS\CoreOssException;

// 从环境变量中获取访问凭证。运行本代码示例之前，请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。 
$provider = new EnvironmentVariableCredentialsProvider();
// Endpoint以杭州为例，其它Region请按实际情况填写。
$endpoint = "http://oss-cn-hangzhou.aliyuncs.com";
// 填写源Bucket名称。
$from_bucket = "yourSrcBucketName";
// 填写源Object的完整路径。Object完整路径中不能包含Bucket名称，例如srcdir/exampleobject.txt。
$from_object = "yourSrcObjectName";
// 填写与源Bucket处于同一地域的目标Bucket名称。
$to_bucket = "yourDestBucketName";
// 填写目标Object的完整路径。Object完整路径中不能包含Bucket名称，例如destdir/exampleobject.txt。
$to_object = 'yourDestObjectName';

// 根据实际情况设置分片大小，单位为字节。
$part_size = 256*1024*1024;

try{
    $config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,
        "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
        "region"=> "cn-hangzhou"
    );
    $ossClient = new OssClient($config);

    $objectMeta = $ossClient->getObjectMeta($from_bucket, $from_object);

    $length = $objectMeta['content-length'] + 0;

    // 初始化分片拷贝任务。
    $upload_id = $ossClient->initiateMultipartUpload($to_bucket, $to_object);

    // 分片拷贝。
    $pieces = $ossClient->generateMultiuploadParts($length, $part_size);
    $response_upload_part = array();
    $copyId = 1;
    $upload_position = 0;

    foreach ($pieces as $i => $piece) {
        $from_pos = $upload_position + (integer)$piece['seekTo'];
        $to_pos = (integer)$piece['length'] + $from_pos - 1;
        $up_options = array(
            'start' => $from_pos,
            'end' => $to_pos,
              'headers'=>array(
                // 如果源Object的ETag值和您提供的ETag相等，则执行拷贝操作，并返回200 OK。
                // 'x-oss-copy-source-if-match' => '5B3C1A2E053D763E1B002CC****',
                // 如果源Object的ETag值和您提供的ETag不相等，则执行拷贝操作，并返回200 OK。
                // 'x-oss-copy-source-if-none-match' => '5B3C1A2E053D763E1B002CC****',
                // 如果指定的时间等于或者晚于文件实际修改时间，则正常拷贝文件，并返回200 OK。
                // 'x-oss-copy-source-if-unmodified-since' => gmdate('2021-12-09T07:01:56.000Z'),
                // 如果指定的时间早于文件实际修改时间，则正常拷贝文件，并返回200 OK。
                // 'x-oss-copy-source-if-modified-since' => gmdate('2021-12-09T07:01:56.000Z'),
          ),
        );
        $response_upload_part[] = $ossClient->uploadPartCopy( $from_bucket, $from_object, $to_bucket, $to_object, $copyId, $upload_id, $up_options);
        $copyId = $copyId + 1;
    }

    // 完成分片拷贝。
    $upload_parts = array();
    foreach ($response_upload_part as $i => $etag) {
        $upload_parts[] = array(
            'PartNumber' => ($i + 1),
            'ETag' => $etag,
        );
    }
    $result = $ossClient->completeMultipartUpload($to_bucket, $to_object, $upload_id, $upload_parts);
} catch(OssException $e) {
    printf(__FUNCTION__ . ": FAILED\n");
    printf($e->getMessage() . "\n");
    return;
}
print(__FUNCTION__ . ": OK" . "\n");

    相关文档

    • 拷贝小文件

      • 关于拷贝小文件的完整示例代码，请参见GitHub示例。

      • 关于拷贝小文件的API接口说明，请参见CopyObject。

    • 拷贝大文件

      • 关于拷贝大文件的完整示例代码，请参见GitHub示例。

      • 关于拷贝大文件的API接口说明，请参见UploadPartCopy。