對于任何一個模型,如果需要使用軟刪除功能,需要在模型中使用 Illuminate\Database\Eloquent\SoftDeletes
這個 trait 。軟刪除功能需要實現(xiàn)的功能有以下幾點:
1.模型執(zhí)行刪除操作,只標記刪除,不執(zhí)行真正的數(shù)據(jù)刪除
2.查詢的時候自動過濾已經(jīng)標記為刪除的數(shù)據(jù)
3.可以設置是否查詢已刪除的數(shù)據(jù),可以設置只查詢已刪除的數(shù)據(jù)
4.已刪除數(shù)據(jù)可以恢復
Model的軟刪除功能實現(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;
}
因為在子類中使用了 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查詢過濾刪除數(shù)據(jù)
Laravel中允許在Model中 static::addGlobalScope
方法添加全局的 Scope 。這樣就可以在查詢條件中添加一個全局條件。Laravel中軟刪除數(shù)據(jù)的過濾也是使用這種方式實現(xiàn)的。
SoftDeletes trait中加入了 Illuminate\Database\Eloquent\SoftDeletingScope
全局的 Scope 。并在 SoftDeletingScope 中實現(xiàn)查詢自動過濾被刪除數(shù)據(jù),指定查詢已刪除數(shù)據(jù)功能。
public static function bootSoftDeletes()
{
static::addGlobalScope(new SoftDeletingScope);
}
遠程關聯(lián)數(shù)據(jù)的軟刪除處理
Scope的作用只在于當前模型,以及關聯(lián)模型操作上。如果是遠程關聯(lián),則還需要額外的處理。Laravel遠程關聯(lián)關系通過 hasManyThrough 實現(xiàn)。里面有兩個地方涉及到軟刪除的查詢。
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 中通過中間模型關聯(lián)遠程模型,會根據(jù) throughParentSoftDeletes
判斷中間模型是否有軟刪除,如果有軟刪除會過濾掉中間模型被刪除的數(shù)據(jù)。
以上就是Laravel實現(xiàn)軟刪除的大概邏輯。這里有一個細節(jié),Laravel中軟刪除的標記是一個時間格式的字段,默認 delete_at
。通過是否為null判斷數(shù)據(jù)是否刪除。
但是有的時候,項目中會使用一個整形的字段標記數(shù)據(jù)是否刪除。在這樣的場景下,需要對Laravel的軟刪除進行修改才能夠實現(xiàn)。
主要的方案是:
1.自定義 SoftDeletes trait,修改字段名稱,修改更新刪除標記操作;
2.自定義 SoftDeletingScope 修改查詢條件
3.自定義 HasRelationships trait,在自定義的 HasRelationships 中重寫 newHasManyThrough 方法,實例化自定義的 HasManyThrough 對象
總結
以上所述是小編給大家介紹的Laravel 實現(xiàn)數(shù)據(jù)軟刪除功能,希望對大家有所幫助,如果大家有任何疑問歡迎給我留言,小編會及時回復大家的!
您可能感興趣的文章:- Laravel5.1 框架模型創(chuàng)建與使用方法實例分析
- Laravel 5框架學習之模型、控制器、視圖基礎流程
- Laravel模型事件的實現(xiàn)原理詳解
- Laravel模型間關系設置分表的方法示例
- laravel學習教程之關聯(lián)模型
- laravel學習筆記之模型事件的幾種用法示例
- Laravel框架模型的創(chuàng)建及模型對數(shù)據(jù)操作示例
- laravel model模型處理之修改查詢或修改字段時的類型格式案例
- Laravel 關聯(lián)模型-關聯(lián)新增和關聯(lián)更新的方法
- Laravel 模型使用軟刪除-左連接查詢-表起別名示例
- Laravel5.1 框架模型軟刪除操作實例分析