Laravel 运用 OSS

2019-01-02 更新：请直接使用更优雅的 oss 组件 iidestiny/laravel-filesystem-oss

对象存储 ( Object Storage Service, 简称 OSS ) OSS 相信大家都听过, 它是阿里云对外提供的海量, 安全和高可靠的云存储服务. 大家可以把自己网站的资源存上面加快自己网站速度, aliyun 官网也有文档不过对于新手来说有点难, 那么这里我给大家推荐一个组件和组件的使用.

johnlui/aliyun-oss 这个组件是 John Lui 作者封装好的组件, 用法超简单, 不过这个组件有许多要注意的地方, 不然出错了, 掉坑里爬不出来!

安装

composer require "johnlui/aliyun-oss"

配置

组件下载完成之后, 作者的 GitHub 上面说需要在 app/config/app.php 中增加四项配置, 我建议在 app/config 下面新建一个 alioss.php 文件然后在添加配置:

<?php
return [
    'ossServer' => env('ALIOSS_SERVER', null),                      // 外网
    'ossServerInternal' => env('ALIOSS_SERVERINTERNAL', null),      // 内网
    'AccessKeyId' => env('ALIOSS_KEYID', null),                     // key
    'AccessKeySecret' => env('ALIOSS_KEYSECRET', null),             // secret
    'BucketName' => env('ALIOSS_BUCKETNAME', null)                  // bucket
];

然后在 .ENV 文件里面把配置信息都填上.

注意

这里有一个大坑, 粗心的朋友一般不会发现, 在填写外网和公网配置的时候, 有的朋友直接在 OSS 管理控制台中把外网和内网一长串的链接复制走, 如下图:

在这个组件中, 桶名称是需要额外填写的, 所以外网和内网哪儿, 只需要填写桶名后面的内容, 如图:

再有一点是填写外网和内网的时候需要加上 http:// 协议, 不然后面出错你又得掉坑半天出不来, 最终配置信息如下图:

构建 Service 文件

后台需要一个 Service 文件, 在 app/Service 下新建一个 oss.php 文件, 由于前面步骤我把配置文件放在 app/config/alioss.php 里面, 所以还要对原作者给出的例子作修改下, 如下代码:

# oss.php
<?php

namespace App\Services;

use JohnLui\AliyunOSS\AliyunOSS;


class OSS
{

    private $ossClient;
    private static $bucketName;

    public function __construct($isInternal = false)
    {
        $serverAddress = $isInternal ? config('alioss.ossServerInternal') : config('alioss.ossServer');
        $this->ossClient = AliyunOSS::boot(
            $serverAddress,
            config('alioss.AccessKeyId'),
            config('alioss.AccessKeySecret')
        );
    }

    public static function upload($ossKey, $filePath)
    {
        $oss = new OSS(false); // 上传文件使用内网，免流量费
        $oss->ossClient->setBucket(config('alioss.BucketName'));
        $res = $oss->ossClient->uploadFile($ossKey, $filePath);
        return $res;
    }

    /**
     * 直接把变量内容上传到oss
     * @param $osskey
     * @param $content
     */
    public static function uploadContent($osskey, $content)
    {
        $oss = new OSS(false); // 上传文件使用内网，免流量费
        $oss->ossClient->setBucket(config('alioss.BucketName'));
        $oss->ossClient->uploadContent($osskey, $content);

    }

    /**
     * 删除存储在oss中的文件
     *
     * @param string $ossKey 存储的key（文件路径和文件名）
     * @return
     */
    public static function deleteObject($ossKey)
    {
        $oss = new OSS(false); // 上传文件使用内网，免流量费

        return $oss->ossClient->deleteObject(config('alioss.BucketName'), $ossKey);
    }

    /**
     * 复制存储在阿里云OSS中的Object
     *
     * @param string $sourceBuckt 复制的源Bucket
     * @param string $sourceKey - 复制的的源Object的Key
     * @param string $destBucket - 复制的目的Bucket
     * @param string $destKey - 复制的目的Object的Key
     * @return Models\CopyObjectResult
     */
    public function copyObject($sourceBuckt, $sourceKey, $destBucket, $destKey)
    {
        $oss = new OSS(true); // 上传文件使用内网，免流量费

        return $oss->ossClient->copyObject($sourceBuckt, $sourceKey, $destBucket, $destKey);
    }

    /**
     * 移动存储在阿里云OSS中的Object
     *
     * @param string $sourceBuckt 复制的源Bucket
     * @param string $sourceKey - 复制的的源Object的Key
     * @param string $destBucket - 复制的目的Bucket
     * @param string $destKey - 复制的目的Object的Key
     * @return Models\CopyObjectResult
     */
    public function moveObject($sourceBuckt, $sourceKey, $destBucket, $destKey)
    {
        $oss = new OSS(true); // 上传文件使用内网，免流量费

        return $oss->ossClient->moveObject($sourceBuckt, $sourceKey, $destBucket, $destKey);
    }

    public static function getUrl($ossKey)
    {
        $oss = new OSS();
        $oss->ossClient->setBucket(config('alioss.BucketName'));
        return $oss->ossClient->getUrl($ossKey, new \DateTime("+1 day"));
    }

    public static function createBucket($bucketName)
    {
        $oss = new OSS();
        return $oss->ossClient->createBucket($bucketName);
    }

    public static function getAllObjectKey($bucketName)
    {
        $oss = new OSS();
        return $oss->ossClient->getAllObjectKey($bucketName);
    }

    /**
     * 获取指定Object的元信息
     *
     * @param  string $bucketName 源Bucket名称
     * @param  string $key 存储的key（文件路径和文件名）
     * @return object 元信息
     */
    public static function getObjectMeta($bucketName, $osskey)
    {
        $oss = new OSS();
        return $oss->ossClient->getObjectMeta($bucketName, $osskey);
    }

}

使用

首先引入命名空间 use App\Services\OSS;, 在 Laravel 5.1 中使用方法如下

// 获取表单提交的图片
$pic = $request->file('pic');
// 判断图片有效性
if (!$pic->isValid()) {
   return back()->withErrors('上传图片无效..');
}
// 获取图片在临时文件中的地址
$pic = $pic->getRealPath();
// 制作文件名
$key = time() . rand(10000, 99999999) . '.jpg';
//阿里 OSS 图片上传
$result = OSS::upload($key, $pic);
if ($result) {
   // success
} else {
   // fail
}

注意: 如果你上传长时间没反应的话, 说明你上传使用的是内网, 你得改成外网上传, 找到 Service/oss.php 里面的 upload 方法, 将 $oss = new OSS(true); true 改为 false, 上传程序即可成功!

附上其他使用方法

OSS::upload('文件名', '本地路径'); // 上传一个文件

echo OSS::getUrl('某个文件的名称'); // 打印出某个文件的外网链接

OSS::createBucket('一个字符串'); // 新增一个 Bucket。注意，Bucket 名称具有全局唯一性，也就是说跟其他人的 Bucket 名称也不能相同。

OSS::getAllObjectKey('某个 Bucket 名称'); // 获取该 Bucket 中所有文件的文件名，返回 Array。

可以在上指定 OSSOptions，比如 ContentType 之类的：

$oss = new OSS;
$oss->upload('t5.svg','2676143e4cb25df80e6e84f34fb22058.svg',['ContentType'=>'image/svg+xml'])

PS

感谢关注「GitHub 热门」公众号，带你了解技术圈内热门新鲜事！

本作品采用《CC 协议》，转载必须注明作者和本文链接