Laravelで楽観的ロックをつくってみる

Laravelには<a href="https://readouble.com/laravel/5.8/ja/queries.html#pessimistic-locking" target="_blank">悲観的ロックの機能</a>は備わってるけど、楽観的ロックの機能が用意されていないっぽいのでつくってみました。

# そもそも悲観的ロック・楽観的ロックとは？？
書きたい事から外れるので、ざっくりというと、、

- 悲観的ロック：自分がデータを取ってきた時点でロックをかけて、他の人にはそのデータを取ってこれないようにする。
- 楽観的ロック：誰でもデータを取ってこれるけど、先に更新した人が勝ちで、更新前のデータを後から更新しようとしてもダメ。

わかりやすく丁寧に説明してくれている記事はこちら↓

- 「<a href="https://qiita.com/NagaokaKenichi/items/73040df85b7bd4e9ecfc" target="_blank">排他制御（楽観ロック・悲観ロック）の基礎</a>」
- 「<a href="https://qiita.com/daiching/items/835fa37de22b397eece0" target="_blank">データベースの「ロック」という概念は2種類ある</a>」

ということで、今回は「楽観的ロック」を作ってみます。
たまに見かける「他の人が変更してるので、画面更新して最新の情報を表示してね」的なメッセージが出るアレです。

今回は管理画面で「タイトル」と「本文」だけがある記事を更新するケースを考えてみます。

# シナリオケース
<img width="1188" alt="" src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/510032/58712c89-d497-6e14-62d3-509e737e0566.png">

# 仕組み
ざっくりとした仕組みはこんな感じ。

1.  編集画面を表示した時に`<hidden>`で最終更新日時を隠し持っておく
2.  更新処理の直前に現在のレコードをselectして最終更新日時を取得する
3.  「hiddenの値 < 現在のレコードの値」だった場合は他の人が先に更新してるのでエラーにする

※処理1：最終更新日時ではなくレコードのバージョンを保存するカラムを作って、更新のたびにインクリメントしていく方法もあります。

※処理2〜3：レコードを更新する時の条件としてhiddenの値を指定して、更新結果が0件の場合はエラーとする方法もあるかと思います。


```sql
update blog set
    title = ?,   -- 入力値
    body = ?,  -- 入力
    edited_at = ?  -- CURRENT_TIMESTAMP()
where
    id = ?
    and
    edited_at = ? -- hiddenの日時
```

# 環境

- php7.3
- laravel5.8
- mysql5.7



# 構成

#### テーブル

```sql
CREATE TABLE `blog` (
  `id` int(11) unsigned NOT NULL AUTO_INCREMENT,
  `title` varchar(30) DEFAULT NULL,
  `body` text,
  `edited_at` timestamp NULL DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

```

#### ディレクトリ構成

※必要なものだけ記述しています。


```
├── app
│   ├── Http
│   │   └── Controllers
│   ├── Models
│   │   └── Blog.php
│   ├── Observers
│   │   └── OptimisticLockObserver.php
│   ├── Services
│   │   └── BlogService.php
│   ├── Traits
│   │   └── OptimisticLockObserverTrait.php
├── resources
│   └── views
│       ├── input.blade.php

```

ではでは、具体的な処理へ。

### 1.  編集画面を表示した時に`<hidden>`で最終更新日時を隠し持っておく


```/resources/views/input.blade.php
<form action="/save" method="post">
    @csrf
    <input type="hidden" name="edited_at" value="{{old('edited_at', $blog->edited_at??null)}}" />
    <input type="text" name="title" value="{{old('title', $blog->title??null)}}">
    <textarea name="body">{{old('body', $blog->body??null)}}</textarea>
</form>
```


これは単純にhiddenを作りましたというだけ。


### 2.  更新処理の直前に現在のレコードをselectして最終更新日時を取得する

#### 更新処理

```/app/Services/BlogService.php
<?php

namespace App\Services;

use App\Models\Blog;

class BlogService{

    /**
     * 保存
     *
     * @param array $values
     * @param Blog|null $blog
     */
    public function save(array $values, Blog $blog=null)
    {
        $input = collect($values);

        $model = $blog ?: new Blog();
        $model->title = $input->get('title');
        $model->body = $input->get('body');
        $model->setEditedAt($input->get('edited_at'));

        $model->save();
    }
}
```

`$model->setEditedAt($input->get('edited_at'));`で画面のhiddenに保持していた更新日時をモデルに設定しています。
引数がNullでも動くようにしているので、新規作成時でも上記の記述で大丈夫です。


#### 楽観的ロック制御のための仕組み

```/app/Models/Blog.php
<?php

namespace App\Models;

use App\Traits\OptimisticLockObserverTrait;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;


class Blog extends Model
{
    use SoftDeletes;
    use OptimisticLockObserverTrait;

    /**
     * 日付へキャストする属性
     *
     * @var array
     */
    protected $dates = [
        'created_at',
        'updated_at',
        'edited_at',
        'deleted_at',
    ];
}

```

`use OptimisticLockObserverTrait;`でトレイトを使ってBlogモデルに2つのfunctionを定義しています。


```/app/Traits/OptimisticLockObserverTrait.php
<?php

namespace App\Traits;

use App\Observers\OptimisticLockObserver;
use Carbon\Carbon;

trait OptimisticLockObserverTrait
{
    protected static function bootOptimisticLockObserverTrait()
    {
        self::observe(OptimisticLockObserver::class);
    }

    public function setEditedAt($editedAt){
        $this->{OptimisticLockObserver::OPTIMISTIC_LOCK_CHECK_COLUMN} = $editedAt? Carbon::parse($editedAt): null;
    }
}
```

#### setEditedAt()

前述の`BlogService#save`で呼び出していて、これを呼び出すとモデルオブジェクトに楽観的ロックチェック用の一時プロパティを追加して最終更新日を設定しています。
（更新処理でこのfunctionを呼び出さなければ楽観的ロックは行わないう様になります。）


#### bootOptimisticLockObserverTrait()
このfunctionですが、

- 修飾子が`static`であること
- function名が「boot【+クラス名】」であること

というのがポイントで、このルールに則って定義していると、Modelクラスのコンストラクタでこのfunctionを実行してくれるというものです。

そして、functionの中身の`self::observe(OptimisticLockObserver::class);`は、Modelクラスが読み込んでる`Concerns\HasEvents`トレイトのfunctionに定義されていてい、コメントに

>Register observers with the model.

と書いてあるので、<a href="https://readouble.com/laravel/5.8/ja/eloquent.html#observers">オブザーバ</a>をサービスプロバイダではなく、モデルで登録する機能のようです。


そしてこの機能を利用して登録しているオブザーバクラスはこちらです。

### 3.  「hiddenの値 < 現在のレコードの値」だった場合は他の人が先に更新してるのでエラーにする

```/app/Observers/OptimisticLockObserver.php
<?php

namespace App\Observers;


use App\Exceptions\ExclusionException;
use Carbon\Carbon;
use Illuminate\Database\Eloquent\Model;

class OptimisticLockObserver
{
    /**
     * 楽観的ロックチェック用の一時プロパティ
     */
    const OPTIMISTIC_LOCK_CHECK_COLUMN = 'edited_at_optimistic_lock_check_column';


    /**
     * INSERT前
     *
     * @param Model $model
     */
    public function creating(Model $model){
        if (!$this->checkPropExists($model)) return;

        $this->unsetOptimisticLockColumn($model);
        $model->edited_at = Carbon::now();
    }

    /**
     * UPDATE前
     *
     * @param Model $model
     */
    public function updating(Model $model){
        if (!$this->checkPropExists($model)) return;

        $this->check($model, 'update');
        $model->edited_at = Carbon::now();
    }

    /**
     * 論理削除前
     *
     * @param Model $model
     */
    public function deleting(Model $model){
        if (!$this->checkPropExists($model)) return;

        $this->check($model, 'delete');
        $model->edited_at = Carbon::now();
    }

    /**
     * 物理削除前
     *
     * @param Model $model
     */
    public function restoring(Model $model){
        if (!$this->checkPropExists($model)) return;

        $this->check($model, 'delete');
        $model->edited_at = Carbon::now();
    }

    /**
     * 楽観的ロックチェック
     *
     * @param Model $model
     */
    private function check(Model $model, $msgType){
        //楽観的ロックチェック用の一時プロパティがあった時だけチェックする
        if (!$this->checkPropExists($model)) return;

        //現時点でのDBのデータを取得
        $currentMe = $model->withTrashed()->find($model->id);
        $currentEditedAt = $currentMe->edited_at;
        //更新されているかチェック
        if($model->{self::OPTIMISTIC_LOCK_CHECK_COLUMN} != $currentEditedAt){
            //楽観ロック
            throw new ExclusionException(trans('error_message.exclusion.'.$msgType));
        }

        $this->unsetOptimisticLockColumn($model);
    }

    /**
     * 楽観的ロック用の一時プロパティを削除する
     * これをしないと存在しないカラムに値を登録しようとしてsave()時にエラーになる。
     *
     * @param Model $model
     */
    private function unsetOptimisticLockColumn(Model $model){
        unset($model->{self::OPTIMISTIC_LOCK_CHECK_COLUMN});
    }

    /**
     * 楽観的ロック用の一時プロパティがあるかチェックする
     *
     * @param Model $model
     * @return bool true:ある
     */
    private function checkPropExists(Model $model){
        return array_key_exists(self::OPTIMISTIC_LOCK_CHECK_COLUMN, $model->getAttributes());
    }
}
```

Eloquentモデルの<a href="https://readouble.com/laravel/5.8/ja/eloquent.html#events" target="_blank">イベント処理</a>を記述しています。レコードの登録・更新・削除前に実行されます。

処理内容は、

1. モデルオブジェクトに楽観的ロックチェック用のプロパティが存在したら
2. 対象レコードの`edited_at`カラムの値をselectする
3. 「プロパティの値 < `edited_at`カラム」の場合は`ExclusionException`（自作のException）をスローする
4. 全部OKなら、モデルオブジェクトの`edited_at`に現在日時を追加する

となっています。あとはEloquentの流れに乗って勝手に更新される。

ここら辺のオブザーバ周りは「<a href="https://qiita.com/maimai-swap/items/6597c04721adbc48fec2" target="_blank">Laravelのeloquentのeventでcreated_byとかupdated_byとか更新するobserverとtrait</a>」をまるっと参考にさせてもらいました。

# 参考

最後にもう一度、参考にさせて頂いた記事をまとめておきます。

- 「<a href="https://qiita.com/NagaokaKenichi/items/73040df85b7bd4e9ecfc" target="_blank">排他制御（楽観ロック・悲観ロック）の基礎</a>」
- 「<a href="https://qiita.com/daiching/items/835fa37de22b397eece0" target="_blank">データベースの「ロック」という概念は2種類ある</a>」
- 「<a href="https://qiita.com/maimai-swap/items/6597c04721adbc48fec2" target="_blank">Laravelのeloquentのeventでcreated_byとかupdated_byとか更新するobserverとtrait</a>」