Laravel Eloquent 之 Fill 方法解析

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

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

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

用 Laravel 的童鞋應(yīng)該都知道,fill 方法是一個給 Eloquent 實例賦值屬性的方法,讓我們點開 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 會先去調(diào)用一個自身的 totallyGuarded 方法,讓我們點開這個方法:

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

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

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

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

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

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

    return $attributes;
}

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

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

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

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

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

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),那么會判斷一下此屬性是否存在于 fillable 數(shù)組中,如果存在,則返回 True,

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

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

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

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

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

然后回到 fill 方法接著看,如果此屬性通過了 isFillable 方法的過濾,那么將此屬性賦值給自身 (因為時間有限,setAttribute 這個方法就不細講啦~),

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

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

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

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

在對所有的屬性進行檢測并且賦值后, Laravel 會將自身返回

return $this;

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

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

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

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

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

然后 Laravel 會返回完成賦值操作后的 $this

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