README

为Eloquent模型添加乐观锁功能。

安装

composer require reshadman/laravel-optimistic-locking

此包支持Laravel 10.* .

用法

基本用法

在模型中使用 \Reshadman\OptimisticLocking\OptimisticLocking 特性

<?php

class BlogPost extends Model {
    use OptimisticLocking;
}

并将整数字段 lock_version 添加到模型的表中

<?php

$schema->integer('lock_version')->unsigned()->nullable();

然后您就可以开始使用了，如果两个不同的进程 并发 修改了相同的资源，则会抛出以下异常

<?php
\Reshadman\OptimisticLocking\StaleModelLockingException::class;

您应该捕获上述异常，并根据您的业务逻辑采取适当的操作。

在业务事务中维护lock_version

您可以通过通知您的API或HTML客户端当前的版本来在业务事务中跟踪lock版本

<input type="hidden" name="lock_version" value="{{$blogPost->lock_version}}" 

并在控制器中

<?php

// Explicitly setting the lock version
class PostController {
    public function update($id)
    {
        $post = Post::findOrFail($id);
        $post->lock_version = request('lock_version');
        $post->save();
        // You can also define more implicit reusable methods in your model like Model::saveWithVersion(...$args); 
        // or just override the default Model::save(...$args); method which accepts $options
        // Then automatically read the lock version from Request and set into the model.
    }
}

因此，如果两个作者正在并发编辑相同的内容，您可以跟踪您的 读取状态，并要求第二个作者重写他的更改。

禁用和启用乐观锁

您可以禁用和启用特定实例的乐观锁

<?php
$blogPost->disableLocking();
$blogPost->enableLocking();

默认情况下，当您在模型中使用 OptimisticLocking 特性时，乐观锁是启用的，要更改默认行为，可以将锁定严格设置为 false

<?php
class BlogPost extends \Illuminate\Database\Eloquent\Model 
{
    use \Reshadman\OptimisticLocking\OptimisticLocking;
    
    protected $lock = false;
}

然后您可以启用它： $blogPost->enableLocking();

使用不同的列来跟踪版本

默认情况下，使用 lock_version 列来跟踪版本，您可以通过覆盖以下方法来更改此行为

<?php
class BlogPost extends \Illuminate\Database\Eloquent\Model
{
    use \Reshadman\OptimisticLocking\OptimisticLocking;
    
    /**
     * Name of the lock version column.
     *
     * @return string
     */
    protected static function lockVersionColumn()
    {
        return 'track_version';
    }
}

什么是乐观锁？

有关详细说明，请阅读《企业应用架构模式》的并发部分。

有两种方法可以处理通用的并发竞争条件

1. 不允许其他进程（或用户）读取和更新相同的资源（悲观锁）
2. 允许其他进程并发读取相同的资源，但如果其中一个进程在其他人之前更新了资源，则不允许进一步更新（乐观锁）。

Laravel允许使用文档中描述的悲观锁，此包允许您以Rails的方式实现乐观锁。

乐观锁过程中发生了什么？

每次您对资源（模型）执行upsert操作时，表中的lock_version计数器字段都会增加1，如果您读取了资源，但另一个进程在您读取之后更新了该资源，则实际的版本计数器会增加1，如果当前进程尝试更新模型，则会抛出StaleModelLockingException，您应根据业务逻辑处理竞争条件（合并、重试、忽略）。这很简单，只需将以下标准添加到乐观锁模型的更新查询中即可

<?php
$query->where('id', $this->id)
    ->where('lock_version', $this->lock_version)
    ->update($changes);

如果资源在您的更新尝试之前已被更新，则上述操作将简单地更新0条记录，这意味着模型在当前尝试之前已被更新或已删除。

我们为什么不使用updated_at来跟踪更改？

因为它们可能在两次并发更新中保持不变。

运行测试

克隆存储库，执行composer install并运行

vendor/bin/phpunit

许可协议

MIT许可协议（MIT）。请参阅许可文件获取更多信息。