本文详细介绍了在 laravel 应用中，如何高效地统计关联模型的数量，例如统计每个部门下的用户数量。通过讲解 eloquent 的 `withcount()` 方法，文章展示了如何优化数据查询，避免n+1问题，并在 inertia.js 与 vue.js 前端框架中正确地展示这些统计结果，从而提升应用性能和代码可读性。
理解关联模型计数的需求
在构建数据库驱动的应用程序时，经常会遇到需要统计某个模型关联的子模型数量的场景。例如，在一个部门管理系统中，我们可能需要显示每个部门有多少名员工。初学者往往会尝试在循环中或通过独立的查询来获取这些计数，但这种方法通常会导致性能问题，尤其是在数据量较大时。
原始的问题描述中，尝试使用 User::where('department_id')->count() 来统计用户数量，并将其赋值给 total_members。然而，这种做法的问题在于它统计的是所有用户的总数，而不是每个特定部门的用户数。为了实现每个部门的独立用户计数，我们需要一种更优雅、更高效的 Eloquent 解决方案。
建立模型关系
在使用 Eloquent 的高级功能之前，确保你的模型之间已经正确地建立了关系。对于部门和用户之间的关系，一个部门可以拥有多个用户，而一个用户属于一个部门。这通常通过在 Department 模型中定义 hasMany 关系，在 User 模型中定义 belongsTo 关系来实现。
app/Models/Department.php
<?php namespace App\Models;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
class Department extends Model
{
use HasFactory;
protected $fillable = ['name'];
/**
* 获取属于该部门的用户。
*/
public function users()
{
return $this->hasMany(User::class);
}
}
app/Models/User.php
<?php namespace App\Models;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;
use Laravel\Sanctum\HasApiTokens;
class User extends Authenticatable
{
use HasApiTokens, HasFactory, Notifiable;
protected $fillable = [
'name',
'email',
'password',
'department_id', // 确保用户模型中包含部门外键
];
protected $hidden = [
'password',
'remember_token',
];
protected $casts = [
'email_verified_at' => 'datetime',
];
/**
* 获取用户所属的部门。
*/
public function department()
{
return $this->belongsTo(Department::class);
}
}
使用 withCount() 优化查询
Laravel Eloquent 提供了 withCount() 方法，这是一个极其强大的功能，用于在不加载完整关联模型集合的情况下，统计关联模型的数量。它会在查询结果中为每个父模型添加一个 [relation_name]_count 属性。
DepartmentController.php
<?php namespace App\Http\Controllers;
use App\Models\Department;
use App\Models\User; // 如果不再需要，可以移除
use Illuminate\Http\Request;
use Inertia\Inertia;
class DepartmentController extends Controller
{
public function index()
{
// 使用 withCount('users') 来统计每个部门的用户数量
$departments = Department::withCount('users')
->orderBy('name')
->get();
return Inertia::render('back/app/departments/index', [
'filters' => request()->all('visibility', 'status', 'search'),
'departments' => $departments,
// 'total_members' => User::where('department_id')->count(), // 这行代码可以移除
]);
}
}
在上述代码中，Department::withCount('users') 会在每个 Department 模型实例上添加一个名为 users_count 的属性，其中包含了该部门下用户的数量。这种方法避免了 N+1 查询问题，因为 Laravel 会通过一个高效的 SQL 查询来完成计数，而不是为每个部门执行单独的计数查询。
在 Vue.js/Inertia.js 中展示统计结果
当数据通过 Inertia.js 传递到 Vue.js 组件后，你可以直接访问 department.users_count 属性来显示每个部门的用户数量。
Index.vue
<template><!-- ... 其他模板代码 ... --><table>
<thead><tr>
<th>部门名称</th>
<th>成员数量</th>
<th>操作</th>
</tr></thead>
<tbody><tr v-for="department in departments" :key="department.id">
<td class="px-6 py-4 whitespace-no-wrap text-sm leading-5 font-medium text-gray-900">
{{ department.name }}
</td>
<td class="flex items-center text-sm leading-5 text-gray-500 px-6 py-4 whitespace-no-wrap">
<!-- 直接访问 users_count 属性 -->
<span class="font-medium">{{ department.users_count }}</span> {{ $trans('labels.members') }}
</td>
<td class="px-6 py-4 whitespace-no-wrap text-right text-sm leading-5 font-medium">
<inertia-link :href="route('app:projectdepartment.index', {id: department.id})">
{{ $trans('labels.view-activity') }}
</inertia-link>
</td>
</tr></tbody>
</table>
<!-- ... 其他模板代码 ... --></template><script setup>
import { defineProps } from 'vue';
const props = defineProps({
departments: Array,
filters: Object,
});
</script>
注意事项与最佳实践
- 关系名称一致性： withCount() 方法的参数必须是模型中定义的关系方法的名称（例如 users）。Laravel 会自动将其转换为 users_count 属性。
- 性能优势： withCount() 避免了 N+1 查询问题。如果没有它，你可能会在循环中为每个部门执行一个 department->users()->count() 查询，这会导致大量的数据库往返，严重影响性能。
- 自定义计数列名： 如果需要自定义计数属性的名称，可以传入一个数组：withCount(['users as total_users'])，这样属性名将变为 total_users。
-
条件计数： withCount() 也支持添加条件。例如，如果你只想统计活跃用户，可以这样写：
Department::withCount(['users' => function (Builder $query) { $query->where('is_active', true); }])->get();这将生成 users_count 属性，但只包含活跃用户。
- 多个关系计数： 你可以同时对多个关系进行计数：Department::withCount(['users', 'projects'])->get()。
总结
通过利用 Laravel Eloquent 提供的 withCount() 方法，我们可以优雅且高效地解决统计关联模型数量的问题。这种方法不仅优化了数据库查询性能，避免了常见的 N+1 问题，还使得代码更加简洁和易于维护。在开发 Laravel 应用时，理解并善用 Eloquent 关系和其提供的各种辅助方法，是提升应用质量和开发效率的关键。
