Go printer.Config.Fprint 怎么控制 AST 输出缩进

要控制 printer.Config.Fprint 的 AST 输出缩进，直接设置 Config.Indent。它表示所有代码至少增加多少个基础缩进层级；Tabwidth 只负责制表位宽度，Mode 决定缩进和对齐最终使用制表符还是空格。三者作用不同，不能只改 Tabwidth 来代替 Indent。

常用配置是 Indent: 2、Tabwidth: 8、Mode: printer.TabIndent | printer.UseSpaces：基础缩进增加两级，缩进保留制表符，对齐位置使用空格，行为更接近 Go 源码常见排版。

先给结论：Indent 管基础层级，Mode 管输出策略

我第一次用 go/printer 打印函数节点时，直觉上把 Tabwidth 从 8 改成 4，以为整个片段会向右缩进四格。结果只是制表位宽度改变，片段仍从行首开始。真正决定“整体往右放几级”的字段是 Indent。

Indent 会和节点内部缩进叠加。假设基础值是 2，函数声明从两级位置开始，函数体内语句再增加 AST 自身的一层，条件块内语句继续增加一层。它不是把每行机械替换成同样数量的空格。

完整示例：给函数声明增加两级基础缩进

下面示例先解析一段源码，再取出第一个声明节点。这样既能看到基础缩进，也能观察函数体和条件块如何继续叠加层级。

package main

import (
    "bytes"
    "fmt"
    "go/parser"
    "go/printer"
    "go/token"
)

func main() {
    const src = `package demo

func Check(n int) int {
    if n > 10 {
        return n * 2
    }
    return n
}`

    // FileSet 保存源码位置，printer 会据此解释节点中的 token.Pos。
    fset := token.NewFileSet()
    file, err := parser.ParseFile(fset, "demo.go", src, parser.ParseComments)
    if err != nil {
        panic(fmt.Errorf("解析源码失败: %w", err))
    }
    if len(file.Decls) == 0 {
        panic("源码中没有可打印的声明")
    }

    cfg := &printer.Config{
        Mode:     printer.TabIndent | printer.UseSpaces,
        Tabwidth: 8,
        Indent:   2, // 所有行先增加两级基础缩进。
    }

    var out bytes.Buffer
    if err := cfg.Fprint(&out, fset, file.Decls[0]); err != nil {
        panic(fmt.Errorf("打印 AST 失败: %w", err))
    }

    fmt.Print(out.String())
}

这个配置不会修改 AST，也不会改写原始源码文件。它只影响写入 io.Writer 的排版结果，因此适合生成模板片段、文档示例、测试快照或嵌套在其他文本中的 Go 代码。

Mode 怎么选：三个常用配方

配方一：Go 常见缩进与空格对齐

cfg := &printer.Config{
    Mode:     printer.TabIndent | printer.UseSpaces,
    Tabwidth: 8,
    Indent:   1, // 整体增加一级缩进，内部层级继续由 AST 决定。
}

TabIndent 让缩进独立使用制表符，UseSpaces 让列对齐使用空格。这是需要保留 Go 代码习惯、同时让声明对齐稳定时的常见组合。注意，包级 printer.Fprint 使用默认配置，但官方文档明确说明：若要得到与 gofmt 匹配的输出，应使用 go/format。

配方二：输出字节中尽量使用空格

cfg := &printer.Config{
    Mode:     printer.UseSpaces, // 不设置 TabIndent，让 tabwriter 用空格展开。
    Tabwidth: 4,
    Indent:   2,
}

这种配置适合把代码片段嵌入不希望出现制表符的文本载体。这里的 Tabwidth: 4 决定制表位展开宽度；Indent: 2 仍表示两个基础层级。最终每行的空格数还会受到当前列和对齐需求影响，因此不要把它理解为简单的 2 × 4 字符替换器。

配方三：保留 printer 的原始制表控制

cfg := &printer.Config{
    Mode:     printer.RawFormat,
    Tabwidth: 8, // RawFormat 不经过 tabwriter，此值不再控制展开效果。
    Indent:   1,
}

RawFormat 会绕过 tabwriter，且 UseSpaces 会被忽略。输出中可能保留制表字符，更适合调试 printer 的原始排版标记或交给下游自行处理，而不是直接作为用户可见源码。

几个容易踩的误区

误区一：Tabwidth 就是每级缩进空格数

不是。Indent 决定基础缩进层级数量，Tabwidth 是 tabwriter 的列宽参数。只有结合具体 Mode 和当前列位置，才能判断最终字节或视觉宽度。

误区二：Indent 会改变 AST 的节点位置

不会。节点里的 token.Pos 和 FileSet 仍然保持原值。Indent 只是打印器的输出配置。如果启用了 printer.SourcePos，打印器还可能写出 //line 指令来保持原始源码位置，这与视觉缩进是另一件事。

误区三：Config.Fprint 一定等于 gofmt

不保证。go/printer 负责打印 AST，go/format 才是面向 gofmt 风格输出的接口。若目标是生成可提交的完整 Go 文件，通常先构造 AST，再调用 format.Node 更合适；若目标是把一个节点嵌到现有文档的某个缩进层级，printer.Config.Fprint 的 Indent 更直接。

误区四：打印函数体后再删除花括号就能稳定得到片段

对固定输入可以工作，但这种字符串后处理依赖输出形状。若只是要语句列表，Config.Fprint 支持 []ast.Stmt，直接传语句切片通常比打印 BlockStmt 再切字符串更稳。

打印语句切片时的实用封装

下面函数接收 []ast.Stmt，允许调用方指定基础缩进层级，并统一使用接近 Go 常见排版的 Mode。把配置集中在一个入口，可以避免不同生成器各自选择缩进策略。

package astprint

import (
    "bytes"
    "fmt"
    "go/ast"
    "go/printer"
    "go/token"
)

// Statements 将语句列表打印为带基础缩进的 Go 代码片段。
func Statements(fset *token.FileSet, stmts []ast.Stmt, indent int) (string, error) {
    if fset == nil {
        return "", fmt.Errorf("FileSet 不能为空")
    }
    if indent 

如果 AST 是手工构造的，位置字段可能无效。Fprint 仍能打印许多节点，但注释位置、空行和源码位置相关行为会不同。需要保留注释时，可以打印完整 *ast.File，或使用 printer.CommentedNode 显式绑定节点与注释组。

什么时候该换成 go/format

快速回答

只想让 AST 片段整体右移两级：设置 Indent: 2。

希望缩进用 tab、对齐用空格：设置 Mode: printer.TabIndent | printer.UseSpaces，通常配合 Tabwidth: 8。

希望尽量输出空格：只设置 printer.UseSpaces，不要加 TabIndent。

为什么改 Tabwidth 没有整体右移：因为它控制制表位宽度，不是基础缩进层级。

为什么和 gofmt 仍有差异：因为 go/printer 的可配置打印不等同于 gofmt；完整源码优先交给 go/format。

把这三个维度拆开后，配置就很清楚：Indent 决定“从第几级开始”，AST 决定“内部再嵌套几级”，Mode + Tabwidth 决定“这些层级最终如何呈现”。

官方包文档：https://pkg.go.dev/go/printer