Ent 聚合查询实战指南Aggregate、GroupBy 与自定义 SQL 修饰符【免费下载链接】entAn entity framework for Go项目地址: https://gitcode.com/gh_mirrors/en/ent本指南基于 ent 框架的官方文档 aggregate.md系统讲解在 ent 查询构建器中使用Aggregate聚合函数、GroupBy分组、跨边分组Group By Edge以及Modify自定义 SQL 修饰符Having Group By的完整实战方法。读完本文你将掌握如何用类型安全的 Go 代码替代手写 SQL 完成 SUM、MIN、MAX、COUNT、AVG 等统计查询并能深入自定义 SQL 层实现存储特定的分组聚合逻辑。概述从查询构建器到 SQL 聚合ent 的查询 API 在client.T.Query()返回的类型安全查询构建器之上提供了三个与聚合相关的扩展点Aggregate(fns ...AggregateFunc)向查询追加一个或多个聚合函数列例如ent.Sum、ent.Min、ent.Max、ent.Count、ent.AvgGroupBy(field string, fields ...string)按一个或多个字段对结果分组返回GroupBy构建器可与Aggregate组合使用Modify(modifiers ...func(s *sql.Selector))在 SQL 层对查询进行任意修改例如追加GROUP BY ... HAVING ...子句或通过sql.Selector手动Join其他表。这些方法由 ent 代码生成器entc写入每个实体的查询构建器中模板定义位于 entc/gen/template/builder/query.tmpl。聚合函数的实际 SQL 拼接则交由 dialect/sql/builder.go 中的构建器完成。Aggregate单字段与多字段聚合Aggregate选项允许在一条查询中添加一个或多个聚合函数。其签名由 entc/gen/template/base.tmpl 生成为func Aggregate(fns ...AggregateFunc) *TSelect单个聚合字段对Payment实体的amount字段求和并直接以int形式取出结果package main import ( context project/ent project/ent/payment project/ent/pet ) func Do(ctx context.Context, client *ent.Client) { // Aggregate one field. sum, err : client.Payment.Query(). Aggregate( ent.Sum(payment.Amount), ). Int(ctx) }Int(ctx)是聚合查询的便捷终结方法当只聚合一个字段时它把第一行第一列的结果扫描为int并返回。多个聚合字段同时聚合多个字段时需要把结果扫描到结构体切片中。Sum、Min、Max、Count可任意组合输出列的默认命名与聚合函数同名package main import ( context project/ent project/ent/pet ) func Do(ctx context.Context, client *ent.Client) { // Aggregate multiple fields. var v []struct { Sum, Min, Max, Count int } err : client.Pet.Query(). Aggregate( ent.Sum(pet.FieldAge), ent.Min(pet.FieldAge), ent.Max(pet.FieldAge), ent.Count(), ). Scan(ctx, v) }这里的Scan(ctx, v)会把结果集的每一行映射到结构体字段上字段名与聚合函数名一一对应Sum、Min、Max、Count。聚合函数的生成与实现ent.Sum等函数由代码生成器按aggregate配置逐一生成定义在 entc/gen/template/base.tmpl// Sum applies the sum aggregation function on the given field of each group. func Sum(field string) AggregateFunc { return func(s *sql.Selector) string { if err : checkColumn(s.TableName(), field); err ! nil { s.AddError(ValidationError{Name: field, err: fmt.Errorf(package: %w, err)}) return } return sql.Sum(s.C(field)) } }关键点在于 entc/gen/template/dialect/sql/by.tmpl 中的实现细节AggregateFunc的真实类型是func(*sql.Selector) string即“接收 SQL 选择器、返回一段 SQL 表达式字符串”的函数Count()不带字段参数内部生成COUNT(*)Mean均值在 SQL 层被映射为AVG每个带字段的聚合函数都会先调用checkColumn校验字段是否真实存在于对应表中见 entc/gen/template/dialect/sql/by.tmpl。而sql.Sum、sql.Count、sql.Min、sql.Max、sql.Avg的底层实现位于 dialect/sql/builder.go它们统一通过Func构建器把标识符包装为SUM(x)、COUNT(x)、MIN(x)、MAX(x)、AVG(x)形式的 SQL 片段例如// Sum wraps the ident with the SUM aggregation function. func Sum(ident string) string { f : Func{} f.Sum(ident) return f.String() }byName负责拼接函数名与括号包裹的列名dialect/sql/builder.go。Group By按字段分组统计GroupBy让查询按一个或多个字段分组再配合Aggregate计算每组的统计值。按多个字段分组并聚合按所有用户的name和age分组并统计每组的年龄总和与用户数package main import ( context project/ent project/ent/user ) func Do(ctx context.Context, client *ent.Client) { var v []struct { Name string json:name Age int json:age Sum int json:sum Count int json:count } err : client.User.Query(). GroupBy(user.FieldName, user.FieldAge). Aggregate(ent.Count(), ent.Sum(user.FieldAge)). Scan(ctx, v) }这里GroupBy(user.FieldName, user.FieldAge)生成GROUP BY name, ageAggregate(ent.Count(), ent.Sum(user.FieldAge))追加COUNT(*)与SUM(age)两列。结果通过结构体的json标签按列名扫描。按单个字段分组并取列值如果只想拿到分组后的某一列去重后的值列表可以省略Aggregate直接使用Strings(ctx)等便捷方法package main import ( context project/ent project/ent/user ) func Do(ctx context.Context, client *ent.Client) { names, err : client.User. Query(). GroupBy(user.FieldName). Strings(ctx) }Strings(ctx)会把GROUP BY name结果的第一列扫描为[]string。同理还有Ints(ctx)、Int64s(ctx)、IDs(ctx)等系列方法适用于“取一列”的常见场景。GroupBy 的底层执行流程GroupBy生成器最终通过sqlScan执行其实现见 entc/gen/template/dialect/sql/group.tmpl流程如下基于根查询创建sql.Selector依次执行每个AggregateFunc收集聚合表达式字符串若未显式选择列则默认选择“分组字段列 聚合函数列”调用selector.GroupBy(...)生成GROUP BY子句通过 driver 执行查询并用sql.ScanSlice扫描结果。因此GroupBy(f1, f2).Aggregate(...)最终等价于SELECT f1, f2, COUNT(*), SUM(f2) FROM table GROUP BY f1, f2Group By Edge跨边的自定义聚合当聚合目标不在当前实体而在其关联实体边上时需要写存储特定的自定义聚合函数。下面的例子按用户的id与name分组并计算每个用户所有宠物的平均年龄package main import ( context log project/ent project/ent/pet project/ent/user entgo.io/ent/dialect/sql ) func Do(ctx context.Context, client *ent.Client) { var users []struct { ID int Name string Average float64 } err : client.User.Query(). GroupBy(user.FieldID, user.FieldName). Aggregate(func(s *sql.Selector) string { t : sql.Table(pet.Table) s.Join(t).On(s.C(user.FieldID), t.C(pet.OwnerColumn)) return sql.As(sql.Avg(t.C(pet.FieldAge)), average) }). Scan(ctx, users) }这段代码的关键动作sql.Table(pet.Table)取得 pets 表的引用dialect/sql/builder.gos.Join(t).On(...)把 pets 表 JOIN 到当前查询连接条件为user.id pet.owner_idsql.Avg(t.C(pet.FieldAge))计算宠物年龄均值sql.As(expr, average)为该表达式起别名dialect/sql/builder.go别名average与结果结构体的Average字段对应由于AggregateFunc可以访问并修改*sql.Selector因此可以在聚合的同时扩展查询本身此处即 JOIN这正是“自定义聚合函数适合写存储特定逻辑”的原因。生成的 SQL 大致为SELECT users.id, users.name, AVG(pets.age) AS average FROM users JOIN pets ON users.id pets.owner_id GROUP BY users.id, users.name提示As本身也是一个公开的“伪聚合函数”见 entc/gen/template/base.tmpl可用ent.As(ent.Sum(f1), sum_field1)这类形式对内置聚合结果重命名。Having Group By自定义 SQL 修饰符如果你需要控制查询的所有部分例如添加HAVING过滤可以借助Modify直接操作sql.Selector。下面的例子查询每个角色role中年龄最大的用户package main import ( context log entgo.io/ent/dialect/sql project/ent project/ent/user ) func Do(ctx context.Context, client *ent.Client) { var users []struct { Id int Age int Role string } err : client.User.Query(). Modify(func(s *sql.Selector) { s.GroupBy(user.Role) s.Having( sql.EQ( user.FieldAge, sql.Raw(sql.Max(user.FieldAge)), ), ) }). ScanX(ctx, users) }Modify方法由 SQL dialect 模板生成entc/gen/template/dialect/sql/feature/modifier.tmpl其语义是“为查询附加自定义逻辑”接收func(s *sql.Selector)类型的修饰符列表。这里做了三件事s.GroupBy(user.Role)按角色分组s.Having(...)追加HAVING子句sql.EQ(user.FieldAge, sql.Raw(sql.Max(user.FieldAge)))限定“本行年龄等于该组最大年龄”。注意sql.Raw至关重要。它告诉谓词构建器sql.Max(user.FieldAge)是一段原始 SQL 表达式而非绑定参数值。sql.Raw的实现位于 dialect/sql/builder.go其Query()直接返回原始字符串且不带任何参数若不加sql.RawMAX(user.age)会被当作参数值处理HAVING条件就会失真。另外ScanX(ctx, v)与Scan行为一致但出错时直接 panic见 entc/gen/template/base.tmpl适合在错误无需优雅处理的场景下简化代码。上面的代码本质上生成的 SQL 查询为SELECT * FROM user GROUP BY user.role HAVING user.age MAX(user.age)小结与进阶指引ent 的聚合能力形成了一个从“类型安全 API”到“裸 SQL”的完整梯度需求推荐 API示例单字段统计Aggregate 便捷终结方法Aggregate(ent.Sum(f)).Int(ctx)多字段统计AggregateScanAggregate(ent.Sum(f), ent.Min(f), ...)分组统计GroupByAggregateGroupBy(f1, f2).Aggregate(ent.Count(), ...)取分组列值GroupByStrings/Ints/...GroupBy(f).Strings(ctx)跨边聚合自定义AggregateFuncsql.SelectorJOIN 关联表后sql.Avgsql.As完全自定义Modifysql.SelectorGroupByHavingsql.Raw继续深入可以参考仓库中的相关资源聚合函数与AggregateFunc的生成模板entc/gen/template/base.tmpl、entc/gen/template/dialect/sql/by.tmplGroupBy/Aggregate/Scan构建器定义entc/gen/template/builder/query.tmplGroupBy 执行与列组装逻辑entc/gen/template/dialect/sql/group.tmplSQL 层聚合函数与As、Raw、EQ实现dialect/sql/builder.go、dialect/sql/builder.goModify方法模板entc/gen/template/dialect/sql/feature/modifier.tmpl。需要说明的是上述示例中的project/ent等导入路径需替换为你的项目实际生成的 ent 包路径聚合与分组 API 面向 SQL 方言MySQL、PostgreSQL、SQLite 等生成Gremlin 方言下的实现与签名略有不同见 entc/gen/template/dialect/gremlin/by.tmpl使用前请确认你的存储类型。【免费下载链接】entAn entity framework for Go项目地址: https://gitcode.com/gh_mirrors/en/ent创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考