Laravel Eloquent 之 Fill 方法解析

skinner 發(fā)布于2019-06-28 14:26 / 3748人閱讀

摘要：上一次分析了中的模型事件與觀察者模式這次來(lái)解析一下中的用的童鞋應(yīng)該都知道方法是一個(gè)給實(shí)例賦值屬性的方法讓我們點(diǎn)開(kāi)方法先看一看它的源碼這里筆者所使用的版本為最新版為了方便閱讀刪除掉了注釋首先可以看到會(huì)先去調(diào)用一個(gè)自身的方法讓我們點(diǎn)開(kāi)

上一次分析了 Laravel 中的模型事件與觀察者模式,這次來(lái)解析一下 Eloquent 中的 fill

用 Laravel 的童鞋應(yīng)該都知道,fill 方法是一個(gè)給 Eloquent 實(shí)例賦值屬性的方法,讓我們點(diǎn)開(kāi) fill 方法先看一看它的源碼:

這里筆者所使用的版本為 Laravel 5.5最新版,為了方便閱讀,刪除掉了注釋

public function fill(array $attributes)
{
    $totallyGuarded = $this->totallyGuarded();

    foreach ($this->fillableFromArray($attributes) as $key => $value) {
        $key = $this->removeTableFromKey($key);

        if ($this->isFillable($key)) {
            $this->setAttribute($key, $value);
        } elseif ($totallyGuarded) {
            throw new MassAssignmentException($key);
        }
    }

    return $this;
}

首先可以看到,Laravel 會(huì)先去調(diào)用一個(gè)自身的 totallyGuarded 方法,讓我們點(diǎn)開(kāi)這個(gè)方法:

public function totallyGuarded()
{
   return count($this->getFillable()) == 0 && $this->getGuarded() == ["*"];
}

可以看到這個(gè)方法的作用就是去獲取自身的 fillable 與 guarded,然后判斷他們是否都為 不可批量賦值 狀態(tài),最后返回一個(gè)布爾值

// 返回一個(gè) True or False 的布爾值
// 如果未設(shè)置 fillable 與 guarded,則會(huì)返回 True (注意,在這種情況下,此 `Model` 是不允許批量賦值任何屬性的哦)
// 反之則返回 False
$totallyGuarded = $this->totallyGuarded();

Ok,讓我們回到剛才的 fill 方法繼續(xù)往下看

接下來(lái)是一個(gè) foreach 循環(huán),但是在循環(huán)之前,Laravel 對(duì)傳入的賦值屬性執(zhí)行了 fillableFromArray 這個(gè)方法,再點(diǎn)進(jìn)去看一下,

protected function fillableFromArray(array $attributes)
{
    if (count($this->getFillable()) > 0 && ! static::$unguarded) {
        return array_intersect_key($attributes, array_flip($this->getFillable()));
    }

    return $attributes;
}

此方法會(huì)檢測(cè)你是否在 fillable 數(shù)組中定義了值,如果定義了值,則會(huì)返回 fillable 與 attributes 相交的值,如果沒(méi)有,則返回 attributes 自身

然后回到 fill ,在調(diào)用 fillableFromArray 對(duì)參數(shù)進(jìn)行處理之后,現(xiàn)在返回的值只剩我們?cè)试S批量賦值的屬性了 (如果你定義了)

循環(huán)第一行,先使用 removeTableFromKey 對(duì)參數(shù)的 Key 進(jìn)行處理,刪除鍵中的表名,此方法就不做過(guò)多講解,只是一個(gè)字符串拆分取值的函數(shù)

$key = $this->removeTableFromKey($key);

接著往下看,Laravel對(duì)將要進(jìn)行填充的每個(gè)屬性都調(diào)用了 isFillable 方法來(lái)確保此屬性是可以被填充的,讓我們看一看它的源碼:

public function isFillable($key)
{
   if (static::$unguarded) {
       return true;
   }

   if (in_array($key, $this->getFillable())) {
       return true;
   }

   if ($this->isGuarded($key)) {
       return false;
   }

   return empty($this->getFillable()) &&
       ! Str::startsWith($key, "_");
}

可以看到,在此方法中 Laravel 先判斷了此 Model 是否禁用了守衛(wèi) (guarded),如果此 Model 并未啟用守衛(wèi),那么直接返回 True

if (static::$unguarded) {
    return true;
}

如果啟用了守衛(wèi),那么會(huì)判斷一下此屬性是否存在于 fillable 數(shù)組中,如果存在,則返回 True,

if (in_array($key, $this->getFillable())) {
    return true;
}

如果此屬性不存在于 fillable 數(shù)組中,那么 Laravel 會(huì)再次判斷此屬性是否存在于 guarded 數(shù)組中,如果存在于此數(shù)組中,那么此屬性就不是一個(gè)可以被批量賦值的屬性,那么就會(huì)直接返回 False

if ($this->isGuarded($key)) {
    return false;
}

如果以上都不符合,那么 Laravel 在最后會(huì)判斷一下自身的 fillable 數(shù)組是為空并且此屬性是以 _ 開(kāi)頭,然后返回一個(gè)布爾值

return empty($this->getFillable()) && ! Str::startsWith($key, "_");

然后回到 fill 方法接著看,如果此屬性通過(guò)了 isFillable 方法的過(guò)濾,那么將此屬性賦值給自身 (因?yàn)闀r(shí)間有限,setAttribute 這個(gè)方法就不細(xì)講啦~),

$this->setAttribute($key, $value);

如果沒(méi)有通過(guò) isFillable 方法的過(guò)濾,那么 Laravel 會(huì)判斷一下自身 Model 是否處于不限制任何屬性批量賦值的狀態(tài),如果不是,那么 Laravel 會(huì)直接拋出一個(gè) Exception

// 判斷此屬性是否通過(guò)了檢測(cè)
if ($this->isFillable($key)) {
    // 將此屬性賦值給自身
    $this->setAttribute($key, $value);

// 如果沒(méi)有通過(guò)檢測(cè),那么判斷一下自身 `Model` 是否為全部不可批量賦值狀態(tài),如果是,那么會(huì)拋出一個(gè) `Exception`
} elseif ($totallyGuarded) {
    throw new MassAssignmentException($key);
}

在對(duì)所有的屬性進(jìn)行檢測(cè)并且賦值后, Laravel 會(huì)將自身返回

return $this;

解析完畢,以上就是 fill 方法的源碼啦~,最后來(lái)一個(gè)小結(jié)

在你調(diào)用 fill 方法的時(shí)候,Laravel 首先就會(huì)去檢測(cè)當(dāng)前 Model 的狀態(tài),

當(dāng)你設(shè)置了 fillable 數(shù)組,沒(méi)有設(shè)置 guarded 數(shù)組時(shí),那么此 Model 會(huì)處于 僅可批量賦值指定屬性 的狀態(tài)
  當(dāng)你沒(méi)有設(shè)置 fillable 數(shù)組,卻設(shè)置了 guarded 數(shù)組時(shí),那么此 Model 會(huì)處于 可批量賦值任何屬性 的狀態(tài)
  至于你同時(shí)設(shè)置了 fillable 與 guarded 數(shù)組的情況就不去討論了,因?yàn)檫@樣做本身就是被 Laravel 所禁止的

然后調(diào)用 fillableFromArray 去獲取 attributes 與 fillable 數(shù)組的交集,如果你沒(méi)有定義 fillable 或者禁用掉了守衛(wèi),那么此方法會(huì)直接返回 attributes

然后 Laravel 會(huì)對(duì)返回的數(shù)組做一個(gè)循環(huán),在這個(gè)循環(huán)中 Laravel 會(huì)對(duì)每一個(gè)屬性調(diào)用 isFillable 方法檢測(cè)這個(gè)屬性是否可以被填充,如果沒(méi)有通過(guò)此方法的檢測(cè)(不存在于fillable 數(shù)組中并且沒(méi)有設(shè)置 guarded 數(shù)組或存在于 guarded 數(shù)組中),那么 Laravel會(huì)檢測(cè)當(dāng)前 Model 是否處于 僅可批量賦值指定屬性 狀態(tài),如果是,那么會(huì)直接拋出一個(gè) Exception

然后 Laravel 會(huì)返回完成賦值操作后的 $this

以上就是 Eloquent 中 fill 方法的源碼解析啦~,Laravel 的源碼讀下來(lái)還是很清晰易懂的~,不得不再次佩服 Laravel 的設(shè)計(jì),不愧為 巨匠級(jí)框架