Laravel ShowSQL 安装与使用指南

Laravel ShowSQL 安装与使用指南

laravel-showsqlA Laravel package to output a specific sql to your favourite debugging tool. The supported log output is Laravel Telescope, Laravel Log, Ray, Clockwork, Laravel Debugbar and your browser.项目地址:https://gitcode.com/gh_mirrors/la/laravel-showsql

---

1. 项目目录结构及介绍

Laravel ShowSQL 是一个专为 Laravel 框架设计的包，用于将特定的 SQL 查询输出到开发者偏爱的调试工具中，如 Laravel Telescope、Laravel Log、Ray、Clockwork 或浏览器的日志里。以下是一般性的描述其核心结构，实际结构可能会随着版本更新有所变化：

• src: 这个目录包含了主要的包逻辑代码。

  • Facade: 包含了对 Facade 的定义，允许在应用中方便地使用 ShowSql 方法。
  • ServiceProvider: 实现了服务提供者，负责注册绑定到 Laravel 服务容器。
  • ShowSql.php: 主要的查询增强类，添加了 showSql() 方法到查询构建器或 Eloquent。

• config: 包含配置文件，默认配置了日志输出的目标。

• routes: 开发过程中可能用到的测试路由（在实际发布中通常不包括）。

• tests: 测试脚本，确保包的功能正确无误。

• README.md: 包含了安装说明、使用案例以及其他重要信息。

2. 项目的启动文件介绍

Laravel ShowSQL 不直接有一个“启动文件”供外部直接调用。该包通过 Composer 自动加载，并且一旦正确安装并配置，在你的 Laravel 应用程序中就可以通过引入 Facade 或门面来立即使用。关键的“启动”动作是通过 Laravel 的自动服务提供者机制完成的，即在服务容器中注册必要的组件。

当你执行 composer require dietercoopman/laravel-showsql --dev 后，Laravel 自动加载系统会处理一切，无需手动引入任何启动文件。若要启用和配置它，只需遵循 README 文件中的指示进行即可。

3. 项目的配置文件介绍

Laravel ShowSQL 提供了一个可发布的配置文件，你可以通过运行以下命令将其导入你的应用中：

php artisan vendor:publish --tag=showsql-config

这将在你的 config 目录下创建或更新一个名为 laravel-showsql.php 的文件。此配置文件提供了对输出目标的选择性控制：

return [
    'to' => [
        'telescope' => false,
        'ray' => true,
        'clockwork' => true,
        'debugbar' => true,
        'log' => false,
        'browser' => false,
    ],
];

默认配置启用的是 Ray、Clockwork 和 Laravel Debugbar 输出。你可以根据需求修改这些值，比如关闭某些输出或仅保留一种。此外，如果你希望自定义日志行为，可以通过向 showSql() 方法传递回调函数实现。

记住，这些配置更改需在应用重启后生效，以确保新的设置被加载。

至此，我们已经涵盖了Laravel ShowSQL的基本结构、启动概念以及配置文件的介绍，为你快速上手该扩展包提供了基础指导。

laravel-showsqlA Laravel package to output a specific sql to your favourite debugging tool. The supported log output is Laravel Telescope, Laravel Log, Ray, Clockwork, Laravel Debugbar and your browser.项目地址:https://gitcode.com/gh_mirrors/la/laravel-showsql