如何在 Go 中安全执行多语句 SQL 脚本(含文件加载与事务处理)

go 的 `database/sql` 标准库不支持单次 `exec()` 执行含多个分号的 sql 脚本,需手动拆分语句并在事务中逐条执行;本文提供健壮的字符串/文件加载方案、防空语句处理、错误回滚机制及生产级替代建议。

在 Go 应用初始化阶段(如安装脚本),常需执行包含 DDL(建表)和 DML(初始化数据)的 SQL 脚本。但直接将多语句拼接为单个字符串并调用 db.Exec() 会触发错误:"pq: cannot insert multiple commands into a prepared statement"。这不是 PostgreSQL 驱动(如 lib/pq 或 pgx)的限制,而是 Go 标准库 database/sql 的明确设计约束——Exec() 和 Query() 仅接受单条 SQL 语句,不支持分号分隔的批处理。

✅ 推荐实现:安全拆分 + 事务封装

以下是一个生产就绪的函数,支持从字符串或文件读取 SQL 脚本,并在事务中顺序执行每条非空语句:

import (
    "database/sql"
    "fmt"
    "io/ioutil"
    "strings"
)

// ExecuteSQLScript 在事务中执行 SQL 脚本(支持多语句)
func ExecuteSQLScript(db *sql.DB, script string) error {
    tx, err := db.Begin()
    if err != nil {
        return fmt.Errorf("failed to begin transaction: %w", err)
    }
    defer func() {
        if r := recover(); r != nil {
            _ = tx.Rollback()
        }
    }()

    // 按分号分割(兼容 ;、;\n、;\r\n)
    statements := strings.Split(script, ";")
    for i, stmt := range statements {
        cleanStmt := strings.TrimSpace(stmt)
        if cleanStmt == "" || strings.HasPrefix(cleanStmt, "--") || strings.HasPrefix(cleanStmt, "/*") {
            continue // 跳过空行和注释
        }

        _, err := tx.Exec(cleanStmt)
        if err != nil {
            _ = tx.Rollback()
            return fmt.Errorf("failed to execute statement #%d (%q): %w", i+1, cleanStmt[:min(50, len(cleanStmt))], err)
        }
    }

    return tx.Commit()
}

// 从文件加载并执行
func ExecuteSQLFile(db *sql.DB, filename string) error {
    content, err := ioutil.ReadFile(filename)
    if err != nil {
        return fmt.Errorf("failed to read SQL file %s: %w", filename, err)
    }
    return ExecuteSQLScript(db, string(content))
}

func min(a, b int) int {
    if a < b {
        return a
    }
    return b
}

⚠️ 关键注意事项

  • 分号不是万能分隔符:SQL 字符串字面量(如 'foo;bar')内的分号不应被拆分。上述简单分割适用于无嵌套分号的初始化脚本(推荐用于 DDL/DML 初始化)。若需完整 SQL 解析,应使用专业解析器(如 github.com/xwb1989/sqlparser)。
  • 注释处理:代码已跳过 -- 行注释和 /* */ 块注释开头的语句,避免执行无效内容。
  • 事务原子性:任一语句失败即回滚全部操作,确保数据库状态一致。
  • 资源安全:使用 defer + recover() 防止 panic 导致事务未关闭。

? 生产环境更优方案:使用迁移工具

对于长期维护的应用,强烈建议采用成熟的 SQL 迁移工具替代手写脚本执行逻辑,它们天然解决版本管理、幂等性、依赖顺序、回滚支持等问题:

工具 特点 适用场景
goose 支持 Go 代码迁移 + SQL 文件,带版本号、up/down、CLI 工具 中大型项目,需复杂逻辑或动态数据初始化
rambler 轻量纯 SQL 迁移,基于文件名排序执行,零依赖 简洁需求,偏好纯 SQL 管理
golang-migrate 最流行,支持 10+ 数据库,CLI + Go API,云存储后端 多数据库、CI/CD 集成、企业级部署

示例(goose):

goose postgres "user=xxx dbname=xxx sslmode=disable" up

对应迁移文件:20250101120000_create_users_table.sql

总结

  • ✅ 短期方案:用 strings.Split() 拆分语句 + sql.Tx 事务封装,注意过滤空行与注释;
  • ✅ 加载来源:可无缝切换 string 字面量、ioutil.ReadFile() 或 embed.FS(Go 1.16+);
  • ⚠️ 避免陷阱:勿在生产环境硬编码长 SQL 字符串;勿忽略事务错误处理;
  • ? 长期演进:立即引入 goose 或 golang-migrate,将初始化脚本纳入版本化迁移流程——这是 Go 生态中事实标准的

    最佳实践。