Laravel用户模型获取跨库关联国家数据时报返回类型不匹配错误

• 访问器的返回类型声明错误。你定义getCountryIdAttribute方法的返回值类型为?Illuminate\Database\Query\Builder，但实际代码返回的是Country模型实例或null，类型不匹配直接触发了返回值类型错误。
• 访问器使用逻辑不符合需求。你需要的是新增country嵌套对象字段，而非覆盖原有country_id字段的取值，修改country_id的访问器会破坏原有字段的正常功能。
• Country模型配置错误。你在$attributes属性中定义了字段列表，该属性的作用是设置模型的默认属性值，不是声明表字段，配置错误可能引发额外问题。
• 手动写查询的方式容易产生N+1性能问题，每次读取用户数据都会单独发起一次国家表查询，不如Laravel原生的关联关系规范高效。

步骤1：修正Country模型配置 #

删除错误的$attributes配置，修正后代码如下：

use Illuminate\Database\Eloquent\Model;

class Country extends Model
{
    /**
     * The database connection that should be used by the model.
     *
     * @var string
     */
    protected $connection = 'my second db connection name';

    /**
     * The table associated with the model.
     *
     * @var string
     */
    protected $table = 'countries';

    /**
     * The primary key associated with the table.
     *
     * @var string
     */
    protected $primaryKey = 'id';
}

步骤2：在User模型中定义关联关系（推荐方案，无N+1问题） #

删除你之前写的getCountryIdAttribute访问器，新增country关联方法，同时配置隐藏不需要的country_id字段：

// User模型中新增代码
public function country()
{
    return $this->belongsTo(Country::class, 'country_id');
}

// 配置序列化时隐藏country_id字段
protected $hidden = ['country_id'];

步骤3：查询用户时预加载关联 #

查询用户数据时使用with方法预加载country关联，即可直接得到符合要求的返回格式：

// 查询示例
$user = User::with('country')->find($userId);
// 直接返回$user即可得到包含嵌套country对象的响应

可选方案：使用访问器实现（不推荐，存在N+1性能问题） #

如果一定要用访问器实现，需要修改访问器名称、返回类型，同时配置追加字段：

// User模型中新增代码
public function getCountryAttribute(): ?Country
{
    return Country::where('id', $this->country_id)->first();
}

// 配置序列化时追加country字段、隐藏country_id字段
protected $appends = ['country'];
protected $hidden = ['country_id'];

内容的提问来源于stack exchange，提问作者Omar Fayad