Wire 是编译前生成注入代码的工具,要求 wire.go 带 // +build wireinject 标签、置于目标包内、仅含 injector 和 wire.Build() 调用;所有 provider 必须导出、签名清晰、无副作用,生成的 inject.go 需提交至 Git。
Wire 不是运行时框架,它在编译前就生成 inject.go(或 wire_gen.go),你看到的 NewApp、NewHandler 全是普通 Go 函数,不是 magic。漏跑 wire build,编译直接报 undefined: NewApp——因为那函数根本不存在。
wire.go 文件必须带 // +build wireinject 标签
这个注释不是可选的“说明”,而是 Go 构建约束(build tag)。没有它,go build 会直接跳过该文件,wire build 也就找不到 wire.Build() 调用。
-
wire.go必须放在你要生成注入器的包里(比如cmd/myapp/或internal/di/),不能丢在根目录或无关包中 - 文件里只放 injector 声明(如
InitializeApp())和wire.Build()调用,别塞业务逻辑 - 所有参与构建的函数(
NewDB、NewCache等)必须导出(首字母大写),否则wire build看不见
wire.Build() 参数必须全是 provider 函数
wire.Build() 不接受结构体、变量、闭包或未导出函数,只认签名清晰的 provider:输入是依赖项,输出是你想提供的类型。
- 第一个参数通常是 injector 函数(如
InitializeApp),后面跟它依赖的所有 provider(NewDB、NewRedis、ProvideConfig) - 如果某个 provider 需要参数(如
func ProvideDB(dsn string) *sql.DB),而dsn本身也是依赖项,就必须确保有另一个 provider 返回string,或用wire.Value显式绑定 - 两个 provider 都返回
*sql.DB?Wire 直接报错。解决方式只有两种:wire.Value绑定具体实例,或用wire.Struct+ 字段标签区分用途
生成的 inject.go 必须提交到 Git
inject.go 是构建产物,但不是临时缓存——它是编译链的硬依赖。CI 流程里不跑 wire build,或者本地 .gitignore 把它过滤了,新成员拉代码后 go run main.go 就会失败。
sematic
一个开源的机器学习平台
下载
立即学习“go语言免费学习笔记(深入)”;
- 生成文件开头明确写着
// Code generated by Wire. DO NOT EDIT.,手动改等于自毁一致性 - CI 中建议加检查:
git diff --quiet || (echo "wire_gen.go out of date"; exit 1) - 常见错误:本地
.gitignore写了**/*.go或inject*,导致文件没进仓库
provider 函数不能有副作用
Wire 不执行 provider 函数体,只看签名;但它生成的初始化代码会在程序启动时无条件调用这些函数。所以:
- 别在
NewDB()里做db.Ping()或启 goroutine——失败就 panic,且这个 panic 发生在运行时,Wire 查不到 - 返回
(*sql.DB, error)是 OK 的,Wire 会自动处理 error 并中断初始化 - 参数类型必须精确匹配:
*sql.DB≠database/sql.DB,也 ≠ 自定义别名type DB *sql.DB(除非用wire.Bind显式声明)
最常被忽略的点:Wire 的报错永远发生在生成阶段,而不是运行时。一旦你看到 no provider found for *redis.Client,问题一定出在 provider 没导出、没加进 wire.Build()、类型别名没处理,或者构建标签写错了——跟运行环境、配置、网络完全无关。