Laravel给生产环境添加监听事件代码分享

laravel版本：5.2.*

一、创建监听器

php artisan make:listener QueryListener --event=Illuminate\Database\Events\QueryExecuted

or

sudo /usr/local/bin/php artisan make:listener QueryListener --event=Illuminate\Database\Events\QueryExecuted

会自动生成文件 app/Listeners/QueryListener.php

二、注册事件

打开 app/Providers/EventServiceProvider.php，在 $listen 中添加 IlluminateDatabaseEventsQueryExecuted 事件的监听器为 QueryListener

protected $listen = [ 
 'IlluminateDatabaseEventsQueryExecuted' => [
  'AppListenersQueryListener',
 ],
];

最终代码如下

namespace AppProviders;
use IlluminateContractsEventsDispatcher as DispatcherContract;
use IlluminateFoundationSupportProvidersEventServiceProvider as ServiceProvider;
class EventServiceProvider extends ServiceProvider
{
 /**
  * The event listener mappings for the application.
  *
  * @var array
  */
 protected $listen = [
  'AppEventsSomeEvent' => [
   'AppListenersEventListener',
  ],
  'IlluminateDatabaseEventsQueryExecuted' => [
   'AppListenersQueryListener',
  ],
 ];
 /**
  * Register any other events for your application.
  *
  * @param IlluminateContractsEventsDispatcher $events
  * @return void
  */
 public function boot(DispatcherContract $events)
 {
  parent::boot($events);
  //
 }
}

三、添加逻辑

打开 app/Listeners/QueryListener.php

光有一个空的监听器是不够的，我们需要自己实现如何把 $sql 记录到日志中。为此，对 QueryListener 进行改造，完善其 handle 方法如下:

$sql = str_replace("?", "'%s'", $event->sql);
$log = vsprintf($sql, $event->bindings);
Log::info($log);

最终代码如下

namespace AppListeners;
use Log;
use IlluminateDatabaseEventsQueryExecuted;
use IlluminateQueueInteractsWithQueue;
use IlluminateContractsQueueShouldQueue;
class QueryListener
{
 /**
  * Create the event listener.
  *
  * @return void
  */
 public function __construct()
 {
  //
 }
 /**
  * Handle the event.
  *
  * @param QueryExecuted $event
  * @return void
  */
 public function handle(QueryExecuted $event)
 {
  $sql = str_replace("?", "'%s'", $event->sql);
  $log = vsprintf($sql, $event->bindings);
  Log::info($log);
 }
}