Laravel Eloquent 中整合 SUM 聚合函数与多列查询的实践指南

本教程详细阐述了如何在 Laravel Eloquent 中将包含 `SUM` 聚合函数和 `GROUP BY` 的复杂原始 SQL 查询转换为可读性更强的查询构建器语句。核心在于利用 `DB::raw()` 方法在 `select()` 子句中正确集成聚合函数，同时保留其他所需字段，从而实现数据汇总与明细查询的有效结合。

引言：从原始 SQL 到 Eloquent 的挑战

在 Web 开发中，我们经常需要处理涉及数据聚合的复杂查询，例如计算某个分组的总和、平均值或计数。当使用原始 SQL 语句时，这通常通过 SUM()、COUNT() 等聚合函数结合 GROUP BY 子句来实现。例如，以下是一个典型的原始 SQL 查询，用于计算每个产品的购物车数量总和，并获取产品详情：

SELECT SUM(carts.quantity) as couuntq, carts.productid, products.name, products.price, products.gallary
FROM carts, products
WHERE carts.productid = products.id
  AND carts.userid = [userid]
GROUP BY carts.productid
ORDER BY carts.productid;

尽管原始 SQL 功能强大，但在 Laravel 项目中，我们更倾向于使用 Eloquent ORM 或查询构建器来提高代码的可读性、可维护性和安全性。然而，将上述包含聚合函数和多列选择的复杂 SQL 转换为 Eloquent 语句时，开发者常会遇到挑战。

理解聚合函数在 Eloquent 中的应用

Laravel 查询构建器提供了一些便捷的聚合方法，如 sum()、count()、avg()、max() 和 min()。这些方法通常作为查询的终结器（terminal methods），意味着它们会直接执行查询并返回一个单一的聚合结果。例如：

// 获取所有购物车中商品数量的总和
$totalQuantity = DB::table('carts')->sum('quantity');

// 获取满足条件的用户购物车商品数量总和
$userTotalQuantity = DB::table('carts')
                        ->where('userid', $userid)
                        ->sum('quantity');

这种用法非常直接，但它只返回一个标量值。当我们需要在 SELECT 子句中同时包含聚合结果（如 SUM(quantity)）和分组后的其他列（如 productid, product.name）时，直接使用 -youjiankuohaophpcnsum('column') 将不再适用，因为它会覆盖或阻止其他列的选取。

解决方案：利用 DB::raw() 整合聚合函数

为了在 SELECT 子句中灵活地集成聚合函数和其他列，Laravel 查询构建器提供了 DB::raw() 方法。DB::raw() 允许你在查询构建器中插入任意的原始 SQL 片段，这为处理复杂场景提供了极大的便利。

核心思想是：将聚合函数表达式（例如 SUM(carts.quantity) as couuntq）作为 DB::raw() 的参数，然后将其与你希望选择的其他列一同传递给 select() 方法。

use Illuminate\Support\Facades\DB;

// 示例语法
DB::table('your_table')
    ->select(
        DB::raw('SUM(column_name) as alias_name'), // 聚合函数
        'another_column',                           // 其他列
        'yet_another_column'
    )
    // ... 其他查询条件
    ->get();

逐步转换示例

现在，我们将上述原始 SQL 查询逐步转换为 Laravel 查询构建器语句。

原始 SQL 查询回顾：

SELECT SUM(carts.quantity) as couuntq, carts.productid, products.name, products.price, products.gallary
FROM carts, products
WHERE carts.productid = products.id
  AND carts.userid = [userid]
GROUP BY carts.productid
ORDER BY carts.productid;

1. 表连接 (JOIN)

原始 SQL 使用了隐式连接 (FROM carts, products WHERE carts.productid = products.id)。在查询构建器中，我们应使用显式的 join() 方法：

DB::table('carts')
    ->join('products', 'carts.productid', '=', 'products.id')

2. 条件筛选 (WHERE)

筛选条件 carts.userid = [userid] 可以直接使用 where() 方法：

->where('carts.userid', $userid)

注意： 原始 SQL 中的 WHERE carts.productid = products.id 在 JOIN 子句中已经处理，因此在 WHERE 子句中重复此条件是冗余的。在 Eloquent 中，我们应该避免这种冗余，确保 JOIN 语句正确定义连接关系即可。

蓝心千询

蓝心千询是vivo推出的一个多功能AI智能助手

34

查看详情

3. 聚合与选择列 (SELECT with SUM)

这是最关键的一步。我们将 SUM(carts.quantity) as couuntq 包装在 DB::raw() 中，并与 carts.productid, products.name, products.price, products.gallary 一同传递给 select() 方法：

->select(
    DB::raw('SUM(carts.quantity) as couuntq'),
    'carts.productid',
    'products.name',
    'products.price',
    'products.gallary'
)

4. 分组 (GROUP BY)

使用 groupBy() 方法对 carts.productid 进行分组：

->groupBy('carts.productid')

5. 排序 (ORDER BY)

使用 orderBy() 方法对结果进行排序：

->orderBy('carts.productid', 'asc')

6. 获取结果 (GET)

最后，调用 get() 方法执行查询并获取结果集：

->get();

完整的 Eloquent 查询示例

结合以上步骤，完整的 Laravel 查询构建器代码如下：

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use Illuminate\Support\Facades\DB;

class CartController extends Controller
{
    public function getUserCartSummary(Request $request, $userId)
    {
        // 假设 $userId 变量已定义，例如从路由参数获取
        // $userId = $request->user()->id; // 如果是认证用户
        // 或者 $userId = $request->route('userId'); // 如果是路由参数

        $results = DB::table('carts')
            ->join('products', 'carts.productid', '=', 'products.id')
            ->select(
                DB::raw('SUM(carts.quantity) as couuntq'),
                'carts.productid',
                'products.name',
                'products.price',
                'products.gallary'
            )
            ->where('carts.userid', $userId)
            ->groupBy('carts.productid')
            ->orderBy('carts.productid', 'asc')
            ->get();

        // 返回或处理结果
        return response()->json($results);
    }
}

注意事项与最佳实践

1. 别名 (Aliases): 为 DB::raw() 表达式中的聚合结果指定清晰的别名（例如 as couuntq），这有助于在处理结果集时更容易地访问数据。

2. 安全性:DB::raw() 功能强大，但如果将用户直接输入未经处理地拼接到 DB::raw() 中，可能导致 SQL 注入漏洞。在本例中，$userId 作为 where() 方法的第二个参数，Laravel 会自动对其进行参数绑定，从而有效防止 SQL 注入。始终确保任何用户输入在进入 DB::raw() 之前都经过严格的验证和清理。

3. 调试: 在开发过程中，如果对生成的 SQL 语句有疑问，可以使用 toSql() 和 getBindings() 方法来检查查询构建器实际执行的 SQL 语句及其绑定参数：

   $query = DB::table('carts')
       ->join('products', 'carts.productid', '=', 'products.id')
       ->select(
           DB::raw('SUM(carts.quantity) as couuntq'),
           'carts.productid',
           'products.name',
           'products.price',
           'products.gallary'
       )
       ->where('carts.userid', $userId)
       ->groupBy('carts.productid')
       ->orderBy('carts.productid', 'asc');
   
   // 打印生成的 SQL 语句
   // echo $query->toSql();
   // print_r($query->getBindings());
   
   $results = $query->get();

   登录后复制

4. 其他聚合函数:DB::raw() 的用法不仅限于 SUM()。当你需要 COUNT(), AVG(), MAX(), MIN() 等其他聚合函数与非聚合列一同选择时，也可以采用相同的方式。

总结

通过本教程，我们学习了如何在 Laravel Eloquent 中，利用 DB::raw() 方法有效地将包含 SUM 聚合函数和 GROUP BY 的复杂原始 SQL 查询转换为清晰、可维护的查询构建器语句。掌握 DB::raw() 的使用是 Laravel 开发者处理高级数据库查询的关键技能，它在保持 Eloquent 优雅性的同时，提供了足够的灵活性来应对复杂的业务需求。

以上就是Laravel Eloquent 中整合 SUM 聚合函数与多列查询的实践指南的详细内容，更多请关注php中文网其它相关文章！