1. 手册内容

在实际项目中,对数据频繁使用删除操作会导致性能问题,软删除的作用就是把数据加上删除标记,而不是真正的删除,同时也便于需要的时候进行数据的恢复。
要使用软删除功能,需要引入SoftDelete trait,例如User模型按照下面的定义就可以使用软删除功能:

  1. <?php
  2. namespace app\index\model;
  3. use think\Model;
  4. use think\model\concern\SoftDelete;
  5. class User extends Model
  6. {
  7. use SoftDelete;
  8. protected $deleteTime = 'delete_time';
  9. }

deleteTime属性用于定义你的软删除标记字段,ThinkPHP的软删除功能使用时间戳类型(数据表默认值为Null),用于记录数据的删除时间。

V5.1.9+版本开始,可以支持defaultSoftDelete属性来定义软删除字段的默认值,在此之前的版本,软删除字段的默认值必须为null

  1. <?php
  2. namespace app\index\model;
  3. use think\Model;
  4. use think\model\concern\SoftDelete;
  5. class User extends Model
  6. {
  7. use SoftDelete;
  8. protected $deleteTime = 'delete_time';
  9. protected $defaultSoftDelete = 0;
  10. }

可以用类型转换指定软删除字段的类型,建议数据表的所有时间字段统一一种类型。

定义好模型后,我们就可以使用:

  1. <?php
  2. // 软删除
  3. User::destroy(1);
  4. // 真实删除
  5. User::destroy(1,true);
  6. $user = User::get(1);
  7. // 软删除
  8. $user->delete();
  9. // 真实删除
  10. $user->delete(true);

默认情况下查询的数据不包含软删除数据,如果需要包含软删除的数据,可以使用下面的方式查询:

  1. <?php
  2. User::withTrashed()->find();
  3. User::withTrashed()->select();

如果仅仅需要查询软删除的数据,可以使用:

  1. <?php
  2. User::onlyTrashed()->find();
  3. User::onlyTrashed()->select();

恢复被软删除的数据

  1. <?php
  2. $user = User::onlyTrashed()->find(1);
  3. $user->restore();

软删除仅对模型的删除方法有效,如果直接使用数据库的删除方法则无效,例如下面的方式无效(将不会执行任何操作)。

  1. <?php
  2. $user = new User;
  3. $user->where('id',1)->delete();

2. 测试实例

2.1 产生问题,delete_time 插入的数据是 0000-00-00 00:00:00

模型中添加:

  1. <?php
  2. // 添加
  3. use think\model\concern\SoftDelete;
  4. // 添加
  5. // 软删除使用
  6. use SoftDelete;
  7. protected $deleteTime = 'delete_time';

数据库添加:完全相同的字段 delete_time

service 中使用的方法:使用的是 destroy() 方法

  1. <?php
  2. // 使用软删除
  3. public function softDel($id)
  4. {
  5. return (UserModel::destroy($id)) ? '删除成功' : '删除失败';
  6. }

controller 中的方法:

  1. <?php
  2. // 测试软删除使用
  3. public function fun15(UserService $service, $id)
  4. {
  5. return $service->softDel($id);
  6. }

先后将数据表的对应规则换成 delete_time 属性 对应 delete_time 字段 deleteTime => deleteTime 都是发现数据标记确实打上了标记,但是 打上的时间为
0000-00-00 00:00:00

2.2 解决办法

在模型中设置字段转换,delete_time 要求 mysql 默认的日期时间是一个 timestamp unix 时间戳的问题,需要我们去转换成 datetime 类型

模型中添加下面的代码:

  1. <?php
  2. // 设置自动类型转换
  3. protected $type = [
  4. 'delete_time' => 'datetime'
  5. ];

3. 如何优雅的进行批量软删除