오류 처리 (Error Handling)

• 소개
• 설정
• 예외 처리
  • 예외 보고
  • 예외 로그 수준
  • 타입별 예외 무시
  • 예외 렌더링
  • 보고 가능한 예외와 렌더링 가능한 예외
• 보고된 예외 제한하기
• HTTP 예외
  • 사용자 정의 HTTP 오류 페이지

소개 (Introduction)

새 Laravel 프로젝트를 시작하면 오류와 예외 처리는 이미 설정되어 있습니다. 하지만 언제든지 애플리케이션의 bootstrap/app.php에서 withExceptions 메서드를 사용하여 애플리케이션이 예외를 어떻게 보고하고 렌더링할지 관리할 수 있습니다.

withExceptions 클로저에 제공되는 $exceptions 객체는 Illuminate\Foundation\Configuration\Exceptions의 인스턴스이며, 애플리케이션의 예외 처리를 관리하는 역할을 합니다. 이 문서 전반에서 이 객체를 더 자세히 살펴보겠습니다.

설정 (Configuration)

config/app.php 설정 파일의 debug 옵션은 오류에 대한 정보가 사용자에게 실제로 얼마나 표시되는지를 결정합니다. 기본적으로 이 옵션은 .env 파일에 저장된 APP_DEBUG 환경 변수의 값을 따르도록 설정되어 있습니다.

로컬 개발 중에는 APP_DEBUG 환경 변수를 true로 설정해야 합니다.

프로덕션 환경에서는 APP_DEBUG 값이 항상 false여야 합니다. 프로덕션에서 이 값이 true로 설정되어 있으면, 민감한 설정 값이 애플리케이션의 최종 사용자에게 노출될 위험이 있습니다.

예외 처리 (Handling Exceptions)

예외 보고

Laravel에서 예외 보고는 예외를 로그에 기록하거나 Sentry, Flare 같은 외부 서비스로 보내는 데 사용됩니다. 기본적으로 예외는 로깅 설정에 따라 기록됩니다. 하지만 원하는 방식으로 자유롭게 예외를 로그에 기록할 수 있습니다.

서로 다른 타입의 예외를 서로 다른 방식으로 보고해야 하는 경우, 애플리케이션의 bootstrap/app.php에서 report 예외 메서드를 사용하여 특정 타입의 예외를 보고해야 할 때 실행될 클로저를 등록할 수 있습니다. Laravel은 클로저의 타입 힌트를 검사하여 해당 클로저가 어떤 타입의 예외를 보고하는지 판단합니다.

use App\Exceptions\InvalidOrderException;

->withExceptions(function (Exceptions $exceptions): void {
    $exceptions->report(function (InvalidOrderException $e) {
        // ...
    });
})

report 메서드를 사용하여 사용자 정의 예외 보고 콜백을 등록하더라도, Laravel은 여전히 애플리케이션의 기본 로깅 설정을 사용하여 예외를 기록합니다. 예외가 기본 로깅 스택으로 전달되는 것을 중단하고 싶다면, 보고 콜백을 정의할 때 stop 메서드를 사용하거나 콜백에서 false를 반환할 수 있습니다.

use App\Exceptions\InvalidOrderException;

->withExceptions(function (Exceptions $exceptions): void {
    $exceptions->report(function (InvalidOrderException $e) {
        // ...
    })->stop();

    $exceptions->report(function (InvalidOrderException $e) {
        return false;
    });
})

특정 예외의 예외 보고 방식을 사용자 정의하려면 보고 가능한 예외를 사용할 수도 있습니다.

전역 로그 컨텍스트

사용 가능한 경우, Laravel은 모든 예외 로그 메시지에 현재 사용자의 ID를 컨텍스트 데이터로 자동 추가합니다. 애플리케이션의 bootstrap/app.php 파일에서 context 예외 메서드를 사용하여 직접 전역 컨텍스트 데이터를 정의할 수도 있습니다. 이 정보는 애플리케이션이 기록하는 모든 예외 로그 메시지에 포함됩니다.

->withExceptions(function (Exceptions $exceptions): void {
    $exceptions->context(fn () => [
        'foo' => 'bar',
    ]);
})

예외 로그 컨텍스트

모든 로그 메시지에 컨텍스트를 추가하는 것은 유용할 수 있지만, 때로는 특정 예외에 로그에 포함하고 싶은 고유한 컨텍스트가 있을 수 있습니다. 애플리케이션의 예외 중 하나에 context 메서드를 정의하면, 해당 예외와 관련되어 예외 로그 항목에 추가되어야 하는 데이터를 지정할 수 있습니다.

<?php

namespace App\Exceptions;

use Exception;

class InvalidOrderException extends Exception
{
    // ...

    /**
     * Get the exception's context information.
     *
     * @return array<string, mixed>
     */
    public function context(): array
    {
        return ['order_id' => $this->orderId];
    }
}

report 헬퍼

때로는 예외를 보고하되 현재 요청 처리는 계속해야 할 수 있습니다. report 헬퍼 함수는 사용자에게 오류 페이지를 렌더링하지 않고도 예외를 빠르게 보고할 수 있게 해줍니다.

public function isValid(string $value): bool
{
    try {
        // Validate the value...
    } catch (Throwable $e) {
        report($e);

        return false;
    }
}

보고된 예외 중복 제거

애플리케이션 전반에서 report 함수를 사용하고 있다면, 같은 예외를 여러 번 보고하여 로그에 중복 항목이 생성될 수 있습니다.

하나의 예외 인스턴스가 반드시 한 번만 보고되도록 보장하고 싶다면, 애플리케이션의 bootstrap/app.php 파일에서 dontReportDuplicates 예외 메서드를 호출할 수 있습니다.

->withExceptions(function (Exceptions $exceptions): void {
    $exceptions->dontReportDuplicates();
})

이제 같은 예외 인스턴스로 report 헬퍼를 호출하면, 첫 번째 호출만 보고됩니다.

$original = new RuntimeException('Whoops!');

report($original); // reported

try {
    throw $original;
} catch (Throwable $caught) {
    report($caught); // ignored
}

report($original); // ignored
report($caught); // ignored

예외 로그 수준

애플리케이션의 로그에 메시지가 기록될 때, 메시지는 지정된 로그 수준으로 기록됩니다. 로그 수준은 기록되는 메시지의 심각도 또는 중요도를 나타냅니다.

앞서 언급했듯이, report 메서드를 사용하여 사용자 정의 예외 보고 콜백을 등록하더라도 Laravel은 여전히 애플리케이션의 기본 로깅 설정을 사용하여 예외를 기록합니다. 하지만 로그 수준은 때때로 메시지가 기록되는 채널에 영향을 줄 수 있으므로, 특정 예외가 어떤 로그 수준으로 기록될지 설정하고 싶을 수 있습니다.

이를 위해 애플리케이션의 bootstrap/app.php 파일에서 level 예외 메서드를 사용할 수 있습니다. 이 메서드는 첫 번째 인수로 예외 타입을 받고, 두 번째 인수로 로그 수준을 받습니다.

use PDOException;
use Psr\Log\LogLevel;

->withExceptions(function (Exceptions $exceptions): void {
    $exceptions->level(PDOException::class, LogLevel::CRITICAL);
})

타입별 예외 무시

애플리케이션을 만들다 보면 절대 보고하고 싶지 않은 예외 타입이 있을 수 있습니다. 이러한 예외를 무시하려면 애플리케이션의 bootstrap/app.php 파일에서 dontReport 예외 메서드를 사용할 수 있습니다. 이 메서드에 전달된 클래스는 절대 보고되지 않습니다. 다만 사용자 정의 렌더링 로직은 여전히 가질 수 있습니다.

use App\Exceptions\InvalidOrderException;

->withExceptions(function (Exceptions $exceptions): void {
    $exceptions->dontReport([
        InvalidOrderException::class,
    ]);
})

또는 예외 클래스에 Illuminate\Contracts\Debug\ShouldntReport 인터페이스를 간단히 "표시"할 수도 있습니다. 예외에 이 인터페이스가 표시되어 있으면, Laravel의 예외 핸들러는 해당 예외를 절대 보고하지 않습니다.

<?php

namespace App\Exceptions;

use Exception;
use Illuminate\Contracts\Debug\ShouldntReport;

class PodcastProcessingException extends Exception implements ShouldntReport
{
    //
}

특정 타입의 예외를 언제 무시할지 더 세밀하게 제어해야 한다면, dontReportWhen 메서드에 클로저를 전달할 수 있습니다.

use App\Exceptions\InvalidOrderException;
use Throwable;

->withExceptions(function (Exceptions $exceptions): void {
    $exceptions->dontReportWhen(function (Throwable $e) {
        return $e instanceof PodcastProcessingException &&
               $e->reason() === 'Subscription expired';
    });
})

Laravel 내부에서는 404 HTTP 오류로 인해 발생한 예외나 유효하지 않은 CSRF 토큰으로 생성된 419 HTTP 응답처럼 일부 오류 타입을 이미 자동으로 무시합니다. Laravel이 특정 타입의 예외를 더 이상 무시하지 않도록 지시하고 싶다면, 애플리케이션의 bootstrap/app.php 파일에서 stopIgnoring 예외 메서드를 사용할 수 있습니다.

use Symfony\Component\HttpKernel\Exception\HttpException;

->withExceptions(function (Exceptions $exceptions): void {
    $exceptions->stopIgnoring(HttpException::class);
})

예외 렌더링

기본적으로 Laravel 예외 핸들러는 예외를 HTTP 응답으로 변환해 줍니다. 하지만 특정 타입의 예외에 대해 사용자 정의 렌더링 클로저를 자유롭게 등록할 수 있습니다. 이를 위해 애플리케이션의 bootstrap/app.php 파일에서 render 예외 메서드를 사용할 수 있습니다.

render 메서드에 전달되는 클로저는 Illuminate\Http\Response 인스턴스를 반환해야 하며, 이 인스턴스는 response 헬퍼를 통해 생성할 수 있습니다. Laravel은 클로저의 타입 힌트를 검사하여 해당 클로저가 어떤 타입의 예외를 렌더링하는지 판단합니다.

use App\Exceptions\InvalidOrderException;
use Illuminate\Http\Request;

->withExceptions(function (Exceptions $exceptions): void {
    $exceptions->render(function (InvalidOrderException $e, Request $request) {
        return response()->view('errors.invalid-order', status: 500);
    });
})

또한 render 메서드를 사용하여 NotFoundHttpException 같은 Laravel 또는 Symfony 내장 예외의 렌더링 동작을 재정의할 수도 있습니다. render 메서드에 전달된 클로저가 값을 반환하지 않으면, Laravel의 기본 예외 렌더링이 사용됩니다.

use Illuminate\Http\Request;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;

->withExceptions(function (Exceptions $exceptions): void {
    $exceptions->render(function (NotFoundHttpException $e, Request $request) {
        if ($request->is('api/*')) {
            return response()->json([
                'message' => 'Record not found.'
            ], 404);
        }
    });
})

예외를 JSON으로 렌더링

예외를 렌더링할 때, Laravel은 요청의 Accept 헤더를 기준으로 예외를 HTML 응답으로 렌더링할지 JSON 응답으로 렌더링할지 자동으로 판단합니다. Laravel이 HTML 또는 JSON 예외 응답을 렌더링할지 판단하는 방식을 사용자 정의하고 싶다면, shouldRenderJsonWhen 메서드를 사용할 수 있습니다.

use Illuminate\Http\Request;
use Throwable;

->withExceptions(function (Exceptions $exceptions): void {
    $exceptions->shouldRenderJsonWhen(function (Request $request, Throwable $e) {
        if ($request->is('admin/*')) {
            return true;
        }

        return $request->expectsJson();
    });
})

예외 응답 사용자 정의

드물게 Laravel의 예외 핸들러가 렌더링하는 전체 HTTP 응답을 사용자 정의해야 할 수 있습니다. 이를 위해 respond 메서드를 사용하여 응답 사용자 정의 클로저를 등록할 수 있습니다.

use Symfony\Component\HttpFoundation\Response;

->withExceptions(function (Exceptions $exceptions): void {
    $exceptions->respond(function (Response $response) {
        if ($response->getStatusCode() === 419) {
            return back()->with([
                'message' => 'The page expired, please try again.',
            ]);
        }

        return $response;
    });
})

보고 가능한 예외와 렌더링 가능한 예외

애플리케이션의 bootstrap/app.php 파일에서 사용자 정의 보고 및 렌더링 동작을 정의하는 대신, 애플리케이션의 예외에 직접 report와 render 메서드를 정의할 수 있습니다. 이러한 메서드가 존재하면 프레임워크가 자동으로 호출합니다.

<?php

namespace App\Exceptions;

use Exception;
use Illuminate\Http\Request;
use Illuminate\Http\Response;

class InvalidOrderException extends Exception
{
    /**
     * Report the exception.
     */
    public function report(): void
    {
        // ...
    }

    /**
     * Render the exception as an HTTP response.
     */
    public function render(Request $request): Response
    {
        return response(/* ... */);
    }
}

예외가 Laravel 또는 Symfony의 내장 예외처럼 이미 렌더링 가능한 예외를 확장한다면, 예외의 render 메서드에서 false를 반환하여 해당 예외의 기본 HTTP 응답을 렌더링할 수 있습니다.

/**
 * Render the exception as an HTTP response.
 */
public function render(Request $request): Response|bool
{
    if (/** Determine if the exception needs custom rendering */) {

        return response(/* ... */);
    }

    return false;
}

예외에 특정 조건이 충족될 때만 필요한 사용자 정의 보고 로직이 포함되어 있다면, Laravel이 때때로 기본 예외 처리 설정을 사용하여 해당 예외를 보고하도록 지시해야 할 수 있습니다. 이를 위해 예외의 report 메서드에서 false를 반환할 수 있습니다.

/**
 * Report the exception.
 */
public function report(): bool
{
    if (/** Determine if the exception needs custom reporting */) {

        // ...

        return true;
    }

    return false;
}

report 메서드에 필요한 의존성을 타입 힌트로 지정할 수 있으며, Laravel의 서비스 컨테이너가 해당 의존성을 메서드에 자동으로 주입합니다.

보고된 예외 제한하기

애플리케이션이 매우 많은 수의 예외를 보고한다면, 실제로 로그에 기록되거나 애플리케이션의 외부 오류 추적 서비스로 전송되는 예외 수를 제한하고 싶을 수 있습니다.

예외를 무작위 샘플링 비율로 가져오려면 애플리케이션의 bootstrap/app.php 파일에서 throttle 예외 메서드를 사용할 수 있습니다. throttle 메서드는 Lottery 인스턴스를 반환해야 하는 클로저를 받습니다.

use Illuminate\Support\Lottery;
use Throwable;

->withExceptions(function (Exceptions $exceptions): void {
    $exceptions->throttle(function (Throwable $e) {
        return Lottery::odds(1, 1000);
    });
})

예외 타입을 기준으로 조건부 샘플링을 수행할 수도 있습니다. 특정 예외 클래스의 인스턴스만 샘플링하고 싶다면, 해당 클래스에 대해서만 Lottery 인스턴스를 반환할 수 있습니다.

use App\Exceptions\ApiMonitoringException;
use Illuminate\Support\Lottery;
use Throwable;

->withExceptions(function (Exceptions $exceptions): void {
    $exceptions->throttle(function (Throwable $e) {
        if ($e instanceof ApiMonitoringException) {
            return Lottery::odds(1, 1000);
        }
    });
})

로그에 기록되거나 외부 오류 추적 서비스로 전송되는 예외에 대해 Lottery 대신 Limit 인스턴스를 반환하여 레이트 리밋을 적용할 수도 있습니다. 예를 들어 애플리케이션이 사용하는 서드파티 서비스가 중단되어 예외가 갑자기 대량으로 발생하고 로그가 넘쳐나는 상황을 막고 싶을 때 유용합니다.

use Illuminate\Broadcasting\BroadcastException;
use Illuminate\Cache\RateLimiting\Limit;
use Throwable;

->withExceptions(function (Exceptions $exceptions): void {
    $exceptions->throttle(function (Throwable $e) {
        if ($e instanceof BroadcastException) {
            return Limit::perMinute(300);
        }
    });
})

기본적으로 제한은 예외의 클래스를 레이트 리밋 키로 사용합니다. Limit의 by 메서드를 사용하여 직접 키를 지정하면 이를 사용자 정의할 수 있습니다.

use Illuminate\Broadcasting\BroadcastException;
use Illuminate\Cache\RateLimiting\Limit;
use Throwable;

->withExceptions(function (Exceptions $exceptions): void {
    $exceptions->throttle(function (Throwable $e) {
        if ($e instanceof BroadcastException) {
            return Limit::perMinute(300)->by($e->getMessage());
        }
    });
})

물론 예외 종류에 따라 Lottery와 Limit 인스턴스를 함께 반환할 수도 있습니다.

use App\Exceptions\ApiMonitoringException;
use Illuminate\Broadcasting\BroadcastException;
use Illuminate\Cache\RateLimiting\Limit;
use Illuminate\Support\Lottery;
use Throwable;

->withExceptions(function (Exceptions $exceptions): void {
    $exceptions->throttle(function (Throwable $e) {
        return match (true) {
            $e instanceof BroadcastException => Limit::perMinute(300),
            $e instanceof ApiMonitoringException => Lottery::odds(1, 1000),
            default => Limit::none(),
        };
    });
})

HTTP 예외 (HTTP Exceptions)

일부 예외는 서버의 HTTP 오류 코드를 나타냅니다. 예를 들어 "페이지를 찾을 수 없음" 오류(404), "인증되지 않음 오류"(401), 또는 개발자가 직접 발생시킨 500 오류일 수 있습니다. 애플리케이션 어디에서든 이러한 응답을 생성하려면 abort 헬퍼를 사용할 수 있습니다.

abort(404);

사용자 정의 HTTP 오류 페이지

Laravel은 다양한 HTTP 상태 코드에 대한 사용자 정의 오류 페이지를 쉽게 표시할 수 있게 해줍니다. 예를 들어 404 HTTP 상태 코드에 대한 오류 페이지를 사용자 정의하려면 resources/views/errors/404.blade.php 뷰 템플릿을 생성합니다. 이 뷰는 애플리케이션에서 생성되는 모든 404 오류에 대해 렌더링됩니다. 이 디렉터리 안의 뷰는 대응하는 HTTP 상태 코드와 일치하도록 이름을 지정해야 합니다. abort 함수가 발생시킨 Symfony\Component\HttpKernel\Exception\HttpException 인스턴스는 $exception 변수로 뷰에 전달됩니다.

<h2>{{ $exception->getMessage() }}</h2>

vendor:publish Artisan 명령어를 사용하여 Laravel의 기본 오류 페이지 템플릿을 게시할 수 있습니다. 템플릿이 게시되면 원하는 대로 사용자 정의할 수 있습니다.

php artisan vendor:publish --tag=laravel-errors

대체 HTTP 오류 페이지

특정 HTTP 상태 코드 범위에 대한 "대체" 오류 페이지도 정의할 수 있습니다. 발생한 특정 HTTP 상태 코드에 대응하는 페이지가 없을 경우 이 페이지가 렌더링됩니다. 이를 위해 애플리케이션의 resources/views/errors 디렉터리에 4xx.blade.php 템플릿과 5xx.blade.php 템플릿을 정의합니다.

대체 오류 페이지를 정의하더라도 Laravel은 404, 500, 503 상태 코드에 대해 내부적으로 전용 페이지를 가지고 있으므로, 대체 페이지는 이 오류 응답들에는 영향을 주지 않습니다. 이 상태 코드들에 대해 렌더링되는 페이지를 사용자 정의하려면 각각에 대한 사용자 정의 오류 페이지를 별도로 정의해야 합니다.