superbalist / laravel-google-cloud-storage
Laravel 的 Google Cloud Storage 文件系统
Requires
- php: >=5.5.9
- illuminate/filesystem: ^5.1|^6.0|^7.0|^8.0
- illuminate/support: ^5.1|^6.0|^7.0|^8.0
- league/flysystem-cached-adapter: ^1.0
- superbalist/flysystem-google-storage: >=3.0 <8.0
Requires (Dev)
- phpunit/phpunit: >=4.8
README
Laravel 的 Google Cloud Storage 文件系统。
此包是 flysystem-google-storage 的包装器,将其作为可用的存储磁盘桥接到 Laravel。
安装
composer require superbalist/laravel-google-cloud-storage
如果您使用的是 Laravel 5.4 或更早版本,请在 app.php 中注册服务提供者
'providers' => [ // ... Superbalist\LaravelGoogleCloudStorage\GoogleCloudStorageServiceProvider::class, ]
如果您使用的是 Laravel 5.5 或更高版本,Composer 将自动为您注册提供者。
在您的 filesystems.php 配置中添加一个新的磁盘
'gcs' => [ 'driver' => 'gcs', 'project_id' => env('GOOGLE_CLOUD_PROJECT_ID', 'your-project-id'), 'key_file' => env('GOOGLE_CLOUD_KEY_FILE', null), // optional: /path/to/service-account.json 'bucket' => env('GOOGLE_CLOUD_STORAGE_BUCKET', 'your-bucket'), 'path_prefix' => env('GOOGLE_CLOUD_STORAGE_PATH_PREFIX', null), // 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 ],
身份验证
Google 客户端使用几种方法来确定如何与 Google API 进行身份验证。
-
如果您在磁盘配置中的
key_file
键指定了一个路径,将使用该 JSON 凭据文件。 -
如果设置了
GOOGLE_APPLICATION_CREDENTIALS
环境变量,则使用该变量。putenv('GOOGLE_APPLICATION_CREDENTIALS=/path/to/service-account.json');
-
然后尝试从 'well known path' 加载密钥文件
- 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 获取更多说明。
用法
$disk = Storage::disk('gcs'); // create a file $disk->put('avatars/1', $fileContents); // check if a file exists $exists = $disk->exists('file.jpg'); // get file modification date $time = $disk->lastModified('file1.jpg'); // copy a file $disk->copy('old/file1.jpg', 'new/file1.jpg'); // move a file $disk->move('old/file1.jpg', 'new/file1.jpg'); // get url to file $url = $disk->url('folder/my_file.txt'); // Set the visibility of file to public $disk->setVisibility('folder/my_file.txt', 'public'); // See https://laravel.net.cn/docs/5.3/filesystem for full list of available functionality