返回资讯中心
外部精选
软件工程
#开发者实时流

ant 库利用 Go 1.27 泛型方法实现免代码生成的编译期列名校验查询

来源标题:Go 1.27's Generic Methods: Compile-Checked ORM Columns Without Generated Code

Go 数据库库 ant 利用 Go 1.27 新增的泛型方法,让查询 API 直接接收结构体字段指针作为列名,从而在编译期校验列是否存在及值类型是否匹配,无需代码生成步骤。作者称 ant.Gt(&Users.Age, 18) 这类写法可在编译时发现拼写错误,避免 GORM、Bun 等到运行时才报错的问题。文章还讨论了该方案的运行时开销以及编译通过后仍可能出错的场景。

Hacker News 最新borderss2026/11/11 · 6 天前29 分钟阅读

以下正文由 AI 翻译自 Hacker News 最新(原文版权归原站所有),可能存在偏差,重要内容请以原文为准。

Go 数据库库会让你在两种取舍之间二选一。GORM 和 Bun 把列名当作字符串,所以 “agee > ?” 能顺利构建,直到第一次运行才报错。ent 和 sqlc 在构建时检查每一列,但它们要靠一个 schema 文件或一整个 SQL 文件夹,再加一个生成步骤,你的代码才能编译。

我想要这种检查,但不想要生成器。Go 1.27 加入了泛型方法,而它正是缺失的那一块拼图:可链式调用的查询 API 现在可以把你自己结构体字段的指针当作列名。ant.Gt(&Users.Age, 18) 指定了 age 列,编译器会检查 Age 是否存在,以及 18 是否是该字段的正确类型。无需生成任何代码。

这篇文章讲的是它如何工作、运行时开销有多大,以及哪些地方即使编译通过仍会出错。这个库叫 ant,由我维护。

查询年龄大于 18 的用户及其帖子,按姓名排序,每次取 10 条。

var Users = ant.FieldsUser users, err := db.Users. Include(&Users.Posts). Where(ant.Gt(&Users.Age, 18)). OrderBy(&Users.Name). Limit(10). All(ctx)

var users []User err := db.WithContext(ctx). Preload("Posts"). Where("age > ?", 18). Order("name"). Limit(10). Find(&users). Error

var users []User err := db.NewSelect(). Model(&users). Relation("Posts"). Where("age > ?", 18). Order("name"). Limit(10). Scan(ctx)

users, err := client.User.Query(). WithPosts(). Where(user.AgeGT(18)). Order(user.ByName()). Limit(10). All(ctx)

tools/compare 会把这四个查询都跑在同一个 PostgreSQL 数据库上,并检查它们返回相同的行。下面是每个方案在构建时能捕获的问题。我通过编译每个错误逐一测试了每个单元格:

GORM 也在朝这个方向走。它有一个泛型 API 和一个可选的 CLI,用于生成带类型的字段辅助方法。那属于代码生成,但是可选的;如果你已经在用 GORM,这是获得部分此类检查的最省事方式。

以下错误来自 Go 1.27.3 上的 go build,只裁剪了文件路径。

db.Users.Where(ant.Gt(&Users.Agee, 18)) Users.Agee undefined (type *User has no field or method Agee)

类型错误的值:

db.Users.Where(ant.Gt(&Users.Age, "18")) cannot use "18" (untyped string constant) as int value in argument to ant.Gt

拼错的关系:

db.Users.Include(&Users.Psots) Users.Psots undefined (type *User has no field or method Psots)

在条件中把关系当作值使用。Eq 需要一个可比较的值,而切片不是:

db.Users.Where(ant.Eq(&Users.Posts, nil)) []Post does not satisfy comparable

这些错误信息没有一条提到 ant。它们都是关于普通 Go 字段的普通 Go 错误,你的编辑器会在你输入时显示它们。用 gopls 重命名 Age,所有用到它的查询都会跟着改。

ant.FieldsUser 返回一个探针:一个不持有任何数据的 *User。它唯一的职责就是拥有一个地址。当你写 &Users.Age 时,你得到的是指向该探针中 Age 偏移处的一个指针。ant 分三步把这个指针还原成列。

第 3 步的类型检查之所以存在,是因为仅靠偏移量会有歧义。结构体与其第一个字段共享地址:&Users.Base 和 &Users.Base.ID 指向同一个字节。Resolve 上的类型参数无需额外成本就能区分它们,因为编译器已经知道 V。

下面是真实的代码,已做删减。完整版本在 internal/meta/meta.go。

func ProbeT any *T { model := OfT // reflected once per type, then cached // (under mu: return the existing probe for model, if there is one) p := new(T) probes = append(probes, probe{unsafe.Pointer(p), uintptr(unsafe.Pointer(p)), model}) return p }

func Resolve[V any](ptr *V) (Ref, bool) { addr := uintptr(unsafe.Pointer(ptr)) t := reflect.TypeForV mu.RLock() defer mu.RUnlock() for _, p := range probes { if addr < p.base || addr >= p.base+p.model.Type.Size() { continue } off := addr - p.base for _, f := range p.model.Fields { if f.Offset == off && f.Type == t { return Ref{Model: p.model, Field: f}, true } } // relations are matched the same way } return Ref{}, false }

解析大约耗时 21 ns,且不分配内存。数据来自 tests/benchmarks 中的 BenchmarkProbeResolution,在 Ryzen 5 3600 搭配 Go 1.27.3 上运行了五次,注册了少量探针。扫描是线性的,所以有数百个模型的应用每次查找开销会更大,但相对于一次数据库往返仍然很小。

人们有理由质疑的地方是:这能成立,只因为 Go 运行时不会移动堆对象。探针的地址必须在进程整个生命周期内保持不变。Go 的垃圾回收器目前不做压缩、不移动对象,而语言层面没有任何承诺说它永远不会。ant 在列表里保留原始的 unsafe.Pointer,让探针保持可达;TestProbeSurvivesGC 强制触发两次回收,并检查地址没有改变。如果未来某个 Go 版本加入了移动式回收器,那个测试就是我发现问题的地方,届时设计就需要对象固定(pinning)或换一套身份标识方案。

先说一个合理的反对意见:ant.Gt(&Users.Age, 18) 是一个普通的泛型函数,func Gt[V Ordered](field *V, value V) Cond。这在 Go 1.18 就能编译了。条件从来不是问题所在。

问题出在链式调用上。OrderBy 需要知道传入字段的类型,才能要求它是可排序的类型。Include 需要关系的元素类型,以便可选的结果塑造函数拿到带类型的 *Query[Post]。在 1.27 之前,方法不能声明自己的类型参数。在 go.mod 中用 go 1.26 试试,编译器会说:

generic method requires go1.27 or later

所以 API 之前只能用包级函数,而它们会从内向外嵌套:

// before 1.27: the reader starts in the middle users, err := ant.OrderBy( ant.Include( db.Users.Where(ant.Gt(&Users.Age, 18)), &Users.Posts, ), &Users.Name, ).Limit(10).All(ctx)

// 1.27: top to bottom users, err := db.Users. Include(&Users.Posts). Where(ant.Gt(&Users.Age, 18)). OrderBy(&Users.Name). Limit(10). All(ctx)

(原文较长,此处译出前 6000 字,完整内容请点「打开原文」。)

正文由 探How 从来源站点 RSS 同步,内容未经改写;遇到排版缺失或需要图片、视频时请以原文为准。

打开原文
去社区讨论 →