原文
Fx:一个易于使用的依赖注入(DI)框架。这个框架使Uber开发人员在创建新的Go应用程序非常容易。这篇文章涉及以下三个方面:
- 为什么你需要在Go应用程序中使用依赖注入
- Fx框架介绍
- 一个利用Fx的示例应用程序
为什么你需要在Go应用程序中使用依赖注入
什么是依赖注入(DI)?下面来自Stack Overflow中的一个高分答案
依赖注入
依赖项
以下函数的作用是:查询SQL数据库并返回结果
func query() (email string) {
db, err := sql.Open("postgres", "user=postgres dbname=test ...")
if err != nil {
panic(err)
}
err = db.QueryRow(`SELECT email FROM "user" WHERE id = $1`, 1).Scan(&email)
if err != nil {
panic(err)
}
return email
}
DI*sql.DBDIDI
func query(db *sql.DB) (email string) {
err = db.QueryRow(`SELECT email FROM "user" WHERE id = $1`, 1).Scan(&email)
if err != nil {
panic(err)
}
return email
}
func TestQuery(t *testing.T) {
db := mockDB()
defer db.Close()
email := query(db)
assert.Equal(t, email, "email@example.com")
}
structinterfacesmocks
Fx介绍:一个Go依赖注入框架
Fx是Uber在Go语言中易用使用的DI解决方案。Fx’s GoDoc:
可重用可组合
fx.Appfx.Appfx.New()
func main() {
fx.New().Run()
}
Fx具有应用程序生命周期的概念。通过生命周期管理,可以注册在应用程序的启动和停止时要执行的功能。一个常见的用例是:为路由注册处理程序。
func main() {
fx.New(
fx.Invoke(register),
).Run()
}
func register(lifecycle fx.Lifecycle) {
mux := http.NewServeMux()
server := http.Server{
Addr: ":8080",
Handler: mux,
}
mux.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusOK)
})
lifecycle.Append(
fx.Hook{
OnStart: func(context.Context) error {
go server.ListenAndServe()
return nil
},
OnStop: func(ctx context.Context) error {
return server.Shutdown(ctx)
}
}
)
}
fx.Invoke()registerlifecycleregister
func newObject() *object {
return &object{}
}
func main() {
fx.New(
fx.Provide(newObject),
fx.Invoke(doStuff),
).Run()
}
func doStuff(obj *object) {
// Do stuff with obj
}
Fx提供了许多其他高级DI功能。其GoDoc提供了用法示例。
模块化Fx应用程序示例
loggerfx*zap.Logger
var Module = fx.Provide(New)
// --snip--
func New() (*zap.Logger, error) {
// --snip--
}
Handlerinternal/handler/internal/handler/module.goHandler
// In module.go
package handler
// --snip--
var Module = fx.Options(
hello.Module,
user.Module,
// ...
)
// In main.go
fx.New(
handler.Module, // this provides all the handlers registered previously
)
结论
通过上面的例子,我们可以发现Fx是一个非常轻量级的DI框架,可以促进良好的代码结构。我用它来构建多个MVCS风格的应用程序。尽管乍一看使用Fx似乎会产生更多样板代码,但实际上,这使代码库更易于浏览,程序包也更易于测试。