如何使用自定义ERROR 500模板和EventListener报告Symfony2上的生产错误?

时间:2016-05-19 07:51:44

标签: php templates exception-handling symfony

我想在自定义错误500模板上报告我的错误消息。所以,我按照上的official symfony tutorial覆盖了默认错误模板

app/
└─ Resources/
   └─ TwigBundle/
      └─ views/
         └─ Exception/
            ├─ error404.html.twig
            ├─ error403.html.twig
            ├─ error.html.twig      # All other HTML errors (including 500)
            ├─ error404.json.twig
            ├─ error403.json.twig
            └─ error.json.twig      # All other JSON errors (including 500)

我的error500.html.twig页面模板如下所示:

            <div class=" details">
              <h3>Oops! Something went wrong.</h3>
              <p> We are fixing it! Please come back in a while.
                  <br/> TEST</p>
                  <div class="alert alert-danger display-hide" {{message ? 'style="display: block;"'}}>
                      <button class="close" data-close="alert"></button>
                      <span>{{message ? message | trans}}</span>
                  </div>
                <p>
                    <a href="{{path('homepage')}}" class="btn red btn-outline"> OK, take me to the homepage </a>
                    <br> </p>
            </div>

现在,我想通过使用侦听 onKernelException 的ExceptionListener来编写特定的message参数,如Symfony cookbook所述:

use Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;

class ExceptionListener
{
  public function onKernelException(GetResponseForExceptionEvent $event)
  {
    // You get the exception object from the received event
    $exception = $event->getException();
    $message = sprintf(
        'My Error says: %s with code: %s',
        $exception->getMessage(),
        $exception->getCode()
    );

    // Customize your response object to display the exception details
    $response = new Response();
    $response->setContent($message);

    // HttpExceptionInterface is a special type of exception that
    // holds status code and header details
    if ($exception instanceof HttpExceptionInterface) {
        $response->setStatusCode($exception->getStatusCode());
        $response->headers->replace($exception->getHeaders());
    } else {
        $response->setStatusCode(Response::HTTP_INTERNAL_SERVER_ERROR);
    }

    // Send the modified response object to the event
    $event->setResponse($response);
  }
}

我认为我只是错过了设置Symfony\Component\HttpFoundation\Response正确模板的正确方法。实际上我已经能够拦截内核异常事件,但是我返回了一个没有任何模板的经典HTML错误页面。

我正在使用 PHP 7 Symfony 2.8.4

修改

我找到了通过STATUS CODE拦截异常类型的正确方法:

public function onKernelException(GetResponseForExceptionEvent $event)
 {
    $exception = $event->getException();
    $statusCode = $exception->getStatusCode();
    $message = sprintf(
        'ERROR: %s with code: %s',
        $exception->getMessage(),
        $exception->getCode()
    );

    switch ($statusCode) {
      case 404:
          $errorTemplate = 'TwigBundle:Exception:error404.html.twig';
          break;
      case 403:
          $errorTemplate = 'TwigBundle:Exception:error403.html.twig';
          break;
      default:
          $errorTemplate = 'TwigBundle:Exception:error500.html.twig';
          break;
    }
    $response = $this->templating->renderResponse(
        $errorTemplate,
        ['message' => $message]
        );

    // HttpExceptionInterface is a special type of exception that
    // holds status code and header details
    if ($exception instanceof HttpExceptionInterface) {
        $response->setStatusCode($exception->getStatusCode());
        $response->headers->replace($exception->getHeaders());
    } else {
        $response->setStatusCode(Response::HTTP_INTERNAL_SERVER_ERROR);
    }

    $event->setResponse($response);
}

1 个答案:

答案 0 :(得分:3)

您需要手动呈现例外模板。

为此,请将模板服务传递给您的事件监听器:

services:
    app.exception_listener:
        class: AppBundle\EventListener\ExceptionListener
        arguments: [ '@templating' ] # Here
        tags:
            - { name: kernel.event_listener, event: kernel.exception }

然后,在ExceptionListener类中添加以下内容:

use Symfony\Bundle\FrameworkBundle\Templating\EngineInterface;
// ...

class ExceptionListener
{
    /** @var EngineInterface */
    private $templating;

    /**
     * @param EngineInterface $templating
     */
    public function __construct(EngineInterface $templating) 
    {
        $this->templating = $templating;
    }

    // ...
}

然后,用它来渲染你的视图:

public function onKernelException(GetResponseForExceptionEvent $event)
{
    // ...

    $response = $this->templating->renderResponse(
        'TwigBundle:Exception:error_500.html.twig',
        ['message' => $message]
    );

    $event->setResponse($response);
}

注意
应正确使用自定义(覆盖)模板,否则使用'TwigBundle/Exception/error_500.html.twig'作为$this->templating->renderResponse()的第一个参数,而不是'TwigBundle:Exception:error_500.html.twig'

根据当前环境切换使用的模板

从TwigBundle(您希望在dev中使用)复制原始模板,并将其内容复制到新的app/Resources/TwigBundle/Exception/error_500_dev.html.twig

error_500_prod.html.twig中重命名自定义模板。

将环境作为参数注入您的服务:

app.exception_listener:
    # ...
    arguments: [ '@templating', '%kernel.environment%' ]

在构造函数中将它设置为ExceptionListener :: $ env,就像完成模板一样。

然后,使用它来渲染好的模板:

$response = $this->renderResponse(
    sprintf('TwigBundle:Exception:error_500_%s', $this->env),
    // ...
);