golang如何使用sqlc代码生成_golang sqlc类型安全代码生成方法

浅晨同学_4300

浅晨同学_4300

2026-04-04

362人浏览

原创

sqlc生成的go代码不能直接用database/sql的scan,因其采用sqlx风格的structscan/scan,要求结构体字段名、类型、顺序与sql列严格匹配,且需正确配置db标签、导出字段及大小写一致。

golang如何使用sqlc代码生成_golang sqlc类型安全代码生成方法

sqlc 生成的 Go 代码为什么不能直接用 database/sql 的 Scan?

因为 sqlc 默认生成的是结构体(struct)和查询函数,它不依赖 database/sql 的 Scan 接口,而是用 sqlx 风格的 Get/Select 模式——底层调用的是 rows.StructScan 或 row.Scan,但前提是字段名、类型、顺序必须严格匹配。常见错误是:数据库列名含下划线(如 user_id),而 Go 结构体字段用了 UserID,但没加正确的 db 标签,导致扫描失败或字段为零值。

  • 确保 sqlc.yaml 中启用了 emit_json_tags: true 和 emit_db_tags: true(默认开启)
  • 结构体字段必须导出(首字母大写),且 db 标签值要和 SQL 列名完全一致(区分大小写,除非 DB 是 case-insensitive)
  • 如果用了 AS 别名,比如 SELECT name AS full_name,那结构体字段的 db 标签就得是 db:"full_name"

如何让 sqlc 生成带自定义类型(如 uuid.UUID 或 time.Time)的字段?

sqlc 默认把 PostgreSQL 的 UUID 映射为 string,TIMESTAMP 映射为 time.Time —— 看似合理,但实际中常需要更精确的控制,比如强制用 github.com/google/uuid.UUID,或把 TIMESTAMPTZ 统一转成带时区的 time.Time。

  • 在 sqlc.yaml 的 packages 下配置 overrides,例如:
    overrides:
    - db_type: "uuid"
      go_type: "github.com/google/uuid.UUID"
      go_imports:
        - "github.com/google/uuid"
  • 对时间类型,PostgreSQL 的 timestamptz 默认已映射为 time.Time,但若发现时区丢失,检查是否漏了 timezone=UTC 在数据库连接串里
  • 自定义类型必须实现 driver.Valuer 和 sql.Scanner,否则运行时报 cannot scan into dest

sqlc generate 报错 “no statements found” 怎么办?

这是最常卡住新手的问题:sqlc 找不到 SQL 文件,或文件里没识别为有效语句。它只认以 -- name: 开头的注释块,且要求格式极其严格。

Golang Uber Dig
Golang Uber Dig

使用 uber-go/dig 在 Golang 中实现依赖注入——基于反射容器,提供 Provide/Invoke、dig.In/dig.Out 参数与结果对象,支持命名依赖等

下载
  • SQL 文件必须以 .sql 结尾,且放在 sqlc.yaml 中 sql: 配置的路径下(如 ./query/*.sql)
  • -- name: 必须顶格写,冒号后至少一个空格,后面接函数名 + 空格 + SQL 类型,例如:-- name: GetUser :one
  • 每条语句之间必须有空行;:one、:many、:exec 必须小写,不能写成 ONE 或 One
  • 别用 VS Code 的「SQLTools」插件自动加的注释模板,它可能插入了不可见 Unicode 字符

生成的代码里为什么没有 context.Context 参数?

sqlc v1.14+ 默认启用 experimental_context,但旧项目升级后容易忽略这个开关。不带 context 的函数无法超时控制或取消,线上易出长尾请求。

  • 确认 sqlc.yaml 中 version 是 "2"(不是 "1"),且包含:
    sql:
      - engine: "postgresql"
        schema: "schema.sql"
        queries: "query/"
        gen:
          go:
            package: "db"
            out: "db"
            experimental_context: true
  • 生成后所有查询函数第一个参数都是 ctx context.Context,调用时务必传入非 nil 上下文,比如 ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
  • 如果已有代码没传 ctx,编译直接报错,没法“悄悄兼容”

真正麻烦的不是生成逻辑,而是 SQL 注释的格式容错率极低,多一个空格、少一个换行,sqlc 就当它不存在。建议把 sqlc generate 加进 CI 的 pre-commit hook 里,早暴露比上线后查半天强。

golang免费学习笔记(深入):立即使用
在学习笔记中,你将探索golang的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

golang

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

3169

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2308

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1240

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1198

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1356

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2158

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3460

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

15775

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

549

3

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程