Symfony與GraphQL的錯誤處理與日志記錄

Symfony和GraphQL都是強大的框架，它們可以幫助您構建高效、可靠的應用程序。在這兩個框架中，錯誤處理和日志記錄是非常重要的部分，它們可以幫助您識別和解決問題。

Symfony錯誤處理

Symfony提供了一個強大的錯誤處理機制，可以幫助您捕獲和處理應用程序中的錯誤。以下是Symfony中常見的錯誤處理方法：

1. 異常處理：Symfony使用異常處理器來捕獲和處理異常。您可以通過在app/Exceptions/Handler/ExceptionSubscriber.php文件中定義一個訂閱者來自定義異常處理。

namespace App\Exceptions\Handler;

use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
use Symfony\Component\HttpKernel\Exception\MethodNotAllowedHttpException;
use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
use Symfony\Component\HttpFoundation\JsonResponse;

class ExceptionSubscriber implements \Symfony\Component\EventDispatcher\EventSubscriberInterface
{
    public function onKernelException(ExceptionEvent $event)
    {
        $exception = $event->getException();

        if ($exception instanceof NotFoundHttpException) {
            return new JsonResponse(['error' => 'Not Found'], Response::HTTP_NOT_FOUND);
        }

        if ($exception instanceof MethodNotAllowedHttpException) {
            return new JsonResponse(['error' => 'Method Not Allowed'], Response::HTTP_METHOD_NOT_ALLOWED);
        }

        if ($exception instanceof HttpExceptionInterface) {
            return new JsonResponse(['error' => $exception->getMessage()], Response::HTTP_BAD_REQUEST);
        }
    }

    public static function getSubscribedEvents()
    {
        return [
            \Symfony\Component\HttpKernel\Event\ExceptionEvent::class => 'onKernelException',
        ];
    }
}

2. 錯誤頁面：Symfony允許您為不同的HTTP狀態代碼定義自定義錯誤頁面。您可以在templates目錄下創建一個名為bundles/TwigBundle/Exception的文件夾，并在其中放置自定義錯誤頁面。

3. 日志記錄：Symfony使用Monolog作為默認的日志記錄器。您可以在config/packages/monolog.yaml文件中配置日志記錄器。

monolog:
    handlers:
        main:
            type: stream
            path: "%kernel.project_dir%/var/logs/symfony.log"
            level: info
        error:
            type: stream
            path: "%kernel.project_dir%/var/logs/symfony_error.log"
            level: error

GraphQL錯誤處理

GraphQL提供了一種靈活的錯誤處理機制，可以幫助您捕獲和處理查詢和變更中的錯誤。以下是GraphQL中常見的錯誤處理方法：

1. 錯誤格式：GraphQL使用特定的錯誤格式來表示錯誤。您可以在解析器中使用throw new \GraphQL\Error\Error('message', $code, $locations);來拋出錯誤。

use GraphQL\Error\Error;

function resolveField($object, $args, $context)
{
    if (!$object->hasField('field')) {
        throw new Error('Field not found', 400, ['locations' => $context['path']]);
    }

    return $object->getField('field');
}

2. 錯誤類型：您可以使用不同的錯誤類型來表示不同類型的錯誤。例如，您可以使用UserInputError來表示用戶輸入錯誤。

use GraphQL\Error\UserInputError;

function resolveField($object, $args, $context)
{
    if (!$object->hasField('field')) {
        throw new UserInputError('Field not found', ['locations' => $context['path']]);
    }

    return $object->getField('field');
}

3. 日志記錄：您可以使用Monolog或其他日志記錄庫來記錄GraphQL錯誤。例如，您可以在解析器中使用\Monolog\Logger::error('Error message', ['context' => $context]);來記錄錯誤。

use \Monolog\Logger;

function resolveField($object, $args, $context)
{
    if (!$object->hasField('field')) {
        \Monolog\Logger::error('Field not found', ['context' => $context]);
        throw new Error('Field not found', 400, ['locations' => $context['path']]);
    }

    return $object->getField('field');
}

總之，Symfony和GraphQL都提供了強大的錯誤處理和日志記錄功能，可以幫助您構建可靠、高效的應用程序。通過合理地配置和使用這些功能，您可以更好地識別和解決問題，提高應用程序的穩定性。