Go database/sql sql.Out 接收存储过程输出参数的绑定方法

调用带 OUT 或 INOUT 参数的存储过程时，Go 侧不要把输出值当成普通入参传入。正确做法是准备一个具体类型的变量，用 sql.Out{Dest: &变量} 交给 ExecContext；需要把初值一并传给存储过程时，再设置 In: true。输出值会回写到同一个变量中，但前提是当前数据库驱动支持输出参数。

官方文档：https://pkg.go.dev/database/sql#Out

OUT 参数的值是怎样进入 Go 变量的

sql.Out 只描述“这个参数要接收存储过程输出”，它不是一个独立的查询结果集。Dest 保存的是目标变量的指针，驱动完成调用后把可转换的输出值写入该地址。因此，变量类型要先按存储过程的输出类型准备好，不能把普通值直接填进 Dest。

package main

import (
	"context"
	"database/sql"
	"fmt"
)

func callSummary(ctx context.Context, db *sql.DB) (string, error) {
	var summary string // 用具体变量接收 OUT 参数，Dest 必须传它的指针

	_, err := db.ExecContext(
		ctx,
		"ReportSummary",
		sql.Named("ReportID", 42),
		sql.Named("Summary", sql.Out{Dest: &summary}), // 纯 OUT：只声明回写目标
	)
	if err != nil {
		return "", fmt.Errorf("调用 ReportSummary 失败: %w", err) // 保留驱动原始错误
	}
	return summary, nil // 调用成功后再读取回写的变量
}

这里的 ReportSummary 和参数名只是示例，具体占位符、命名规则以及存储过程名称由驱动和数据库决定。关键关系是：sql.Named 负责参数名，sql.Out 负责输出语义，Dest 负责接收地址。

Dest 与 In 的边界决定调用方式

纯 OUT 参数没有要传入的初值，设置 Dest 即可。INOUT 参数既需要初值，又需要接收新值，此时 Dest 仍然是同一个指针，同时把 In 设为 true。调用前，驱动读取指针指向的初值；调用后，再把结果写回。

func callCounter(ctx context.Context, db *sql.DB) (int, error) {
	value := 10 // INOUT 的初始值会通过 Dest 指针提供给驱动
	_, err := db.ExecContext(
		ctx,
		"AdjustCounter",
		sql.Named("Counter", sql.Out{Dest: &value, In: true}), // In=true 表示先读入再回写
	)
	if err != nil {
		return 0, fmt.Errorf("调整计数器失败: %w", err) // 不要把驱动错误吞掉
	}
	return value, nil // 这里拿到存储过程返回的新值
}

In 不是“是否成功”的开关，也不能替代数据库端参数声明。若数据库端只是 OUT，却误设为 INOUT，驱动可能拒绝参数或把初值当作无效输入。

遇到不支持时先查驱动能力，再查代码

官方文档明确提醒，并非所有数据库和驱动都支持 OUTPUT 参数。出现“不支持输出参数”“参数类型不匹配”或类似错误时，按下面的顺序缩小范围：

1. 确认数据库端参数确实声明为 OUT 或 INOUT，名称和顺序与 Go 调用一致。
2. 确认 Dest 是可写指针，且 Go 类型能接收驱动返回的值；不要传不可写的普通值。
3. 确认使用的驱动文档是否实现输出参数，必要时查看它要求的位置参数还是命名参数。
4. 保留 ExecContext 的错误和上下文取消，不要只根据返回变量的零值判断成功。

如果驱动明确不支持 OUTPUT，换成数据库支持的结果集返回方式，或把存储过程改成普通查询接口，通常比在 Go 侧反复调整 sql.Out 更稳妥。sql.Out 解决的是参数绑定，不会抹平不同数据库的存储过程语法差异。

延伸问答

Dest 可以直接传普通变量吗？

不可以。Dest 需要指向可写目标，常见写法是 &out；直接传字符串或整数值无法让驱动回写。

OUT 参数一定要用 sql.Named 吗？

不一定，是否支持命名参数取决于驱动和数据库；但用 sql.Named 能把参数名表达清楚，位置参数驱动仍应按其文档调整。

为什么 ExecContext 成功但变量还是零值？

先确认数据库端确实设置了输出值，再检查 Dest 类型、参数模式和驱动支持；零值本身不能证明输出参数已正确处理。

把 sql.Out 看成“带接收地址的参数描述”就不容易混淆：OUT 只接收，INOUT 先传入再回写，最终能否工作由数据库端声明和驱动能力共同决定。