abhinavdobhal / laravelcdn
Laravel 内容分发网络(CDN)包
Requires
- php: >=5.5.9
- aws/aws-sdk-php: ~3.0
- illuminate/config: 5.0.*|5.1.*|5.2.*|5.3.*|5.4.*|5.5.*|5.6.*|5.7.*
- illuminate/support: 5.0.*|5.1.*|5.2.*|5.3.*|5.4.*|5.5.*|5.6.*|5.7.*
- symfony/console: 2.*|3.*|4.*
- symfony/finder: 2.*|3.*|4.*
Requires (Dev)
- mockery/mockery: 0.9.3
- phpunit/phpunit: ~4.0
README
Laravel 内容分发网络包
此包允许开发者使用单个 artisan 命令将他们的资源(或任何公共文件)上传到 CDN。然后,它允许他们在本地文件和在线版本之间切换。
从 Vinelab/cdn 分支而来
该项目是从 https://github.com/Vinelab/cdn 分支而来的。所有原始作品的荣誉都属于那里。
Laravel 支持
- 此分支支持 Laravel 5.2 一直到 Laravel 5.5(包括 master)。
- Laravel 5.5 支持,包括包自动发现。
亮点
- Amazon Web Services (AWS) - S3
- DigitalOcean (DO) - Spaces
- Artisan 命令上传内容到 CDN
- 简单的 Facade 访问 CDN 资源
问题
- 此包是 Laravel FileSystem 的替代品吗?它们可以一起工作吗?
- 不是,这个包是在 Laravel 4 中引入的,其主要目的是通过从 CDN 加载它们到视图页面来管理您的 CDN 资源,并轻松地在本地和 CDN 版本的文件之间切换。此外,它还允许您在指定资产目录和规则后使用单个命令上传所有资产。FileSystem 是在 Laravel 5 中引入的,旨在简化文件从 CDN 的加载/上传。它可以像此包一样用于从 CDN 加载资源,但由于它期望您逐个上传文件,因此上传您的资产到 CDN 会更困难。因此,此包仍然不是 Laravel FileSystem 的替代品,并且它们可以一起使用。
安装
通过 Composer
在项目中需要 publiux/laravelcdn
composer require "publiux/laravelcdn:~2.0"
如果您正在使用 Laravel 5.4 或以下版本,则需要注册服务提供者
Laravel 5.4 及以下:将服务提供者和外观添加到 config/app.php
'providers' => array( //... Publiux\laravelcdn\CdnServiceProvider::class, ),
'aliases' => array( //... 'CDN' => Publiux\laravelcdn\Facades\CdnFacadeAccessor::class ),
如果您正在使用 Laravel 5.5,则无需注册服务提供者,因为此包可以自动发现。
发布包配置文件
php artisan vendor:publish --provider 'Publiux\laravelcdn\CdnServiceProvider'
环境配置
此包可以通过编辑 config/app.php 文件进行配置。或者,您可以在 .env 文件中设置许多选项。
AWS 凭据
在 .env 文件中设置您的 AWS 凭据和其他设置。
注意:您应该在项目根目录中始终有一个 .env 文件,以保存您的敏感信息。此文件通常不应提交到您的 VCS。
AWS_ACCESS_KEY_ID= AWS_SECRET_ACCESS_KEY=
CDN URL
设置 CDN URL
'url' => env('CDN_Url', 'https://s3.amazonaws.com'),
这可以在 .env 文件中按如下方式更改
CDN_Url=
绕过
要加载您的本地资源进行测试或开发,将 bypass
选项设置为 true
'bypass' => env('CDN_Bypass', false),
这可以在 .env 文件中按如下方式更改
CDN_Bypass=
Cloudfront 支持
'cloudfront' => [ 'use' => env('CDN_UseCloudFront', false), 'cdn_url' => env('CDN_CloudFrontUrl', false) ],
这可以在 .env 文件中按如下方式更改
CDN_UseCloudFront= CDN_CloudFrontUrl=
默认 CDN 提供商
目前,唯一的 CDN 提供商是 AwsS3。尽管 DigitalOcean 本地支持 AWS API,但您可以通过提供端点来利用它,请参阅 cdn.php 配置文件以获取更多信息。此选项不能在 .env 中设置。
'default' => 'AwsS3',
CDN 提供商配置
'aws' => [ 's3' => [ 'version' => 'latest', 'region' => '', 'endpoint' => '', // For DO Spaces '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 ],
其他配置
'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,也可以使用以下命令“清空”您的资源。
推送
只有变更过的资源会被推送到CDN。(感谢)
上传资源到CDN
php artisan cdn:push
您可以在 cdn.php 配置文件中指定文件夹上传前缀。您的资源将被上传到S3中的该文件夹。
清空
从CDN删除资源
php artisan cdn:empty
注意:这将删除您的整个存储桶。如果您在推送资源时指定了上传文件夹,这可能不是您想要的结果。
加载资源
使用 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
注意:mix
与 Laravel 5.4 的 mix
工作方式相同,它从 public 文件夹加载 mix-manifest.json 文件并选择 webpack 生成的正确文件版本。
{{CDN::mix('/js/main.js')}} // example result: https://js-bucket.s3.amazonaws.com/public/js/main-85cafe36ff.js {{CDN::mix('/css/style.css')}} // example result: https://css-bucket.s3.amazonaws.com/public/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。
安全问题
如果您发现任何安全问题,请通过发送电子邮件到 publiux@gmail.com 而不是使用问题跟踪器来获得更快的响应。您应该同时打开一个问题。
鸣谢
- Raul Ruiz(分支者)
- Mahmoud Zalt(原始开发者)
- Filipe Garcia(在分支前贡献,未归功的重复上传验证拉取请求)
- 原始项目贡献者
- 此分支的所有贡献者
许可
MIT 许可证(MIT)。有关更多信息,请参阅 许可文件。
变更日志
v2.0.5
- 添加了连接错误报告
v2.0.4
- 添加了对 DigitalOcean Spaces 的 API 支持
v2.0.3
- 添加了对上传文件夹前缀的支持
v2.0.2
- 更新了说明文档,以详细说明 Laravel <5.5 的使用方法
v2.0.1
- 修复了 composer.json 中的拼写错误
v2.0.0
- 支持 Laravel 5.5
v1.0.3
- 修复了无法使用无协议的 URL 为 CloudFront 的错误。有效的 URL 现在以 http、https 或简单地以 ‘//’ 开头。
v1.0.2
- 修复了意外省略了 elixir 函数的错误。
v1.0.1
- 允许使用环境变量进行配置