原文
Fx:一个易于使用的依赖注入(DI)框架。这个框架使Uber开发人员在创建新的Go应用程序非常容易。这篇文章涉及以下三个方面:
- 为什么你需要在Go应用程序中使用依赖注入
- Fx框架介绍
- 一个利用Fx的示例应用程序
为什么你需要在Go应用程序中使用依赖注入
什么是依赖注入(DI)?下面来自Stack Overflow中的一个高分答案
依赖注入
是5美分概念的25美元术语,[...]依赖注入意味着给对象一个实例变量,[...]
简而言之,DI是提供对象所需依赖项
的技术。互联网上有大量关于DI的资源比我更能解释这个概念。因此,我将通过演示一个例子来简要说明,这个例子展现了DI的最重要好处之一:它使测试变得非常容易。
以下函数的作用是:查询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.DB
),而不是将其作为输入参数。这使单元测试成为一个问题。我们如何模拟数据库? DI
解决了可测性问题。以下代码使用DI
,并且可以轻松进行测试。
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")
}
类似可测试性的改进不仅适用于数据库连接,还适用于你定义的任何自定义struct
。如果你为特定领域(domain)的实体(entity)定义接口(interfaces
),函数也可以接受接口,那么就可以在测试期间向函数提供mocks
Fx介绍:一个Go依赖注入框架
Fx是Uber在Go语言中易用使用的DI解决方案。Fx’s GoDoc:
fx是一个DI框架,可以简单地从
可重用
,可组合
的模块中构建应用程序
我们不想将Spring及其所有复杂性引入Go(一种强调简单性和可维护性的语言)中。我的目标是展示Fx轻巧易学。本节介绍Fx公开的几种类型和功能。
所有Fx应用程序均以fx.App
开头,该fx.App
可以从fx.New()
构建。可以初始化并运行一个最小的Fx应用程序,列如:
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的DI功能。应用程序使用fx.Invoke()
调用register
函数。应用启动后,生命周期(lifecycle
)将自动作为参数传递给register
函数。本示例将使用Go的标准库启动HTTP服务器。
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应用程序示例
我已经创建了一个运行HTTP服务器的示例Fx应用。它使用Fx应用程序中的一些常见模式。例如,该应用由小的可重复使用的模块组成,例如loggerfx
,它提供了*zap.Logger
var Module = fx.Provide(New)
// --snip--
func New() (*zap.Logger, error) {
// --snip--
}
Fx使你可以很好地构建代码。Handler
可以放在internal/handler/
子目录中,例如示例应用程序中的hello处理程序。然后可以通过在internal/handler/module.go
中定义一个处理程序模块,将所有Handler
提供给Fx应用程序,如下所示:
// 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似乎会产生更多样板代码,但实际上,这使代码库更易于浏览,程序包也更易于测试。
有疑问加站长微信联系(非本文作者)