记一次Laravel中with()方法事故 | 指尖的彩虹

link管理

链接快照平台

输入网页链接，自动生成快照
标签化管理网页链接

`get()` 方法

在看下最后执行的 get() 方法还是在上面的同一个文件中

/**
 * Execute the query as a "select" statement.
 * 将查询作为 select 语句执行
 * @param  array  $columns
 * @return \Illuminate\Database\Eloquent\Collection|static[]
 */
public function get($columns = ['*'])
{
    $builder = $this->applyScopes();
    // If we actually found models we will also eager load any relationships that
    // have been specified as needing to be eager loaded, which will solve the
    // n+1 query issue for the developers to avoid running a lot of queries.
    // 主要就是讲为了避免 n+1 查询问题 会去加载需要预加载的关联模型
    // 下面的count 里是 \Illuminate\Database\Eloquent\Model[] 的模型数组 基本命中了都会大于0
    // 然后执行 eagerLoadRelations() 方法
    if (count($models = $builder->getModels($columns)) > 0) {
        $models = $builder->eagerLoadRelations($models);
    }
    return $builder->getModel()->newCollection($models);
}

下面看 eagerLoadRelations() 方法还是同一个文件

/**
 * Eager load the relationships for the models.
 *
 * @param  array  $models
 * @return array
 */
public function eagerLoadRelations(array $models)
{
	// 从上面的测试中 此时 $this->eagerLoad 应该是 ['servant' => function() {}]
    foreach ($this->eagerLoad as $name => $constraints) {
        // For nested eager loads we'll skip loading them here and they will be set as an
        // eager load on the query to retrieve the relation so that they will be eager
        // loaded on that query, because that is where they get hydrated as models.
        // 如果key 里没有 . 就去执行  eagerLoadRelation() 方法
        if (strpos($name, '.') === false) {
            $models = $this->eagerLoadRelation($models, $name, $constraints);
        }
    }
    return $models;
}

下面看 eagerLoadRelation() 方法的实现还是同一个文件

/**
 * Eagerly load the relationship on a set of models.
 *
 * @param  array  $models
 * @param  string  $name
 * @param  \Closure  $constraints
 * @return array
 */
protected function eagerLoadRelation(array $models, $name, Closure $constraints)
{
    // First we will "back up" the existing where conditions on the query so we can
    // add our eager constraints. Then we will merge the wheres that were on the
    // query back to it in order that any where conditions might be specified.
    // 获取关联关系对应的方法 也就是 servant()了
    $relation = $this->getRelation($name);
	// 给关联关系设置约束 传递进去的是查询全部数据的 \Illuminate\Database\Eloquent\Collection 对象数组 也就是全部数据了
    // 这是一个抽象方法需要各自去实现
    $relation->addEagerConstraints($models);
	// 放到闭包执行 然后原来的空闭包就变成了类似下面这样
    // function(Relation $query) {
    //    
    // };
    $constraints($relation);
    // Once we have the results, we just match those back up to their parent models
    // using the relationship instance. Then we just return the finished arrays
    // of models which have been eagerly hydrated and are readied for return.
    // 大概就是说一旦获取到结果 我们可以和父模型进行匹配 把对应的结果设置到关联中 然后返回完整的模型数组
    // 在简单点就是把关联匹配的数据分别根据主表关联的字段（比如id）然后对应设置到主表Collection对象中关联的key上 也就是上面的servant
    return $relation->match(
        $relation->initRelation($models, $name),
        $relation->getEager(), $name
    );
}
// 然后是一对多关联 hasMany()方法最终继承自 HasOneOrMany 类 在文件 `\vendor\laravel\framework\src\Illuminate\Database\Eloquent\Relations\HasOneOrMany.php` 看下它的实现
/**
 * Set the constraints for an eager load of the relation.
 *
 * @param  array  $models
 * @return void
 */
public function addEagerConstraints(array $models)
{
	// 就是使用了一个wherein查询 查询的值是从上面传递进来的所有数据的集合中取出关联的lcoalKey(也就是设置hasMany中的localKey 所以是id)
    // 对应本例子就是 wherein('master_id', [1, 2]);
    $this->query->whereIn(
        $this->foreignKey, $this->getKeys($models, $this->localKey)
    );
}
// 上面的match()方法最终执行到了这里
/**
 * Match the eagerly loaded results to their many parents.
 *
 * @param  array   $models
 * @param  \Illuminate\Database\Eloquent\Collection  $results
 * @param  string  $relation
 * @param  string  $type
 * @return array
 */
protected function matchOneOrMany(array $models, Collection $results, $relation, $type)
{
    $dictionary = $this->buildDictionary($results);
    // Once we have the dictionary we can simply spin through the parent models to
    // link them up with their children using the keyed dictionary to make the
    // matching very convenient and easy work. Then we'll just return them.
    foreach ($models as $model) {
        if (isset($dictionary[$key = $model->getAttribute($this->localKey)])) {
            $model->setRelation(
                $relation, $this->getRelationValue($dictionary, $key, $type)
            );
        }
    }
    return $models;
}

好了一通设置后最终返回了 \Illuminate\Database\Eloquent\Collection 对象数组这个很熟悉了吧走到这里每个master下都设置上了一个名为 servant 的属性其值对应的是 Collection(Servant) ，所以后续的操作比如直接取出关联子表中的属性其实都是从这里直接取出，并不会去查询数据库了

预加载SQL执行过程

讲完了底层实现，下面看下执行过程中到底都执行了什么SQL。为了方便看结果直接使用 Laravel-debugbar 来监测

1.加载全部

1
2
3

$masters = Master::with('servant')->get();
// select * from `master`
// select * from `servant` where `servant`.`master_id` in (1, 2)

2.给关联增加条件

$masters = Master::with(['servant' => function($query) {
    $query->select('id', 'master_id', 'name', 'level')->orderBy('level', 'DESC');
}])->get();
// select * from `master`
// select `id`, `master_id`, `name`, `level` from `servant` where `servant`.`master_id` in (1, 2) order by `level` desc

其实增加条件过滤、筛选字段过滤、排序等都不影响。其最终只会执行2条SQL

3.给关联设置first()

$masters = Master::with(['servant' => function($query) {
    $query->select('id', 'master_id', 'name', 'level')->orderBy('level', 'ASC')->first();
}])->get();
// select * from `mi_master`
// select `id`, `master_id`, `name`, `level` from `mi_servant` where `mi_servant`.`master_id` in (1, 2) order by `level` asc limit 1
// select `id`, `master_id`, `name`, `level` from `mi_servant` where `mi_servant`.`master_id` in (1, 2) order by `level` asc limit 1

这个时候他查询的都是同一条SQL。因为根据源码分析他最后的关联是使用了 wherein(关联字段, [所有主表关联主键的数组]) 这种形式来设置约束条件所有执行的都是同一条SQL。（PS：上面为什么是in(1, 2) 因为我只有2条测试数据，关联主键分别是1 和 2 如果你有3条记录主键分别是 5 6 7 那他就是in(5, 6, 7)了）。

正常来说会在执行 get() 的时候发生2条SQL查询一条是查询全部的一条是根据全部的id查询匹配条件的，总共2条SQL

为什么会变成3条SQL呢，因为在 eagerLoadRelation() 中 $constraints($relation); 这里把同一个 Relation 传进了闭包然后在外面执行 $query->select('id', 'master_id', 'name', 'level')->orderBy('level', 'ASC')->first(); 会多一次查询出来查询内容是一样的。

然后 first() 会使用 limit 1 来过滤结果所以最终查询到的子结果只有一条，然后在给Master设置属性的时候会有一个关联条件的匹配，而限制了只有一条基本只会命中一个Master的ID了，所以造成了最终的结果中有些有关联属性有些却为空

解决办法

一种就是先给主表查询全部（或者按指定条件查询主表），然后在用到的子表数据的时候去动态属性的形式来加载出子表的数据

$masters = Master::get();
foreach ($masters as $key => $val) {
    $servant = $val->servant()->select('id', 'master_id', 'name', 'level')->orderBy('level', 'DESC')->first();
    dd($servant->toArray());
}

不过这样会造成一个问题就是每天子表数据取出来都会有一次查询产生

第二种办法就是查询的时候只按需要条件过滤然后在取数据的时候自己去获取需要的数据如下

$masters = Master::with(['servant' => function($query) {
    $query->select('id', 'master_id', 'name', 'level')->orderBy('level', 'DESC');
}])->get();
foreach ($masters as $key => $val) {
    // ...
}

创建测试数据

一对多关联

预加载 `with()` 方法

`get()` 方法

预加载SQL执行过程

解决办法

创建测试数据

一对多关联

预加载 with() 方法

get() 方法

预加载SQL执行过程

解决办法

预加载 `with()` 方法

`get()` 方法