Spatie Laravel Backup 高级用法：向备份中添加额外文件-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00633/article/details/148488801

Spatie Laravel Backup 高级用法：向备份中添加额外文件

laravel-backup A package to backup your Laravel app 项目地址: https://gitcode.com/gh_mirrors/la/laravel-backup

理解备份流程

在深入探讨如何添加额外文件之前，我们需要先了解 Spatie Laravel Backup 包的基本备份流程。这个流程可以分为三个主要阶段：

清单创建阶段：系统会创建一个包含所有待备份文件的清单
压缩阶段：根据清单创建压缩文件
存储阶段：将压缩文件复制到配置的存储位置

为什么需要添加额外文件

在实际项目开发中，我们经常会遇到一些特殊需求，例如：

备份某些运行时生成的文件
包含不在默认备份目录中的配置文件
添加项目特有的资源文件
备份用户上传的媒体文件

这些文件可能不在默认的备份配置中，但又确实需要被包含在备份中。

使用 BackupManifestWasCreated 事件

Spatie Laravel Backup 提供了一个关键事件 BackupManifestWasCreated，它正好在清单创建之后、压缩开始之前触发。这个事件为我们提供了一个完美的时机来修改备份清单。

事件结构分析

让我们仔细看看这个事件类：

namespace Spatie\Backup\Events;

use Spatie\Backup\Tasks\Backup\Manifest;

class BackupManifestWasCreated
{
    /** @var \Spatie\Backup\Tasks\Backup\Manifest */
    public $manifest;

    public function __construct(Manifest $manifest)
    {
        $this->manifest = $manifest;
    }
}

这个事件类非常简单，它只包含一个公共属性 $manifest，这个属性是 Manifest 类的实例，提供了操作备份清单的方法。

实现文件添加

基本实现方式

在 Laravel 中，我们可以通过事件监听器来响应这个事件。以下是一个基本的实现示例：

use Spatie\Backup\Events\BackupManifestWasCreated;

Event::listen(BackupManifestWasCreated::class, function (BackupManifestWasCreated $event) {
    $event->manifest->addFiles([
        '/path/to/file1',
        '/path/to/file2',
        // 更多文件路径...
    ]);
});

实际应用示例

假设我们需要备份用户上传的图片和项目特定的配置文件：

Event::listen(BackupManifestWasCreated::class, function (BackupManifestWasCreated $event) {
    // 用户上传的图片目录
    $userUploads = storage_path('app/public/uploads/*');
    
    // 项目特定配置文件
    $customConfig = config_path('custom.php');
    
    $event->manifest->addFiles(
        array_merge(
            glob($userUploads),
            [$customConfig]
        )
    );
});

高级技巧

动态文件添加

我们可以根据环境或条件动态决定要添加哪些文件：

Event::listen(BackupManifestWasCreated::class, function (BackupManifestWasCreated $event) {
    $filesToAdd = [];
    
    if (app()->environment('production')) {
        $filesToAdd[] = config_path('production-only.php');
    }
    
    if (config('backup.include_logs')) {
        $filesToAdd[] = storage_path('logs/*');
    }
    
    $event->manifest->addFiles($filesToAdd);
});

文件验证

在添加文件前进行验证是个好习惯：

Event::listen(BackupManifestWasCreated::class, function (BackupManifestWasCreated $event) {
    $files = [
        '/path/to/important/file',
        '/another/path'
    ];
    
    $existingFiles = array_filter($files, function ($file) {
        return file_exists($file);
    });
    
    $event->manifest->addFiles($existingFiles);
});