README

简介

Heimdal 是一个专门为 API 构建而设计的 Laravel 异常处理器。

为什么需要它？

在构建 API 时，如何将错误发送给用户有一定的规范和注意事项。像 Laravel 这样的框架并不是专门为 API 构建者设计的。这个小库正好填补了这个空白。例如，像 JSON API 这样的规范有关于错误格式的指南。

安装

composer require optimus/heimdal ~1.0

将服务提供者添加到 config/app.php

// other providers...
Optimus\Heimdal\Provider\LaravelServiceProvider::class,

发布配置。

php artisan vendor:publish --provider="Optimus\Heimdal\Provider\LaravelServiceProvider"

将异常处理器添加到 bootstrap/app.php

$app->singleton(
    Illuminate\Contracts\Debug\ExceptionHandler::class,
    Optimus\Heimdal\ExceptionHandler::class
);

它做什么？

想象一下，你有一段代码抛出了 InvalidArgumentException。这是一个服务器错误（500）。它将通过以下描述的流程进行解析。

1. Exception is thrown
2. The Exception is parsed through reports. A reporter is a class that reports the Exception. Log it in logs, send to external trackers like Sentry, Bugsnag etc.
3. The Exception is parsed through an appropriate formatter that formats the response in accordance to the error type.
4. The response is sent to the user.

这不是 Laravel 做的吗？

是的，基本上是这样的。然而，如果你想向类似 Sentry 这样的系统报告，通常你会通过类似 Monolog 这样的方式来做。Monolog 的问题是很难获取报告者的响应。例如，Sentry 为每个报告的异常返回一个唯一的 ID，这对于用户来说非常有用，因为他们可以将它提供给客户支持。Heimdal 通过将所有报告者的响应传递给格式化类来支持这一点，这使得格式化类可以使用报告者的响应来生成最终的响应。

其次，Heimdal 提供了关于如何向用户报告不同错误类型的合理默认值，并使得为特定异常类型实现替代响应变得非常简单。

配置

Heimdal 有两件事情需要配置：格式化器和报告者。

报告者

你应该确定你的异常应该报告到哪里。Heimdal 仍然调用 Laravel 中的基本报告函数，所以你的异常仍然会按正常方式记录。但是，添加外部报告很容易。Heimdal 默认集成了 Sentry。要将异常发送到 Sentry，只需在 config/optimus.heimdal.php 中的 reporters 部分添加以下条目：

'sentry' => [
    'class'  => \Optimus\Heimdal\Reporters\SentryReporter::class,
    'config' => [
        'dsn' => '',
        // For extra options see https://docs.sentry.io/clients/php/config/
        // php version and environment are automatically added.
        'sentry_options' => []
    ]
]

添加自定义报告者，例如 Bugsnag，就像编写一个小的报告者类一样简单

<?php

namespace My\Namespace\Exceptions\Reporters;

use Optimus\Heimdal\Reporters\ReporterInterface;

class BugsnagReporter implements ReporterInterface
{
    public function __construct(array $config)
    {
        // initialize with config
    }

    public function report(Exception $e)
    {
        // report to bugsnag
    }
}

然后将其添加到 config/optimus.heimdal.php

'bugsnag' => [
    'class'  => \My\Namespace\Exceptions\Reporters\BugsnagReporter::class,
    'config' => [
        // config.
    ]
]

格式化器

Heimdal 默认已提供合理的格式化器。在 config/optimus.heimdal.php 中有一个定义格式化器优先级的部分。

'formatters' => [
    SymfonyException\UnprocessableEntityHttpException::class => Formatters\UnprocessableEntityHttpExceptionFormatter::class,
    SymfonyException\HttpException::class => Formatters\HttpExceptionFormatter::class,
    Exception::class => Formatters\ExceptionFormatter::class,
],

条目越高，优先级越高。在这个例子中，一个 UnprocessableEntityHttpException 将使用 UnprocessableEntityHttpExceptionFormatter 进行格式化，因为它是最先的条目。然而，一个 NotFoundHttpException 不会匹配 UnprocessableEntityHttpException，但它会匹配 HttpException（因为它是一个子类），因此将使用 HttpExceptionFormatter 进行格式化。

你可以轻松编写自定义格式化器

<?php

namespace My\Namespace\Exceptions\Formatters;

use Exception;
use Illuminate\Http\JsonResponse;
use Optimus\Heimdal\Formatters\BaseFormatter;

class NotFoundHttpExceptionFormatter extends BaseFormatter
{
    public function format(JsonResponse $response, Exception $e, array $reporterResponses)
    {
        $response->setStatusCode(404);
        $data = $response->getData(true);

        if ($this->debug) {
            $data = array_merge($data, [
                'code'   => $e->getCode(),
                'message'   => $e->getMessage(),
                'exception' => (string) $e,
                'line'   => $e->getLine(),
                'file'   => $e->getFile()
            ]);
        } else {
            $data['message'] = [
                'message' => 'The resource was not found.',
                'log_id' => $reporterResponses['sentry']['sentry_id']
            ]
        }

        $response->setData($data);
    }
}

注意我们如何轻松地使用 $reporterResponses 将 Sentry 日志的 ID 添加到 JSON 响应中。现在我们只需将其添加到 config/optimus.heimdal.php

'formatters' => [
    SymfonyException\UnprocessableEntityHttpException::class => Formatters\UnprocessableEntityHttpExceptionFormatter::class,
    SymfonyException\NotFoundHttpException::class => My\Namespace\Exceptions\Formatters\NotFoundHttpExceptionFormatter::class,
    SymfonyException\HttpException::class => Formatters\HttpExceptionFormatter::class,
    Exception::class => Formatters\ExceptionFormatter::class,
],

现在所有 NotFoundHttpException 都将使用我们的自定义格式化器进行格式化。

可用的报告者

Sentry

要将异常发送到 Sentry，请将以下报告者配置添加到 config/optimus.heimdal.php。

'reporters' => [
    'sentry' => [
        'class'  => \Optimus\Heimdal\Reporters\SentryReporter::class,
        'config' => [
            'dsn' => '',
            // For extra options see https://docs.sentry.io/clients/php/config/
            // php version and environment are automatically added.
            'sentry_options' => []
        ]
    ]
]

在运行时添加上下文

有时您希望在运行时添加信息，例如请求数据、用户信息等。为此，您可以向 config 数组中添加 add_context 键。以下是一个实现示例。

'reporters' => [
    'sentry' => [
        'class'  => \Optimus\Heimdal\Reporters\SentryReporter::class,
        'config' => [
            'dsn' => env('SENTRY_DSN'),
            // For extra options see https://docs.sentry.io/clients/php/config/
            // php version and environment are automatically added.
            'add_context' => function (Exception $e) {
                $context = [
                    'environment' => app()->environment(),
                    'release' => \Infrastructure\Version::getGitTag()
                ];

                $user = \Auth::User();
                if ($user) {
                    $context['user'] = [
                        'id' => $user->id,
                        'email' => $user->email,
                    ];
                } else {
                    $context['user'] = [];
                }

                // When running in console request is not available
                if (substr(php_sapi_name(), 0, 3) !== 'cli') {
                    $request = app('request');

                    if (!isset($context['extra'])) {
                        $context['extra'] = [];
                    }

                    $context['extra']['request_data'] = json_encode($request->all());
                    $context['user']['ip_address'] = \Request::getClientIp();
                }

                return $context;
            }
        ]
    ]
]

Bugsnag

感谢Nikolaj Løvenhardt Petersen添加支持

使用Laravel安装指南安装Bugsnag

要将异常发送到Bugsnag，请在 config/optimus.heimdal.php 中添加以下报告器配置。

'reporters' => [
    'bugsnag' => [
        'class'  => \Optimus\Heimdal\Reporters\BugsnagReporter::class,
        'config' => []
    ]
]

Rollbar

要将异常发送到Rollbar，请在 config/optimus.heimdal.php 中添加以下报告器配置。

'reporters' => [
'rollbar' => [
        'class'  => \Optimus\Heimdal\Reporters\RollbarReporter::class,
        'config' => [
            'access_token' => '',
            'environment' => 'production'
        ]
    ]
]

完整的配置选项列表可在此处找到

标准

此包符合PSR-1、PSR-2和PSR-4。如果您发现不符合标准的地方，请通过pull request发送补丁。

测试

$ phpunit

贡献

有关详细信息，请参阅CONTRIBUTING。

许可

MIT许可（MIT）。有关更多信息，请参阅许可文件。

cumulati / optimus-heimdal

维护者

详细信息