Laravel多对多关系实现用户互赞匹配

本文探讨了在 Laravel 中构建类似 Tinder 的互赞匹配功能时，如何正确定义多对多关系。针对常见的 `matches` 关系返回空数组的问题，我们分析了在关系定义中使用已加载模型数据的局限性，并提供了一种基于数据库连接（JOIN）的解决方案，确保在预加载时也能准确获取互赞用户列表，并提供了迁移和数据填充的最佳实践。

1. 问题背景：多对多关系中获取互赞匹配的挑战

在构建社交应用，特别是像 Tinder 这样的匹配系统时，一个核心功能是识别出那些相互喜欢的用户。在 Laravel 中，这通常通过定义多对多关系来实现。然而，开发者在尝试定义一个 matches 关系来获取互赞用户时，可能会遇到返回空数组的问题，即使数据表明存在互赞记录。

假设我们有一个 users_users_liked 枢纽表来记录用户之间的“喜欢”行为：

Schema::create('users_users_liked', function (Blueprint $table) {
    $table->increments('id');
    $table->unsignedInteger('user_id')->index();
    $table->foreign('user_id')->references('id')->on('users')->onDelete('cascade')->onUpdate('cascade');
    $table->unsignedInteger('user_liked_id')->nullable()->index();
    $table->foreign('user_liked_id')->references('id')->on('users')->onDelete('cascade')->onUpdate('cascade');
    $table->timestamps();
});

在 User 模型中，我们可能定义了 likesToUsers（我喜欢谁）和 likesFromUsers（谁喜欢我）两个关系：

// User.php
public function likesToUsers()
{
    return $this->belongsToMany(self::class, 'users_users_liked', 'user_id', 'user_liked_id');
}

public function likesFromUsers()
{
    return $this->belongsToMany(self::class, 'users_users_liked', 'user_liked_id', 'user_id');
}

然后，为了获取互赞匹配，一种直观但错误尝试的 matches 关系定义可能如下：

public function matches()
{
    return $this->likesFromUsers()->whereIn('user_id', $this->likesToUsers->keyBy('id'));
}

当尝试使用 User::with('matches')->findOrFail(1); 预加载匹配用户时，matches 数组通常会返回空。这背后的原因主要有两点：

1. keyBy('id') 的使用不当： whereIn 方法期望接收一个 ID 数组作为其第二个参数。然而，$this->likesToUsers->keyBy('id') 返回的是一个以 ID 为键、模型实例为值的集合。正确的做法应该是使用 pluck('id') 来获取纯 ID 数组。
2. 关系定义中依赖已加载模型数据： 更根本的问题在于，在关系定义中直接调用 $this->likesToUsers 试图访问一个尚未被加载（或在当前查询上下文中不可用）的关系的已加载数据。当 Laravel 尝试预加载 matches 关系时，它构建的是一个数据库查询，而不是在每个模型实例上执行 PHP 逻辑。这意味着 $this->likesToUsers 在构建 matches 关系的预加载查询时是无法有效提供数据的，尤其是在批量预加载多个用户时，它无法为每个用户动态地构建正确的查询条件。

2. 解决方案：利用数据库连接（JOIN）实现互赞匹配

解决上述问题的关键在于，将互赞匹配的逻辑转换成纯粹的数据库查询操作，而不是依赖于 PHP 中已加载的模型数据。通过自连接枢纽表，我们可以有效地找到相互喜欢的记录。

以下是正确定义 matches 关系的方法：

belongsToMany(self::class, 'users_users_liked', 'user_id', 'user_liked_id');
    }

    public function likesFromUsers()
    {
        return $this->belongsToMany(self::class, 'users_users_liked', 'user_liked_id', 'user_id');
    }

    /**
     * 获取互赞匹配的用户。
     */
    public function matches()
    {
        return $this->likesFromUsers()
            ->join('users_users_liked as alt_users_users_liked', function (JoinClause $join) {
                $join
                    ->whereColumn('users_users_liked.user_liked_id', 'alt_users_users_liked.user_id')
                    ->whereColumn('users_users_liked.user_id', 'alt_users_users_liked.user_liked_id');
            });
    }
}

代码解析：

1. $this->likesFromUsers()： 这建立了获取“谁喜欢我”的基础查询。在内部，它已经将 users 表与 users_users_liked 枢纽表进行了连接。
2. join('users_users_liked as alt_users_users_liked', ...)： 这是核心步骤。我们将 users_users_liked 枢纽表再次连接到当前查询中，并为其指定一个别名 alt_users_users_liked。这样我们就可以在同一个查询中引用枢纽表的两个不同“视图”。
3. function (JoinClause $join)： 这是一个闭包，用于定义连接条件。
   • $join->whereColumn('users_users_liked.user_liked_id', 'alt_users_users_liked.user_id')： 这个条件确保了第一个连接（由 likesFromUsers 隐式创建）中“被喜欢用户”的 ID 等于第二个连接中“喜欢用户”的 ID。这表示“当前用户 A 喜欢了用户 B”。
   • $join->whereColumn('users_users_liked.user_id', 'alt_users_users_liked.user_liked_id')： 这个条件确保了第一个连接中“喜欢用户”的 ID 等于第二个连接中“被喜欢用户”的 ID。这表示“用户 B 喜欢了当前用户 A”。

通过这两个 whereColumn 条件的组合，我们有效地筛选出了那些在 users_users_liked 表中存在互逆记录的条目，从而准确地找到了互赞匹配的用户。这种方法将复杂的逻辑直接下推到数据库层面，确保了预加载的正确性和效率。

3. 数据库迁移和数据填充的最佳实践

除了正确的模型关系定义，优化数据库迁移和数据填充也是构建健壮应用的重要组成部分。

3.1 简化枢纽表迁移

Laravel 提供了 foreignId() 方法，可以极大简化外键的定义，并能链式调用 constrained()、cascadeOnDelete()、cascadeOnUpdate() 等方法。

优化后的 users_users_liked 迁移文件可以这样定义：

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

class CreateUsersUsersLikedTable extends Migration
{
    public function up()
    {
        Schema::create('users_users_liked', function (Blueprint $table) {
            $table->id(); // 使用 id() 替代 increments('id')
            $table->foreignId('user_id')->constrained()->cascadeOnDelete()->cascadeOnUpdate();
            $table->foreignId('user_liked_id')->constrained('users')->cascadeOnDelete()->cascadeOnUpdate();
            $table->timestamps();
        });
    }

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

• $table->id()：是 $table->bigIncrements('id') 的别名，通常更推荐使用。
• $table->foreignId('user_id')->constrained()：会自动猜测关联的表名（此处为 users 表）和列名（id）。
• $table->foreignId('user_liked_id')->constrained('users')：如果列名与表名不符（例如，user_liked_id 关联到 users 表的 id 列），可以明确指定关联表名。

3.2 添加唯一约束

为了防止在枢纽表中出现重复的“喜欢”记录（即用户 A 喜欢用户 B 的记录出现多次），强烈建议为 user_id 和 user_liked_id 的组合添加唯一约束。

Schema::create('users_users_liked', function (Blueprint $table) {
    $table->id();
    $table->foreignId('user_id')->constrained()->cascadeOnDelete()->cascadeOnUpdate();
    $table->foreignId('user_liked_id')->constrained('users')->cascadeOnDelete()->cascadeOnUpdate();
    $table->timestamps();

    // 添加唯一约束
    $table->unique(['user_id', 'user_liked_id']);
});

这个唯一约束确保了任何一对 (user_id, user_liked_id) 在表中只能出现一次。

3.3 数据填充（Seeding）优化

在开发和测试环境中，使用 Laravel 的模型工厂（Model Factories）是生成大量测试数据的更专业和灵活的方式，而不是手动编写复杂的 attach 逻辑。模型工厂允许你定义模型属性的默认状态，并轻松创建具有特定关系的模型实例。

虽然这与解决关系定义问题不直接相关，但它是一种推荐的数据填充实践，值得在教程中提及。

4. 总结

在 Laravel 中处理复杂的多对多关系，特别是需要基于枢纽表中的互逆条件进行筛选时，理解关系定义的工作原理至关重要。避免在关系定义中依赖已加载的模型数据，而是将复杂的逻辑下推到数据库层面，通过 join 和 whereColumn 等方法构建高效的 SQL 查询，是解决此类问题的最佳实践。

通过本文介绍的基于数据库连接的 matches 关系定义，结合 foreignId() 简化迁移和添加唯一约束等最佳实践，开发者可以构建出更健壮、高效且易于维护的 Laravel 应用程序。