Laravel パスワード リセットのカスタマイズをマスターする: 包括的なガイド

導入

パスワード リセット機能は、最新の Web アプリケーションの重要なコンポーネントです。 Laravel はすぐに使える堅牢なソリューションを提供しますが、特定の要件を満たすため、またはユーザー エクスペリエンスを向上させるために、このプロセスを調整する必要がある場合があります。このチュートリアルでは、Laravel のパスワード リセット ワークフローのカスタマイズについて詳しく説明し、基本的な変更から高度なテクニックまですべてをカバーします。

Laravel 認証の簡単な歴史

カスタマイズについて詳しく説明する前に、Laravel の認証ソリューションがどのように進化してきたかを理解するために、記憶を辿ってみましょう。

1. Laravel UI: Laravel の完全な認証ソリューションの最初のイテレーション。長年にわたってコミュニティに役立ちました。
2. Laravel Breeze: Tailwind CSS の人気の高まりから生まれた Breeze は、最小限で軽量かつ最新の認証スキャフォールディングを提供しました。
3. Laravel Jetstream: より高度な機能が必要なユーザーのために、2FA やチーム管理機能を含む幅広い認証をカバーする Jetstream が導入されました。
4. Laravel Fortify: 任意のフロントエンドで使用できるヘッドレス認証バックエンド。開発者が独自の UI を実装できる柔軟性を提供します。

Laravelのパスワードリセットフローを理解する

Laravel のパスワード リセット プロセスには通常、次の手順が含まれます:

1. ユーザーがパスワードのリセットをリクエスト
2. トークンが生成され、保存されます
3. リセットリンク (署名付き URL) が記載された電子メールがユーザーに送信されます
4. ユーザーがリンクをクリックし、新しいパスワードを入力します
5. パスワードが更新され、トークンが無効になります

このフローはほとんどのアプリケーションで適切に機能しますが、ニーズに合わせてこのプロセスのさまざまな側面をカスタマイズすることもできます。

私たちが構築しているもの

このチュートリアルでは、カスタマイズされたパスワード リセット フローを備えた、裸の Laravel SaaS (最小限) アプリケーションを作成します。以下について説明します:

• Breeze を使用して新しい Laravel アプリケーションをセットアップする
• パスワードリセット URL のカスタマイズ
• パスワードリセットメールの内容を変更する
• パスワードリセット後の成功通知の追加
• 変更に応じた自動テストの実装とカスタマイズ

はじめる

新しい Laravel アプリケーションをセットアップすることから始めましょう:

composer create-project laravel/laravel password-reset-demo
cd password-reset-demo

次に進む前に、バージョン管理のために Git を初期化しましょう:

git init
git add .
git commit -m "Initial commit"

次に、Laravel Breeze をインストールして、基本認証スキャフォールディングを取得しましょう。

composer require laravel/breeze --dev
php artisan breeze:install

プロンプトが表示されたら、ニーズに最も適したスタックを選択します。このチュートリアルでは、Livewire を使用します:

php artisan breeze:install

  Which Breeze stack would you like to install?
❯ livewire

  Would you like dark mode support? (yes/no) [no]
❯ no

  Which testing framework do you prefer? [PHPUnit]
❯ Pest

インストール後、変更をコミットしましょう:

git add .
git commit -m "Add Authentication and Pages"

次に、データベースをセットアップして移行を実行します。

php artisan migrate

フロントエンド アセットをインストールしてコンパイルします:

npm install
npm run dev

この時点で、認証機能を備えた基本的な Laravel アプリケーションが完成しました。テストを実行して、すべてが期待どおりに動作していることを確認してみましょう:

php artisan test

すべてのテストが成功し、カスタマイズを続行するためのゴーサインが示されているはずです。

パスワード リセット URL のカスタマイズ

デフォルトでは、Laravel (Breeze を使用) はパスワードのリセットに標準 URL (/reset-password) を使用します。これを AppServiceProvider でカスタマイズしましょう:

<?php

namespace App\Providers;

use App\Models\User;
use Illuminate\Auth\Notifications\ResetPassword;
use Illuminate\Support\ServiceProvider;

class AppServiceProvider extends ServiceProvider
{
    public function boot(): void
    {
        ResetPassword::createUrlUsing(function (User $user, string $token) {
            return url(route('password.reset', [
                'token' => $token,
                'email' => $user->getEmailForPasswordReset(),
            ], false));
        });
    }
}

このカスタマイズにより、リセット URL 構造を変更したり、パラメーターを追加したり、必要に応じて完全に異なるドメインを指定したりすることもできます。たとえば、次のように変更できます:

return "https://account.yourdomain.com/reset-password?token={$token}&email={$user->getEmailForPasswordReset()}";

パスワードリセットメールの変更

次に、パスワードリセットメールの内容をカスタマイズしてみましょう。これを行うには、AppServiceProvider に次を追加します。

use Illuminate\Notifications\Messages\MailMessage;

// ...

public function boot(): void
{
    // ... previous customizations

    ResetPassword::toMailUsing(function (User $user, string $token) {
        $url = url(route('password.reset', [
            'token' => $token,
            'email' => $user->getEmailForPasswordReset(),
        ], false));

        return (new MailMessage)
            ->subject(config('app.name') . ': ' . __('Reset Password Request'))
            ->greeting(__('Hello!'))
            ->line(__('You are receiving this email because we received a password reset request for your account.'))
            ->action(__('Reset Password'), $url)
            ->line(__('This password reset link will expire in :count minutes.', ['count' => config('auth.passwords.' . config('auth.defaults.passwords') . '.expire')]))
            ->line(__('If you did not request a password reset, no further action is required.'))
            ->salutation(__('Regards,') . "\n" . config('app.name') . " Team");
    });
}

注: __() 関数はローカリゼーションのヘルパーであり、アプリケーション内の文字列を簡単に翻訳できます。

パスワードリセット成功通知の追加

ユーザー エクスペリエンスとセキュリティを強化するために、パスワードのリセットが成功した後に送信される通知を追加しましょう。まず、新しい通知を作成します:

php artisan make:notification PasswordResetSuccessfullyNotification

新しく作成した通知を編集します:

<?php

namespace App\Notifications;

use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Notifications\Messages\MailMessage;
use Illuminate\Notifications\Notification;

class PasswordResetSuccessfullyNotification extends Notification implements ShouldQueue
{
    use Queueable;

    public function via($notifiable)
    {
        return ['mail'];
    }

    public function toMail($notifiable)
    {
        return (new MailMessage)
            ->subject('Password Reset Successful')
            ->greeting('Hello!')
            ->line('Your password has been successfully reset.')
            ->line('If you did not reset your password, please contact support immediately.')
            ->action('Login to Your Account', url('/login'))
            ->line('Thank you for using our application!');
    }
}

次に、PasswordReset イベントのリスナーを作成します。

php artisan make:listener SendPasswordResetSuccessfullyNotification --event=PasswordReset

リスナーを更新します:

<?php

namespace App\Listeners;

use App\Notifications\PasswordResetSuccessfullyNotification;
use Illuminate\Auth\Events\PasswordReset;
use Illuminate\Contracts\Queue\ShouldQueue;

class SendPasswordResetSuccessfullyNotification implements ShouldQueue
{
    public function handle(PasswordReset $event)
    {
        $event->user->notify(new PasswordResetSuccessfullyNotification());
    }
}

このリスナーを EventServiceProvider に忘れずに登録してください。

カスタマイズをテストする

カスタマイズが期待どおりに機能することを確認するには、テストが非常に重要です。 testing/Feature/Auth/PasswordResetTest.php:
で既存のパスワード リセット テストを更新します。

<?php

namespace Tests\Feature\Auth;

use App\Models\User;
use App\Notifications\PasswordResetSuccessfullyNotification;
use Illuminate\Auth\Notifications\ResetPassword;
use Illuminate\Support\Facades\Notification;
use Tests\TestCase;

class PasswordResetTest extends TestCase
{
    public function test_reset_password_link_can_be_requested(): void
    {
        Notification::fake();

        $user = User::factory()->create();

        $this->post('/forgot-password', ['email' => $user->email]);

        Notification::assertSentTo($user, ResetPassword::class, function ($notification) use ($user) {
            $response = $this->get($notification->toMail($user)->actionUrl);
            $this->assertStringContainsString('Reset Password', $response->getContent());
            return true;
        });
    }

    public function test_password_can_be_reset_with_valid_token(): void
    {
        Notification::fake();

        $user = User::factory()->create();

        $this->post('/forgot-password', ['email' => $user->email]);

        Notification::assertSentTo($user, ResetPassword::class, function ($notification) use ($user) {
            $token = $notification->token;

            $response = $this->post('/reset-password', [
                'token' => $token,
                'email' => $user->email,
                'password' => 'new-password',
                'password_confirmation' => 'new-password',
            ]);

            $response->assertSessionHasNoErrors();

            Notification::assertSentTo($user, PasswordResetSuccessfullyNotification::class);

            return true;
        });
    }

    public function test_reset_password_email_contains_custom_content(): void
    {
        Notification::fake();

        $user = User::factory()->create();

        $this->post('/forgot-password', ['email' => $user->email]);

        Notification::assertSentTo($user, ResetPassword::class, function ($notification) use ($user) {
            $mailMessage = $notification->toMail($user);
            $this->assertStringContainsString('Hello!', $mailMessage->greeting);
            $this->assertStringContainsString('Regards,', $mailMessage->salutation);
            return true;
        });
    }
}

Conclusion

Customizing Laravel's password reset workflow allows you to create a more tailored and user-friendly experience for your application. We've covered how to modify the reset URL, customize the email content, add a success notification, and ensure everything works through automated testing.

Remember, while customization can be powerful, it's essential to maintain security best practices throughout the process. Always validate user input, use secure token generation and storage methods, and follow Laravel's security recommendations.

Some additional considerations for further improvements:

1. Implement rate limiting on password reset requests to prevent abuse.
2. Add logging for successful and failed password reset attempts for security auditing.
3. Consider implementing multi-channel notifications (e.g., SMS, push notifications) for critical security events like password resets.
4. Regularly review and update your password policies to align with current security best practices.

For more advanced topics and Laravel insights, check out the official Laravel documentation and stay tuned to the Laravel community resources for more in-depth tutorials and best practices.

Happy coding, and may your Laravel applications be ever secure and user-friendly!

以上がLaravel パスワード リセットのカスタマイズをマスターする: 包括的なガイドの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。