版本控制系统 - Versionable

版本控制系统 - Versionable

Laravel 模型版本管理，从未如此简单

Versionable 是一个用于 Laravel 的库，可帮助你轻松追踪和恢复模型的所有更改记录。

// 回滚到上一版本
$content->previousVersion()->revert();

// 根据版本获取模型
$oldModel = Version::find(100)->getModel();

安装与配置

通过 Composer 进行安装：

composer require mpociot/versionable

然后运行迁移文件：

php artisan migrate --path=vendor/mpociot/versionable/src/migrations

或者发布并运行迁移文件：

php artisan vendor:publish --provider="Mpociot\Versionable\Providers\ServiceProvider" --tag="migrations"
php artisan migrate

使用方法

在你想进行版本控制的模型中，引入 VersionableTrait。

class Content extends Model {

    use Mpociot\Versionable\VersionableTrait;

}

这样就完成了！

每次更新模型时，新的版本都会保存当前的属性信息在数据库中。

现有数据的版本化

如果你的应用已经有了一些历史数据，可以使用 createInitialVersion() 方法为现有模型创建初始版本，或者使用 Model::initializeVersions() 来批量处理。

排除字段

有些情况下，不希望每个属性变动都创建新版本，例如在用户模型中可能有一个 last_login_at 字段，你不希望每次登录都创建新版本。你可以通过设置模型上的 dontVersionFields 属性来排除这些字段。

class User extends Model {

    use VersionableTrait;

    /**
     * @var array
     */
    protected $dontVersionFields = [ 'last_login_at' ];

}

隐藏字段版本化

有时你需要将通常隐藏的字段（如 hidden 或 visible 属性）存储在版本信息中，可以通过在版战控制模型上定义 versionedHiddenFields 属性实现。

最大存储版本数

你可以控制每个模型的最大存储版本数量，默认没有限制。如果需要设定上限，可在模型中添加 $keepOldVersions 属性。

class User {

    use VersionableTrait;

    // 保留最近10个版本。
    protected $keepOldVersions = 10;

}

获取版本差异

使用 diff 方法查看两个版本之间的差异，结果会以关联数组的形式返回，键是字段名，值是变化后的值。

版本回滚

你可以轻松地回滚至之前的版本，例如：

$content->previousVersion()->revert();

或回滚至特定ID的版本：

$revertedModel = Version::find($version_id)->revert();

关闭版本控制

某些情况下，你可能希望在特定请求中暂时关闭某个模型的版本控制，这可以通过模型的 disableVersioning 和 enableVersioning 方法完成。

自定义版本表

如有需要，你可以为特定模型的版本信息使用不同的表格，只需创建一个新的版本模型类，重设 $table 属性，并在原模型中设置 $versionClass 属性指向这个自定义版本模型。

特点总结

• 易于集成，只须在模型中引入一个 Trait。
• 可灵活设置版本控制策略，比如排除字段、最大版本数等。
• 支持查看版本间的差异，方便对比和回滚。
• 内置了对隐藏字段的版本化支持。
• 提供了关闭版本控制的功能，适用于特殊情况需求。

Versionable 提供了一套优雅的解决方案，让 Laravel 应用中的数据版本控制变得轻而易举。无论是用于跟踪用户数据的变更，还是用于确保文档系统的版本一致性，都将助你事半功倍。现在就尝试一下吧！