开源项目 `qiniu-laravel-storage` 使用教程

开源项目 qiniu-laravel-storage 使用教程

1. 项目的目录结构及介绍

qiniu-laravel-storage 是一个用于集成七牛云存储服务的 Laravel 扩展包。其目录结构如下：

qiniu-laravel-storage/
├── src/
│   ├── QiniuStorageServiceProvider.php
│   ├── QiniuAdapter.php
│   ├── QiniuUrl.php
│   └── ...
├── composer.json
├── README.md
└── ...

• src/ 目录包含了项目的主要源代码文件。

  • QiniuStorageServiceProvider.php：服务提供者，用于注册和启动扩展包。
  • QiniuAdapter.php：适配器，用于处理与七牛云存储的交互。
  • QiniuUrl.php：用于生成七牛云存储对象的 URL。

• composer.json：Composer 配置文件，定义了项目的依赖关系和其他元数据。

• README.md：项目的说明文档，包含了项目的简介、安装和使用说明。

2. 项目的启动文件介绍

项目的启动文件主要是 QiniuStorageServiceProvider.php，它负责注册和启动扩展包。以下是该文件的关键部分：

namespace zgldh\QiniuStorage;

use Illuminate\Support\ServiceProvider;

class QiniuStorageServiceProvider extends ServiceProvider
{
    public function boot()
    {
        // 发布配置文件
        $this->publishes([
            __DIR__.'/config/qiniu.php' => config_path('qiniu.php'),
        ]);
    }

    public function register()
    {
        // 注册服务
        $this->app->singleton('qiniustorage', function ($app) {
            return new QiniuStorage($app['filesystem']->getAdapter());
        });
    }
}

• boot() 方法用于发布配置文件到 Laravel 项目的 config 目录。
• register() 方法用于注册服务，将 QiniuStorage 实例绑定到应用程序容器中。

3. 项目的配置文件介绍

配置文件 config/qiniu.php 包含了与七牛云存储相关的配置信息。以下是配置文件的内容示例：

return [
    'access_key' => env('QINIU_ACCESS_KEY', ''),
    'secret_key' => env('QINIU_SECRET_KEY', ''),
    'bucket' => env('QINIU_BUCKET', ''),
    'domain' => env('QINIU_DOMAIN', ''),
];

• access_key 和 secret_key：七牛云存储的访问密钥。
• bucket：存储空间名称。
• domain：存储空间的域名。

这些配置项通常从 .env 文件中读取，以确保敏感信息的安全。

通过以上内容，您可以了解 qiniu-laravel-storage 项目的目录结构、启动文件和配置文件的基本信息，从而更好地使用和集成该扩展包。