최종 수정일 - 영어 : 1년 전 / 한글 : 8개월 전
영문 같이보기 영어 원문보기

오류 핸들링

시작하기

새로운 라라벨 프로젝트를 시작하면, 오류 및 예외 처리는 기본적으로 설정되어 있습니다. App\Exceptions\Handler 클래스는 애플리케이션에서 발생하는 모든 예외들에 대해 로그를 남기고 사용자에게 그 응답을 렌더링하는 역할을 합니다. 우리는 이 문서 전체를 통해서 이 클래스에 대해서 자세히 살펴볼 것입니다.

설정하기

config/app.php 설정파일의 debug 옵션은 사용자에게 오류 정보를 어느 정도로 표시할지를 결정합니다. 기본적으로 이 옵션은 .env 파일에 담긴 APP_DEBUG 환경변수에 따라서 결정됩니다.

로컬 개발 중에는, APP_DEBUG 환경변수를 true로 설정해야 합니다. 실제 운영환경에서 APP_DEBUG 값은 항상 false로 되어 있어야 합니다. 만약 실제 운영환경에서 이 값을 true로 설정한다면, 애플리케이션의 민감한 설정 값들이 사용자들(end users)에게 노출되어 버립니다.

예외 핸들러

예외의 보고

모든 예외는 App\Exceptions\Handler 클래스가 다룹니다. 이 클래스는 여러분이 사용자 정의 예외 리포터(custom exception reporter)와 렌더러 콜백(renderer callbacks)을 등록할 수 있는 register 메소드를 가지고 있습니다. 이 개념을 자세하게 살펴 봅시다. 예외 보고(Exception Reporting)는, 예외에 대해 로그를 남기거나, Flare, Bugsnag 또는 Sentry와 같은 외부 서비스로 전송할 때 사용합니다. 기본적으로, 예외에 대한 로그는 logging 설정에 따라서 기록 됩니다. 그러나 여러분이 원하는 대로 예외 로그를 남길 수도 있습니다.

예컨데 여러 가지 유형의 예외를 여러 가지 방법에 따라 보고할 필요가 있다면, reportable 메소드를 사용해서 클로저를 등록하여 특정 유형의 예외만 보고될 수 있도록 등록한 클로저를 실행할 수 있습니다. 라라벨은 클로저의 타입힌트(type-hint)를 통해서 클로저가 보고할 예외의 유형을 추론합니다.

use App\Exceptions\InvalidOrderException;

/**
 * Register the exception handling callbacks for the application.
 *
 * @return void
 */
public function register()
{
    $this->reportable(function (InvalidOrderException $e) {
        //
    });
}

여러분이 reportable 메소드를 이용하여 커스텀 예외보고 콜백(custom exception reporting callback) 함수를 등록한 경우에도, 라라벨은 애플리케이션의 기본 로깅 설정에 따라서 예외를 로그에 기록할 것입니다. 만약 여러분이 기본 로깅 스택(default logging stack)으로 더 이상 예외를 전달하지 않도록 하려면 보고 콜백(reporting callback) 함수를 정의할 때 stop 메소드를 사용하거나 콜백 함수에서 false를 반환하면 됩니다.

$this->reportable(function (InvalidOrderException $e) {
    //
})->stop();

$this->reportable(function (InvalidOrderException $e) {
    return false;
});

Note 주어진 예외에 대한 예외 보고(exception reporting)을 커스터마이징하려면, reportable exceptions을 살펴보세요.

글로벌 로그 컨텍스트

라라벨은 자동으로 현재의 사용자 ID를 컨텍스트 데이터(contextual data)로써 모든 예외의 로그 메세지에 자동으로 추가합니다. App\Exceptions\Handler 클래스의 context 메소드를 오버라이딩하여 여러분 자신만의 글로벌 컨텍스트 데이터를 정의할 수 있습니다. 이 정보는 애플리케이션이 기록하는 모든 예외 로그에 포함될 것입니다.

/**
 * Get the default context variables for logging.
 *
 * @return array
 */
protected function context()
{
    return array_merge(parent::context(), [
        'foo' => 'bar',
    ]);
}

예외 로그 컨텍스트

모든 로그 메세지에 컨텍스트를 추가하는 것은 편리하지만, 때때로 특정 예외를 통해서 로그에 포함시키고 싶은 고유의 컨텍스트가 있을 수도 있습니다. 애플리케이션의 커스텀 예외에 context 메소드를 정의하여, 예외 로그 엔트리(the exception's log entry)에 추가하기로한 예외와 관련된(relevant) 어떠한 데이터든 지정할 수 있습니다.

<?php

namespace App\Exceptions;

use Exception;

class InvalidOrderException extends Exception
{
    // ...

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

report 헬퍼 함수

때때로 발생한 예외를 보고할 필요는 있지만 현재의 요청(request)을 중지하지 않고 계속 처리할 필요가 있는 경우도 있습니다. report 헬퍼 함수를 사용하면 오류 페이지를 표시하지 않으면서 예외 핸들러(Exception handler)를 이용해 예외를 보고 할 수 있습니다. 

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

        return false;
    }
}

예외 로그 수준

메시지가 애플리케이션의 로그에 쓰일 때, 메시지는 심각도와 중요도를 나타내는 로그 수준으로 쓰여집니다.

앞서 언급한 바와 같이 당신이 reportable 메서드를 사용하여 커스텀 예외 보고 콜백을 등록했을 때에도 라라벨은 여전히 애플리케이션의 기본 로깅 설정을 사용하여 예외를 기록할 것입니다. 하지만 어떤 메시지가 기록될지에 있어서 로그 수준이 영향을 미치기 때문에 특정 예외가 로그를 남길 때 로그 수준을 설정하고 싶을 수 있습니다.

그렇게 하기 위해서는 애플리케이션의 예외 핸들어에 있는 $levels 프로퍼티에 예외 타입과 그에 해당하는 로그 수준을 배열로 정의하면 됩니다. 

use PDOException;
use Psr\Log\LogLevel;

/**
 * A list of exception types with their corresponding custom log levels.
 *
 * @var array<class-string<\Throwable>, \Psr\Log\LogLevel::*>
 */
protected $levels = [
    PDOException::class => LogLevel::CRITICAL,
];

유형에 따른 예외 무시

애플리케이션을 구축할 때, 여러분이 무시하거나 보고하지 않기를 원하는 몇 가지 유형의 예외가 있을 수도 있습니다. 애플리케이션의 예외 핸들러는 빈 배열로 초기화된 $dontReport 속성을 가지고 있습니다. 이 속성에 추가된 클래스는 오류를 보고하지 않습니다.(never) 하지만 오류를 보고하지 않더라도 커스텀 렌더링 로직을 가질 수 있습니다.

use App\Exceptions\InvalidOrderException;

/**
 * A list of the exception types that are not reported.
 *
 * @var array<int, class-string<\Throwable>>
 */
protected $dontReport = [
    InvalidOrderException::class,
];

Note 내부적으로 라라벨은 편의를 위해 몇몇 타입의 에러를 무시합니다. 404 HTTP "not found" 에러 또는 CSRF 토큰 인증을 통과하지 못한 경우에 발생하는 419 HTTP responses generated 등의 에러 입니다.

예외의 렌더링

기본적으로 라라벨의 예외 핸들러는 예외를 HTTP 응답으로 변환합니다. 그러나 특정한 유형의 예외에 대해 사용자 정의 렌더링 클로저(Closure)를 자유롭게 등록할 수 있습니다. 이는 예외 핸들러의 renderable 메소드를 통해 이뤄집니다.

rednerable 메소드에 전달된 클로저(Closure)는 response 헬퍼 함수를 통해서 생성된 Illuminate\Http\Response의 인스턴스를 반환해야 합니다. 라라벨은 클로저의 타입힌트(type-hint)를 통해서 클로저가 예외 유형을 추론하며 예외 유형에 맞는 렌더링 메시지를 표시합니다.

use App\Exceptions\InvalidOrderException;

/**
 * Register the exception handling callbacks for the application.
 *
 * @return void
 */
public function register()
{
    $this->renderable(function (InvalidOrderException $e, $request) {
        return response()->view('errors.invalid-order', [], 500);
    });
}

라라벨 또는 심포니의 내장 렌더링 기능(rendering behavior)을 renderable 메소드를 사용하여 재정의 할 수 있습니다. 예를 들어 기본 내장 예외 렌더링 기능에는 NotFoundHttpException이란 예외가 있습니다. renderable 메소드에서 인자로 할당되는 클로저에 NotFoundHttpException 예외를 클로저의 파라메터로 지정한다고 가정해 봅시다. 클로저에서 리턴 값이 반환되지 않는다면 NotFoundHttpException 예외일 경우 실행되는 라라벨의 기본 예외 렌더링이 사용됩니다.

use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;

/**
 * Register the exception handling callbacks for the application.
 *
 * @return void
 */
public function register()
{
    $this->renderable(function (NotFoundHttpException $e, $request) {
        if ($request->is('api/*')) {
            return response()->json([
                'message' => 'Record not found.'
            ], 404);
        }
    });
}

보고 가능한(Reportable) & 렌더링 가능한(Renderable) 예외들

예외 핸들러의 register 메소드에서 예외의 유형을 확인(type-checking)하는 대신에, 커스텀 예외에 report 와 render 메소드를 직접 정의할 수 있습니다. 커스텀으로 정의한 report 와 render가 존재한다면 이들 메소드에 정의된 로직은 프레임워크에 의해 자동으로 호출됩니다.

<?php

namespace App\Exceptions;

use Exception;

class InvalidOrderException extends Exception
{
    /**
    * Report the exception.
    *
    * @return bool|null
    */
    public function report()
    {
        //
    }

    /**
     * Render the exception into an HTTP response.
     *
     * @param  \Illuminate\Http\Request  $request
     * @return \Illuminate\Http\Response
     */
    public function render($request)
    {
        return response(/* ... */);
    }
}

라라벨이나 심포니에 내장된 예외는 에러에 대한 HTTP 리스폰스를 반환합니다. 이들 내장된 예외를 상속하여 사용자 정의 예외를 만드는 경우에는 커스텀 예외의 render 메소드에서 false를 반환함으로써 기본 예외에서 사용되는 디폴트 HTTP 리스폰스를 렌더링 할 수 있습니다.

/**
 * Render the exception into an HTTP response.
 *
 * @param  \Illuminate\Http\Request  $request
 * @return \Illuminate\Http\Response
 */
public function render($request)
{
    // Determine if the exception needs custom rendering...

    return false;
}

특정한 조건을 충족할 때에만 예외를 보고하는 커스텀 예외를 report 메소드 내부에 정의를 할 때 이 커스텀 예외를 라라벨의 기본(default) 예외 처리에 포함되도록 설정할 수 있습니다. 라라벨의 기본 예외 처리에 해당 커스텀 예외가 포함되도록 설정하려면 report 메소드에서 커스텀 예외가 발생할 때 false를 반환하도록 설정하면 됩니다.

/**
 * Report the exception.
 *
 * @return bool|void
 */
public function report()
{
    // Determine if the exception needs custom reporting...

    return false;
}

Note report 메소드에 필요한 의존성을 타입힌트하면 라라벨의 서비스 컨테이너가 자동으로 이를 주입해줍니다.

HTTP 예외

일부 예외들은 서버로부터 HTTP 오류 코드를 표시합니다. 이를테면 "page not found" 오류(404)나, "unauthorized error" (401) 또는 개발자가 만들어낸 500 에러입니다. 애플리케이션의 어느 곳에서든 이러한 응답을 생성하고자 한다면, abort 헬퍼 함수를 사용하면 됩니다.

abort(404);

커스텀 HTTP 오류 페이지

라라벨을 사용하면 다양한 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의 기본 오류 페이지 템플릿을 웹에 띄울 (publish) 수 있습니다. 템플릿을 웹 페이지에 띄웠다면(published), 여러분이 원하는 대로 커스터마이징을 해도 됩니다.

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

HTTP 에러 대체 페이지

HTTP 상태코드에 대한 "대체" 오류 페이지를 정의할 수 있습니다. 오류가 발생한 HTTP 상태 코드와 일치하는 페이지가 없는 경우에 이 대체 페이지가 렌더링 됩니다. 이를 적용하려면 애플리케이션의 resources/views/errors 디렉토리에 4xx.blade.php, 5xx.blade.php 템플릿을 정의하면 됩니다.

Validation-유효성검사 로깅

이 문서의 번역에 기여해주신 분들

N0FreeLunch findstar smartbos 기여에 참여하기