Laravel 8 中使用 Eloquent 高效统计每个分类下的文章数量

本教程详细介绍了如何在 laravel 8 框架中，利用 eloquent orm 的强大功能，特别是通过定义模型关系和使用 `withcount()` 方法，简洁高效地统计每个分类下的文章总数，并获取分类名称。文章将指导读者避免复杂的原始数据库查询，转而采用更符合 laravel 哲学的方式实现这一常见需求，提升代码的可读性和维护性。

在现代 Web 应用开发中，统计不同实体间关联数据的数量是一个非常常见的需求。例如，在一个博客系统中，我们可能需要显示每个分类（Category）下包含的文章（Post）总数。虽然可以通过编写原始 SQL 语句，结合 JOIN 和 GROUP BY 子句来实现，但在 Laravel 框架中，Eloquent ORM 提供了更为优雅、高效且易于维护的解决方案。本文将详细讲解如何利用 Eloquent 的模型关系和 withCount() 方法来达成这一目标。

准备工作：定义 Eloquent 模型

首先，我们需要确保数据库中存在 categories 表和 posts 表，并为它们创建对应的 Eloquent 模型。

假设我们的数据库表结构如下：

• categories 表:

  • id (主键)
  • name (分类名称)
  • ...其他字段

• posts 表:

  • id (主键)
  • category_id (外键，关联 categories 表的 id)
  • ...其他字段

接下来，为这两个表创建对应的 Eloquent 模型：Category 和 Post。

// app/Models/Category.php
namespace App\Models;

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

class Category extends Model
{
    use HasFactory;

    // 默认情况下，Eloquent 会假定表名为模型的复数形式 (categories)
    // 如果表名不符合约定，可以设置 protected $table = 'your_table_name';
}

// app/Models/Post.php
namespace App\Models;

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

class Post extends Model
{
    use HasFactory;

    // 默认情况下，Eloquent 会假定表名为模型的复数形式 (posts)
    // 如果表名不符合约定，可以设置 protected $table = 'your_table_name';
}

建立模型关系：一对多

在一个典型的博客系统中，一个分类可以拥有多篇文章，而一篇文章只属于一个分类。这是一种经典的一对多（One-to-Many）关系。我们需要在 Category 模型中定义这种关系。

在 Category 模型中添加一个 posts() 方法来定义其与 Post 模型的一对多关系：

码哩写作

最懂作者的AI辅助创作工具

91

查看详情

// app/Models/Category.php

namespace App\Models;

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

class Category extends Model
{
    use HasFactory;

    /**
     * 获取属于该分类的所有文章。
     */
    public function posts()
    {
        // 一个 Category 拥有多个 Post
        return $this->hasMany(Post::class);
    }
}

为了完整性，虽然不是本次统计的直接需求，我们也可以在 Post 模型中定义反向关系 belongsTo：

// app/Models/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()
    {
        // 一个 Post 属于一个 Category
        return $this->belongsTo(Category::class);
    }
}

使用 withCount() 统计文章数量

Eloquent 提供了 withCount() 方法，它可以方便地统计关联模型的数量，而无需手动编写复杂的 JOIN 和 GROUP BY 语句。通过在 Category 模型上调用 withCount('posts')，Laravel 会自动为每个 Category 模型实例添加一个名为 posts_count 的属性，其中包含该分类下关联文章的总数。

以下是实现这一功能的代码示例：

<?php

namespace App\Http\Controllers;

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

class CategoryController extends Controller
{
    public function index()
    {
        // 获取所有分类，并统计每个分类下的文章数量
        $categoriesWithPostCounts = Category::withCount('posts')->get();

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

        // 可以在视图中渲染这些数据
        // return view('categories.index', compact('categoriesWithPostCounts'));
    }
}

代码示例解析：

1. use App\Models\Category;：引入 Category 模型。
2. Category::withCount('posts')：这是核心部分。它指示 Eloquent 在查询 Category 模型时，同时统计其 posts 关系（即 Category 模型中定义的 posts() 方法）的数量。
3. -youjiankuohaophpcnget()：执行查询并返回一个 Category 模型实例的集合。
4. $category->posts_count：withCount() 方法会自动在每个 Category 模型实例上添加一个属性。这个属性的命名规则是：关系名 (posts) 加上 _count 后缀，因此就是 posts_count。这个属性的值就是该分类下关联文章的总数。

通过上述代码，您将获得一个包含所有分类及其对应文章数量的集合，无需手动处理复杂的数据库连接和聚合逻辑。

优势与注意事项

1. 代码简洁性与可读性： withCount() 极大地简化了统计关联数据的代码，使其更易于理解和维护。相比于原始的 SQL JOIN 和 GROUP BY 语句，Eloquent 的方式更加符合面向对象的编程范式。
2. 性能优化： Laravel 会生成一个优化的子查询来获取计数，通常比手动编写复杂的 JOIN 语句更高效，尤其是在处理大量数据时。
3. 灵活性：
   • 指定别名： 您可以为计数属性指定一个不同的名称，而不是默认的 _count 后缀。

     $categories = Category::withCount(['posts as total_articles'])->get();
     // 此时，访问计数使用 $category->total_articles

     登录后复制
   • 添加条件： 您可以在 withCount() 中为关联计数添加额外的查询条件，例如只统计已发布的文章。

     $categories = Category::withCount(['posts' => function ($query) {
         $query->where('status', 'published');
     }])->get();
     // 此时 $category->posts_count 将只统计 status 为 'published' 的文章

     登录后复制
   • 多个关系计数： 您可以同时统计多个关联关系的数量。

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

     登录后复制
4. 避免原始查询： 尽管原始数据库查询在某些极端复杂或性能敏感的场景下仍有其用武之地，但对于这种常见的关联计数需求，Eloquent 提供了更优的抽象层，能够有效减少开发者的工作量并降低出错的概率。

总结

通过本文的学习，我们掌握了如何在 Laravel 8 框架中，利用 Eloquent 模型关系和 withCount() 方法，以一种优雅、高效且符合框架最佳实践的方式，统计每个分类下的文章数量。这种方法不仅使代码更加简洁、易读和易于维护，还能充分利用 Laravel 框架提供的性能优化。掌握这一技巧，将有助于您编写出更清晰、更健壮的 Laravel 应用代码。

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