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

v2.0.15 2020-04-09 09:57 UTC

README

alt text

Laravel CDN 资产管理器

Laravel 的内容分发网络包

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

历史

该项目曾拥有多个家,不幸的是,之前的维护者已经失去了对此项目的兴趣。我计划维护此包,因为我们有几个项目使用它。这是 Laravel CDN 的最新版本。

Publiux/laravelcdn 分支而来
Vinelab/cdn 分支而来

该项目最初是从 https://github.com/Vinelab/cdn 分支出来的。所有原始工作的荣誉都属于那里。

Laravel 支持

  • Laravel 5.5、5.6、5.7、5.8 和 6 均受支持,以及包自动发现。

亮点

  • Amazon Web Services (AWS) - S3
  • DigitalOcean (DO) - Spaces
  • Artisan 命令用于上传内容到 CDN
  • 简单的 Facade 用于访问 CDN 资产

问题

  1. 这个包是 Laravel FileSystem 的替代品吗?它们可以一起使用吗?
  • 不,这个包是在 Laravel 4 中引入的,其主要目的是通过从 CDN 加载它们到您的视图页面来管理您的 CDN 资产,并轻松在本地版本和 CDN 版本之间切换文件。此外,它还允许您在指定了资产目录和规则后使用单个命令上传所有资产。FileSystem 是在 Laravel 5 中引入的,旨在简化文件从 CDN 加载/上传的过程。它可以像这个包一样用于从 CDN 加载资产,但上传资产到 CDN 更困难,因为它期望您逐个上传文件。因此,此包仍然不是 Laravel FileSystem 的替代品,并且它们可以一起使用。

安装

通过 Composer

在您的项目中要求 juhasev/laravelcdn

composer require "juhasev/laravelcdn:~2.0"

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

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

'providers' => array(
     //...
     SampleNinja\LaravelCdn\CdnServiceProvider::class,
),
'aliases' => array(
     //...
     'CDN' => SampleNinja\LaravelCdn\Facades\CdnFacadeAccessor::class
),

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

发布包配置文件

php artisan vendor:publish --provider 'SampleNinja\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。尽管如此,由于DO原生支持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

与安全相关的问题

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

鸣谢

许可协议

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

变更日志

v2.0.10

  • 添加了对Laravel 6.0的支持

v2.0.9

  • 添加了对Laravel 5.8的支持

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中使用的bug。有效的Url现在以http、https或简单的'//'开头

v1.0.2

  • 修复了在发布中意外遗漏了elixir函数的bug。

v1.0.1

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