Go 生成的源代码怎么自动格式化后写入文件

用 Go 模板、代码生成器或 AST 拼出源代码后，不要直接把未整理的字符串写入磁盘。标准库的 go/format 提供了更直接的做法：把完整 Go 源文件或声明片段转成 []byte，交给 format.Source，成功后再调用 os.WriteFile。格式化返回错误时停止写入，目标文件就不会被一份语法不完整的半成品覆盖。

最小可靠链路是“生成字符串 → format.Source → 检查 error → os.WriteFile”。完整源文件会整理 imports，局部片段不会；如果构建检查依赖长期不变的格式，还要固定 gofmt 版本。

先用 format.Source 处理生成结果

假设生成器已经得到一段完整的 Go 文件。这里不需要先落盘再调用外部命令，直接在内存中格式化即可。format.Source 返回新的字节切片，原始输入不会被原地修改。

package main

import (
    "fmt"
    "go/format"
    "os"
)

func writeGeneratedGo(path string, source string) error {
    // 先格式化，避免把语法错误或未整理的内容写进目标文件。
    formatted, err := format.Source([]byte(source))
    if err != nil {
        return fmt.Errorf("format generated source: %w", err)
    }

    // 只有格式化成功才落盘；0644 表示文件所有者可写、其他用户可读。
    if err := os.WriteFile(path, formatted, 0644); err != nil {
        return fmt.Errorf("write generated file: %w", err)
    }
    return nil
}

这段链路的关键不是把代码“变漂亮”，而是把格式化当成写入前的门槛。输入语法不完整时，函数在 os.WriteFile 前返回错误；目标路径不可写或目录不存在时，则保留写入阶段的具体原因。

区分完整源文件和声明片段

format.Source 的输入不一定要包含整个文件。官方文档允许完整源文件，也允许一组声明或语句。两者都能格式化，但边界不同，不能把“片段格式化后的结果”当成完整文件处理。

因此，生成器如果输出的是函数片段，通常应在自己的拼装阶段决定 import 列表；如果输出完整文件，则可以让 format.Source 负责完整文件的 import 整理。遇到 expected 'package' 或类似语法错误，不要只加空格，先确认传入的数据究竟是不是一个完整文件。

把格式化字节写入文件并处理错误

写文件时建议把错误分成两层：第一层是源代码无法格式化，第二层是文件系统拒绝写入。这样日志能明确告诉你是生成器产出了坏源码，还是目标目录、权限、磁盘空间等环境条件有问题。

如果目标文件重要，可以先写临时文件并在成功后替换；如果只是构建目录里的中间产物，前面的“先格式化、后写入”通常已经足够。无论采用哪种策略，都不要忽略 format.Source 的返回错误，也不要在错误时继续使用可能不完整的 formatted。

• 格式化失败：记录源代码生成上下文，修复模板、AST 或片段拼接。
• 写入失败：检查父目录、权限、路径和磁盘状态。
• 重复生成：确认写入策略是否需要保留旧文件，避免空结果覆盖已有文件。

固定工具版本应对格式变化

go/format 的文档特别提醒：Go 源代码的格式可能随版本变化。若只是开发机上的生成器，跟随项目 Go 版本通常比较自然；若是预提交检查、代码生成产物比较或跨机器构建，直接依赖每个人当前安装的版本会让结果出现漂移。

这类场景可以把固定版本的 gofmt 放进工具链，并在 CI 中显式调用它。文章开头的内存格式化适合快速生成和写入，但“输出必须多年一致”时，应优先保证执行格式化工具的版本一致，而不是只依赖重新编译后的 go/format 包。

常见问题

format.Source 能格式化不完整的 Go 代码吗？

它可以处理声明或语句列表等局部输入，但输入仍需满足对应语法形式；随意截断一个完整文件，可能直接返回语法错误。

format.Source 会自动补上缺失的 import 吗？

不会。它负责格式化；完整文件中的 imports 可以被排序，但不会根据标识符使用情况替你推断和添加依赖。

为什么格式化成功后还要检查 os.WriteFile？

格式化只说明内存中的源码可按规则输出，不能证明目标路径可写。目录不存在、权限不足或磁盘异常都可能在写入阶段失败。