ビジネスロジッククラスにAuth::user()の結果を外から差し込むスマートな方法

Question

前提・実現したいこと

ログインしないとほとんどの画面が動作しないサイトの開発を行っています。そのサイトのコードで、Laravelに直接依存していないビジネスロジッククラスに、うまいことAuth::user()の情報を自動で注入したいと思っています。
どんな方法があるかご教示ください。

前提

• ビジネスロジックの中はLaravelから切り離したいのでAuth::user()と書きたくない。
• Laravel側から登録しにくるサービスコンテナは使ってもいいと思っている。

ゴール

class SomePlainOldPhpLogic {
    private $user;
}

このロジッククラスのインスタンスが呼ばれると常に$userにAuth::user()が入っていて欲しいです。

試したこと

コンストラクタインジェクション

- 呼び元がコントローラなのでそちらのコンストラクタを利用しようとしました。タイプヒントでビジネスロジックをインジェクションしてから、後追いで情報を追加($logic->setUser( Auth::user() )しようとしました。
- しかしそもそもコンストラクタ内ではAuth::user()が呼べませんでした。
- 上の対策にmiddlewareを使う方法というのも試しましたが、事前にAuth::login()で認証情報を仕込んだテストケースから動かすと情報が入らないという動きをしたので、採用できませんでした。

auth::user()と紐付いたサービスコンテナとしてサービスプロバイダに登録

• registerのときはAuth::user()が呼べませんでした。
• bootのときは呼べそうですが、どう呼んで紐付ければいいのかわかりません。(ここが解決すればなんとかなる？)

ちなみに今は

ビジネスロジックのpublicなメソッドに毎回 Auth::user()を渡しています。ダサいです。
せめて$logic->setUser( Auth::user() )を自動で呼ぶことはできないかな…

補足情報（FW/ツールのバージョンなど）

Laravel 5.4 です。古くてすみません。

Answer 1

• Illuminate\Contracts\Auth\Guard
• Illuminate\Contracts\Auth\Factory

Guard か Factory をDIするのが正攻法だと思います。Guard がデフォルト認証方法に設定されているもの（例えば SessionGuard），Factory が AuthManager に対応します。

class SomePlainOldPhpLogic
{
    protected $guard;

    public function __construct(Guard $guard)
    {
        $this->guard = $guard;
    }

    public function user(): User
    {
        return $this->guard->user();    
    }
}

コンテナの利用方法については
【Laravel】サービスコンテナ・サービスプロバイダ・ファサード・契約に関する補足資料 - Qiita
をご覧ください

Comments

[mpyw]

>> SomePlainOldPhpLogic内にuser持ったら結局依存してる気がするけど

この通りなんですよね…

フレームワーク独立を謳うのであれば，すべて Contract ベースに書かないといけないです。User を User であるとして使っちゃいけないんです，あくまでそれは Authenticatable です。完全な非依存は無理ゲーですね。

[mihit]

ありがとうございます。
Authの契約をこうして利用できるのですね。「デフォルトの認証方式が入る」なども、サービスコンテナの性質から考えれば言われてみるとなるほどと思うのですが…！ ありがたいです。

UserをUserであるとして使ってはいけないというのはつまり、$userを注入するのではなく、契約をベースに$userを「提供する機能」を注入すると考えた方が、より独立性が高まると理解すればよいでしょうか？

[mpyw]

>> 契約をベースに$userを「提供する機能」を注入する

今回の回答はまさにそんな感じなんですが、コメントに書いたのは少し趣旨が違います。Eloquent Model を直接サービス層で使う時点でもう完全な独立は守れない、ということです。 Eloquent Model クラス自体が Laravel とかなり密結合です。（↓のREADMEにあるようにCapsuleとして使ったとしてもここはそんなに変わらないと思う）

illuminate/database: [READ ONLY] Subtree split of the Illuminate Database component (see laravel/framework) https://github.com/illuminate/database

[mpyw]

以下のようなものを作り、

・そのサービス層専用のUserオブジェクト（例えばUserEntity）
・そのサービス層専用のGuardのラッパー（例えばUserEntityProvider）

↓多分ここまでしないと「SomePlainOldPhpLogic は Laravel から独立している」とは言えないと思います。

class UserEntityProvider implements UserEntityProviderContract
{
    protected $guard;

    public function __construct(Guard $guard)
    {
        $this->guard = $guard;
    }

    public function user(): UserEntityContract
    {
        $this->guard->user()->toUserEntity(); // この変換メソッドは User Model 上に実装
    }
}

class SomePlainOldPhpLogic
{
    protected $provider;

    public function __construct(UserEntityProviderContract $provider)
    {
        $this->provider = $provider;
    }

    public function user(): UserEntityContract
    {
        return $this->provider->user();
    }
}

[mpyw]

ここまでするメリットがあるかどうかでいうと正直無いことのほうが多いと思うので、あまり独立性にこだわらなくてもいいかなと思います（本音

[mihit]

なるほど、UserもUserの発行元も本当にLaravelと無関係な実体にまで分離する、これこそが厳密なやり方だというのはよくわかります！
そこまでする必要ない感ただよってるのもわかります！????

遅くなりましたがあっさり動作確認も取れました。直接の問題解決以外にもいろいろな気づきをいただけたのでBA差し上げます。ありがとうございました。

Answer 2

SomePlainOldPhpLogic内にuser持ったら結局依存してる気がするけど
サービスコンテナ使うならこういうのでいいのでは。

public function register()
{
    $this->app->bind(SomePlainOldPhpLogic::class, function ($app) {
        return new SomePlainOldPhpLogic(auth()->user());
    });
}

普通にregister()でauth()->user()が正しく取得できることは手元で確認した。
もちろんsingletonはやめたほうが良さそう。

Comments

[mihit]

動作確認ありがとうございます！ それで一度うまくいかなかったのですが元気出ました。もう一度確認してみます。

$user使うなら結局依存するのはおっしゃるとおりですね。まあLaravelから逃げても普通ORマッパーまでは捨てないか移植するかでしょうし(userのプロパティが変わっちゃうならロジックだって使い回せませんし)、user()の後ならgateも通った後だし、必要なプロパティのおててが生えてくる容れ物としてだけ扱えばだいたい互換する程度の出来栄えを想定してはいます。

[mihit]

$this->app->bind(SomePlainOldPhpLogic::class, function(){
return new SomePlainOldPhpLogic( auth()->guard() );
} );

resolve( SomePlainOldPhpLogic::class )->resolveMyConcerns()

動きました！
Auth:: より auth() のほうがimportを汚さなくていいですね。
ひとまずこんな実装を試しています。ありがとうございました！