在Laravel中为BelongsTo关联启用模型类型检查

问题场景 #

现有User、Post、Comment三个模型，关联关系定义如下：

User模型 #

class User extends Model
{
    public function posts(): HasMany
    {
        return $this->hasMany(Post::class);
    }
}

Comment模型 #

class Comment extends Model
{
    public function post(): BelongsTo
    {
        return $this->belongsTo(Post::class);
    }
}

Post模型 #

class Post extends Model
{
    /**
     * Get the comments for the blog post.
     */
    public function comments(): HasMany
    {
        return $this->hasMany(Comment::class);
    }
}

正常关联Post到Comment时执行：

$comment->post()->associate($post);

但如果误传入User模型：

$comment->post()->associate($user);

Laravel不会校验模型类型，会直接将与User同ID的Post关联到Comment，导致不符合预期的结果。需要实现关联前的模型类型校验机制。

解决方案 #

方法一：自定义关联类重写associate方法 #

创建自定义TypedBelongsTo关联类，继承原生BelongsTo并添加类型校验逻辑：

use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Model;

class TypedBelongsTo extends BelongsTo
{
    public function associate($model)
    {
        if (!($model instanceof $this->related)) {
            throw new \InvalidArgumentException(
                "Expected instance of {$this->related}, got " . get_class($model)
            );
        }

        return parent::associate($model);
    }
}

在Comment模型中使用该自定义关联替代原生belongsTo：

class Comment extends Model
{
    public function post(): TypedBelongsTo
    {
        return new TypedBelongsTo(
            Post::query(),
            $this,
            'post_id',
            'id',
            'post'
        );
    }
}

此后传入错误类型模型时，会直接抛出InvalidArgumentException，阻止错误关联操作。

方法二：全局启用类型校验 #

创建模型基类，重写belongsTo方法统一返回自定义关联类，让所有模型继承该基类即可全局生效：

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;

class BaseModel extends Model
{
    public function belongsTo($related, $foreignKey = null, $ownerKey = null, $relation = null)
    {
        $relation = parent::belongsTo($related, $foreignKey, $ownerKey, $relation);
        
        if ($relation instanceof BelongsTo) {
            return new TypedBelongsTo(
                $relation->getQuery(),
                $relation->getParent(),
                $relation->getForeignKeyName(),
                $relation->getOwnerKeyName(),
                $relation->getRelationName()
            );
        }

        return $relation;
    }
}

方法三：IDE静态校验辅助 #

在关联方法注释中添加类型提示，让IDE在编码阶段提前发现错误：

class Comment extends Model
{
    /**
     * @return BelongsTo<Post>
     */
    public function post(): BelongsTo
    {
        return $this->belongsTo(Post::class);
    }
}

该方法无法在运行时阻止错误，但能大幅降低编码阶段的误操作概率。

内容的提问来源于stack exchange，提问作者MOHAMMAD RASIM