如何优雅地管理Laravel模型归档？使用joelbutcher/laravel-archivable让数据管理更轻松

在日常的 Laravel 项目开发中，数据管理是一个绕不开的话题。我们经常会遇到这样的场景：某个数据（比如一篇文章、一个商品订单）不再活跃，或者完成了其生命周期，但我们又不能彻底删除它。原因可能是需要保留历史记录、方便日后审计，或者仅仅是暂时隐藏而非永久清除。

Laravel 自带的 SoftDeletes 特性无疑是处理逻辑删除的利器，它通过一个 deleted_at 字段，让数据在数据库中依然存在，但在查询时默认被忽略。这很棒！但问题在于，“删除”和“归档”在业务逻辑上往往是两种不同的状态。例如，一个用户可能“删除了”自己的草稿，但管理员仍然可以从“归档”中查看甚至恢复它；或者，我们希望将那些已经完成、不再需要频繁操作的旧订单归档起来，而不是标记为“已删除”。

如果每次遇到归档需求，我们都手动为模型添加一个 is_archived 布尔字段或 archived_at 时间戳字段，然后手动编写全局作用域（Global Scope）、局部作用域（Local Scope）以及归档/恢复的逻辑，这不仅重复劳动，而且随着模型数量的增加，维护起来会变得异常复杂和混乱。我们渴望一种像 SoftDeletes 一样优雅、开箱即用的解决方案。

幸运的是，开源社区总能提供智慧的结晶。今天，我要向大家介绍一个非常实用的 Composer 包——joelbutcher/laravel-archivable，它正是为解决 Laravel 模型归档问题而生。

使用 Composer 轻松解决归档难题

joelbutcher/laravel-archivable 是一个轻量级的包，它通过一个 Eloquent Trait 和一些数据库迁移宏，为你的 Laravel 模型带来了强大的归档能力，而且使用方式与 SoftDeletes 异曲同工，非常符合 Laravel 的开发哲学。

第一步：安装包

首先，通过 Composer 将其安装到你的项目中：

<code class="bash">composer require joelbutcher/laravel-archivable</code>

第二步：数据库迁移

安装完成后，我们需要为需要归档的模型添加一个 archived_at 字段。这个包提供了一个方便的宏，让你可以像使用 timestamps() 或 softDeletes() 一样简单地添加它：

<pre class="brush:php;toolbar:false;">// database/migrations/xxxx_xx_xx_create_posts_table.php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

class CreatePostsTable extends Migration
{
    public function up()
    {
        Schema::create('posts', function (Blueprint $table) {
            $table->id();
            $table->unsignedBigInteger('user_id');
            $table->string('title');
            $table->text('content');
            $table->timestamps();
            $table->archivedAt(); // 优雅地添加归档时间戳字段
        });
    }

    public function down()
    {
        Schema::dropIfExists('posts');
    }
}

如果你需要回滚迁移，同样也有对应的宏：

<pre class="brush:php;toolbar:false;">Schema::table('posts', function (Blueprint $table) {
    $table->dropArchivedAt();
});

第三步：在模型中使用 Trait

接下来，在你的 Eloquent 模型中引入 Archivable Trait：

<pre class="brush:php;toolbar:false;">// app/Models/Post.php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use LaravelArchivable\Archivable; // 引入 Archivable Trait

class Post extends Model
{
    use Archivable; // 使用 Trait

    protected $fillable = ['user_id', 'title', 'content'];
    // ...
}

就这样，你的 Post 模型现在已经具备了归档能力！

第四步：使用归档功能

joelbutcher/laravel-archivable 提供了一系列直观的方法和查询作用域，让你可以轻松地管理模型的归档状态：

Skybox AI

一键将涂鸦转为360°无缝环境贴图的AI神器

140

查看详情

1. 归档和恢复模型实例：

<pre class="brush:php;toolbar:false;">use App\Models\Post;

$post = Post::find(1);

// 归档一篇文章
$post->archive(); // archived_at 字段会被设置为当前时间

// 恢复已归档的文章
$post->unArchive(); // archived_at 字段会被设置为 null

2. 检查模型归档状态：

<pre class="brush:php;toolbar:false;">$post = Post::find(1);

if ($post->isArchived()) {
    echo "这篇文章已归档。";
} else {
    echo "这篇文章未归档。";
}

3. 查询不同归档状态的数据：

默认情况下，Archivable Trait 会自动应用一个全局作用域，只查询未归档的数据，这与 SoftDeletes 的行为一致。

• 获取所有未归档的文章 (默认行为):

<code class="php">$activePosts = Post::all(); // 默认不包含已归档的文章</code>

• 获取包含已归档的所有文章：

<code class="php">$allPosts = Post::withArchived()->get(); // 包含未归档和已归档的文章</code>

• 只获取已归档的文章：

<code class="php">$archivedPosts = Post::onlyArchived()->get(); // 只获取已归档的文章</code>

• 获取所有未归档的文章 (显式调用，与默认行为相同):

<code class="php">$unarchivedPosts = Post::withoutArchived()->get(); // 明确只获取未归档的文章</code>

这些查询作用域让你可以非常灵活地控制数据检索，满足各种业务需求。

总结其优势和实际应用效果

使用 joelbutcher/laravel-archivable 带来了诸多显著优势：

1. 代码简洁性与一致性： 告别手动编写 is_archived 字段、作用域和逻辑的繁琐，只需简单地 use Archivable; 即可获得一套完整的归档解决方案，极大地提升了开发效率和代码的可读性。
2. 与 SoftDeletes 完美区分： 提供了独立的归档机制，与逻辑删除互不干扰，满足了业务中“删除”与“归档”两种不同状态的精细化管理需求。
3. 强大的查询灵活性： withArchived(), onlyArchived(), withoutArchived() 等查询作用域让你可以轻松地筛选和获取不同归档状态的数据，无论是展示给用户、管理后台操作还是进行数据分析，都游刃有余。
4. 易于维护和扩展： 统一的归档接口降低了维护成本和出错率。当有新的模型需要归档功能时，只需简单的几步操作即可完成集成。
5. 符合 Laravel 哲学： 通过 Trait 和宏的方式实现，与 Laravel 自身的设计风格高度契合，让开发者感到熟悉和舒适。

实际应用效果：

在一个电商平台中，你可以将已经售罄、下架或不再活跃的商品归档，而不是直接删除。这样，用户在前端看不到这些商品，但管理员可以随时通过后台查看历史商品数据，甚至在需要时将其恢复上架。

在内容管理系统（CMS）中，可以将一些过时、但仍有参考价值的旧文章或已审核但不再需要在首页展示的文章进行归档。这不仅能保持数据库的“清洁”，避免数据冗余，还能确保重要历史数据的完整性。

总而言之，joelbutcher/laravel-archivable 是一个非常值得推荐的 Laravel 包，它以优雅的方式解决了模型归档的痛点。如果你正在寻找一个简单、高效且与 Laravel 生态无缝集成的归档解决方案，那么它绝对是你的不二之选。

以上就是如何优雅地管理Laravel模型归档？使用joelbutcher/laravel-archivable让数据管理更轻松的详细内容，更多请关注php中文网其它相关文章！