Laravel实现数据软删除功能的代码

  • 更新时间:2020-05-19 10:25:01
  • 编辑:索婧芸
为网友们分享了相关的编程文章,网友赵初露根据主题投稿了本篇教程内容,涉及到laravel、数据、删除、Laravel 实现数据软删除功能相关内容,已被898网友关注,内容中涉及的知识点可以在下方直接下载获取。
  • 《Python金融数据分析(原书第2版)》源代码 / 3.9 MB 推荐度:
  • 数据结构与算法分析:Java语言描述 / 47.3 MB 推荐度:
  • 《数据库应用技术:Access篇(第2版)》习题答案,教案 / 3.16 MB 推荐度:
  • 大数据资源 / 68.07MB 推荐度:
  • 代码虚拟与自动化分析 / 148.3 MB 推荐度:
  • 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 对象

    总结

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

    相关教程

    • PHP框架laravel的.env文件配置详细流程

      在之前的版本 Laravel 是使用 config 文件夹下的 php 文件来完成项目所需要的配置的,后面从大概从 5 开始就使用了 .env 来放置部分配置。那么下面这篇文章主要给大家介绍了关于PHP框架laravel的

      发布时间:2019-06-06

    • laravel实现简单用户权限的代码分析

      这篇文章主要介绍了laravel实现简单用户权限的示例代码,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧

      发布时间:2019-07-25

    • 解析laravel批量更新多条记录的方法

      最近在使用Laravel,想批量插入近千条数据,通过网上找到了相关的解决方法,所以下面这篇文章主要给大家介绍了关于laravel实现批量更新多条记录的相关资料,文中给出了详细的示例代码,需

      发布时间:2020-02-27

    • Laravel创建Zip压缩文件下载的实例方法

      这篇文章主要介绍了Laravel 中创建 Zip 压缩文件并提供下载,本文通过两个任务,实例代码相结合的形式给大家介绍的非常详细,具有一定的参考借鉴价值,需要的朋友可以参考下

      发布时间:2019-09-26

    • Laravel框架+Blob实现的多图上传功能讲解

      这篇文章主要介绍了Laravel框架+Blob实现的多图上传功能,结合实例形式详细分析了Laravel框架+Blob进行多张图片上传操作的前端提交与后台处理相关操作技巧,需要的朋友可以参考下

      发布时间:2019-10-09

    用户留言