1. The current implementation is as follows: events and listeners are registered in the listen property of EventServiceProvider. /app/Providers/EventServiceProvider.php
use Illuminate\Cache\Events\CacheHit;
use Illuminate\Cache\Events\CacheMissed;
use Illuminate\Cache\Events\KeyForgotten;
use Illuminate\Cache\Events\KeyWritten;
use App\Listeners\Cache\LogCacheHitListener;
use App\Listeners\Cache\LogCacheMissedListener;
use App\Listeners\Cache\LogKeyForgottenListener;
use App\Listeners\Cache\LogKeyWrittenListener;
class EventServiceProvider extends ServiceProvider
{
/**
* The event listener mappings for the application.
*
* @var array
*/
protected $listen = [
CacheHit::class => [
LogCacheHitListener::class
],
CacheMissed::class => [
LogCacheMissedListener::class
],
KeyForgotten::class => [
LogKeyForgottenListener::class,
],
KeyWritten::class => [
LogKeyWrittenListener::class,
],
];
2. One of the listeners, LogKeyWrittenListener, is implemented as follows: /app/Listeners/Cache/LogKeyWrittenListener.php
key, ThemePreviewInterface::THEME_EDITOR_SESSION_PREFIX) !== false) {
Log::debug('theme_editor_session_key_written', [
'key' => $event->key,
'tags' => $event->tags,
'value' => $event->value,
'seconds' => $event->seconds
]);
}
}
}
3. Another listener, LogCacheHitListener, is implemented as follows: /app/Listeners/Cache/LogCacheHitListener.php
key, ThemePreviewInterface::THEME_EDITOR_SESSION_PREFIX) !== false) {
Log::debug('theme_editor_session_cache_hit', [
'key' => $event->key,
'tags' => $event->tags,
'value' => $event->value
]);
}
}
}
4. I decided to refactor this based on event subscribers. I wrote an event subscriber, CacheEventSubscriber, to merge the 4 listener files into 1.
isThemeEditorSessionLogDebug($event)) {
Log::debug('theme_editor_session_cache_hit', [
'key' => $event->key,
'tags' => $event->tags,
'value' => $event->value
]);
}
}
/**
* 处理缓存未命中事件
*/
public function handleLogCacheMissed($event)
{
if ($this->isThemeEditorSessionLogDebug($event)) {
Log::debug('theme_editor_session_cache_missed', [
'key' => $event->key,
'tags' => $event->tags
]);
}
}
/**
* 处理缓存删除事件
*/
public function handleLogKeyForgotten($event)
{
if ($this->isThemeEditorSessionLogDebug($event)) {
Log::debug('theme_editor_session_key_forgotten', [
'key' => $event->key,
'tags' => $event->tags
]);
}
}
/**
* 处理缓存写入事件
*/
public function handleLogKeyWritten($event)
{
if ($this->isThemeEditorSessionLogDebug($event)) {
Log::debug('theme_editor_session_key_written', [
'key' => $event->key,
'tags' => $event->tags,
'value' => $event->value,
'seconds' => $event->seconds
]);
}
}
/**
* 是否记录主题编辑器 Session 日志
* @return bool
*/
private function isThemeEditorSessionLogDebug($event)
{
return config('app.debug') === true && strpos($event->key, ThemePreviewInterface::THEME_EDITOR_SESSION_PREFIX) !== false;
}
/**
* 为订阅者注册监听器
*
* @param Dispatcher $events
*/
public function subscribe($events)
{
$events->listen(
CacheHit::class,
'App\Listeners\CacheEventSubscriber@handleLogCacheHit'
);
$events->listen(
CacheMissed::class,
'App\Listeners\CacheEventSubscriber@handleLogCacheMissed'
);
$events->listen(
KeyForgotten::class,
'App\Listeners\CacheEventSubscriber@handleLogKeyForgotten'
);
$events->listen(
KeyWritten::class,
'App\Listeners\CacheEventSubscriber@handleLogKeyWritten'
);
}
}
5. Remove the events and listeners from the listen property of EventServiceProvider, and then add the subscriber to the subscribe property.
class EventServiceProvider extends ServiceProvider
{
/**
* The event listener mappings for the application.
*
* @var array
*/
protected $listen = [
];
protected $subscribe = [
\App\Listeners\CacheEventSubscriber::class
];
6. After testing the 4 events, I found that when using the flush method to delete cached data, KeyForgotten is not triggered. When using the forget method to delete cached data, KeyForgotten is triggered.
Cache::put(ThemePreviewInterface::THEME_EDITOR_SESSION_PREFIX . '20220921', '20220921.value', ThemePreviewInterface::TTL);
Cache::forget(ThemePreviewInterface::THEME_EDITOR_SESSION_PREFIX . '20220921');
[2022-09-21 10:11:12] local.DEBUG: theme_editor_session_key_written {
"key": "theme_editor_session:20220921",
"tags": [],
"value": "20220921.value",
"seconds": 86400
}
[2022-09-21 10:14:19] local.DEBUG: theme_editor_session_key_forgotten {
"key": "theme_editor_session:20220921",
"tags": []
}