如何在Laravel中实现软删除功能

老浩姑娘_1628

老浩姑娘_1628

2025-07-01

754人浏览

原创

软删除是通过添加“已删除”标记而非真正删除数据来保留记录,laravel 提供内置支持。1. 在模型中引入 softdeletes trait 并指定 deleted_at 为日期类型;2. 创建迁移文件使用 softdeletes() 方法添加 deleted_at 字段;3. 调用 delete() 方法实现软删除,forcedelete() 可彻底删除;4. 查询时默认排除软删除记录,withtrashed() 包含所有记录,onlytrashed() 仅包含已软删除记录;5. 恢复记录使用 restore() 方法;6. 自定义字段名需在模型定义 $deletedat 属性并在迁移中创建对应字段;7. 关联查询可通过 withtrashed() 包含软删除记录;8. 全局禁用软删除过滤可调用 reguard(),操作完成后应重新启用作用域

如何在Laravel中实现软删除功能

软删除,简单来说,就是给你的数据表加上一个“已删除”的标记,而不是真的从数据库里删掉。这样,你就可以恢复误删的数据,或者保留历史记录。Laravel 内置了对软删除的支持,用起来相当方便。

实现软删除,主要涉及到模型修改、数据库迁移,以及查询时的过滤。

解决方案

  1. 添加 SoftDeletes Trait 到你的模型:

    在你的模型类中引入 SoftDeletes trait。例如,如果你的模型是 App\Models\Post,就这样写:

    <?php namespace App\Models;
    
    use Illuminate\Database\Eloquent\Model;
    use Illuminate\Database\Eloquent\SoftDeletes;
    
    class Post extends Model
    {
        use SoftDeletes;
    
        protected $dates = ['deleted_at']; // 可选,但推荐,指定 deleted_at 为日期类型
    }

    $dates 属性用于告诉 Eloquent deleted_at 字段应该被视为日期类型,这样你就可以使用 Carbon 对象来处理它。

  2. 创建数据库迁移:

    如果你的数据表还没有 deleted_at 字段,你需要创建一个迁移来添加它。运行:

    php artisan make:migration add_deleted_at_to_posts_table --table=posts

    然后,在生成的迁移文件中,修改 up() 方法:

    <?php use Illuminate\Database\Migrations\Migration;
    use Illuminate\Database\Schema\Blueprint;
    use Illuminate\Support\Facades\Schema;
    
    class AddDeletedAtToPostsTable extends Migration
    {
        public function up()
        {
            Schema::table('posts', function (Blueprint $table) {
                $table->softDeletes();
            });
        }
    
        public function down()
        {
            Schema::table('posts', function (Blueprint $table) {
                $table->dropSoftDeletes();
            });
        }
    }

    运行迁移:

    php artisan migrate

    这会在 posts 表中添加一个 deleted_at 字段,类型为 timestamp

  3. 使用软删除:

    现在,你可以在你的模型中使用 delete() 方法进行软删除:

    $post = Post::find(1);
    $post->delete(); // 这不会真的删除记录,而是设置 deleted_at 字段

    要永久删除记录,可以使用 forceDelete() 方法:

    Academic Writing
    Academic Writing

    擅长学术论文、文献综述、研究方法及学位论文写作,严格遵守学术标准和引用规范。

    下载
    $post->forceDelete(); // 这会真的从数据库中删除记录
  4. 查询软删除的数据:

    默认情况下,Eloquent 查询会排除软删除的记录。如果你想包含软删除的记录,可以使用以下方法:

    • withTrashed():包含所有记录,包括软删除的。

      $posts = Post::withTrashed()->get();
    • onlyTrashed():只包含软删除的记录。

      $posts = Post::onlyTrashed()->get();
    • restore():恢复软删除的记录。

      $post = Post::withTrashed()->find(1);
      $post->restore(); // 恢复 deleted_at 为 null

如何自定义 deleted_at 字段的名称?

默认情况下,Laravel 假设你的软删除字段名为 deleted_at。如果你想使用不同的字段名,可以在你的模型中定义一个 $deletedAt 属性:

<?php namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;

class Post extends Model
{
    use SoftDeletes;

    protected $dates = ['custom_deleted_at'];
    protected $deletedAt = 'custom_deleted_at';
}

然后,在你的数据库迁移中,创建名为 custom_deleted_at 的字段。

软删除对关联关系有什么影响?

使用软删除时,需要注意关联关系的处理。默认情况下,Eloquent 会自动过滤掉软删除的关联记录。例如,如果 Post 模型有一个 comments() 关联关系,并且 Comment 模型也使用了软删除,那么在查询 Postcomments 时,只会返回未被软删除的评论。

如果你想包含软删除的关联记录,可以使用 withTrashed() 方法:

$post = Post::find(1);
$comments = $post->comments()->withTrashed()->get();

或者,你可以在关联关系定义中使用 withTrashed()

public function comments()
{
    return $this->hasMany(Comment::class)->withTrashed();
}

如何在全局范围内禁用软删除的过滤?

有时候,你可能需要在整个应用中禁用软删除的过滤。例如,你可能需要编写一些管理工具,可以访问所有记录,包括软删除的记录。

要做到这一点,你可以使用 Model::reguard() 方法:

Post::reguard(); // 禁用 Post 模型上的所有全局作用域,包括软删除
$posts = Post::all(); // 现在 $posts 包含所有记录,包括软删除的
Post::unguard(false); // 重新启用全局作用域

但是,请谨慎使用此方法,因为它可能会导致意外的行为。最好只在必要时使用,并在完成后立即重新启用全局作用域。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

laravel cad 作用域

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
laravel组件介绍
laravel组件介绍

laravel 提供了丰富的组件,包括身份验证、模板引擎、缓存、命令行工具、数据库交互、对象关系映射器、事件处理、文件操作、电子邮件发送、队列管理和数据验证。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

2024.04.09

817

10

laravel中间件介绍
laravel中间件介绍

laravel 中间件分为五种类型:全局、路由、组、终止和自定。想了解更多laravel中间件的相关内容,可以阅读本专题下面的文章。

2024.04.09

795

9

laravel使用的设计模式有哪些
laravel使用的设计模式有哪些

laravel使用的设计模式有:1、单例模式;2、工厂方法模式;3、建造者模式;4、适配器模式;5、装饰器模式;6、策略模式;7、观察者模式。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

2024.04.09

2328

10

thinkphp和laravel哪个简单
thinkphp和laravel哪个简单

对于初学者来说,laravel 的入门门槛较低,更易上手,原因包括:1. 更简单的安装和配置;2. 丰富的文档和社区支持;3. 简洁易懂的语法和 api;4. 平缓的学习曲线。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.04.10

3201

7

laravel入门教程
laravel入门教程

本专题整合了laravel入门教程,想了解更多详细内容,请阅读专题下面的文章。

2025.08.05

4450

22

laravel实战教程
laravel实战教程

本专题整合了laravel实战教程,阅读专题下面的文章了解更多详细内容。

2025.08.05

2996

13

laravel面试题
laravel面试题

本专题整合了laravel面试题相关内容,阅读专题下面的文章了解更多详细内容。

2025.08.05

5729

7

PHP高性能API设计与Laravel服务架构实践
PHP高性能API设计与Laravel服务架构实践

本专题围绕 PHP 在现代 Web 后端开发中的高性能实践展开,重点讲解基于 Laravel 框架构建可扩展 API 服务的核心方法。内容涵盖路由与中间件机制、服务容器与依赖注入、接口版本管理、缓存策略设计以及队列异步处理方案。同时结合高并发场景,深入分析性能瓶颈定位与优化思路,帮助开发者构建稳定、高效、易维护的 PHP 后端服务体系。

2026.03.04

1336

29

Laravel 框架安装指南
Laravel 框架安装指南

本指南详解 Laravel 框架安装全流程,涵盖 PHP 8.1+ 环境配置、Composer 依赖管理工具安装及国内镜像源优化。重点演示使用 composer create-project 命令创建 Laravel 10/11 项目,解决常见安装错误与依赖冲突。从环境搭建到项目初始化,助您快速完成 Laravel 开发环境部署,为后续 Web 应用开发奠定基础。适合 PHP 初学者与框架迁移开发者参考。

2026.04.09

175

6

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
如何安装 Composer
如何安装 Composer

共1课时 | 176人学习

Composer手册
Composer手册

共0课时 | 0人学习