事件

模型事件实现 psr/event-dispatcher 接口,默认由 hyperf/event 组件提供功能支持。

运行事件

在 ORM 的运行期间,会对应触发以下事件,您可以进行对这些事件进行监听以满足您的需求。

事件 描述
Hyperf\Database\Events\QueryExecuted Query 语句执行后
Hyperf\Database\Events\StatementPrepared SQL 语句 prepared 后
Hyperf\Database\Events\TransactionBeginning 事务开启后
Hyperf\Database\Events\TransactionCommitted 事务提交后
Hyperf\Database\Events\TransactionRolledBack 事务回滚后

SQL 执行监听器

根据上述的 ORM 运行事件,接下来我们来实现一个记录 SQL 的监听器,达到在每次执行 SQL 时记录下来并输出到日志上。 首先我们定义好 DbQueryExecutedListener ,实现 Hyperf\Event\Contract\ListenerInterface 接口并对类定义 Hyperf\Event\Annotation\Listener 注解,这样 Hyperf 就会在应用启动时自动把该监听器注册到事件调度器中,并在事件触发时执行监听逻辑,示例代码如下:

  1. <?php
  2. declare(strict_types=1);
  3. namespace App\Listener;
  4. use Hyperf\Database\Events\QueryExecuted;
  5. use Hyperf\Event\Annotation\Listener;
  6. use Hyperf\Event\Contract\ListenerInterface;
  7. use Hyperf\Logger\LoggerFactory;
  8. use Hyperf\Utils\Arr;
  9. use Hyperf\Utils\Str;
  10. use Psr\Container\ContainerInterface;
  11. use Psr\Log\LoggerInterface;
  12. #[Listener]
  13. class DbQueryExecutedListener implements ListenerInterface
  14. {
  15. private LoggerInterface $logger;
  16. public function __construct(ContainerInterface $container)
  17. {
  18. // 输出到对应名为 sql 的日志 name,如不存在则需自行添加配置
  19. // 这里的 sql 日志 name 不是必须的,只是表达可以将 SQL 执行日志与普通日志区分开
  20. $this->logger = $container->get(LoggerFactory::class)->get('sql');
  21. }
  22. public function listen(): array
  23. {
  24. return [
  25. QueryExecuted::class,
  26. ];
  27. }
  28. /**
  29. * @param QueryExecuted $event
  30. */
  31. public function process(object $event)
  32. {
  33. if ($event instanceof QueryExecuted) {
  34. $sql = $event->sql;
  35. if (! Arr::isAssoc($event->bindings)) {
  36. foreach ($event->bindings as $key => $value) {
  37. $sql = Str::replaceFirst('?', "'{$value}'", $sql);
  38. }
  39. }
  40. $this->logger->info(sprintf('[%s] %s', $event->time, $sql));
  41. }
  42. }
  43. }

模型事件

模型事件与 Eloquent ORM 不太一致,Eloquent ORM 使用 Observer 监听模型事件。Hyperf 提供 钩子函数事件监听 两种形式来处理对应的事件。

钩子函数

事件名 触发实际 是否阻断 备注
booting 模型首次加载前 进程生命周期中只会触发一次
booted 模型首次加载后 进程生命周期中只会触发一次
retrieved 填充数据后 每当模型从 DB 或缓存查询出来后触发
creating 数据创建时
created 数据创建后
updating 数据更新时
updated 数据更新后
saving 数据创建或更新时
saved 数据创建或更新后
restoring 软删除数据恢复时
restored 软删除数据恢复后
deleting 数据删除时
deleted 数据删除后
forceDeleted 数据强制删除后

针对某个模型的事件使用十分简单,只需要在模型中增加对应的方法即可。例如下方保存数据时,触发 saving 事件,主动覆写 created_at 字段。

  1. <?php
  2. declare(strict_types=1);
  3. namespace App\Models;
  4. use Hyperf\Database\Model\Events\Saving;
  5. /**
  6. * @property $id
  7. * @property $name
  8. * @property $gender
  9. * @property $created_at
  10. * @property $updated_at
  11. */
  12. class User extends Model
  13. {
  14. /**
  15. * The table associated with the model.
  16. *
  17. * @var string
  18. */
  19. protected $table = 'user';
  20. /**
  21. * The attributes that are mass assignable.
  22. *
  23. * @var array
  24. */
  25. protected $fillable = ['id', 'name', 'gender', 'created_at', 'updated_at'];
  26. protected $casts = ['id' => 'integer', 'gender' => 'integer'];
  27. public function saving(Saving $event)
  28. {
  29. $this->setCreatedAt('2019-01-01');
  30. }
  31. }

事件监听

当您需要监听所有的模型事件时,可以很方便的自定义对应的 Listener,比如下方模型缓存的监听器,当模型修改和删除后,会删除对应缓存。

  1. <?php
  2. declare(strict_types=1);
  3. namespace Hyperf\ModelCache\Listener;
  4. use Hyperf\Database\Model\Events\Deleted;
  5. use Hyperf\Database\Model\Events\Event;
  6. use Hyperf\Database\Model\Events\Saved;
  7. use Hyperf\Event\Annotation\Listener;
  8. use Hyperf\Event\Contract\ListenerInterface;
  9. use Hyperf\ModelCache\CacheableInterface;
  10. #[Listener]
  11. class DeleteCacheListener implements ListenerInterface
  12. {
  13. public function listen(): array
  14. {
  15. return [
  16. Deleted::class,
  17. Saved::class,
  18. ];
  19. }
  20. public function process(object $event)
  21. {
  22. if ($event instanceof Event) {
  23. $model = $event->getModel();
  24. if ($model instanceof CacheableInterface) {
  25. $model->deleteCache();
  26. }
  27. }
  28. }
  29. }