Go 多行字符串字面量的缩进规范与最佳实践

花韻仙語 2026-01-13 00:00:00 次阅读

go 原生不支持自动去除多行原始字符串首行缩进，直接缩进会导致换行后内容含多余空格；推荐使用 dedent 工具包或手动调整结构，兼顾可读性、可维护性与 sql 语义正确性。

在 Go 中编写多行 SQL 或其他结构化文本时，原始字符串字面量（`...`）虽避免了转义问题，但其缩进处理易引发实际困扰：若按代码缩进对齐字符串内容（如首行顶格、后续行用空格对齐），会导致 SQL 中混入不可见的前导空格，影响查询逻辑或可读性；若将字符串整体左移至行首（即换行后立即开始内容），又会破坏代码整体缩进风格，降低可维护性。

推荐方案一：使用 github.com/lithammer/dedent（最实用）
该库行为类似 Python 的 textwrap.dedent()，自动计算并移除每行共有的最小缩进量，保留相对缩进关系：

import "github.com/lithammer/dedent"

// ✅ 清晰、对齐、无冗余空格
if select == nil {
    select, err = db.Prepare(dedent.Dedent(`
        select name
        from table
        where id = $1
    `))
    if err != nil {
        return nil, err
    }
}

注意：dedent.Dedent 会忽略首行（空行或仅含空白符的行）和末行的缩进，因此上面示例中三重反引号之间的首尾换行及缩进均被安全处理，最终生成的字符串为：

select name
from table
where id = $1

推荐方案二：手动拼接（零依赖，适合简单场景）
对短 SQL 可用 + 拼接 + 单行字符串，保持缩进一致性且无空格风险：

if select == nil {
    query := "select name " +
             "from table " +
             "where id = $1"
    select, err = db.Prepare(query)
    // ...
}