README

适用于Laravel的Google Cloud Storage文件系统。

此包是一个包装器，将flysystem-google-storage（flysystem-google-storage）桥接进Laravel作为可用的存储磁盘。

安装

composer require Devmagellan/laravel-google-cloud-storage

如果您使用的是Laravel 5.4或更早版本，请在app.php中注册服务提供者

'providers' => [
    // ...
    Devmagellan\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进行身份验证。

1. 如果您在磁盘配置中的key_file键中指定了路径，将使用该JSON凭证文件。

2. 如果设置了GOOGLE_APPLICATION_CREDENTIALS环境变量，它将使用该变量。

   putenv('GOOGLE_APPLICATION_CREDENTIALS=/path/to/service-account.json');

3. 然后它将尝试从一个“已知路径”中加载密钥文件

   • windows: %APPDATA%/gcloud/application_default_credentials.json
   • 其他：$HOME/.config/gcloud/application_default_credentials.json

4. 如果在Google App Engine上运行，将使用与应用程序关联的内置服务账户。

5. 如果在Google Compute Engine上运行，将使用与虚拟机实例关联的内置服务账户。

6. 如果您想不使用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），您需要在DNS条目中配置CNAME指向storage.googleapis.com。

请参阅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