php学习Eloquent修改器源码示例解析

admin PHP

2023-12-05 0 738

引言

感觉好长时间没写东西了，一方面主要是自己的角色发生了变化，每天要面对各种各样的事情和突发事件，不能再有一个完整的长时间让自己静下来写代码，或者写文章。

另一方面现在公司技术栈不再停留在只有 Laravel + VUE 了，我们还有小程序、APP 等开发，所以我关注的东西也就多了。

接下来我还是会继续持续「高产」，把写技术文章当作一个习惯，坚持下去。

好了，废话不多说，今天来说一说「Eloquent：修改器」。

一直想好好研究下 Eloquent。但苦于 Eloquent 有太多可研究的，无法找到一个切入点。前两天看一同事好像对这个「Eloquent：修改器」了解不多，所以今天就拿它作为入口，扒一扒其实现源代码。

首先还是拿一个 Demo 为例：

Demo

<?php
namespace App\\Models;
use Illuminate\\Database\\Eloquent\\Model;
use Carbon\\Carbon;
class Baby extends Model
{
protected $table = \’baby\’;
protected $appends = [\’age\’];
public function getAgeAttribute()
{
$date = new Carbon($this->birthday);
return Carbon::now()->diffInYears($date);
}
}

这个代码比较简单，就是通过已有属性birthday，计算 Baby 几岁了，得到age属性。

前端就可以直接拿到结果：

return $baby->age;

同样的，还有setXxxAttribute方法来定义一个修改器。

源代码

读代码还是从使用入手，如上通过$baby->age调用age属性，这个属性没在类中定义，所以只能通过 PHP 的魔术方法__get()调用了。

我们看看Model类的__get()方法：

/**
* Dynamically retrieve attributes on the model.
*
* @param string $key
* @return mixed
*/
public function __get($key)
{
return $this->getAttribute($key);
}

好了，我们开始解读源代码了：

/**
* Get an attribute from the model.
*
* @param string $key
* @return mixed
*/
public function getAttribute($key)
{
if (! $key) {
return;
}
// If the attribute exists in the attribute array or has a \”get\” mutator we will
// get the attribute\’s value. Otherwise, we will proceed as if the developers
// are asking for a relationship\’s value. This covers both types of values.
if (array_key_exists($key, $this->attributes) ||
$this->hasGetMutator($key)) {
return $this->getAttributeValue($key);
}
…
}

重点自然就在第二个if上，主要判断attributes数组中是否包含该属性，如果没有，则会执行函数$this->hasGetMutator($key)：

/**
* Determine if a get mutator exists for an attribute.
*
* @param string $key
* @return bool
*/
public function hasGetMutator($key)
{
return method_exists($this, \’get\’.Str::studly($key).\’Attribute\’);
}

这就对上了我们的Demo中自定义的函数getAgeAttribute()，也就返回true了。

接下来就是执行函数$this->getAttributeValue($key),进而执行函数：return $this->mutateAttribute($key, $value);

/**
* Get the value of an attribute using its mutator.
*
* @param string $key
* @param mixed $value
* @return mixed
*/
protected function mutateAttribute($key, $value)
{
return $this->{\’get\’.Str::studly($key).\’Attribute\’}($value);
}

好了，到此我们基本就知道了获取自定义Attribute的流程了。

相信解析set XxxAttribute也是很简单的。