phantoanit / laravel-debugbar
Laravel的PHP调试栏集成
Requires
- php: >=7.2.5
- illuminate/routing: ^7|^8|^9
- illuminate/session: ^7|^8|^9
- illuminate/support: ^7|^8|^9
- maximebf/debugbar: ^1.17.2
- symfony/finder: ^5|^6
Requires (Dev)
- mockery/mockery: ^1.3.3
- orchestra/testbench-dusk: ^5|^6|^7
- phpunit/phpunit: ^8.5|^9.0
- squizlabs/php_codesniffer: ^3.5
This package is auto-updated.
Last update: 2024-09-25 11:49:18 UTC
README
这是一个将PHP Debug Bar与Laravel集成的包。它包括一个 ServiceProvider 以注册调试栏并将其附加到输出。您可以通过Laravel发布资产和配置它。它启动了一些收集器以与Laravel一起工作,并实现了一些针对Laravel的自定义数据收集器。它已配置为显示重定向和(jQuery)Ajax请求。(显示在下拉菜单中)阅读文档以获取更多配置选项。
注意:仅在开发中使用DebugBar。它可能会减慢应用程序的速度(因为它需要收集数据)。因此,当遇到速度减慢的情况时,请尝试禁用一些收集器。
此包包含一些自定义收集器
- QueryCollector:显示所有查询,包括绑定+计时
- RouteCollector:显示关于当前路由的信息。
- ViewCollector:显示当前加载的视图。(可选:显示共享数据)
- EventsCollector:显示所有事件
- LaravelCollector:显示Laravel版本和环境。(默认禁用)
- SymfonyRequestCollector:用包含更多请求/响应信息的RequestCollector替换
- LogsCollector:显示存储日志的最新日志条目。(默认禁用)
- FilesCollector:显示PHP包含/所需的文件。(默认禁用)
- ConfigCollector:显示配置文件中的值。(默认禁用)
- CacheCollector:显示所有缓存事件。(默认禁用)
为Laravel启动以下收集器
- LogCollector:显示所有日志消息
- SwiftMailCollector和SwiftLogCollector for Mail
以及默认收集器
- PhpInfoCollector
- MessagesCollector
- TimeDataCollector(启动和应用程序计时)
- MemoryCollector
- ExceptionsCollector
它还提供了一个门面接口(Debugbar
),用于轻松记录消息、异常和时间
安装
使用composer安装此包。建议仅在开发时安装此包。
composer require barryvdh/laravel-debugbar --dev
Laravel使用包自动发现,因此不需要手动添加ServiceProvider。
当APP_DEBUG
为true
时,将启用Debugbar。
如果您使用通配符/回退路由,请确保在您的App ServiceProviders之前加载Debugbar ServiceProvider。
Laravel没有自动发现
如果您不使用自动发现,请将ServiceProvider添加到config/app.php中的providers数组中。
Barryvdh\Debugbar\ServiceProvider::class,
如果您想使用门面来记录消息,请将此添加到app.php中的门面
'Debugbar' => Barryvdh\Debugbar\Facades\Debugbar::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"
Laravel与Octane
请确保将LaravelDebugbar添加到config/octane.php中的flush列表中。
'flush' => [ \Barryvdh\Debugbar\LaravelDebugbar::class, ],
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); // `$collection->debug()` will return the collection and dump it as a debug message. Like `$collection->dump()` collect([$var1, $someString])->debug(); start_measure('render','Time for rendering'); stop_measure('render'); add_measure('now', LARAVEL_START, microtime(true)); measure('My long operation', function() { // Do something… });
如果您想的话,可以通过容器或外观添加自己的DataCollectors
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 %}