使用Laravel怎么實現一個數據軟刪除功能

這篇文章給大家介紹使用Laravel怎么實現一個數據軟刪除功能，內容非常詳細，感興趣的小伙伴們可以參考借鑒，希望對大家能有所幫助。

軟刪除功能需要實現的功能有以下幾點:

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 對象

關于使用Laravel怎么實現一個數據軟刪除功能就分享到這里了，希望以上內容可以對大家有一定的幫助，可以學到更多知識。如果覺得文章不錯，可以把它分享出去讓更多的人看到。