README

Google Cloud Storage 文件系统驱动程序用于 Laravel 9（使用 Flysystem v3 和自带的 GCS 适配器）。

寻找 Laravel 8 支持？请使用 v1 分支！

支持我们

我们投入了大量资源来创建一流的开放式源代码包。您可以通过购买我们的付费产品之一来支持我们。

我们非常感谢您从您的家乡寄给我们明信片，并说明您正在使用我们哪个包。您可以在我们的联系方式页面找到我们的地址。我们将所有收到的明信片发布在我们的虚拟明信片墙上。

安装

您可以通过 composer 安装此包

composer require spatie/laravel-google-cloud-storage

接下来，向您的 filesystems.php 配置文件中添加一个新的磁盘

'gcs' => [
    'driver' => 'gcs',
    'key_file_path' => env('GOOGLE_CLOUD_KEY_FILE', null), // optional: /path/to/service-account.json
    'key_file' => [], // optional: Array of data that substitutes the .json file (see below)
    'project_id' => env('GOOGLE_CLOUD_PROJECT_ID', 'your-project-id'), // optional: is included in key file
    'bucket' => env('GOOGLE_CLOUD_STORAGE_BUCKET', 'your-bucket'),
    'path_prefix' => env('GOOGLE_CLOUD_STORAGE_PATH_PREFIX', ''), // optional: /default/path/to/apply/in/bucket
    'storage_api_uri' => env('GOOGLE_CLOUD_STORAGE_API_URI', null), // see: Public URLs below
    'apiEndpoint' => env('GOOGLE_CLOUD_STORAGE_API_ENDPOINT', null), // set storageClient apiEndpoint
    'visibility' => 'public', // optional: public|private
    'visibility_handler' => null, // optional: set to \League\Flysystem\GoogleCloudStorage\UniformBucketLevelAccessVisibility::class to enable uniform bucket level access
    'metadata' => ['cacheControl'=> 'public,max-age=86400'], // optional: default metadata
],

用法

$disk = Storage::disk('gcs');

$disk->put('avatars/1', $fileContents);
$exists = $disk->exists('file.jpg');
$time = $disk->lastModified('file1.jpg');
$disk->copy('old/file1.jpg', 'new/file1.jpg');
$disk->move('old/file1.jpg', 'new/file1.jpg');
$url = $disk->url('folder/my_file.txt');
$url = $disk->temporaryUrl('folder/my_file.txt', now()->addMinutes(30));
$disk->setVisibility('folder/my_file.txt', 'public');

有关可用的完整功能列表，请参阅 https://laravel.net.cn/docs/master/filesystem

身份验证

Google 客户端使用一些方法来确定它应该如何与 Google API 进行身份验证。

如果您在磁盘配置中的 key_file 键中指定了一个路径，将使用该 json 凭据文件。
如果设置了 GOOGLE_APPLICATION_CREDENTIALS 环境变量，则使用该变量。
```
putenv('GOOGLE_APPLICATION_CREDENTIALS=/path/to/service-account.json');
```
然后它将尝试从“已知路径”加载密钥文件
- Windows: %APPDATA%/gcloud/application_default_credentials.json
- 其他：$HOME/.config/gcloud/application_default_credentials.json
如果在 Google App Engine 中运行，将使用与应用程序关联的内置服务帐户。
如果在 Google Compute Engine 中运行，将使用与虚拟机实例关联的内置服务帐户。

如果您想不使用 json 文件直接进行身份验证，您可以在磁盘配置中的 key_file 指定一个包含以下数据的数组

'key_file' => [
    'type' => env('GOOGLE_CLOUD_ACCOUNT_TYPE'),
    'private_key_id' => env('GOOGLE_CLOUD_PRIVATE_KEY_ID'),
    'private_key' => env('GOOGLE_CLOUD_PRIVATE_KEY'),
    'client_email' => env('GOOGLE_CLOUD_CLIENT_EMAIL'),
    'client_id' => env('GOOGLE_CLOUD_CLIENT_ID'),
    'auth_uri' => env('GOOGLE_CLOUD_AUTH_URI'),
    'token_uri' => env('GOOGLE_CLOUD_TOKEN_URI'),
    'auth_provider_x509_cert_url' => env('GOOGLE_CLOUD_AUTH_PROVIDER_CERT_URL'),
    'client_x509_cert_url' => env('GOOGLE_CLOUD_CLIENT_CERT_URL'),
],

公共 URL

适配器实现了一个 getUrl($path) 方法，该方法返回一个文件的公共 URL。

注意：此方法适用于 Laravel 5.2 及更高版本。如果用于 5.1，则将抛出异常。

$disk = Storage::disk('gcs');
$url = $disk->url('folder/my_file.txt');
// http://storage.googleapis.com/bucket-name/folder/my_file.txt

如果您在配置中配置了 path_prefix

$disk = Storage::disk('gcs');
$url = $disk->url('folder/my_file.txt');
// http://storage.googleapis.com/bucket-name/path-prefix/folder/my_file.txt

如果您在配置中配置了自定义的 storage_api_uri

$disk = Storage::disk('gcs');
$url = $disk->url('folder/my_file.txt');
// http://your-custom-domain.com/bucket-name/path-prefix/folder/my_file.txt

对于自定义域名（存储 API URI），您需要配置一个指向 storage.googleapis.com 的 CNAME DNS 条目。

有关进一步说明，请参阅 https://cloud.google.com/storage/docs/xml-api/reference-uris#cname

临时/签名 URL

使用最新的适配器版本，您可以轻松地为默认情况下不可公开查看的文件生成签名 URL。

$disk = Storage::disk('gcs');
$url = $disk->temporaryUrl('folder/my_file.txt', now()->addMinutes(30));
// https://storage.googleapis.com/test-bucket/folder/my_file.txt?GoogleAccessId=test-bucket%40test-gcp.iam.gserviceaccount.com&Expires=1571151576&Signature=tvxN1OS1txkWAUF0cCR3FWK%seRZXtFu42%04%YZACYL2zFQxA%uwdGEmdO1KgsHR3vBF%I9KaEzPbl4b7ic2IWUuo8Jh3IoZFqdTQec3KypjDtt%02DGwm%OO6pWDVV421Yp4z520%o5oMqGBtV8B3XmjW2PH76P3uID2QY%AlFxn23oE9PBoM2wXr8pDXhMPwZNJ0FtckSc26O8PmfVsG7Jvln%CQTU57IFyB7JnNxz5tQpc2hPTHbCGrcxVPEISvdOamW3I%83OsXr5raaYYBPcuumDnAmrK%cyS9%Ky2fL2B2shFO2cz%KRu79DBPqtnP2Zf1mJWBTwxVUCK2jxEEYcXBXtdOszIvlI6%tp2XfVwYxLNFU

统一的存储桶级别访问

Google Cloud Storage 允许在存储桶级别设置权限，即“统一的存储桶级别访问”。

最初观察到错误“当启用统一的存储桶级别访问时，无法插入对象的旧版 ACL”。

当将文件上传到此类存储桶时，请确保配置文件中的 visibility_handler 设置如下

'visibility_handler' => \League\Flysystem\GoogleCloudStorage\UniformBucketLevelAccessVisibility::class,

请参阅https://cloud.google.com/storage/docs/access-control/signed-urls和https://laravel.net.cn/docs/6.x/filesystem获取更多信息。

测试

composer test

变更日志

请参阅CHANGELOG了解最近的变化。

贡献

请参阅CONTRIBUTING获取详细信息。

安全漏洞

请审查我们的安全策略了解如何报告安全漏洞。

鸣谢

Superbalist提供原始的GCS适配器包
Alex Vanderbist
所有贡献者

许可

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

mpsoft-digital / laravel-google-cloud-storage

维护者

详细信息