hexincorp/debugbar

Laravel 的 PHP Debugbar 集成


README

Packagist License Latest Stable Version Total Downloads

对于 Laravel 4,请使用 1.8 分支

这是一个用于将 PHP Debug Bar 与 Laravel 5 集成的包。它包含一个 ServiceProvider 用于注册调试栏并将其附加到输出。您可以通过 Laravel 发布资源和进行配置。它启动了一些收集器以与 Laravel 一起工作,并实现了一些特定于 Laravel 的自定义数据收集器。它配置为显示重定向和(jQuery)Ajax 请求。更多信息请参阅 文档

Screenshot

注意:仅在生产环境中使用 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

更新 composer 后,将 ServiceProvider 添加到 config/app.php 中的 providers 数组

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

Laravel 5.x

Barryvdh\Debugbar\ServiceProvider::class,

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

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

默认情况下启用分析器,如果 app.debug=true。您可以在配置中覆盖它(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');

使用方法

您现在可以使用 Facade(如果已添加)使用 PSR-3 级别(debug、info、notice、warning、error、critical、alert、emergency)添加消息

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…
});

如果您想,可以通过容器或 Facade 添加您自己的数据收集器

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。

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

注意。一旦启用,收集器将被添加(可能会产生额外的开销),所以如果您想在生产中使用 debugbar,请在配置中禁用,并在需要时才启用。

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 扩展将替换 dump 函数,使用 DataFormatter 输出变量。Debug 扩展添加了一个 debug() 函数,它将变量传递给消息收集器,而不是直接在模板中显示。它输出参数,或当为空时;所有上下文变量。

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

Stopwatch 扩展添加了一个类似于 Symfony/Silex Twigbridge 中的 stopwatch 标签

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