运行 Go 中的 generate 工具，自动生成代码【学习笔记】

//go:generate 是 Go 中的注释标记，运行时会触发对应命令，适合与代码生成工具集成。
通过这种方式，可以减少手动编写重复代码的工作量，提高开发效率。

示例场景

//go:generate python3 models.py $GOFILE $GOPACKAGE

假设你希望通过 Python 脚本自动生成一些与 Go 文件相关的辅助代码（比如，数据模型文件或文档），可以通过这种方式实现。
使用 //go:generate python3 models.py $GOFILE $GOPACKAGE 表示在运行 go generate 时，
将执行一段 Python 脚本 models.py，并将 Go 文件的文件名和包名作为参数传递给脚本。这是一种灵活的方式，
可以结合 Python 脚本生成相关的代码或文件。

main.go

//go:generate python3 models.py $GOFILE $GOPACKAGE
package main

import "fmt"

func main() {
    fmt.Println("This is an example of go:generate with Python.")
}

models.py

import sys

# 从命令行获取参数
if len(sys.argv) != 3:
    print("Usage: python3 models.py <GOFILE> <GOPACKAGE>")
    sys.exit(1)

gofile = sys.argv[1]
gopackage = sys.argv[2]

# 输出信息
print(f"Generating models for Go file: {gofile} in package: {gopackage}")

# 模拟生成一个模型文件
output_file = f"{gopackage}_models.txt"
with open(output_file, "w") as f:
    f.write(f"// Models generated for {gofile} in package {gopackage}\n")
    f.write(f"// This file is auto-generated. Do not edit!\n\n")
    f.write("type Model struct {\n")
    f.write("    ID   int\n")
    f.write("    Name string\n")
    f.write("}\n")

print(f"Generated {output_file}")

运行 go generate：

go generate ./...

解释

go generate 的行为：
读取 main.go 文件。
解析其中的 //go:generate 注释。
替换 $GOFILE 为 main.go，替换 $GOPACKAGE 为 main。

实际执行以下命令：
python3 models.py main.go main

Python 脚本的输出：
Generating models for Go file: main.go in package: main
Generated main_models.txt

生成一个文件 main_models.txt，内容如下：
// Models generated for main.go in package main
// This file is auto-generated. Do not edit!

type Model struct {
    ID   int
    Name string
}

总结

灵活性：
go:generate 的这种用法可以结合任意脚本语言，处理复杂的自动化任务。

典型用途：
根据 Go 文件生成配置、辅助代码或文档。
调用外部工具或脚本与 Go 代码进行交互。

注意事项：
确保脚本（如 models.py）在路径中可用。
检查 $GOFILE 和 $GOPACKAGE 是否正确解析并传递。
这种方式非常适合跨语言的开发场景，例如结合 Python 的强大文本处理能力生成高质量代码。