README

Laravel 的内容分发网络包

该包允许开发者在单个 artisan 命令中上传其资产（或任何公共文件）到 CDN。然后它允许他们在本地和在线文件版本之间切换。

从 Vinelab/cdn 分支

该项目是从 https://github.com/Vinelab/cdn 分支的。所有原创工作的功劳都属于那里。

Laravel 支持

此分支支持 Laravel 8 及以上版本。
支持包自动发现。
如果您需要使用 8 以下的 Laravel 版本，请使用此包的 ~3 版本。
Laravel 8 及以上版本应使用此包的 ~4 版本。

亮点

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

在项目中需要 abdullahfaqeir/laravelcdn

composer require "abdullahfaqeir/laravelcdn:~5.0"

如果您正在使用 Laravel 5.4 或以下版本，则需要注册服务提供者

Laravel 5.4 及以下：将服务提供者和外观添加到 config/app.php

'providers' => array(
     //...
     AbdullahFaqeir\LaravelCDN\CdnServiceProvider::class,
),

'aliases' => array(
     //...
     'CDN' => AbdullahFaqeir\LaravelCDN\Facades\CdnFacadeAccessor::class
),

如果您正在使用 Laravel 5.5，则不需要注册服务提供者，因为此包是自动发现的。

发布包配置文件

php artisan vendor:publish --provider 'AbdullahFaqeir\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()函数。

注意：与Laravel的asset一样，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

注意：与Laravel的elixir一样，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

注意：与Laravel 5.4的mix一样，mix从公共文件夹加载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以获取详细信息。

安全相关的问题

如果您发现任何安全相关的问题，请通过电子邮件abdullahfaqeir@gmail.com而不是使用问题跟踪器以获得更快的响应。您应该同时打开一个问题。

致谢

Raul Ruiz（分支者）
Mahmoud Zalt（原始开发者）
Abdullah Al-Faqeir（贡献者）
Filipe Garcia（分支前的贡献者，未经认可的重叠上传验证的拉取请求）
原始项目中的贡献者
所有分支贡献者

许可证

MIT许可证（MIT）。请参阅许可证文件以获取更多信息。

更改日志

v5.0.0

代码重构。
测试用例重构。
正确支持Laravel 9。
最低PHP版本为8.2

v2.0.5

添加了连接错误报告

v2.0.4

添加了对DigitalOcean Spaces的API支持

v2.0.3

添加了对上传文件夹前缀的支持

v2.0.2

更新了readme，详细说明了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函数的bug。

v1.0.1

允许使用环境变量进行配置

abdullahfaqeir / laravelcdn

维护者

详细信息

README

Laravel 的内容分发网络包

从 Vinelab/cdn 分支

Laravel 支持

亮点

问题

安装

通过 Composer

环境配置

AWS 凭据

CDN URL

绕过

Cloudfront 支持

默认 CDN 提供商

CDN 提供商配置

多个存储桶

文件与目录

包含

排除

其他配置

用法

推送

清空

加载资源

测试

支持

贡献

安全相关的问题

致谢

许可证

更改日志

v5.0.0

v2.0.5

v2.0.4

v2.0.3

v2.0.2

v2.0.1

v2.0.0

v1.0.3

v1.0.2

v1.0.1