Laravel 的内容分发网络 (CDN) 包

v1.4.9 2019-11-13 17:25 UTC

README

Total Downloads Latest Stable Version Latest Unstable Version Build Status Scrutinizer Code Quality License

Laravel 内容分发网络包

该包允许开发者通过单个 artisan 命令将他的资产(或任何公开文件)上传到 CDN。然后,它允许他在本地和在线文件版本之间切换。

Laravel 支持

  • 对于 Laravel 5.1,使用最新版本(master)。
  • 对于 Laravel 4.2,使用版本 v1.0.1 L 4.2 的最后支持

亮点

  • Amazon Web Services - S3
  • Artisan 命令上传内容到 CDN
  • 简单的 Facade 访问 CDN 资产

安装

通过 Composer

在你的项目中要求 vinelab/cdn

composer require vinelab/cdn:*

由于这是一个 Laravel 包,我们需要注册服务提供者

将服务提供者添加到 config/app.php

'providers' => array(
     //...
     Vinelab\Cdn\CdnServiceProvider::class,
),

配置

.env 文件中设置凭证。

注意:你必须在项目根目录下有一个 .env 文件,以存储你的敏感信息。

AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=

发布包配置文件

php artisan vendor:publish vinelab/cdn

你可以在 config/cdn.php 中找到它

默认提供者
'default' => 'AwsS3',
CDN 提供者配置
'aws' => [

    's3' => [
    
        'version'   => 'latest',
        'region'    => '',


        'buckets' => [
            'my-backup-bucket' => '*',
        ]
    ]
],
多个存储桶
'buckets' => [

    'my-default-bucket' => '*',
    
    // 'js-bucket' => ['public/js'],
    // 'css-bucket' => ['public/css'],
    // ...
]

文件 & 目录

包含

指定要上传的目录、扩展名、文件和模式。

'include'    => [
    'directories'   => ['public/dist'],
    'extensions'    => ['.js', '.css', '.yxz'],
    'patterns'      => ['**/*.coffee'],
],
排除

指定要忽略的内容。

'exclude'    => [
    'directories'   => ['public/uploads'],
    'files'         => [''],
    'extensions'    => ['.TODO', '.txt'],
    'patterns'      => ['src/*', '.idea/*'],
    'hidden'        => true, // ignore hidden files
],
URL

设置 CDN URL

'url' => 'https://s3.amazonaws.com',
HTTP

设置 HTTP 参数

'http' => '['verify' => path-to-your-pem-certificate-file]',
绕过

要加载本地资产进行测试或开发,将 bypass 选项设置为 true

'bypass' => true,
Cloudfront 支持
'cloudfront'    => [
    'use' => false,
    'cdn_url' => ''
],
其他配置
'acl'           => 'public-read',
'metadata'      => [ ],
'expires'       => gmdate("D, d M Y H:i:s T", strtotime("+5 years")),
'cache-control' => 'max-age=2628000',

你可以始终参考 AWS S3 文档以获取更多详细信息:aws-sdk-php

用法

推送

上传资产到 CDN

php artisan cdn:push

清空

从 CDN 删除资产

php artisan cdn:empty

加载资产

使用 facade Cdn 调用 Cdn::asset() 函数。

注意:asset 与 Laravel 的 asset 工作方式相同,它从 public/ 目录开始查找资产

{{Cdn::asset('assets/js/main.js')}}        // example result: https://js-bucket.s3.amazonaws.com/public/assets/js/main.js

{{Cdn::asset('assets/css/style.css')}}        // example result: https://css-bucket.s3.amazonaws.com/public/assets/css/style.css

注意:elixir 与 Laravel 的 elixir 工作方式相同,它从构建文件夹中加载 manifest.json 文件并选择由 gulp 生成的正确文件修订版

{{Cdn::elixir('assets/js/main.js')}}        // example result: https://js-bucket.s3.amazonaws.com/public/build/assets/js/main-85cafe36ff.js

{{Cdn::elixir('assets/css/style.css')}}        // example result: https://css-bucket.s3.amazonaws.com/public/build/assets/css/style-2d558139f2.css

要从 public/ 目录外部的任何 app/ 目录中引用文件,请使用 Cdn::path() 函数

{{Cdn::path('private/something/file.txt')}}        // example result: https://css-bucket.s3.amazonaws.com/private/something/file.txt

测试

要从项目目录中运行测试,请运行以下命令。

$ ./vendor/bin/phpunit

支持

在 Github 上

贡献

请参阅 CONTRIBUTING 以获取详细信息。

安全性

如果你发现任何安全问题,请通过电子邮件 mahmoud@vinelab.com 而不是使用问题跟踪器。

致谢

许可证

MIT 许可证 (MIT)。有关更多信息,请参阅 许可证文件