20220319[Laravel]想定外のN+1アラート

Transcript

1. [Laravel]想定外のN+1アラート 2022 / 3 / 19 クマ
2. 自己紹介 • 実務入って半年 • PHP(Laravel)、JavaScript(Vue)を書いてます。 • 好き↓ • タガが外れたように満腹まで食べる • ラーメン屋のハシゴ、二郎系マシマシ…etc • 甘いもの • ミスド食べ放題いったり、パンケーキ食らったり • スイパラ行くのが直近目標 P-01
3. 目次 • 話すこと • 前提（こっから本題） • やりたいこと • 起きたこと • 原因 • やったこと（本題おわり） • おわりに P-01
4. 話すこと P-01
5. 話す事 LaravelにてN+1が発生していないように見えたのだが、アラート が出たときの対応方法 ↓こんなの ※Laravel経験がないとイメージつきにくい内容かもです。。。 P-01
6. 前提 P-01
7. 前提 バージョン • PHP 8.0.2 • Laravel 8.5.0 P-01
8. 前提 テーブル構成 P-01 blockedプロパティをチェックしてBANす るか否かをチェックする想定
9. 前提 リレーション ↓Userモデル P-01 UserとUserAttributeで1対1のリレーションを構築
10. やりたいこと P-01
11. やりたいこと いわゆる「垢BAN機能」を実装したい 特定ユーザーをログインできなくする、アレです。 ※ちなみに、この機能自体は本題と関係ないです。 P-01
12. やりたいこと <?php namespace App¥Http¥Middleware; use Closure; use Illuminate¥Http¥Request; use Illuminate¥Support¥Facades¥Auth; class CheckBlockedUser { public function handle(Request $request, Closure $next) { if (Auth::check() && $user = Auth::user()) { $userAttribute = $user->userAttribute; // ※ if ($userAttribute && $userAttribute->blocked == 1) { Auth::logout(); $request->session()->regenerateToken(); Log::notice('Block user from login status. '.$user->id); return redirect()->route('login') ->withErrors(['error' => 'アカウントは凍結されています。']); } } return $next($request); } } P-01 App/Middleware/CheckBlockedUser userAttributeを取得 ➡ここでクエリが発行 (SELECT * FROM user_attribute …) ※補足 ここでblockedプロパティをチェックして BANするか否かをチェック
13. 起きたこと P-01
14. 起きたこと • ブロックユーザーで動作テスト ➡垢BAN機能は実装done（よしよし。） • 正常ユーザー（非ブロックユーザー）での動作テスト ➡ログインできるが、以下アラート発生（おん！？） P-01
15. 起きたこと • このアラートはN+1を勝手に検出して教えてくれるライブラリ 「laravel-query-detector」によるもの • 要約：「User経由でUserAttributeを取得するクエリが必要以 上に実行されているからEager Loadingしてね！」 P-01
16. やりたいこと class CheckBlockedUser { public function handle(Request $request, Closure $next) { if (Auth::check() && $user = Auth::user()) { $userAttribute = $user->userAttribute; // ※ if ($userAttribute && $userAttribute->blocked == 1) { Auth::logout(); $request->session()->regenerateToken(); Log::notice('Block user from login status. '.$user->id); return redirect()->route('login') ->withErrors(['error' => 'アカウントは凍結されています。']); } } return $next($request); } } P-01 App/Middleware/CheckBlockedUser（再掲） ここでしかクエリ発行していないんですが、、、 ただ、、、 ➡原因調査
17. 原因 P-01
18. 原因 P-01 おなじみのLaravel-debugbarで確認したところすぐに判明
19. 原因 P-01 原因はMiddlewareと別でControllerでも同じようなuserAttribute の取得（クエリの実行）をしていた $user = User::find(Auth::id()); // ココでuserAttributeを取得するSQLが発行 $userAttribute = $user->userAttribute; App/Controller/TestController（実際のコード）
20. 原因 P-01 Laravelとしては 「Middlewareで$userAttributeを取得するよ」 「あれ、Controllerでも取得しているね。だったらN+1だね」 と判断しちゃうんだな。。。 ↓アラート発生時のクエリ（イメージ） SELECT * FROM use_attribute; … … SELECT * FROM use_attribute; // ２回同じクエリが発行
21. やったこと P-01
22. やったこと 案は２つ。 1, Middlewareで取得した$userAttributeをControllerまで渡す？ ➡現実的ではない。 2, アラートを表示させない ➡これで行く P-01
23. やったこと 特定条件下でN+1を検出してもアラートを表示させないようにする ➡具体的にはlaravel-query-detector をインストールした時に入っ てくるconfig/querydetector.phpのexceptの箇所に以下記述 ➡無事アラートは発生しなくなった！ P-01 'except' => [ User::class => [ UserAttribute::class, 'userAttribute', ], ] App/Controller/TestController（追加したコード） 今回はUser➡userAttributeの際にN+1が発生し たので、このように記述
24. おわりに P-01
25. おわりに • 自分はdevelopとの差分だけ見て「N+1起こるわけな い！」と決めつけた結果痛い目にあった。。。 • どんなことでも共通するのは「自分の修正した差分だ けに問題が潜んでいるとは限らない」ということ →ある程度問題に取り組んで解決しなければ、視野を広 げる（抽象度を上げる）ことの重要性を痛感 P-01
26. ご清聴ありがとうございました。 P-01