Laravel 如何實現資料的軟刪除

寫PHP的老王發表於2019-08-16
Laravel

對於任何一個模型，如果需要使用軟刪除功能，需要在模型中使用 Illuminate\Database\Eloquent\SoftDeletes 這個 trait。軟刪除功能需要實現的功能有一下幾點:

  1. 模型執行刪除操作，只標記刪除，不執行真正的資料刪除

  2. 查詢的時候自動過濾已經標記為刪除的資料

  3. 可以設定是否查詢已刪除的資料，可以設定只查詢已刪除的資料

  4. 已刪除資料可以恢復

Model的軟刪除功能實現

Illuminate\Database\Eloquent\Model 中delete方法原始碼:

public function delete()
{
  if (is_null($this->getKeyName())) {
    throw new Exception('No primary key defined on model.');
  }
  if (! $this->exists) {
    return;
  }
  if ($this->fireModelEvent('deleting') === false) {
    return false;
  }
  $this->touchOwners();
  $this->performDeleteOnModel();
  $this->fireModelEvent('deleted', false);
  return true;
}

protected function performDeleteOnModel()
{
  $this->setKeysForSaveQuery($this->newModelQuery())
  ->delete();
  $this->exists = false;
}

因為在子類中使用了SoftDeletes trait,所以，SoftDeletes的performDeleteOnModel方法會覆蓋父類的方法,最終透過 runSoftDelete方法更新刪除標記。

protected function performDeleteOnModel()
{
  if ($this->forceDeleting) {
    $this->exists = false;
    return $this->newModelQuery()->where(
        $this->getKeyName(), $this->getKey()
    )->forceDelete();
  }
  return $this->runSoftDelete();
}

protected function runSoftDelete()
{
  $query = $this->newModelQuery()
            ->where($this->getKeyName(), $this->getKey());
  $time = $this->freshTimestamp();
  $columns = [$this->getDeletedAtColumn() => $this->fromDateTime($time)];
  $this->{$this->getDeletedAtColumn()} = $time;
  if ($this->timestamps && ! is_null($this->getUpdatedAtColumn())) {
    $this->{$this->getUpdatedAtColumn()} = $time;
    $columns[$this->getUpdatedAtColumn()] = $this->fromDateTime($time);
  }
  $query->update($columns);
}

Model查詢過濾刪除資料

Laravel中允許在Model中static::addGlobalScope方法新增全域性的Scope。這樣就可以在查詢條件中新增一個全域性條件。Laravel中軟刪除資料的過濾也是使用這種方式實現的。

SoftDeletes trait中加入了Illuminate\Database\Eloquent\SoftDeletingScope全域性的Scope。並在SoftDeletingScope中實現查詢自動過濾被刪除資料，指定查詢已刪除資料功能。


public static function bootSoftDeletes()
{
  static::addGlobalScope(new SoftDeletingScope);
}

遠端關聯資料的軟刪除處理

Scope的作用只在於當前模型，以及關聯模型操作上。如果是遠端關聯，則還需要額外的處理。Laravel遠端關聯關係透過hasManyThrough實現。裡面有兩個地方涉及到軟刪除的查詢。

protected function performJoin(Builder $query = null)
{
  $query = $query ?: $this->query;
  $farKey = $this->getQualifiedFarKeyName();
  $query->join($this->throughParent->getTable(), $this->getQualifiedParentKeyName(), '=', $farKey);
  if ($this->throughParentSoftDeletes()) {
    $query->whereNull(
      $this->throughParent->getQualifiedDeletedAtColumn()
    );
  }
}

public function throughParentSoftDeletes()
{
  return in_array(SoftDeletes::class, class_uses_recursive(
    get_class($this->throughParent)
  ));
}
public function getRelationExistenceQueryForSelfRelation(Builder $query, Builder $parentQuery, $columns = ['*'])
{
  $query->from( $query->getModel()->getTable().' as '
    .$hash = $this->getRelationCountHash()
  );
  $query->join($this->throughParent->getTable(), 
    $this->getQualifiedParentKeyName(), '=', $hash.'.'.$this->secondLocalKey
  );
  if ($this->throughParentSoftDeletes()) {
    $query->whereNull($this->throughParent->getQualifiedDeletedAtColumn());
  }
  $query->getModel()->setTable($hash);
  return $query->select($columns)->whereColumn(
    $parentQuery->getQuery()->from.'.'.$query->getModel()->getKeyName(), '=', $this->getQualifiedFirstKeyName()
  );
}

performJoin 中透過中間模型關聯遠端模型，會根據throughParentSoftDeletes判斷中間模型是否有軟刪除，如果有軟刪除會過濾掉中間模型被刪除的資料。

以上就是Laravel實現軟刪除的大概邏輯。這裡有一個細節，Laravel中軟刪除的標記是一個時間格式的欄位，預設delete_at。透過是否為null判斷資料是否刪除。

但是有的時候，專案中會使用一個整形的欄位標記資料是否刪除。在這樣的場景下，需要對Laravel的軟刪除進行修改才能夠實現。

主要的方案是:

  1. 自定義SoftDeletes trait，修改欄位名稱，修改更新刪除標記操作；

  2. 自定義SoftDeletingScope 修改查詢條件

  3. 自定義HasRelationships trait，在自定義的HasRelationships中重寫newHasManyThrough方法，例項化自定義的HasManyThrough物件

具體內容，後續文章介紹。

本作品採用《CC 協議》，轉載必須註明作者和本文連結
寫PHP的老王

相關文章