ログイン後のリダイレクト先、その２

Tue, 03 May 2022 07:55:47 +0900

前回の記事ではログインボタンからログインした場合について解説しました。そちらのケースでは、RouteServiceProvider::HOMEを任意の値に変更する事でリダイレクト先を指定できました。今回はもう少し掘り下げ、ログインが必要なページにアクセスし強制的にログインページに飛ばされた場合について見てみましょう。

ログインページへ強制リダイレクト、からのログイン

未ログインの状態でログインが必要なページに遷移するとアクセスがガードされログインフォームに飛ばされますが、そこからログインした場合はどこにリダイレクトするでしょうか？前回の記事でRouteServiceProvider::HOMEに設定したトップページ（’/’）でしょうか？確認してみましょう。

以下のようにweb.phpを編集して’sayhi’というrouteを追加します。

routes/web.php

<?php

use Illuminate\Support\Facades\Route;

/*
|--------------------------------------------------------------------------
| Web Routes
|--------------------------------------------------------------------------
|
| Here is where you can register web routes for your application. These
| routes are loaded by the RouteServiceProvider within a group which
| contains the "web" middleware group. Now create something great!
|
*/

Route::get('/', function () {
    return view('welcome');
});

Route::get('/dashboard', function () {
    return view('dashboard');
})->middleware(['auth'])->name('dashboard');

// ルート sayhi を追加
Route::get('/sayhi', function () {
    return sprintf('<h1>Hi, %s</h1>', auth()->user()->name);
})->middleware(['auth'])->name('sayhi');

require __DIR__.'/auth.php';

未ログインの状態でsayhiページを開いてみましょう。php artisan serveでwebサーバを起動しているならhttp://localhost:8000/sayhiから開けます。アクセスがガードされログインページに飛ばされるはずです。そしてログインすると。。。

sayhiページが表示されました。

redirect()->intended(...)、再び

認証が必要なページにアクセスしログインページに飛ばされた場合、ログイン後は元々アクセスしようとしていたページにリダイレクトされるようです。これはどういうプロセスでそうなっているのでしょうか？

以下、AuthenticatedSessionControllerのstore()を再掲します。

app/Http/Controllers/AuthenticatedSessionController.php

/**
 * Handle an incoming authentication request.
 *
 * @param  \App\Http\Requests\Auth\LoginRequest  $request
 * @return \Illuminate\Http\RedirectResponse
 */
public function store(LoginRequest $request)
{
    $request->authenticate();
 
    $request->session()->regenerate();
 
    return redirect()->intended(RouteServiceProvider::HOME);
}

前回は掘り下げなかった、redirect()->intended(…) の処理を追ってみましょう。 intended()は以下のように定義されています。

vendor/laravel/framework/src/Illuminate/Routing/Redirector.php

/**
 * Create a new redirect response to the previously intended location.
 *
 * @param  string  $default
 * @param  int  $status
 * @param  array  $headers
 * @param  bool|null  $secure
 * @return \Illuminate\Http\RedirectResponse
 */
public function intended($default = '/', $status = 302, $headers = [], $secure = null)
{
    $path = $this->session->pull('url.intended', $default);

    return $this->to($path, $status, $headers, $secure);
}

ここでの処理のポイントは３つです。

sessionにurl.intendedがセットされていればその値をリダイレクト先とする
url.intendedがセットされていなければ、引数で渡されたパスをリダイレクト先とする（ここではRouteServiceProvider::HOME）
url.intendedも引数もセットされていない場合、引数のデフォルト値である'/'をリダイレクト先とする

ログインページに飛ばされた際、debugbarのsessionタブを開くとurl.intendedに元々アクセスしようとしていたURLがセットされているのが確認できます。

尚、sessionのpull()はセッションから値を取得し削除する為、ログイン後url.intendedはセッションに残っていません。

ログイン後のリダイレクト先、その１

Mon, 02 May 2022 07:55:30 +0900

ECサイトなど会員登録機能を備えたサイトは大きくなると利便性やマーケティング的な観点からページ遷移にとても気を使うようになります。ログイン後のリダイレクト先も重視される導線の一つですね。先の案件でそれらを見直す機会があったので挙動や設定方法について備忘録を兼ねてまとめます。

事前準備

以降の解説はLaravel Breezeがインストールされている状態から進めます。一緒に手を動かしながら進める方は過去の記事、Laravel 8.xのインストールを参考にインストールして下さい。

途中、debugbarでsessionの状態を確認します。必要であればそちらもインストールを、

composer require barryvdh/laravel-debugbar --dev

ログインボタンからログインした際のリダイレクト先

まずは通常のログイン遷移を確認してみましょう。新規のプロジェクトにLaravel Breezeをインストールした状態だと、トップページ右上のLog inからログインからログインできますね。

そして、ログイン後はdashboardページへ遷移しました。

これを任意のURL、例えば、トップページ（’/’）に変更したい場合はどうすれば良いでしょうか？

ログイン時に実行されているのはAuthenticatedSessionControllerのstore()ですので、そちらを確認してみましょう。

app/Http/Controllers/AuthenticatedSessionController.php

/**
 * Handle an incoming authentication request.
 *
 * @param  \App\Http\Requests\Auth\LoginRequest  $request
 * @return \Illuminate\Http\RedirectResponse
 */
public function store(LoginRequest $request)
{
    $request->authenticate();

    $request->session()->regenerate();

    return redirect()->intended(RouteServiceProvider::HOME);
}

リダイレクト先は、redirect()->intended(RouteServiceProvider::HOME);によって決まっているようです。こちらのメソッドの詳しい解析は後に回して、引数のRouteserviceProvider::HOMEという定数に注目です。

RouteServiceProviderを確認するとHOMEは現在のリダイレクト先である’/dashboard’となっていました。この値をトップページ（’/’）に変更してみましょう。

app/Providers/RouteServiceProvider.php

class RouteServiceProvider extends ServiceProvider
{
    /**
     * The path to the "home" route for your application.
     *
     * This is used by Laravel authentication to redirect users after login.
     *
     * @var string
     */
    public const HOME = '/';    // '/dashboard' から変更
...