README

Laravel 9的Google Cloud Storage文件系统驱动程序（使用Flysystem v2及其自己的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
    'visibility' => 'public', // optional: public|private
    '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

测试

composer test

变更日志

请参阅CHANGELOG以获取有关最近更改的更多信息。

贡献

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

安全漏洞

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

致谢

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

许可证

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

maelga / laravel-google-cloud-storage

维护者

详情