Laravel Eloquent 关联模型计数：高效统计分类下文章数量

本文旨在指导读者如何在 laravel 8 中利用 eloquent orm 高效统计每个分类下关联的文章数量。通过定义模型间的 `hasmany` 关系并结合 `withcount` 方法，我们能够以简洁、可维护的方式获取带有计数结果的分类数据，避免复杂的原始 sql join 查询，从而提升开发效率和代码可读性。

在 Laravel 应用开发中，我们经常需要统计关联模型的数量，例如统计每个分类下有多少篇文章，或者每个用户发布了多少条评论。传统上，这可能需要编写复杂的 SQL JOIN 语句并手动计算。然而，Laravel 的 Eloquent ORM 提供了一种更优雅、更“Laravel 式”的解决方案——withCount 方法，它能极大地简化这一过程。

1. 理解并定义模型关联关系

首先，我们需要确保数据库表结构支持这种关联，并且在 Laravel 中正确定义了模型。根据问题描述，我们有 categories 表和 posts 表，其中 posts 表通过 category_id 字段关联到 categories 表。这表明 Category 模型与 Post 模型之间存在“一对多”的关系：一个分类可以拥有多篇文章，而一篇文章只属于一个分类。

为了在 Eloquent 中表达这种关系，我们需要在 Category 模型中定义一个 hasMany 方法。

app/Models/Category.php

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;

class Category extends Model
{
    use HasFactory;

    /**
     * 获取此分类下的所有文章。
     */
    public function posts()
    {
        return $this->hasMany(Post::class);
    }
}

app/Models/Post.php (为完整性考虑，Post 模型也应定义反向关联)

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;

class Post extends Model
{
    use HasFactory;

    /**
     * 获取此文章所属的分类。
     */
    public function category()
    {
        return $this->belongsTo(Category::class);
    }
}

2. 使用 Eloquent withCount 统计关联模型数量

定义好关联关系后，我们就可以利用 Eloquent 提供的 withCount 方法来轻松统计每个分类下的文章数量了。withCount 方法会在查询结果中自动添加一个 _count 后缀的属性，其中包含关联模型的数量。

<?php

namespace App\Http\Controllers;

use App\Models\Category;
use Illuminate\Http\Request;

class CategoryController extends Controller
{
    /**
     * 获取所有分类及其对应的文章数量。
     *
     * @return \Illuminate\Database\Eloquent\Collection
     */
    public function index()
    {
        $categoriesWithPostCount = Category::withCount('posts')->get();

        // 遍历结果并查看每个分类的名称和文章数量
        foreach ($categoriesWithPostCount as $category) {
            echo "分类名称: " . $category->name . ", 文章数量: " . $category->posts_count . "<br>";
        }

        return $categoriesWithPostCount;
    }
}

在上述代码中：

易笔AI论文

专业AI论文生成，免费生成论文大纲，在线生成选题/综述/开题报告等论文模板

103

查看详情

• Category::withCount('posts') 会指示 Eloquent 在查询 categories 表时，同时计算每个分类所关联的 posts 数量。
• ->get() 执行查询并返回一个 Collection 对象。
• 对于 Collection 中的每一个 Category 模型实例，都会额外添加一个 posts_count 属性，其值就是该分类下文章的总数。

示例输出结构：

当你获取 $categoriesWithPostCount 后，每个 Category 模型实例将包含类似以下的数据：

[
    {
        "id": 1,
        "name": "技术",
        "created_at": "...",
        "updated_at": "...",
        "posts_count": 5 // 这个是 withCount 添加的属性
    },
    {
        "id": 2,
        "name": "生活",
        "created_at": "...",
        "updated_at": "...",
        "posts_count": 3
    }
]

3. 与原始 DB 查询对比及优势

原始问题中提供了一个尝试使用 DB::table 进行查询的例子：

$categ = DB::table('posts')
 ->select('category_id', 'categories.id', DB::raw('count(posts.id) as total_product'))
 ->join('categories', 'posts.category_id', '=', 'categories.id')
 ->groupBy('posts.category_id')
 ->get();

这个原始查询尝试通过 posts 表作为主表进行 JOIN，然后分组计数。虽然理论上可以实现类似功能，但存在以下几个问题和劣势：

1. 查询方向不直观： 通常我们希望从 Category 的角度出发，查询其关联的 Post 数量，而不是从 Post 出发。
2. SQL 复杂性： 随着业务逻辑的增长，手写 JOIN 和 GROUP BY 会变得越来越复杂，容易出错。
3. 可读性与维护性差： SQL 字符串硬编码在 PHP 代码中，降低了代码的可读性和未来的维护成本。
4. 未充分利用 Eloquent： 放弃了 Eloquent 提供的模型实例、属性访问器、修改器等一系列便利功能。

相比之下，使用 Category::withCount('posts')->get() 的 Eloquent 方法具有显著优势：

• 简洁明了： 一行代码即可表达意图，易于理解。
• 面向对象： 返回的是 Eloquent 模型实例集合，可以直接访问 Category 的其他属性，以及新添加的 posts_count 属性。
• 可维护性高： 业务逻辑与数据库操作分离，数据库结构变化时，通常只需更新模型定义，而无需修改大量 SQL 查询。
• 性能优化： Eloquent 在底层会生成优化的 SQL 语句，通常比手动编写的 SQL 更高效。

4. 注意事项与最佳实践

• 模型命名与文件路径： 确保模型文件（如 Category.php, Post.php）位于 app/Models 目录下，并且命名符合 PSR-4 规范（单数形式，首字母大写）。
• 外键约定： Laravel 默认的外键约定是 关联模型名_id（例如 category_id），如果你的外键名称不符合此约定，需要在 hasMany 或 belongsTo 方法中明确指定。
• 性能考量： withCount 实际上会执行一个单独的 COUNT 查询（但通常是优化的），并将其结果 JOIN 到主查询中。对于极大规模的数据集，如果性能成为瓶颈，可以考虑其他更底层的优化手段，但在大多数情况下，withCount 是非常高效的选择。
• 多个关联计数： 你可以同时对多个关联关系进行计数，例如 Category::withCount(['posts', 'comments'])->get()。
• 条件计数： withCount 也支持添加条件，例如 Category::withCount(['posts' => function (Builder $query) { $query->where('status', 'published'); }])->get()，这会只统计已发布的文章。

总结

Laravel Eloquent ORM 的 withCount 方法为统计关联模型数量提供了一个强大且优雅的解决方案。通过正确定义模型间的关联关系，开发者可以避免编写复杂的原始 SQL，从而提高代码的可读性、可维护性和开发效率。在 Laravel 8 及更高版本中，这是处理此类统计需求的首选方法。

以上就是Laravel Eloquent 关联模型计数：高效统计分类下文章数量的详细内容，更多请关注php中文网其它相关文章！