Mikro-ORM中使用SQL聚合函数的最佳实践

在使用Mikro-ORM进行数据库操作时，开发者经常会遇到需要使用SQL聚合函数如SUM、COUNT等的情况。本文将通过一个典型场景，详细介绍如何在Mikro-ORM中正确使用这些函数。

问题背景

在Mikro-ORM中，当开发者尝试使用QueryBuilder构建包含聚合函数的查询时，可能会遇到SQL语法错误。例如，以下查询会报错：

const results = await orm.em
    .createQueryBuilder(User, "u")
    .select(["u.id as id", "sum(t.amount) as total"])
    .leftJoin("u.jncSales", "t")
    .where({ email: "foo" })
    .getResultList();

生成的SQL语句会将聚合函数错误地包含在反引号中：

select `u`.`id` as `id`, `sum(t`.`amount)` as `total` from `user` as `u`...

这会导致数据库引擎无法识别sum函数，因为它被错误地当作列名处理。

解决方案

Mikro-ORM提供了专门的sql标签函数来处理原生SQL表达式。正确使用聚合函数的方法是：

import { sql } from '@mikro-orm/core';

const results = await orm.em
    .createQueryBuilder(User, "u")
    .select(["u.id as id", sql`sum(t.amount)`.as('total')])
    .leftJoin("u.jncSales", "t")
    .where({ email: "foo" })
    .getResultList();

原理分析

Mikro-ORM的QueryBuilder默认会对所有标识符进行转义（使用反引号或双引号），以防止SQL注入。当直接传入"sum(t.amount)"这样的字符串时，整个表达式会被当作一个列名进行转义。

使用sql标签函数可以明确告诉QueryBuilder：这部分是原生SQL表达式，不需要进行转义处理。这样生成的SQL语句会保持聚合函数的正确语法：

select `u`.`id` as `id`, sum(t.amount) as `total` from `user` as `u`...

扩展应用

这种方法不仅适用于SUM函数，还可以用于其他SQL函数和表达式：

// 使用COUNT函数
sql`count(t.id)`.as('transactionCount')

// 使用复杂表达式
sql`(t.amount * 1.1)`.as('amountWithTax')

// 使用字符串函数
sql`concat(u.firstName, ' ', u.lastName)`.as('fullName')

最佳实践建议

1. 对于简单的属性选择，可以直接使用字符串标识符
2. 对于任何SQL函数调用或复杂表达式，都应该使用sql标签函数
3. 考虑为常用聚合查询创建自定义Repository方法
4. 在复杂查询场景下，可以考虑使用原生SQL查询

通过遵循这些实践，可以确保在Mikro-ORM中安全、高效地使用SQL聚合函数和各种表达式。