
最近在开发一个 CakePHP 项目时,我遇到了一个让人头疼的问题:用户反馈不小心删除了重要数据,急需找回。同时,业务方也提出需求,希望能够保留部分已删除数据的历史记录,以便进行审计和分析。传统的 delete() 方法会直接将数据从数据库中移除,这让数据恢复变得异常困难,甚至不可能,也完全无法满足保留历史记录的需求。我尝试了手动添加 is_deleted 字段,并在每次查询时手动过滤,但这不仅增加了大量的重复代码,还很容易出错,效率低下。
Composer在线学习地址:学习地址
正当我为如何优雅地实现这一功能而苦恼时,我发现了 muffin/trash 这个 Composer 包,它简直是 CakePHP 开发者处理软删除的救星!
告别“真删除”,拥抱“软删除”
“软删除”(Soft Delete)是一种数据管理策略,它不像传统的“硬删除”那样直接从数据库中物理移除记录。相反,它通过在记录中设置一个特定的标记(通常是一个时间戳字段,如 deleted_at 或 trashed),来表示这条记录已被“删除”。这样,数据实际上仍然存在于数据库中,只是在查询时被过滤掉,不再向用户展示。
这种方式的优势显而易见:
立即学习“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.phpnamespace AppModelTable;use CakeORMTable;class UsersTable extends Table{ public function initialize(array $config): void { parent::initialize($config); // 启用 Muffin/Trash 行为 $this->addBehavior('Muffin/Trash.Trash'); }}默认情况下,
muffin/trash会查找名为deleted或trashed的可空DATETIME字段。如果你的字段名不同,例如deleted_at,你可以通过配置来指定:
AppMall应用商店
AI应用商店,提供即时交付、按需付费的人工智能应用服务
56 查看详情
![]()
// 在你的 Table 类的 initialize() 方法中$this->addBehavior('Muffin/Trash.Trash', [ 'field' => 'deleted_at']);或者,你也可以在全局的
config/bootstrap.php中进行配置:// config/bootstrap.phpuse CakeCoreConfigure;Configure::write('Muffin/Trash.field', 'deleted_at');配置完成后,当你对这个表执行
delete()操作时,muffin/trash会自动将deleted_at字段设置为当前时间,而不是真正地删除记录。同时,所有的find()查询也会自动过滤掉deleted_at字段不为NULL的记录,完美实现了软删除!更多高级用法与功能
muffin/trash不仅仅是简单地标记删除,它还提供了许多实用的功能来增强你的数据管理能力:查询被软删除的记录:
onlyTrashed():只查询被软删除的记录。$trashedUsers = $this->Users->find('onlyTrashed')->all();
withTrashed():查询所有记录,包括被软删除的。$allUsers = $this->Users->find('withTrashed')->all();恢复被软删除的记录:
restoreTrash($entity):恢复指定的被软删除记录。$trashedUser = $this->Users->find('onlyTrashed')->first();if ($trashedUser) {$this->Users->restoreTrash($trashedUser);}
cascadingRestoreTrash($entity):恢复指定记录及其所有关联的被软删除记录。永久删除记录:
如果你确实需要永久删除某条记录,可以使用
purge选项:$this->Users->delete($entity, ['purge' => true]);或者,清空所有被软删除的记录:
$this->Users->emptyTrash(); // 永久删除所有被软删除的记录级联软删除:当父级记录被软删除时,你可能希望其关联的子级记录也一并被软删除。只需在 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。它将彻底改变你处理数据删除的方式,让你的应用更加健壮、灵活!以上就是手滑不再怕!用Composer和Muffin/Trash为你的CakePHP应用实现优雅软删除的详细内容,更多请关注php中文网其它相关文章!
版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/245737.html
微信扫一扫
支付宝扫一扫