模型关联查询不完全指南 · ThinkPHP官方博客

### 2018 年 11 月 24 日发布 ## 前言 ThinkPHP5的模型关联是按照面向对象的开发思想重构的，和`3.2`时代的关联模型实现和用法完全不同。因此，要掌握`5.*`的模型关联，必须要有面向对象的思想意识，重新认识新版的模型关联，这是理解和掌握模型关联的关键。掌握模型关联的关键是掌握关联的定义和查询，关联的写入完全可以用模型自身的写入来完成，而不要依赖关联写入（只有某些特殊的关联才需要单独的关联写入）。本文主要为大家尽量浅显的讲解下模型关联的查询操作和注意事项，主要指导开发者打通模型关联的使用障碍和恐惧，从而可以渐入佳境的学习模型关联。由于模型关联涉及的面比较广，没法做到面面俱到，因此本文内容不做太多深入，以免形成长篇累牍，更加详细的模型关联用法建议参考官方的《[掌握ThinkPHP5.0数据库和模型](https://www.kancloud.cn/thinkphp/master-database-and-model)》教程中的「[第八章：模型关联](https://www.kancloud.cn/thinkphp/master-database-and-model/265559)」。 ## 基本用法关联定义是第一步，如果没法正确的完成关联定义，你将不得其门而入。但其实关联的定义方法本身很简单，难点在于判断你的业务操作应该使用什么关联关系，而具体表之间的关系其实在做数据库架构设计的时候已经明确了的。关联关系通常有一个参照模型，这个参照模型我们一般称为主模型（或者当前模型），关联关系对应的模型就是关联模型，关联关系是指定义在主模型中的关联关系，有些关联关系还会设计到一个中间表的概念，但中间表不一定需要存在具体的模型。关联模型本身也是一个普通的独立模型，具备模型的所有功能。两个模型之间的关联关系就是通过关联方法来定义的。目前已经支持的关联关系如下： |模型方法|关联类型| |---|---| |`hasOne`|一对一HAS ONE| |`belongsTo`|一对一BELONGS TO| |`hasMany`|一对多 HAS MANY| |`hasManyThrough`|远程一对多 HAS MANY THROUTH| |`belongsToMany`|多对多 BELONGS TO MANY| |`morphMany`|多态一对多 MORPH MANY| |`morphTo`|多态 MORPH TO| >[info] 具体的关联定义方法可以参考官方手册，不是文本的重点，因此不做详细说明。以一个简单的博客和分类表为例，每个分类下有多个博客，这就属于一对多关联（`hasMany`），每篇博客都属于某个分类，这就是一对一关联（`blongsTo`），博客模型的`cate_id`和分类模型的`id`属性则是两个模型关联的纽带和约束。具体的关联定义如下：博客模型 ``` <?php namespace app\index\model; use think\Model; class Blog extends Model { /** * 获取博客所属的分类 */ public function cate() { return $this->belongsTo('Cate'); } } ``` 如果你的模型都在同一个命名空间下，直接使用模型名称就行，如果不在同一个命名空间下，则需要给出完整的类名，例如： ``` <?php namespace app\index\model; use think\Model; class Blog extends Model { /** * 获取博客所属的分类 */ public function cate() { return $this->belongsTo(\app\common\Cate::class); } } ``` 分类模型 ``` <?php namespace app\index\model; use think\Model; class Cate extends Model { /** * 获取分类下的所有博客信息 */ public function blogs() { return $this->hasMany('Blog'); } } ``` 当我们查询到某个博客数据的时候，可以很简单的通过模型关联获取到分类数据。 ``` // 查询博客数据 $blog = Blog::find(3); // 获取博客所属分类模型 $cate = $blog->cate; ``` 如果没有使用模型关联的设计，你必须使用下面的方法获取分类数据。 ``` // 查询博客数据 $blog = Blog::find(3); // 获取博客所属分类模型 $cate = Cate::where('id', $blog->cate_id)->find(); ``` 很明显，模型关联能够简化多个模型之间的查询，关联关系越是复杂，带来的效果更明显。需要的时候关联关系本身还可以多级嵌套，例如： ``` // 查询博客数据 $blog = Blog::find(3); // 获取作者的档案 $info = $blog->user->profile; ``` 通过模型的属性方式是获取关联模型数据的最简单的一种方式，该方式会查询满足关联条件的所有关联数据。对于一对多关联而言，如果只需要获取部分关联数据，就需要改成关联方法的调用方式，下面一个例子给出了两种方式代码的区别。 ``` $cate = Cate::find(1); // 获取当前分类下所有的博客 $blogs = $cate->blogs; // 获取当前分类的最新三条博客 $blogs = $cate->blogs() ->order('create_time', 'desc') ->limit(3) ->select(); ``` 至于具体的关联方法怎么定义，可以参考官方手册，已经给出了明确的说明，就不再多说了，这里总结一些注意事项。 ## 驼峰命名的关联方法获取关于关联定义有一个很多开发者容易混淆的地方，所有的关联方法定义必须使用首字母小写的驼峰命名规范，但在获取关联属性的时候，则推荐使用小写+下划线方式的对应属性名称，但方法调用依然是保持驼峰命名。举例说明如下： ``` <?php namespace app\index\model; use think\Model; class Cate extends Model { /** * 获取分类下的所有博客信息 */ public function currentBlogs() { return $this->hasMany('Blog'); } } ``` 关联查询代码 ``` $cate = Cate::find(1); // 获取当前分类下所有的博客 $blogs = $cate->current_blogs; // 获取当前分类的最新三条博客 $blogs = $cate->currentBlogs() ->order('create_time', 'desc') ->limit(3) ->select(); ``` ## 一个关联关系可以定义多个关联方法一个关联关系并不代表只能定义一个关联方法，我们可以为不同的查询需求定义多个不同的关联方法，以分类和博客的一对多关联关系为例，我们可以这样定义。 ``` <?php namespace app\index\model; use think\Model; class Cate extends Model { /** * 获取分类下的所有博客信息 */ public function blogs() { return $this->hasMany('Blog'); } /** * 获取分类下的最新三条博客信息 */ public function lastThreeBlog() { return $this->hasMany('Blog') ->order('create_time', 'desc') ->limit(3); } } ``` >[info] 你可以在模型关联方法中使用查询构造器完成对关联数据的条件约束，`5.1`版本的话还可以支持在关联方法中调用模型的自定义方法。可以通过下面的代码来调用不同的关联数据。 ``` $cate = Cate::find(1); // 获取当前分类下所有的博客 $blogs = $cate->blogs; // 获取当前分类的最新三条博客 $blogs = $cate->last_three_blog ``` ## 关联方法定义支持参数还是上面的需求，我们希望获取最近的N条博客数据，但希望具体多少条在查询的时候传入，这需要我们首先给关联方法增加一个参数。 ``` /** * 获取分类下的最新N条博客信息 */ public function lastBlog($number = 3) { return $this->hasMany('Blog') ->order('create_time', 'desc') ->limit($number); } ``` 查询的时候使用 ``` $cate = Cate::find(1); // 获取当前分类下最新的10条博客 $blogs = $cate->lastBlog(10)->select(); ``` ## 典型的`N+1`查询问题如果要查询3个分类，以及每个分类的博客数据，按照普通的关联查询就会产生3+1次查询，随着数据量的越来越大查询次数会越来越多，性能也会急剧下降。 ``` $cates = Cate::select([1,2,3]); foreach($cates as $cate) { $blogs = $cate->blogs; } ``` 如果查看页面Trace信息可以看到当前产生了4次查询操作。预载入查询就是为了解决这个`N+1`问题而应运而生的，我们只要把代码改成如下： ``` $cates = Cate::with(['blogs'])->select([1,2,3]); foreach($cates as $cate) { $blogs = $cate->blogs; } ``` 你会发现最终产生的查询次数为2次，事实上无论有多少分类数据，最终的查询次数都是2次，很好的解决了查询性能问题。 >[info] `with`方法支持同时指定多个关联方法，因此使用数组参数是更好的规范。 ## 预载入查询的数据筛选预载入查询的数据筛选有两种方式，第一种方式前面我们已经介绍过了，就是为该关联关系增加额外的方法定义，然后在方法里面进行查询条件的筛选，这种对于有明确的筛选需求比较有效，查询代码也比较简单。 ``` $cates = Cate::with(['last_three_blog']) ->select([1,2,3]); ``` >[info] `with`方法中的关联方法名可以是实际的关联定义方法名，也可以是关联方法名的小写+下划线转换名。第二种方式就是在预载入查询的时候通过闭包动态指定查询条件。 ``` // 给预载入查询指定筛选条件 $cates = Cate::with(['blogs' => function($query){ $query->order('create_time', 'desc')->limit(3); }])->select([1,2,3]); ``` ## 延迟预载入关联预载入查询并非是惰性的，无论最后数据是否需要使用，查询已经产生了，有些情况下，需要根据查询出来的数据来决定是否需要使用关联预载入，使用延迟预载入可以实现关联数据的惰性查询，有效提高性能，避免浪费不必要的查询。 ``` $cates = Cate::select([1,2,3]); // 使用延迟预载入查询关联数据 $cates->load('blogs'); foreach($cates as $cate) { $blogs = $cate->blogs; } ``` ## 关联统计经常会有一些对关联数据进行聚合统计的需求，框架提供了便捷的关联统计方法。 ``` $cates = Cate::withCount(['blogs']) ->select([1,2,3]); foreach($cates as $cate) { // 获取分类下的博客总数 echo $cate->blogs_count; } ``` 如果要改变默认的统计字段名称，可以改成 ``` $cates = Cate::withCount(['blogs' => 'blog_count']) ->select([1,2,3]); foreach($cates as $cate) { // 获取分类下的博客总数 echo $cate->blog_count; } ``` 也支持使用闭包方式进行统计查询的条件限制 ``` $cates = Cate::withCount(['blogs' => function($query) { $query->where('status', 1); }])->select([1,2,3]); foreach($cates as $cate) { // 获取分类下的博客总数 echo $cate->blogs_count; } ``` 除了`count`统计外，还支持`sum/max/min/avg`等聚合统计。 ``` $cates = Cate::withSum(['blogs' => 'total_read'],'read_count') ->select([1,2,3]); foreach($cates as $cate) { // 获取分类下的博客阅读总数 echo $cate->total_read; } ``` >[info] 关联统计查询用的是子查询方式，所以并不会增加额外的查询次数。 ## 关联数据输出使用了关联查询后，依然可以使用`hidden`/`visible`/`append`方法进行模型数据的输出调整。 ``` $blog = Blog::with('cate')->find(1); // 隐藏分类的部分属性 $blog->hidden(['cate' => ['remark', 'create_time', 'update_time']]) ->toArray(); ``` ## 根据关联条件查询 ``` // 查询博客超过10个的分类 $cates = Cate::has('blogs','>',10)->select(); // 查询最近3天发过博客的分类 $cates = Cate::hasWhere('blogs', function($query) { $query->whereTime('create_time', '-3 days'); })->select(); ``` 闭包里面的查询条件是关联模型的约束，如果你需要添加主模型的额外约束条件，可以单独追加使用`where`方法或者其它的查询构造器，不过要注意由于`hasWhere`方法使用的是`JOIN`查询，在查询条件中要指定别名。 ``` // 查询最近3天发过博客并且状态正常的分类按name排序 $cates = Cate::hasWhere('blogs', function($query) { $query->whereTime('create_time', '-3 days'); })->where('Cate.status', 1) ->order('Cate.name') ->select(); ``` ## 自关联如果你的模型关联到自身（例如子分类和分类的关联关系），就需要在定义关联的时候设置自关联。 ``` <?php namespace app\index\model; use think\Model; class Cate extends Model { /** * 获取分类下的所有博客信息 */ public function blogs() { return $this->hasMany('Blog'); } /** * 获取当前分类的子分类 */ public function sub() { return $this->hasMany('Cate', 'parent_id') ->selfRelation(); } } ``` 关联查询代码 ``` $cate = Cate::with('sub')->find(1); ```