README

Laravel Debugbar

关于 v3 版本的说明：现在通过要求安装包来启用 Debugbar，但默认仍需要 APP_DEBUG=true！

对于 Laravel < 5.5，请使用 2.4 分支！

这是一个将 PHP Debug Bar 与 Laravel 5 集成的软件包。它包括一个 ServiceProvider，用于注册 debugbar 并将其附加到输出。您可以通过 Laravel 发布资产并进行配置。它启动了一些 Collectors 以与 Laravel 一起工作，并实现了几个针对 Laravel 的自定义 DataCollectors。它已配置为显示重定向和 (jQuery) Ajax 请求。（在下拉菜单中显示）阅读 文档 了解更多配置选项。

注意：仅在生产环境中使用 DebugBar。它可能会减慢应用程序的速度（因为它需要收集数据）。因此，当遇到性能问题时，请尝试禁用一些收集器。

此软件包包含一些自定义收集器

• QueryCollector：显示所有查询，包括绑定 + 计时
• RouteCollector：显示当前路由的信息。
• ViewCollector：显示当前加载的视图。（可选：显示共享数据）
• EventsCollector：显示所有事件
• LaravelCollector：显示 Laravel 版本和环境。（默认情况下禁用）
• SymfonyRequestCollector：用更多关于请求/响应的信息替换 RequestCollector
• LogsCollector：显示存储日志的最新条目。（默认情况下禁用）
• FilesCollector：显示 PHP 包括/所需的文件。（默认情况下禁用）
• ConfigCollector：显示配置文件中的值。（默认情况下禁用）
• CacheCollector：显示所有缓存事件。（默认情况下禁用）

为 Laravel 启动以下收集器

• LogCollector：显示所有日志消息
• SwiftMailCollector 和 SwiftLogCollector 用于邮件

和默认收集器

• PhpInfoCollector
• MessagesCollector
• TimeDataCollector（启动和应用计时）
• MemoryCollector
• ExceptionsCollector

它还提供了一个用于轻松记录消息、异常和时间的 Facade 接口

安装

使用 composer 安装此包。建议只在开发环境中要求安装此包。

composer require barryvdh/laravel-debugbar --dev

Laravel 5.5 使用包自动发现，因此不需要手动添加 ServiceProvider。

当 APP_DEBUG 为 true 时，将启用 Debugbar。

如果您使用通配符/回退路由，请确保在您的 App ServiceProvider 之前加载 Debugbar ServiceProvider。

Laravel 5.5+

如果您不使用自动发现，请将 ServiceProvider 添加到 config/app.php 中的 providers 数组中

Barryvdh\Debugbar\ServiceProvider::class,

如果您想使用 facade 来记录消息，请将以下内容添加到 app.php 中的 facades

'Debugbar' => Barryvdh\Debugbar\Facade::class,

默认情况下，如果APP_DEBUG=true，则启用性能分析器。您可以在配置中（debugbar.enabled）或通过在.env中设置DEBUGBAR_ENABLED来覆盖它。在config/debugbar.php中查看更多选项。您还可以在配置中设置是否包含/排除供应商文件（如FontAwesome、Highlight.js和jQuery）。如果您已经在网站中使用它们，请设置为false。您还可以仅显示js或css供应商，通过将其设置为'js'或'css'。由于Highlight.js需要css + js，因此将语法高亮设置为true。

使用发布命令将包配置复制到您的本地配置中

php artisan vendor:publish --provider="Barryvdh\Debugbar\ServiceProvider"

Lumen

对于Lumen，在bootstrap/app.php中注册不同的Provider

if (env('APP_DEBUG')) {
 $app->register(Barryvdh\Debugbar\LumenServiceProvider::class);
}

要更改配置，请将文件复制到您的配置文件夹中并启用它

$app->configure('debugbar');

用法

现在您可以使用外观（当添加时），使用PSR-3级别（调试、信息、通知、警告、错误、严重、警报、紧急）添加消息

Debugbar::info($object);
Debugbar::error('Error!');
Debugbar::warning('Watch out…');
Debugbar::addMessage('Another message', 'mylabel');

并开始/停止计时

Debugbar::startMeasure('render','Time for rendering');
Debugbar::stopMeasure('render');
Debugbar::addMeasure('now', LARAVEL_START, microtime(true));
Debugbar::measure('My long operation', function() {
    // Do something…
});

或记录异常

try {
    throw new Exception('foobar');
} catch (Exception $e) {
    Debugbar::addThrowable($e);
}

还有可用于最常见调用的辅助函数

// All arguments will be dumped as a debug message
debug($var1, $someString, $intValue, $object);

start_measure('render','Time for rendering');
stop_measure('render');
add_measure('now', LARAVEL_START, microtime(true));
measure('My long operation', function() {
    // Do something…
});

如果您想的话，可以通过容器或外观添加自己的数据收集器

Debugbar::addCollector(new DebugBar\DataCollector\MessagesCollector('my_messages'));
//Or via the App container:
$debugbar = App::make('debugbar');
$debugbar->addCollector(new DebugBar\DataCollector\MessagesCollector('my_messages'));

默认情况下，Debugbar注入在</body>之前。如果您想自己注入Debugbar，请将配置选项'inject'设置为false，并使用自己渲染器，并遵循http://phpdebugbar.com/docs/rendering.html

$renderer = Debugbar::getJavascriptRenderer();

注意：不使用自动注入将禁用请求信息，因为它是添加在响应之后。您可以在配置中将默认_request数据收集器作为替代添加。

运行时启用/禁用

您可以在运行时启用或禁用调试条

\Debugbar::enable();
\Debugbar::disable();

注意。一旦启用，收集器就会被添加（可能会产生额外的开销），因此如果您想在生产中使用调试条，请禁用配置并在需要时启用。

Twig集成

Laravel Debugbar附带两个Twig扩展。这些与rcrowe/TwigBridge 0.6.x进行了测试

将以下扩展添加到您的TwigBridge配置/extensions.php（或手动注册扩展）

'Barryvdh\Debugbar\Twig\Extension\Debug',
'Barryvdh\Debugbar\Twig\Extension\Dump',
'Barryvdh\Debugbar\Twig\Extension\Stopwatch',

输出扩展将替换dump函数，使用数据格式化器输出变量。调试扩展添加一个debug()函数，将变量传递给消息收集器，而不是直接在模板中显示它。它输出参数，或当为空时；所有上下文变量。

{{ debug() }}
{{ debug(user, categories) }}

计时器扩展添加一个类似于stopwatch标签的标签，类似于Symfony/Silex Twigbridge中的标签。

{% stopwatch "foo" %}
    …some things that gets timed
{% endstopwatch %}