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

Composer在线学习地址：学习地址

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

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

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

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

立即学习“PHP免费学习笔记（深入）”；

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

使用 Composer 引入 muffin/trash

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

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

<code class="bash">composer require muffin/trash</code>

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

<code class="bash">bin/cake plugin load Muffin/Trash</code>

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

<code class="php">$this->addPlugin('Muffin/Trash');</code>

轻松配置，即刻生效

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

<pre class="brush:php;toolbar:false;">// 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 会查找名为 deleted 或 trashed 的可空 DATETIME 字段。如果你的字段名不同，例如 deleted_at，你可以通过配置来指定：

燕雀Logo

为用户提供LOGO免费设计在线生成服务

101

查看详情

<pre class="brush:php;toolbar:false;">// 在你的 Table 类的 initialize() 方法中
$this->addBehavior('Muffin/Trash.Trash', [
    'field' => 'deleted_at'
]);

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

<pre class="brush:php;toolbar:false;">// 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()：只查询被软删除的记录。

     <code class="php">$trashedUsers = $this->Users->find('onlyTrashed')->all();</code>

     登录后复制
   • withTrashed()：查询所有记录，包括被软删除的。

     <code class="php">$allUsers = $this->Users->find('withTrashed')->all();</code>

     登录后复制

2. 恢复被软删除的记录：

   • restoreTrash($entity)：恢复指定的被软删除记录。

     <pre class="brush:php;toolbar:false;">$trashedUser = $this->Users->find('onlyTrashed')->first();
     if ($trashedUser) {
     $this->Users->restoreTrash($trashedUser);
     }

     登录后复制
   • cascadingRestoreTrash($entity)：恢复指定记录及其所有关联的被软删除记录。

3. 永久删除记录：

   • 如果你确实需要永久删除某条记录，可以使用 purge 选项：

     <code class="php">$this->Users->delete($entity, ['purge' => true]);</code>

     登录后复制
   • 或者，清空所有被软删除的记录：

     <code class="php">$this->Users->emptyTrash(); // 永久删除所有被软删除的记录</code>

     登录后复制

4. 级联软删除： 当父级记录被软删除时，你可能希望其关联的子级记录也一并被软删除。只需在 Table 关系中设置 'dependent' => true, 'cascadeCallbacks' => true，并确保 muffin/trash 行为也附加到子级 Table 类上即可。

   <pre class="brush:php;toolbar:false;">// 在父级 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中文网其它相关文章！