Laravel 模型(Model) 关联(eloquent-relationships) 查询未找到值返回默认值 作者: Chuwen 时间: 2023-05-29 分类: Laravel 评论 ## Laravel 模型关联查询未找到值返回默认值 在实际业务中，经常会用到模型关联查询，但是有时候关联的那个模型在数据库中不存在，则会返回 null，如果你再去判断是否为 null 逻辑就很复杂，下面给出一个现实中的常见一个例子 假设有 2 个模型，`User::class` 和 `UserConfig::class` **User::class** ```php <?php namespace App\Models; /** * \App\Models\User * * @property int $id * @property string $username * ... 省略部分属性 * * @property-read \App\Models\UserConfig|null $config */ class User extends Model { protected $table = "users"; public function config() { return $this->hasOne(\App\Models\UserConfig::class, 'uid', 'id'); } } ``` **UserConfig::class** ```php <?php namespace App\Models; /** * \App\Models\UserConfig * * @property int $id * @property int $uid * @property array $locales * ... 省略部分属性 */ class UserConfig extends Model { protected $table = "config"; } ``` 示例代码： ```php $uid = 1; $userM = User::findOrFail($uid); return [ // 如果关联的 config 模型查找不到值，就会报错 'locales' => $userM->config->locales ]; ``` ## 解决方法 [翻阅文档](https://laravel.com/docs/10.x/eloquent-relationships#default-models)发现有这样一个方法 `withDefault()` 官方文档的解释： > The belongsTo, hasOne, hasOneThrough, and morphOne relationships allow you to define a default model that will be returned if the given relationship is null. This pattern is often referred to as the Null Object pattern and can help remove conditional checks in your code. In the following example, the user relation will return an empty App\Models\User model if no user is attached to the Post model: > > 机器翻译成中文： > >> 如果给定的关系为空，则可以定义默认模型。这种模式通常称为 `空对象模式`，可以帮助删除代码中的条件检查。在以下示例中，如果没有用户附加到Post模型，用户关系将返回一个空的App\Models\User模型： 用法很简单，只需要在 `hasOne` 末尾加上 `->withDefault()` 方法，然后在 `UserConfig::class` 的 `$attributes` 属性写上默认值即可 **User::class** ```php <?php namespace App\Models\Admin; /** * \App\Models\User * * @property int $id * @property string $username * ... 省略部分属性 * * @property-read \App\Models\UserConfig|null $config */ class User extends Model { protected $table = "users"; public function config() { return $this->hasOne(\App\Models\UserConfig::class, 'uid', 'id')->withDefault(); } } ``` **UserConfig::class** ```php <?php namespace App\Models; /** * \App\Models\UserConfig * * @property int $id * @property int $uid * @property array $locales * ... 省略部分属性 */ class UserConfig extends Model { protected $table = "config"; protected $attributes = [ 'locales' => ['en'] ]; } ``` ```php $uid = 1; $userM = User::findOrFail($uid); return [ // 如果关联的 config 模型查找不到值，就会返回默认值 ['en'] 'locales' => $userM->config->locales ]; ```