Laravel Eloquent：高效统计每个分类下的文章数量

本文将详细介绍如何在 laravel 8 中利用 eloquent orm 高效地统计每个分类下的文章数量。我们将从定义模型间的关联关系入手，逐步讲解如何使用 `withcount` 方法，从而避免手动编写复杂的 sql join 语句，以更优雅、可读性更强的方式实现数据聚合统计，并探讨其优势和使用场景。

在 Web 开发中，尤其是在构建内容管理系统（CMS）时，统计不同分类下相关内容的数量是一个非常常见的需求。例如，在一个博客系统中，我们可能需要显示每个文章分类下包含的文章总数。虽然可以通过 SQL 的 JOIN 和 GROUP BY 语句来实现，但在 Laravel 这样的框架中，利用其强大的 Eloquent ORM 可以以更简洁、更符合框架习惯的方式完成这项任务。

1. 场景描述与传统 SQL 方法回顾

假设我们有两个数据表：categories（分类）和 posts（文章）。

• categories 表包含：id (主键), name (分类名称) 等字段。
• posts 表包含：id (主键), category_id (外键，关联到 categories.id), title 等字段。

我们的目标是获取每个分类的名称以及该分类下对应的文章数量。

如果使用原生的 SQL 或 Laravel 的查询构造器（Query Builder），常见的实现方式如下：

SELECT
    c.name,
    COUNT(p.id) AS total_posts
FROM
    categories c
JOIN
    posts p ON c.id = p.category_id
GROUP BY
    c.id, c.name;

对应的 Laravel 查询构造器代码可能如下：

use Illuminate\Support\Facades\DB;

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

// 结果示例：
// [
//     { "name": "技术", "total_posts": 15 },
//     { "name": "生活", "total_posts": 8 },
//     // ...
// ]

这种方法虽然有效，但在处理复杂的关联查询时，手动管理 JOIN 条件和 GROUP BY 字段会增加代码的复杂性和出错的可能性。Laravel Eloquent 提供了更优雅的解决方案。

2. 定义 Eloquent 模型及关系

首先，我们需要为 categories 表和 posts 表创建对应的 Eloquent 模型。

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;

    protected $fillable = ['name'];

    /**
     * 一个分类可以有多个文章。
     */
    public function posts()
    {
        return $this->hasMany(Post::class);
    }
}

app/Models/Post.php:

美图设计室

5分钟在线高效完成平面设计，AI帮你做设计

29

查看详情

<?php

namespace App\Models;

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

class Post extends Model
{
    use HasFactory;

    protected $fillable = ['title', 'category_id'];

    /**
     * 一篇文章属于一个分类。
     */
    public function category()
    {
        return $this->belongsTo(Category::class);
    }
}

在这里，我们在 Category 模型中定义了一个 posts() 方法，它返回 hasMany 关系，表示一个分类可以拥有多篇文章。这是实现统计的关键。

3. 使用 withCount 方法高效统计

定义好模型关系后，Laravel Eloquent 提供了一个非常方便且高效的方法 withCount() 来统计关联模型的数量。

use App\Models\Category;

$categoriesWithPostCount = Category::withCount('posts')->get();

// 遍历结果
foreach ($categoriesWithPostCount as $category) {
    echo "分类名称: " . $category->name . ", 文章数量: " . $category->posts_count . "\n";
}

代码解释：

• Category::withCount('posts')：这会指示 Eloquent 在查询 categories 表时，同时对每个分类查询其关联的 posts 数量。
• ->get()：执行查询并获取所有结果。

结果结构：withCount 方法会在每个 Category 模型实例上添加一个名为 posts_count 的属性（默认情况下，关联方法名后加 _count），其中包含了该分类下文章的总数。

// 示例输出的 $categoriesWithPostCount 结构：
[
    {
        "id": 1,
        "name": "技术",
        "created_at": "...",
        "updated_at": "...",
        "posts_count": 15 // 这是 withCount 添加的属性
    },
    {
        "id": 2,
        "name": "生活",
        "created_at": "...",
        "updated_at": "...",
        "posts_count": 8
    },
    // ...
]

4. withCount 的优势与高级用法

优势：

1. 代码简洁性： 无需手动编写复杂的 JOIN 和 GROUP BY 语句，大大简化了代码。
2. 可读性： 通过方法名 withCount('posts') 即可清晰表达意图。
3. 性能优化： Eloquent 会生成优化的 SQL 查询，通常会使用子查询或左连接来实现计数，避免了加载所有关联模型实例到内存中，提高了性能。
4. 复用性： 关系一旦定义，可以在任何需要统计关联模型数量的地方使用 withCount。

高级用法：

• 统计多个关联关系：

  $categories = Category::withCount(['posts', 'comments'])->get();
  // 此时每个 category 对象会有 posts_count 和 comments_count 属性

  登录后复制

• 自定义计数列名： 如果你不想使用默认的 关联名_count 作为属性名，可以传入一个数组：

  $categories = Category::withCount(['posts as total_articles'])->get();
  // 此时每个 category 对象会有 total_articles 属性
  echo $category->total_articles;

  登录后复制

• 对计数进行条件过滤： 你可以在 withCount 中添加闭包来对计数进行条件过滤，例如只统计已发布的文章：

  $categories = Category::withCount(['posts' => function ($query) {
      $query->where('published', true);
  }])->get();
  // 此时 posts_count 将只包含已发布的文章数量

  登录后复制

总结

在 Laravel 中，当需要统计关联模型的数量时，强烈推荐使用 Eloquent 的 withCount 方法。它不仅能显著提高代码的简洁性和可读性，还能通过生成优化的 SQL 查询来保证良好的性能。通过正确定义模型间的关联关系，开发者可以充分利用 Eloquent ORM 的强大功能，更高效地处理数据查询和统计任务。

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