이메일 확인

• 소개
  • 모델 준비
  • 데이터베이스 준비
• 라우팅
  • 이메일 확인 알림
  • 이메일 확인 핸들러
  • 확인 이메일 재전송
  • 라우트 보호
• 사용자 정의
• 이벤트

소개

많은 웹 애플리케이션에서 사용자가 애플리케이션을 사용하기 전에 이메일 주소를 확인하도록 요구합니다. 사용자가 애플리케이션을 만들 때마다 이 기능을 수동으로 다시 구현하도록 강요하는 대신, 라라벨은 이메일 확인 요청을 보내고 확인하는 편리한 내장 서비스를 제공합니다.

모델 준비

시작하기 전에 App\Models\User 모델이 Illuminate\Contracts\Auth\MustVerifyEmail 계약을 구현하는지 확인하세요.

<?php
 
namespace App\Models;
 
use Illuminate\Contracts\Auth\MustVerifyEmail;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;
 
class User extends Authenticatable implements MustVerifyEmail
{
    use Notifiable;
 
    // ...
}

이 인터페이스가 모델에 추가되면 새로 등록된 사용자에게 이메일 확인 링크가 포함된 이메일이 자동으로 전송됩니다. 이는 라라벨이 Illuminate\Auth\Events\Registered 이벤트에 대해 Illuminate\Auth\Listeners\SendEmailVerificationNotification 리스너를 자동으로 등록하기 때문에 원활하게 이루어집니다.

스타터 키트를 사용하지 않고 애플리케이션 내에서 등록을 수동으로 구현하는 경우, 사용자 등록이 성공한 후 Illuminate\Auth\Events\Registered 이벤트를 디스패치해야 합니다.

use Illuminate\Auth\Events\Registered;
 
event(new Registered($user));

데이터베이스 준비

다음으로, users 테이블에는 사용자의 이메일 주소가 확인된 날짜와 시간을 저장하기 위한 email_verified_at 열이 있어야 합니다. 일반적으로 이는 라라벨의 기본 0001_01_01_000000_create_users_table.php 데이터베이스 마이그레이션에 포함됩니다.

라우팅

이메일 확인을 제대로 구현하려면 세 개의 라우트를 정의해야 합니다. 첫째, 라라벨이 등록 후 보낸 확인 이메일에서 이메일 확인 링크를 클릭해야 한다는 알림을 사용자에게 표시하는 라우트가 필요합니다.

둘째, 사용자가 이메일에서 이메일 확인 링크를 클릭할 때 생성된 요청을 처리하는 라우트가 필요합니다.

셋째, 사용자가 실수로 첫 번째 확인 링크를 잃어버린 경우 확인 링크를 재전송하는 라우트가 필요합니다.

이메일 확인 알림

앞서 언급했듯이, 사용자가 등록 후 라라벨에서 이메일로 보낸 이메일 확인 링크를 클릭하도록 지시하는 뷰를 반환하는 라우트를 정의해야 합니다. 이 뷰는 사용자가 이메일 주소를 먼저 확인하지 않고 애플리케이션의 다른 부분에 액세스하려고 할 때 표시됩니다. App\Models\User 모델이 MustVerifyEmail 인터페이스를 구현하는 한 링크가 사용자에게 자동으로 이메일로 전송된다는 점을 기억하세요.

Route::get('/email/verify', function () {
    return view('auth.verify-email');
})->middleware('auth')->name('verification.notice');

이메일 확인 알림을 반환하는 라우트는 verification.notice로 이름 지어야 합니다. 라우트가 이 정확한 이름을 갖는 것이 중요합니다. 라라벨에 포함된 verified 미들웨어가 사용자가 이메일 주소를 확인하지 않은 경우 자동으로 이 라우트 이름으로 리디렉션하기 때문입니다.

이메일 확인 핸들러

다음으로, 사용자에게 이메일로 전송된 이메일 확인 링크를 클릭할 때 생성되는 요청을 처리하는 라우트를 정의해야 합니다. 이 라우트는 verification.verify로 이름 지어야 하며 auth 및 signed 미들웨어가 할당되어야 합니다.

use Illuminate\Foundation\Auth\EmailVerificationRequest;
 
Route::get('/email/verify/{id}/{hash}', function (EmailVerificationRequest $request) {
    $request->fulfill();
 
    return redirect('/home');
})->middleware(['auth', 'signed'])->name('verification.verify');

넘어가기 전에 이 라우트를 좀 더 자세히 살펴보겠습니다. 먼저, 일반적인 Illuminate\Http\Request 인스턴스 대신 EmailVerificationRequest 요청 유형을 사용하고 있음을 알 수 있습니다. EmailVerificationRequest는 라라벨에 포함된 폼 요청입니다. 이 요청은 요청의 id 및 hash 매개변수의 유효성 검사를 자동으로 처리합니다.

다음으로, 요청에서 fulfill 메서드를 직접 호출할 수 있습니다. 이 메서드는 인증된 사용자에 대해 markEmailAsVerified 메서드를 호출하고 Illuminate\Auth\Events\Verified 이벤트를 디스패치합니다. markEmailAsVerified 메서드는 Illuminate\Foundation\Auth\User 기본 클래스를 통해 기본 App\Models\User 모델에서 사용할 수 있습니다. 사용자의 이메일 주소가 확인되면 원하는 곳으로 리디렉션할 수 있습니다.

확인 이메일 재전송

사용자가 이메일 주소 확인 이메일을 잘못 배치하거나 실수로 삭제하는 경우가 있습니다. 이를 수용하기 위해 사용자가 확인 이메일 재전송을 요청할 수 있도록 라우트를 정의할 수 있습니다. 그런 다음 확인 알림 뷰 내에 간단한 양식 제출 버튼을 배치하여 이 라우트로 요청을 할 수 있습니다.

use Illuminate\Http\Request;
 
Route::post('/email/verification-notification', function (Request $request) {
    $request->user()->sendEmailVerificationNotification();
 
    return back()->with('message', 'Verification link sent!');
})->middleware(['auth', 'throttle:6,1'])->name('verification.send');

라우트 보호

라우트 미들웨어는 확인된 사용자만 지정된 라우트에 액세스하도록 허용하는 데 사용할 수 있습니다. 라라벨에는 Illuminate\Auth\Middleware\EnsureEmailIsVerified 미들웨어 클래스의 별칭인 verified 미들웨어 별칭이 포함되어 있습니다. 이 별칭은 라라벨에서 자동으로 등록되어 있으므로 verified 미들웨어를 라우트 정의에 연결하기만 하면 됩니다. 일반적으로 이 미들웨어는 auth 미들웨어와 쌍을 이룹니다.

Route::get('/profile', function () {
    // 확인된 사용자만 이 라우트에 액세스할 수 있습니다...
})->middleware(['auth', 'verified']);

확인되지 않은 사용자가 이 미들웨어가 할당된 라우트에 액세스하려고 하면 자동으로 verification.notice 이름이 지정된 라우트로 리디렉션됩니다.

사용자 정의

확인 이메일 사용자 정의

기본 이메일 확인 알림은 대부분의 애플리케이션 요구 사항을 충족해야 하지만 라라벨을 사용하면 이메일 확인 메일 메시지가 구성되는 방식을 사용자 정의할 수 있습니다.

시작하려면 Illuminate\Auth\Notifications\VerifyEmail 알림에서 제공하는 toMailUsing 메서드에 클로저를 전달합니다. 클로저는 알림을 받는 수신 가능한 모델 인스턴스와 사용자가 이메일 주소를 확인하기 위해 방문해야 하는 서명된 이메일 확인 URL을 받습니다. 클로저는 Illuminate\Notifications\Messages\MailMessage 인스턴스를 반환해야 합니다. 일반적으로 애플리케이션의 AppServiceProvider 클래스의 boot 메서드에서 toMailUsing 메서드를 호출해야 합니다.

use Illuminate\Auth\Notifications\VerifyEmail;
use Illuminate\Notifications\Messages\MailMessage;
 
/**
 * 모든 애플리케이션 서비스 부트스트랩.
 */
public function boot(): void
{
    // ...
 
    VerifyEmail::toMailUsing(function (object $notifiable, string $url) {
        return (new MailMessage)
            ->subject('이메일 주소 확인')
            ->line('아래 버튼을 클릭하여 이메일 주소를 확인하세요.')
            ->action('이메일 주소 확인', $url);
    });
}

이벤트

라라벨 애플리케이션 스타터 키트를 사용하는 경우, 라라벨은 이메일 확인 프로세스 중에 Illuminate\Auth\Events\Verified 이벤트를 디스패치합니다. 애플리케이션에 대한 이메일 확인을 수동으로 처리하는 경우 확인이 완료된 후 이러한 이벤트를 수동으로 디스패치할 수 있습니다.