0

0

手滑不再怕!用Composer和Muffin/Trash为你的CakePHP应用实现优雅软删除

DDD

DDD

发布时间:2025-10-12 14:09:01

|

593人浏览过

|

来源于php中文网

原创

手滑不再怕!用composer和muffin/trash为你的cakephp应用实现优雅软删除

最近在开发一个 CakePHP 项目时,我遇到了一个让人头疼的问题:用户反馈不小心删除了重要数据,急需找回。同时,业务方也提出需求,希望能够保留部分已删除数据的历史记录,以便进行审计和分析。传统的 delete() 方法会直接将数据从数据库中移除,这让数据恢复变得异常困难,甚至不可能,也完全无法满足保留历史记录的需求。我尝试了手动添加 is_deleted 字段,并在每次查询时手动过滤,但这不仅增加了大量的重复代码,还很容易出错,效率低下。

Composer在线学习地址:学习地址

正当我为如何优雅地实现这一功能而苦恼时,我发现了 muffin/trash 这个 Composer 包,它简直是 CakePHP 开发者处理软删除的救星!

告别“真删除”,拥抱“软删除”

“软删除”(Soft Delete)是一种数据管理策略,它不像传统的“硬删除”那样直接从数据库中物理移除记录。相反,它通过在记录中设置一个特定的标记(通常是一个时间戳字段,如 deleted_attrashed),来表示这条记录已被“删除”。这样,数据实际上仍然存在于数据库中,只是在查询时被过滤掉,不再向用户展示。

这种方式的优势显而易见:

立即学习PHP免费学习笔记(深入)”;

  • 数据安全: 避免了意外删除导致的数据永久丢失,提供了数据恢复的可能性。
  • 审计追踪: 能够保留完整的历史记录,方便进行数据审计和分析。
  • 用户体验: 类似于“回收站”功能,用户可以更安心地操作数据。

使用 Composer 引入 muffin/trash

muffin/trash 是一个为 CakePHP ORM 表提供软删除支持的插件。通过 Composer,你可以非常方便地将其集成到你的项目中。

首先,在你的 CakePHP 项目根目录下,使用 Composer 安装 muffin/trash

composer require muffin/trash

安装完成后,你需要加载这个插件。最简单的方式是使用 CakePHP 的 shell 命令:

bin/cake plugin load Muffin/Trash

或者,你也可以手动在 src/Application.php 文件的 bootstrap() 方法中添加:

$this->addPlugin('Muffin/Trash');

轻松配置,即刻生效

muffin/trash 的使用非常直观。你只需要在需要软删除功能的 Table 类(例如 UsersTable.php)的 initialize() 方法中,像添加其他行为一样,引入 Trash 行为即可:

// src/Model/Table/UsersTable.php

namespace App\Model\Table;

use Cake\ORM\Table;

class UsersTable extends Table
{
    public function initialize(array $config): void
    {
        parent::initialize($config);

        // 启用 Muffin/Trash 行为
        $this->addBehavior('Muffin/Trash.Trash');
    }
}

默认情况下,muffin/trash 会查找名为 deletedtrashed 的可空 DATETIME 字段。如果你的字段名不同,例如 deleted_at,你可以通过配置来指定:

Pixso AI
Pixso AI

Pixso AI是一款智能生成设计稿工具,通过AI一键实现文本输入到设计稿生成。

下载
// 在你的 Table 类的 initialize() 方法中
$this->addBehavior('Muffin/Trash.Trash', [
    'field' => 'deleted_at'
]);

或者,你也可以在全局的 config/bootstrap.php 中进行配置:

// config/bootstrap.php
use Cake\Core\Configure;

Configure::write('Muffin/Trash.field', 'deleted_at');

配置完成后,当你对这个表执行 delete() 操作时,muffin/trash 会自动将 deleted_at 字段设置为当前时间,而不是真正地删除记录。同时,所有的 find() 查询也会自动过滤掉 deleted_at 字段不为 NULL 的记录,完美实现了软删除!

更多高级用法与功能

muffin/trash 不仅仅是简单地标记删除,它还提供了许多实用的功能来增强你的数据管理能力:

  1. 查询被软删除的记录:

    • onlyTrashed():只查询被软删除的记录。
      $trashedUsers = $this->Users->find('onlyTrashed')->all();
    • withTrashed():查询所有记录,包括被软删除的。
      $allUsers = $this->Users->find('withTrashed')->all();
  2. 恢复被软删除的记录:

    • restoreTrash($entity):恢复指定的被软删除记录。
      $trashedUser = $this->Users->find('onlyTrashed')->first();
      if ($trashedUser) {
      $this->Users->restoreTrash($trashedUser);
      }
    • cascadingRestoreTrash($entity):恢复指定记录及其所有关联的被软删除记录。
  3. 永久删除记录:

    • 如果你确实需要永久删除某条记录,可以使用 purge 选项:
      $this->Users->delete($entity, ['purge' => true]);
    • 或者,清空所有被软删除的记录:
      $this->Users->emptyTrash(); // 永久删除所有被软删除的记录
  4. 级联软删除: 当父级记录被软删除时,你可能希望其关联的子级记录也一并被软删除。只需在 Table 关系中设置 'dependent' => true, 'cascadeCallbacks' => true,并确保 muffin/trash 行为也附加到子级 Table 类上即可。

    // 在父级 Table 的 initialize() 方法中
    $this->hasMany('Comments', [
        'dependent' => true,
        'cascadeCallbacks' => true,
    ]);

    如果你不希望级联软删除,可以设置 'cascadeOnTrash' => false

总结与应用效果

muffin/trash 结合 Composer,为 CakePHP 开发者提供了一个极其优雅和高效的软删除解决方案。它将复杂的软删除逻辑封装成一个简单的行为,极大地减少了开发工作量,提升了代码的可维护性。

通过引入 muffin/trash,我的项目成功解决了以下问题:

  • 数据丢失风险降到最低: 用户不再担心误删操作,数据安全得到极大保障。
  • 业务需求灵活满足: 轻松实现数据恢复和历史记录查询,满足了审计和分析的需求。
  • 开发效率显著提升: 无需手动编写复杂的过滤和更新逻辑,只需几行配置代码即可搞定。

如果你正在使用 CakePHP,并且还在为数据删除问题而烦恼,那么强烈推荐你尝试 muffin/trash。它将彻底改变你处理数据删除的方式,让你的应用更加健壮、灵活!

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
composer是什么插件
composer是什么插件

Composer是一个PHP的依赖管理工具,它可以帮助开发者在PHP项目中管理和安装依赖的库文件。Composer通过一个中央化的存储库来管理所有的依赖库文件,这个存储库包含了各种可用的依赖库的信息和版本信息。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

154

2023.12.25

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

237

2023.09.22

java中null的用法
java中null的用法

在Java中,null表示一个引用类型的变量不指向任何对象。可以将null赋值给任何引用类型的变量,包括类、接口、数组、字符串等。想了解更多null的相关内容,可以阅读本专题下面的文章。

458

2024.03.01

数据库Delete用法
数据库Delete用法

数据库Delete用法:1、删除单条记录;2、删除多条记录;3、删除所有记录;4、删除特定条件的记录。更多关于数据库Delete的内容,大家可以访问下面的文章。

275

2023.11.13

drop和delete的区别
drop和delete的区别

drop和delete的区别:1、功能与用途;2、操作对象;3、可逆性;4、空间释放;5、执行速度与效率;6、与其他命令的交互;7、影响的持久性;8、语法和执行;9、触发器与约束;10、事务处理。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

213

2023.12.29

数据库三范式
数据库三范式

数据库三范式是一种设计规范,用于规范化关系型数据库中的数据结构,它通过消除冗余数据、提高数据库性能和数据一致性,提供了一种有效的数据库设计方法。本专题提供数据库三范式相关的文章、下载和课程。

359

2023.06.29

如何删除数据库
如何删除数据库

删除数据库是指在MySQL中完全移除一个数据库及其所包含的所有数据和结构,作用包括:1、释放存储空间;2、确保数据的安全性;3、提高数据库的整体性能,加速查询和操作的执行速度。尽管删除数据库具有一些好处,但在执行任何删除操作之前,务必谨慎操作,并备份重要的数据。删除数据库将永久性地删除所有相关数据和结构,无法回滚。

2082

2023.08.14

vb怎么连接数据库
vb怎么连接数据库

在VB中,连接数据库通常使用ADO(ActiveX 数据对象)或 DAO(Data Access Objects)这两个技术来实现:1、引入ADO库;2、创建ADO连接对象;3、配置连接字符串;4、打开连接;5、执行SQL语句;6、处理查询结果;7、关闭连接即可。

349

2023.08.31

C++ 设计模式与软件架构
C++ 设计模式与软件架构

本专题深入讲解 C++ 中的常见设计模式与架构优化,包括单例模式、工厂模式、观察者模式、策略模式、命令模式等,结合实际案例展示如何在 C++ 项目中应用这些模式提升代码可维护性与扩展性。通过案例分析,帮助开发者掌握 如何运用设计模式构建高质量的软件架构,提升系统的灵活性与可扩展性。

14

2026.01.30

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
第二十四期_PHP8编程
第二十四期_PHP8编程

共86课时 | 3.4万人学习

成为PHP架构师-自制PHP框架
成为PHP架构师-自制PHP框架

共28课时 | 2.5万人学习

第二十三期_PHP编程
第二十三期_PHP编程

共93课时 | 6.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号