美文网首页
3分钟短文 | Laravel 日志全程记录 SQL 查询语句,

3分钟短文 | Laravel 日志全程记录 SQL 查询语句,

作者: 程序员小助手 | 来源:发表于2020-10-16 21:18 被阅读0次

    引言

    Laravel 提供给了比较强大的ORM数据库操作方式,如果在数据库端考虑到性能问题,
    难以打开MySQL的慢日志,或者处于审计考虑,要在系统内全程跟踪所有的SQL操作,
    应该如何实现呢?不会要改写框架底层代码?

    本文就来为大家提供解决的思路。

    学习时间

    因为考虑到是全局记录SQL语句,那么肯定不可能在所有的数据库模型操作上都手动加上日志,
    那样的效率实在是令人胆寒。

    所以方法只能是在独立于系统之外的地方寻求突破口。事件是个不错的想法。

    因为laravel框架提供了事件监听方式,可以在系统启动过程中注册一个事件触发器收集过程数据,记录该流程内的SQL操作,应该就大差不差了。

    比如注册 illuminate.query 事件。理想的情况下,代码应该是类似下面这样的:

    Event::listen('illuminate.query', function($sql)
    {
      Log::error($sql);
    });
    

    开启一个事件监听,如果query发生,则将传入的SQL语句参数写入日志内。

    上面的只能算是伪代码,真正实施起来,要考虑的过程因素有很多。比如首先要查看 database 配置文件内,日志功能是否打开。
    也就是 log 配置项是否设置为 true。

    我们使用全局的 Config 类获取配置信息:

    Config::get('database.log', false)
    

    如果没有开启数据库日志,则手动处理,将上述 illuminate.query 事件的监听器写入系统内。当然传入的参数要多一些,
    $query, $bindings, $time, $name,分别是 SQL 语句,绑定的参数,执行的时间,以及标志名。

    那么监听事件实现起来是这样的:

    Event::listen('illuminate.query', function($query, $bindings, $time, $name){}
    

    好了,既然获取到传入的数据了,就可以实现我们的处理逻辑。为了处理方便,将所有原始数据写入 Log 类方法的第二个传参,
    我们将参数打包到数组:

    $data = compact('bindings', 'time', 'name');
    

    因为单个SQL语句绑定的参数有很多,所以这个 bindings 数组,需要手动处理一下:

    foreach ($bindings as $i => $binding)
    {   
        if ($binding instanceof \DateTime)
        {   
            $bindings[$i] = $binding->format('\'Y-m-d H:i:s\'');
        }
        else if (is_string($binding))
        {   
            $bindings[$i] = "'$binding'";
        }   
    } 
    

    对于传入的日期时间对象,进行格式化;如果是时间戳或者字符串,直接存档。

    我们需要做的工作,就是把位置参数和SQL语句进行还原,生成原始的带参数的SQL语句,
    不得不提 vsprintf 这个函数,大家有必要深入学习一下。

    $query = str_replace(array('%', '?'), array('%%', '%s'), $query);
    $query = vsprintf($query, $bindings); 
    

    注意laravel生成的SQL语句占位符是问号,而vsprintf函数占位符是百分号,所以先进行转换,然后调用。
    最后把准备好的数据一股脑写到Log内:

    Log::info($query, $data);
    

    我们还可以利用框架 ServiceProvider 注册上述监听器。比如创建一个 DebugServiceProvider,写入下面的代码:

    namespace App\Providers;
    
    use Illuminate\Database\Events\QueryExecuted;
    use Illuminate\Support\Facades\Event;
    use Illuminate\Support\Facades\Log;
    use Illuminate\Support\ServiceProvider;
    
    class DebugServiceProvider extends ServiceProvider
    {
        public function register()
        {
            // Event::listen()
        }
    

    在 register 内注册上述事件,不过传参我们使用 QueryExecuted 类:

    Event::listen(QueryExecuted::class, function (QueryExecuted $query) {});
    

    访问 binding, sql 属性访问 QueryExecuted 类的属性即可。

    写在最后

    本文使用事件的方式实现全局的SQL语句监听日志记录,能够帮助大家熟悉数据库操作的深层知识,非常值得一试。

    Happy coding :-)

    我是@程序员小助手,持续分享编程知识,欢迎关注。

    相关文章

      网友评论

          本文标题:3分钟短文 | Laravel 日志全程记录 SQL 查询语句,

          本文链接:https://www.haomeiwen.com/subject/wbytmktx.html