Laravelでトランザクションを張る2つの方法！

Laravelでトランザクションを張る方法について書いてみました。
Laravel8 + MySQL8で確認しています。

トランザクションを張る方法は下記の2つです。
・DBのコミットやロールバック自分で書く。
・transactionメソッドを使って、クロージャの中でSQL操作を完結させる。

公式では、下記に記載されています。

Laravel - The PHP Framework For Web Artisans

Laravel is a PHP web application framework with expressive, elegant syntax. We’ve already laid the foundation — freeing ...

そもそもトランザクションとは？
DBファサードを使用する準備
手動でトランザクションを張る
1. 解説
クロージャを使用してトランザクションを張る
1. 解説

そもそもトランザクションとは？

簡単に言うと、トランザクションは処理のまとまりのことです。
トランザクションを開始して、コミットされるまでをひとまとまりとして処理します。
エラーが発生したり、例外が投げられた場合は処理をなかったことにして、トランザクションの開始前に戻します。

DBファサードを使用する準備

DBファサードを使用することで、トランザクションを張ることができます。
DBファサードを使用するには、使用したいファイルの頭に下記のようにuse文を追加します。

use Illuminate\Support\Facades\DB;

手動でトランザクションを張る

下記のように書くことで、トランザクションを張ることができます。
beginTransactionメソッドでトランザクションを開始して、commitメソッドでデータベースに反映します。

try {
    DB::beginTransaction();

    User::create([
        'name'     => 'taro',
        'email'    => 'hoge1@example.com',
        'password' => 'password'
    ]);

    User::create([
        'name'     => 'hanako',
        'email'    => 'hoge2@example.com',
        'password' => 'password'
    ]);

    DB::commit();
} catch (Throwable $e) {
    DB::rollBack();
}

解説

DB::beginTransactionでトランザクションを開始します。
DB::commitが呼ばれるまでは、データベースに反映されません。

今回の例はUserテーブルにデータをインサートしているだけです。
もし、複数のインサート処理やいろいろな処理がある場合にcommitまで行かずに処理が止まったりすると、インサートしたデータが反映されずに処理が終わります。
こうすることで、データの整合性を保つことができます。

エラーがあった場合は、catchで掴んでロールバックします。
DB::rollBackを呼ぶことで、トランザクションをロールバックしてくれます。
これまでのデータベースの変更をトランザクションの開始時まで戻してくれます。

クロージャを使用してトランザクションを張る

手動でトランザクションを張ってみましたが、指定したブロックの処理が終わったらコミットしてくれる書き方があります。
下記のように書くことで、クロージャの中の処理が終わるまでコミットされず、終わったらコミットされるようになります。

DB::transaction(function () {
    User::create([
        'name'     => 'taro',
        'email'    => 'hoge@example.com',
        'password' => 'password'
    ]);
});

ちなみに、引数を渡したい場合は下記のようにクロージャにuseを書くといいです。

DB::transaction(function () use($name, $email, $password) {
    User::create([
        'name'     => $name,
        'email'    => $email,
        'password' => $password
    ]);
});