首页 > 语言 > PHP > 正文

Laravel 实现数据软删除功能

2024-05-05 00:10:59
字体:
来源:转载
供稿:网友

对于任何一个模型,如果需要使用软删除功能,需要在模型中使用 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 对象

总结

以上所述是小编给大家介绍的Laravel 实现数据软删除功能,希望对大家有所帮助,如果大家有任何疑问欢迎给我留言,小编会及时回复大家的!


注:相关教程知识阅读请移步到PHP教程频道。
发表评论 共有条评论
用户名: 密码:
验证码: 匿名发表

图片精选