快捷導(dǎo)航

Laravel 實(shí)現(xiàn)數(shù)據(jù)軟刪除功能

更新時(shí)間：2019年08月21日 15:56:20 作者：寫(xiě)PHP的老王

這篇文章主要介紹了Laravel 實(shí)現(xiàn)數(shù)據(jù)軟刪除功能,文中給大家提到了軟刪除功能的實(shí)現(xiàn)方法，需要的朋友可以參考下

對(duì)于任何一個(gè)模型，如果需要使用軟刪除功能，需要在模型中使用 Illuminate\Database\Eloquent\SoftDeletes 這個(gè) trait 。軟刪除功能需要實(shí)現(xiàn)的功能有以下幾點(diǎn):

1.模型執(zhí)行刪除操作，只標(biāo)記刪除，不執(zhí)行真正的數(shù)據(jù)刪除

2.查詢的時(shí)候自動(dòng)過(guò)濾已經(jīng)標(biāo)記為刪除的數(shù)據(jù)

3.可以設(shè)置是否查詢已刪除的數(shù)據(jù)，可以設(shè)置只查詢已刪除的數(shù)據(jù)

4.已刪除數(shù)據(jù)可以恢復(fù)

Model的軟刪除功能實(shí)現(xiàn)

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;
}

因?yàn)樵谧宇愔惺褂昧?nbsp;SoftDeletes trait,所以， SoftDeletes 的 performDeleteOnModel 方法會(huì)覆蓋父類的方法,最終通過(guò) runSoftDelete 方法更新刪除標(biāo)記。

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查詢過(guò)濾刪除數(shù)據(jù)

Laravel中允許在Model中 static::addGlobalScope 方法添加全局的 Scope 。這樣就可以在查詢條件中添加一個(gè)全局條件。Laravel中軟刪除數(shù)據(jù)的過(guò)濾也是使用這種方式實(shí)現(xiàn)的。

SoftDeletes trait中加入了 Illuminate\Database\Eloquent\SoftDeletingScope 全局的 Scope 。并在 SoftDeletingScope 中實(shí)現(xiàn)查詢自動(dòng)過(guò)濾被刪除數(shù)據(jù)，指定查詢已刪除數(shù)據(jù)功能。

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

遠(yuǎn)程關(guān)聯(lián)數(shù)據(jù)的軟刪除處理

Scope的作用只在于當(dāng)前模型，以及關(guān)聯(lián)模型操作上。如果是遠(yuǎn)程關(guān)聯(lián)，則還需要額外的處理。Laravel遠(yuǎn)程關(guān)聯(lián)關(guān)系通過(guò) hasManyThrough 實(shí)現(xiàn)。里面有兩個(gè)地方涉及到軟刪除的查詢。

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 中通過(guò)中間模型關(guān)聯(lián)遠(yuǎn)程模型，會(huì)根據(jù) throughParentSoftDeletes 判斷中間模型是否有軟刪除，如果有軟刪除會(huì)過(guò)濾掉中間模型被刪除的數(shù)據(jù)。

以上就是Laravel實(shí)現(xiàn)軟刪除的大概邏輯。這里有一個(gè)細(xì)節(jié)，Laravel中軟刪除的標(biāo)記是一個(gè)時(shí)間格式的字段，默認(rèn) delete_at 。通過(guò)是否為null判斷數(shù)據(jù)是否刪除。

但是有的時(shí)候，項(xiàng)目中會(huì)使用一個(gè)整形的字段標(biāo)記數(shù)據(jù)是否刪除。在這樣的場(chǎng)景下，需要對(duì)Laravel的軟刪除進(jìn)行修改才能夠?qū)崿F(xiàn)。

主要的方案是:

1.自定義 SoftDeletes trait，修改字段名稱，修改更新刪除標(biāo)記操作；

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

3.自定義 HasRelationships trait，在自定義的 HasRelationships 中重寫(xiě) newHasManyThrough 方法，實(shí)例化自定義的 HasManyThrough 對(duì)象

總結(jié)

以上所述是小編給大家介紹的Laravel 實(shí)現(xiàn)數(shù)據(jù)軟刪除功能，希望對(duì)大家有所幫助，如果大家有任何疑問(wèn)歡迎給我留言，小編會(huì)及時(shí)回復(fù)大家的！

您可能感興趣的文章: