Laravel ORM 对 Model::find 方法进行缓存
前段时间做项目时候,想要在不改变方法签名的情况下,给 Model::find 方法做个缓存。而且想要做到即插即用。
1.先看一下当我们调用 find 方法时,框架干了什么?
找到 Illuminate\Database\Eloquent\Model 的代码,搜索 find,没有该方法。看来是走了 __callStatic 这个魔术方法。该方法里只有一行代码:
return (new static)->$method(...$parameters);
static 指的是调用该静态方法的类(如果使用的是 UserModel::find(1),则 static 就代表 UserModel 类)。看来是实例化了一个对象,并调用了成员方法。
2.分析如何优雅地在中间插一脚
为了能够在调用 find 时候,先走我们的缓存,所以我们需要覆盖 __callStatic 方法,并检测如果是 find 方法,则优先返回缓存中的数据。
另外,为了能够达到即插即用的效果,我们使用继承的方式,而是使用了 Trait。核心逻辑如下:
public static function create($data = null){
if ($data == null){
return null;
}
$instance = new static;
foreach ($data as $key => $value){
$instance[$key] = $value;
}
return $instance;
}
/**
* 如果方法是 find($id, $nocache)
*
* @param string $method
* @param array $parameters
* @return mixed
*/
public static function __callStatic($method, $parameters)
{
if ($method == 'find'){
// 从缓存中获取数据
$obj = static::create(json_decode(Redis::get(static::getCacheKey($parameters[0])), true));
if (null == $obj){
$obj = (new static)->$method(...$parameters);
if (null == $obj){
return null;
} else {
$key = static::getCacheKey($parameters[0]);
// 设置缓存及过期时间
Redis::set($key, $obj);
Redis::expire($key, static::$expire_time);
return $obj;
}
} else {
$obj->exists = true;
return $obj;
}
} else if($method == 'findNoCache'){
$method = 'find';
return (new static)->$method(...$parameters);
}
return (new static)->$method(...$parameters);
}
private static function getCacheKey($id){
$name = str_replace('\\', ':', __CLASS__);
return "{$name}:{$id}";
}
大体逻辑上面已经介绍过了:覆盖 __callStatic 方法,判断如果是调用 find ,则走缓存(无缓存,查询后需要设置缓存)。另新增 findNoCache 方法。
3.细节补充
当修改(或删除)数据(调用 save 方法)时需要删除已缓存的内容。
private static function clearCache($id){
Redis::del(self::getCacheKey($id));
}
/**
* when save, should clear cache
* @param array $options
*/
public function save(array $options = []){
static::clearCache($this[$this->primaryKey]);
return parent::save($options);
}
// delete 方法我暂时写,内容类似 save 方法
如何使用。在需要使用 find 缓存的 Model 类里,加上一行就够了。
class User extends BaseModel
{
use MemoryCacheTrait;
}
快去试试吧。
本文来自PHP中文网的laravel教程栏目:https://www.php.cn/phpkj/laravel/