Laravel如何实现软删除功能?(SoftDeletes代码示例)

10次阅读

laravel软删除通过Softdeletes特性实现,不真正删除记录而是设置deleted_at字段;需在模型中引入trait并添加deleted_at字段迁移,delete()触发软删除,withTrashed()、onlyTrashed()、restore()和forceDelete()分别用于查询全部、仅删除、恢复及强制删除。

Laravel如何实现软删除功能?(SoftDeletes代码示例)

Laravel 的软删除功能通过 SoftDeletes 特性实现,它不会真正从数据库中删除记录,而是给数据打上“已删除”标记(即设置 deleted_at 字段为当前时间),后续查询会自动忽略这些记录。

1. 启用软删除(模型配置)

在需要软删除的 Eloquent 模型中,引入 SoftDeletes trait,并确保数据库表包含 deleted_at 字段:

use IlluminateDatabaseEloquentSoftDeletes;  class Post extends Model {     use SoftDeletes; }

如果表中还没有 deleted_at 字段,可新建迁移文件添加:

php artisan make:migration add_deleted_at_to_posts_table

然后在迁移中写:

public function up(MigrationBuilder $table) {     $table->softDeletes(); }

2. 执行软删除操作

调用 delete() 方法即触发软删除:

$post = Post::find(1); $post->delete(); // 不删除行,只设置 deleted_at = now()

  • 数据库中该记录仍存在,deleted_at 字段被设为当前时间戳
  • 普通查询(如 Post::all()Post::find(1))默认不返回已软删除的数据

3. 查询已软删除或全部数据

软删除后,可通过以下方式显式获取特定状态的数据:

  • withTrashed():查出包括已软删除的所有记录
  • onlyTrashed():只查已软删除的记录
  • restore():恢复单条软删除记录(清空 deleted_at
  • forceDelete():强制物理删除(绕过软删除)

示例:

// 获取所有(含已删除) Post::withTrashed()->get();  // 只获取已删除的 Post::onlyTrashed()->get();  // 恢复某条 $post->restore();  // 彻底删掉(慎用) $post->forceDelete();

4. 注意事项与自定义

默认软删除字段是 deleted_at,若需改名(比如叫 is_deleted 布尔字段),需重写模型属性:

class Post extends Model {     use SoftDeletes;      protected $dates = ['is_deleted'];     protected $softDelete = 'is_deleted'; // Laravel 9+ 不再支持此写法,建议保持 deleted_at      // 实际推荐:仍用 deleted_at,但逻辑上按需处理 }

⚠️ 注意:deleted_at 字段类型必须是 timestampdatetime,且不能设为非空(NULL 允许)。

基本上就这些。软删除不是黑魔法,核心就是自动拦截 delete + 自动过滤查询,用起来很轻量,但得记得迁移加字段、模型加 trait。

text=ZqhQzanResources