오류 처리

소개
구성
예외 처리
보고된 예외 스로틀링
HTTP 예외
- 사용자 정의 HTTP 오류 페이지

소개

새로운 Laravel 프로젝트를 시작할 때, 오류 및 예외 처리는 이미 구성되어 있습니다. 하지만 언제든지 애플리케이션의 bootstrap/app.php에서 withExceptions 메서드를 사용하여 애플리케이션에서 예외가 보고되고 렌더링되는 방식을 관리할 수 있습니다.

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

구성

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

로컬 개발 중에는 APP_DEBUG 환경 변수를 true로 설정해야 합니다. 프로덕션 환경에서는 이 값을 항상 false로 설정해야 합니다. 프로덕션에서 값이 true로 설정되면 애플리케이션의 최종 사용자에게 민감한 구성 값이 노출될 위험이 있습니다.

예외 처리

예외 보고

Laravel에서 예외 보고는 예외를 기록하거나 외부 서비스(예: Sentry 또는 Flare)로 보내는 데 사용됩니다. 기본적으로 예외는 로깅 구성에 따라 기록됩니다. 그러나 원하는 대로 예외를 자유롭게 기록할 수 있습니다.

다양한 유형의 예외를 다양한 방식으로 보고해야 하는 경우, 애플리케이션의 bootstrap/app.php에서 report 예외 메서드를 사용하여 특정 유형의 예외를 보고해야 할 때 실행될 클로저를 등록할 수 있습니다. Laravel은 클로저의 유형 힌트를 검사하여 클로저가 보고하는 예외의 유형을 결정합니다.

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

report 메서드를 사용하여 사용자 정의 예외 보고 콜백을 등록하면 Laravel은 애플리케이션의 기본 로깅 구성을 사용하여 예외를 계속 기록합니다. 예외가 기본 로깅 스택으로 전파되는 것을 중지하려면 보고 콜백을 정의할 때 stop 메서드를 사용하거나 콜백에서 false를 반환하면 됩니다.

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

주어진 예외에 대한 예외 보고를 사용자 정의하려면 보고 가능한 예외를 사용할 수도 있습니다.

전역 로그 컨텍스트

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

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

예외 로그 컨텍스트

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

<?php
 
namespace App\Exceptions;
 
use Exception;
 
class InvalidOrderException extends Exception
{
    // ...
 
    /**
     * 예외의 컨텍스트 정보를 가져옵니다.
     *
     * @return array<string, mixed>
     */
    public function context(): array
    {
        return ['order_id' => $this->orderId];
    }
}

`report` 도우미

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

public function isValid(string $value): bool
{
    try {
        // 값 유효성 검사...
    } catch (Throwable $e) {
        report($e);
 
        return false;
    }
}

보고된 예외 중복 제거

애플리케이션 전체에서 report 함수를 사용하는 경우 동일한 예외를 여러 번 보고하여 로그에 중복된 항목을 생성할 수 있습니다.

예외의 단일 인스턴스가 한 번만 보고되도록 하려면 애플리케이션의 bootstrap/app.php 파일에서 dontReportDuplicates 예외 메서드를 호출하면 됩니다.

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

이제 report 도우미가 동일한 예외 인스턴스와 함께 호출되면 첫 번째 호출만 보고됩니다.

$original = new RuntimeException('이런!');
 
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) {
    $exceptions->level(PDOException::class, LogLevel::CRITICAL);
})

유형별 예외 무시

애플리케이션을 빌드할 때 보고하지 않으려는 일부 유형의 예외가 있을 수 있습니다. 이러한 예외를 무시하려면 애플리케이션의 bootstrap/app.php 파일에서 dontReport 예외 메서드를 사용할 수 있습니다. 이 메서드에 제공된 모든 클래스는 보고되지 않지만 사용자 정의 렌더링 로직이 여전히 있을 수 있습니다.

use App\Exceptions\InvalidOrderException;
 
->withExceptions(function (Exceptions $exceptions) {
    $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
{
    //
}

내부적으로 Laravel은 404 HTTP 오류 또는 유효하지 않은 CSRF 토큰으로 생성된 419 HTTP 응답으로 인한 예외와 같이 일부 유형의 오류를 이미 무시합니다. Laravel이 특정 유형의 예외를 무시하지 않도록 지시하려면 애플리케이션의 bootstrap/app.php 파일에서 stopIgnoring 예외 메서드를 사용할 수 있습니다.

use Symfony\Component\HttpKernel\Exception\HttpException;
 
->withExceptions(function (Exceptions $exceptions) {
    $exceptions->stopIgnoring(HttpException::class);
})

예외 렌더링

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

render 메서드에 전달된 클로저는 response 헬퍼를 통해 생성할 수 있는 Illuminate\Http\Response의 인스턴스를 반환해야 합니다. Laravel은 클로저의 타입 힌트를 검사하여 클로저가 렌더링하는 예외 유형을 결정합니다.

use App\Exceptions\InvalidOrderException;
use Illuminate\Http\Request;
 
->withExceptions(function (Exceptions $exceptions) {
    $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) {
    $exceptions->render(function (NotFoundHttpException $e, Request $request) {
        if ($request->is('api/*')) {
            return response()->json([
                'message' => '레코드를 찾을 수 없습니다.'
            ], 404);
        }
    });
})

예외를 JSON으로 렌더링

예외를 렌더링할 때 Laravel은 요청의 Accept 헤더를 기반으로 예외를 HTML 또는 JSON 응답으로 렌더링해야 하는지 자동으로 결정합니다. Laravel이 HTML 또는 JSON 예외 응답을 렌더링할지 여부를 결정하는 방법을 사용자 정의하려면 shouldRenderJsonWhen 메서드를 사용할 수 있습니다.

use Illuminate\Http\Request;
use Throwable;
 
->withExceptions(function (Exceptions $exceptions) {
    $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) {
    $exceptions->respond(function (Response $response) {
        if ($response->getStatusCode() === 419) {
            return back()->with([
                'message' => '페이지가 만료되었습니다. 다시 시도해 주세요.',
            ]);
        }
 
        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
{
    /**
     * 예외를 보고합니다.
     */
    public function report(): void
    {
        // ...
    }
 
    /**
     * 예외를 HTTP 응답으로 렌더링합니다.
     */
    public function render(Request $request): Response
    {
        return response(/* ... */);
    }
}

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

/**
 * 예외를 HTTP 응답으로 렌더링합니다.
 */
public function render(Request $request): Response|bool
{
    if (/** 예외에 사용자 정의 렌더링이 필요한지 확인 */) {
 
        return response(/* ... */);
    }
 
    return false;
}

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

/**
 * 예외를 보고합니다.
 */
public function report(): bool
{
    if (/** 예외에 사용자 정의 보고가 필요한지 확인 */) {
 
        // ...
 
        return true;
    }
 
    return false;
}

report 메서드의 모든 필요한 종속성을 타입 힌트할 수 있으며, Laravel의 서비스 컨테이너를 통해 해당 메서드에 자동으로 주입됩니다.

보고된 예외 스로틀링

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

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

use Illuminate\Support\Lottery;
use Throwable;
 
->withExceptions(function (Exceptions $exceptions) {
    $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) {
    $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) {
    $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) {
    $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) {
    $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 오류 코드를 설명합니다. 예를 들어, "페이지를 찾을 수 없음" 오류 (404), "권한 없음" 오류 (401) 또는 개발자가 생성한 500 오류가 될 수 있습니다. 애플리케이션의 어느 곳에서든 이러한 응답을 생성하려면 abort 헬퍼를 사용할 수 있습니다.

abort(404);

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 템플릿을 정의하면 됩니다.

폴백 오류 페이지를 정의할 때, 폴백 페이지는 404, 500, 및 503 오류 응답에 영향을 주지 않습니다. Laravel은 이러한 상태 코드에 대한 내부 전용 페이지를 가지고 있기 때문입니다. 이러한 상태 코드에 대해 렌더링되는 페이지를 사용자 정의하려면 각 상태 코드에 대한 사용자 정의 오류 페이지를 개별적으로 정의해야 합니다.