跳转到主内容
极星编程网:以代码为星,赴技术山海!

Go 语言如何利用 wire 实现依赖注入

Wire是编译期依赖注入工具,仅生成硬编码NewXXX调用链,不参与运行时注入;需显式执行wire build生成wire_gen.go并提交至版本库,且wire.go必须含// +build wireinject标签、与目标包同级、仅含injector和wire.Build调用。 Wire 不生成运行时注入逻辑,它只在编译前生成硬编码的
NewXXX
调用链;没跑
wire build
,
InitializeApp
这类函数根本不存在,编译直接失败。 wire.go 文件必须带
// +build wireinject
标签 这是 Go 构建约束,不是注释。没有它,
go build
和
wire build
都会跳过该文件,导致 “no injector found” 或静默无输出。 第一行必须是
// +build wireinject
(前面不能有空格,不能加逗号或额外单词) 文件必须和目标包同级,比如
cmd/myapp/wire.go
或
internal/di/wire.go
,不能放在根目录或无关包里 文件里只放
injector
函数(如
InitializeApp()
)和
wire.Build()
调用,别写业务逻辑、别 import 无关包 provider 函数必须导出且签名严格匹配 Wire 只看函数签名:参数类型决定“要什么”,返回类型决定“给什么”。它不执行函数体,但生成的代码会在启动时无条件调用——所以副作用会直接 panic。 函数名必须首字母大写,比如
NewDB
✅,
newDB
❌ 返回类型必须和依赖字段完全一致:
*sql.DB
≠
database/sql.DB
,也不等于未导出别名
type DB *sql.DB
带
error
返回是合法的(
func() (*sql.DB, error)
),但 injector 签名里没声明接收
error
,Wire 会静默丢弃错误分支 禁止在 provider 里做
db.Ping()
、启 goroutine、读配置文件——这些不是 Wire 能校验的,但会在运行时炸
wire.Build()
漏传依赖,编译时报错位置很误导 Wire 不扫描整个项目,只认
wire.Build()
显式列出的函数。漏掉中间 provider,生成的
wire_gen.go
会缺失某段初始化逻辑,最终报错指向“找不到
NewRepository
”,而不是“你没把
NewRepository
加进
wire.Build
”。 必须显式列出所有环节:如果
App
→
Service
→
Repository
→
*sql.DB
,那
wire.Build(InitializeApp, NewService, NewRepository, NewDB)
一个都不能少 参数依赖也要覆盖:比如
NewDB(cfg Config)
,就得确保
Config
要么由另一个 provider 返回,要么用
wire.Value
注入 两个 provider 都返回
*redis.Client
?Wire 直接报错。得用
wire.Struct
绑定字段,或用
wire.Value
区分用途 生成的
wire_gen.go
必须提交到 Git 它不是缓存文件,而是构建链的硬依赖。CI 里漏跑
wire build
,或本地
.gitignore
把它过滤了,新同事拉代码后
go run main.go
就会报
undefined: InitializeApp
。 文件开头有明确注释:
// Code generated by Wire. DO NOT EDIT.
—— 手动改等于破坏一致性 CI 流程中建议加检查:
git diff --quiet || (echo "wire_gen.go out of date"; exit 1)
测试时想换 mock,别改
wire.go
,另建
test_wire.go
,用
wire.Value(&mockDB{})
替换真实 provider

相关文章