Laravel中PivotModel继承Pivot如何获取关联数据及用户角色关联查询

嘿，我来帮你理清Laravel里自定义Pivot模型的这些问题，都是实际开发中经常碰到的场景，咱们一步步拆解：

首先，你得先确保在多对多关联中指定使用自定义的Pivot模型。假设咱们的中间表是user_role，自定义的Pivot模型叫UserRole，继承自Illuminate\Database\Eloquent\Relations\Pivot。

第一步，在关联模型（比如User和Role）的belongsToMany方法里，用using()指定这个自定义Pivot模型：

// User模型
public function roles()
{
    return $this->belongsToMany(Role::class)->using(UserRole::class);
}

// Role模型
public function users()
{
    return $this->belongsToMany(User::class)->using(UserRole::class);
}

接下来，如果你想通过Pivot模型获取关联数据（比如中间表关联了其他模型，或者你想直接从Pivot模型本身关联到User/Role），只需要在UserRole模型里定义对应的关联方法就行：

// UserRole模型
class UserRole extends Pivot
{
    // 如果中间表不是默认的蛇形命名，需要指定表名
    protected $table = 'user_role';

    // 关联到User模型
    public function user()
    {
        return $this->belongsTo(User::class);
    }

    // 关联到Role模型
    public function role()
    {
        return $this->belongsTo(Role::class);
    }

    // 如果有其他关联，比如中间表关联了操作日志，也可以在这里定义
    // public function operationLog()
    // {
    //     return $this->hasOne(OperationLog::class);
    // }
}

现在，你就可以通过两种方式获取关联数据：

• 从关联模型的pivot属性获取：比如拿到一个User实例后，$user->roles->first()->pivot->user就能拿到对应的用户（当然这个例子有点冗余，实际更多是拿其他关联，比如上面的日志）
• 直接查询自定义Pivot模型并预加载关联：UserRole::with('user', 'role')->get()，这样就能一次性拿到所有中间表数据及其关联的用户和角色。

咱们分三步来实现：

1. 创建并配置自定义Pivot模型 #

先创建UserRole模型，继承Pivot，并定义与User的关联：

namespace App\Models;

use Illuminate\Database\Eloquent\Relations\Pivot;

class UserRole extends Pivot
{
    protected $table = 'user_role'; // 如果表名是默认的user_roles可以省略，这里假设是user_role

    // 建立与User模型的关联
    public function user()
    {
        return $this->belongsTo(User::class);
    }

    // 顺便也定义与Role的关联，方便后续使用
    public function role()
    {
        return $this->belongsTo(Role::class);
    }
}

2. 在User和Role模型中指定使用该Pivot模型 #

修改User和Role的多对多关联方法，添加using()指定自定义Pivot：

// User模型
public function roles()
{
    return $this->belongsToMany(Role::class)
                ->using(UserRole::class)
                ->withPivot('created_at', 'updated_at'); // 如果中间表有额外字段，用withPivot包含，方便获取
}

// Role模型
public function users()
{
    return $this->belongsToMany(User::class)
                ->using(UserRole::class)
                ->withPivot('created_at', 'updated_at');
}

3. 实现查询role_id=1的PivotModel及其关联用户数据的方法 #

这里有两种常用的实现方式，按需选择：

方式一：直接查询自定义Pivot模型（推荐，查询效率更高） #

直接从UserRole模型出发，预加载user关联，然后筛选role_id=1：

// 可以写在控制器或者专门的Repository里
public function getRole1UserPivots()
{
    // 预加载user，避免N+1查询
    $userRolePivots = UserRole::with('user')
                               ->where('role_id', 1)
                               ->get();

    // 遍历结果，每个实例都是UserRole，自带关联的user
    foreach ($userRolePivots as $pivot) {
        echo "用户ID：{$pivot->user->id}，用户名：{$pivot->user->name}，关联时间：{$pivot->created_at}";
    }

    return $userRolePivots;
}

方式二：通过Role模型间接获取 #

先找到role_id=1的角色，再预加载关联的用户（包含pivot数据）：

public function getRole1UserPivots()
{
    $role = Role::with('users') // 预加载用户，同时会自动加载pivot
                ->find(1);

    // 这里的$role->users是User实例集合，每个user的pivot属性就是UserRole实例
    foreach ($role->users as $user) {
        $pivot = $user->pivot;
        echo "用户ID：{$user->id}，用户名：{$user->name}，关联时间：{$pivot->created_at}";
    }

    // 如果只想拿到pivot集合，可以这样
    $pivotCollection = $role->users->pluck('pivot');

    return $pivotCollection;
}

内容的提问来源于stack exchange，提问作者Al-Amin