go依赖注入管理工具wire的使用方法

 更新时间:2023年09月24日 14:39:30   作者:小范真是一把好手  
本文主要介绍了如何使用go wire管理依赖,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧

wire能做什么?

wire是一个依赖注入管理的工具。主要包含两个角色provider,injector,

  • provider: a function that can produce a value.
  • injector: a fucntion that calls providers in dependency order.

我们通过简单电子商务网站的例子来看看wire能干什么。假设有个购物车(ShoppingCart)的对象,该对象由多个产品列表(ProductList)组成,他们的UML关系如下

具体代码实现如下,

type ShoppingCart struct {
    // 依赖于产品列表
    ProductList *ProductList
    // 其他属性和方法
}
// 产品列表模块
type ProductList struct {
    // 一些产品数据和方法
}
// 创建购物车的函数, 这就是依赖注入
// ShoppingCart对象,需要的部分组件,来自于入参,而不是函数内部构建
func NewShoppingCart(pl *ProductList) (*ShoppingCart, error) {
    return &ShoppingCart{ProductList: pl}, nil
}
// 创建产品列表的函数
func NewProductList() (*ProductList, error) {
    return &ProductList{}, nil
}

在不使用wire的情况下,如果我们需要使用ShoppingCart对象,需要下面这样一段初始化代码:

func InitializeShoppingCart() (*ShoppingCart, error) {
	// 1. 首先构建productList
    productList, err := NewProductList()
	if err != nil {
		return nil, err
	}
    // 2. 构建ShoppingCart
	shoppingCart, err := NewShoppingCart(productList)
	if err != nil {
		return nil, err
	}
	return shoppingCart, nil
}

这个例子只涉及到两个对象,所以这段代码写起来不费力气。如果这是一个复杂的WebServer对象呢?我们初始化较多的对象,比如redisDao,MySQLDao,Kafka,Log,httpServer,grpcServer等等,这些依赖关系都需要我们自己处理,那得多麻烦啊。所以,wire就是解决这个问题的,你可以理解wire帮我们写了类似于InitializeShoppingCart 这个函数。 下面,我们来看看如何使用wire?

wire如何解放双手?

我们知道wire中有两个概念,一个是provider,一个是injector,在上面例子中,

  • provider:是NewShoppingCart, NewProductList这两个函数

他们有一个共同点是,都创建一个对象。现在我们需要创建一个指令,告诉wire如何根据这些provider,写出InitializaShoppingCart这个函数。我们想想,如果wire是一个人,你该如何告诉他写这个函数呢?

  • 告诉他,这个函数,最终创建的对象是什么?也就是return是什么?【注,也有一些人这样写,传入的是指针,函数中所有的操作,就是初始化这个指针中的内容】
  • 需要有哪些provider,能够创建最终的对象?

明白这两点,我们新建一个wire.go的文件,并在开始处写上+build wireinjector。接着,写上这样一段代码:

func InitializeShoppingCart() (*ShoppingCart, error) {
	wire.Build(
		NewShoppingCart,
		NewProductList,
	)
	return nil, nil
}

然后,在文件所在目录,执行wire。这个时候,会出现一个wire_gen.go的文件。

func InitializeShoppingCart() (*ShoppingCart, error) {
	productList, err := NewProductList()
	if err != nil {
		return nil, err
	}
	shoppingCart, err := NewShoppingCart(productList)
	if err != nil {
		return nil, err
	}
	return shoppingCart, nil
}

wire生成的代码,和我们自己写的是一样的。相比于处理复杂的对象依赖关系,写一个injector要简单的多。关于wire的使用,还是有一些坑的,下面我们看看如何避开这些坑。

注意事项

坑一:创建同一个对象,只需要一个provider,不要创建多个provider。

set has multiple bindings for go-tool/basic/wire1.Fooer

当injector中,有多个provider生成同一个对象时,会报上述错误。

坑二:当使用接口时,保证上provider生成的是接口,后一个provider使用的也是接口,同时保证1对1关系;

坑三:如果一个provider生成的是接口实现的结构体,另外一个是provider的入参是接口,这个时候,需要显式的使用wire.Bind函数告诉接口的具体实现者。

 var set = wire.NewSet(NewFooerImp, NewSecond, wire.Bind(new(Fooer), new(*MyFooer)))

坑四:提供的Provider需要刚刚好,不要多,也不要少;

  • inject InitializeEvent: unused provider "NewEventNumber: 有没有使用过的provider;
  • inject InitializeEvent: no provider found for Greet: 没有provider;

以上就是go依赖注入管理工具wire的使用方法的详细内容,更多关于go wire管理依赖的资料请关注脚本之家其它相关文章!

相关文章

  • 浅析Go项目中的依赖包管理与Go Module常规操作

    浅析Go项目中的依赖包管理与Go Module常规操作

    这篇文章主要为大家详细介绍了Go项目中的依赖包管理与Go Module常规操作,文中的示例代码讲解详细,对我们深入了解Go语言有一定的帮助,需要的可以跟随小编一起学习一下
    2023-10-10
  • Golang项目在github创建release后自动生成二进制文件的方法

    Golang项目在github创建release后自动生成二进制文件的方法

    这篇文章主要介绍了Golang项目在github创建release后如何自动生成二进制文件,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-03-03
  • Go语言执行系统命令行命令的方法

    Go语言执行系统命令行命令的方法

    这篇文章主要介绍了Go语言执行系统命令行命令的方法,实例分析了Go语言操作系统命令行的技巧,具有一定参考借鉴价值,需要的朋友可以参考下
    2015-02-02
  • Go语言指针用法详解

    Go语言指针用法详解

    Go指针和C指针在许多方面非常相似,但其中也有一些不同。本文详细讲解了Go语言指针的用法,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2022-07-07
  • Golang中使用Swagger生成API文档的流程步骤

    Golang中使用Swagger生成API文档的流程步骤

    Swagger 是一款强大的 API 文档生成工具,可以帮助开发者轻松创建、管理和展示 RESTful API 文档,在本文中,我们将介绍如何在 Golang 项目中使用 Swagger 来生成 API 文档,文中有相关的代码示例供大家参考,需要的朋友可以参考下
    2024-07-07
  • Go语言中更优雅的错误处理

    Go语言中更优雅的错误处理

    Go语言中的错误处理是一个被大家经常拿出来讨论的话题(另外一个是泛型)。篇文章我们将讨论一下如何在现行的 Golang 框架下提供更友好和优雅的错误处理。需要的朋友们可以参考借鉴,下面来一起看看吧。
    2017-02-02
  • golang语言http协议get拼接参数操作

    golang语言http协议get拼接参数操作

    这篇文章主要介绍了golang语言http协议get拼接参数操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-12-12
  • 浅析Go语言中的Range关键字

    浅析Go语言中的Range关键字

    Range是go语言中很独特的一个关键词,也相当好用。下面就跟着小编来再聊聊这个Range关键字,有需要的朋友们可以参考借鉴。
    2016-09-09
  • 使用go xorm来操作mysql的方法实例

    使用go xorm来操作mysql的方法实例

    今天小编就为大家分享一篇关于使用go xorm来操作mysql的方法实例,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
    2019-04-04
  • Go get命令使用socket代理的方法

    Go get命令使用socket代理的方法

    由于某些不可描述的原因,国内使用 go get 命令安装某些包的时候会超时导致失败,比如 net 包、 sys 包、 tools 包等。这篇文章给大家介绍go get 命令使用socket 代理的方法,感兴趣的朋友一起看看吧
    2018-10-10

最新评论