README

README中文版

概述

阿里云对象存储服务（OSS）是阿里云提供的云存储服务，具有海量存储、安全、低成本和高可靠性等特点。您可以通过API在任何时间、任何地点上传和下载数据，并通过Web控制台对数据进行简单的管理。OSS可以存储任何类型的文件，因此适用于各种网站、开发企业和开发者。

运行环境

• PHP 5.3+
• cURL扩展

提示

• 在Ubuntu上，您可以使用apt-get包管理器安装PHP cURL扩展：sudo apt-get install php5-curl。

安装OSS PHP SDK

• 如果您使用composer来管理项目依赖项，请在项目的根目录中运行以下命令

    composer require aliyuncs/oss-sdk-php
  

  您也可以在composer.json文件中声明对阿里云OSS SDK for PHP的依赖。

    "require": {
        "aliyuncs/oss-sdk-php": "~2.0"
    }
  

  然后运行composer install来安装依赖。在Composer依赖管理器安装完成后，在您的PHP代码中导入依赖

    require_once __DIR__ . '/vendor/autoload.php';
  

• 您也可以直接下载打包的PHAR文件，并将其引入到您的代码中

    require_once '/path/to/oss-sdk-php.phar';
  

• 下载SDK源代码，并将SDK目录下的autoload.php文件引入到您的代码中

    require_once '/path/to/oss-sdk/autoload.php';
  

快速使用

常见类

初始化OssClient

SDK对OSS的操作是通过OssClient类来执行的。以下代码创建了一个OssClient对象

<?php
$accessKeyId = "<AccessKeyID that you obtain from OSS>";
$accessKeySecret = "<AccessKeySecret that you obtain from OSS>";
$endpoint = "<Domain that you select to access an OSS data center, such as "oss-cn-hangzhou.aliyuncs.com>";
try {
    $ossClient = new OssClient($accessKeyId, $accessKeySecret, $endpoint);
} catch (OssException $e) {
    print $e->getMessage();
}

对象操作

对象是OSS上最基本的数据单元。您可以简单地将对象视为文件。以下代码上传一个对象

<?php
$bucket= "<Name of the bucket in use. Pay attention to naming conventions>";
$object = "<Name of the object in use. Pay attention to naming conventions>";
$content = "Hello, OSS!"; // Content of the uploaded file
try {
    $ossClient->putObject($bucket, $object, $content);
} catch (OssException $e) {
    print $e->getMessage();
}

桶操作

桶是您用于管理存储对象的存储空间。它是用户的对象管理单元。每个对象必须属于一个桶。以下代码创建一个桶

<?php
$bucket= "<Name of the bucket in use. Pay attention to naming conventions>";
try {
    $ossClient->createBucket($bucket);
} catch (OssException $e) {
    print $e->getMessage();
}

处理返回结果

OssClient提供了以下两种类型的返回数据从接口

• Put和Delete接口：如果没有返回OSSException，并且接口返回了null，则认为PUT和DELETE操作成功。

• Get和List接口：如果没有返回OSSException，并且接口返回了所需的数据，则认为GET和LIST操作成功。例如，

  <?php
  $bucketListInfo = $ossClient->listBuckets();
  $bucketList = $bucketListInfo->getBucketList();
  foreach($bucketList as $bucket) {
      print($bucket->getLocation() . "\t" . $bucket->getName() . "\t" . $bucket->getCreateDate() . "\n");
  }

在上面的代码中，$bucketListInfo属于'OSS\Model\BucketListInfo'数据类型。

运行示例项目

• 修改samples/Config.php以完成配置信息。
• 运行cd samples/ && php RunAll.php。

运行单元测试

• 运行composer install下载依赖库。

• 设置环境变量。

    export OSS_ACCESS_KEY_ID=access-key-id
    export OSS_ACCESS_KEY_SECRET=access-key-secret
    export OSS_ENDPOINT=endpoint
    export OSS_BUCKET=bucket-name
  

• 运行php vendor/bin/phpunit

许可证

• MIT

联系我们

• 阿里云OSS官方网站.
• 阿里云OSS官方论坛.
• 阿里云OSS官方文档中心.
• 阿里云官方技术支持：[提交工单](https://workorder.console.aliyun.com/#/ticket/createIndex)。