39 | 驯服泛型:了解类型参数
下载APP
关闭
渠道合作
推荐作者
39 | 驯服泛型:了解类型参数
2022-11-04 Tony Bai 来自北京
《Tony Bai · Go语言第一课》
课程介绍
讲述:Tony Bai
时长24:16大小22.17M
你好,我是 Tony Bai。
在专栏的结束语中,我曾承诺要补充“泛型篇”,帮助你入门 Go 泛型语法。在经历了 2022 年 3 月 Go 1.18 版本的泛型落地以及 8 月份 Go 1.19 对泛型问题的一轮修复后,我认为是时候开讲 Go 泛型篇了。
不过在正式开讲之前,我还有一些友情提示:和支持泛型的主流编程语言之间的泛型设计与实现存在差异一样,Go 的泛型与其他主流编程语言的泛型也是不同的。我希望你在学习之前,先看一下 Go 泛型设计方案已经明确不支持的若干特性,比如:
不支持泛型特化(specialization),即不支持编写一个泛型函数针对某个具体类型的特殊版本;
不支持元编程(metaprogramming),即不支持编写在编译时执行的代码来生成在运行时执行的代码;
不支持操作符方法(operator method),即只能用普通的方法(method)操作类型实例(比如:getIndex(k)),而不能将操作符视为方法并自定义其实现,比如一个容器类型的下标访问 c[k];
不支持变长的类型参数(type parameters);
… …
这些特性如今不支持,后续大概率也不会支持。所以小伙伴们,尤其是来自 Java、C++ 等语言阵营的小伙伴,在进入 Go 泛型语法学习之前,你一定要先了解 Go 团队的这些设计决策。
泛型篇的内容共有三讲,我们将从泛型的基本语法,也就是类型参数(type parameter)开启驯服泛型之旅,接下来再搞定泛型的难点定义约束(constraints),最后我们再来谈谈 Go 泛型的使用时机。如果你还想 Go 泛型的演化简史,请移步《加餐|聊聊最近大热的 Go 泛型》,这里我也做了详细分析。
那么,今天这泛型篇的第一讲,我们就来聚焦 Go 泛型的基本语法,类型参数。下面我们通过一个最常见的泛型应用场景来开启今天的学习之旅。一个小提醒需要你注意,泛型篇这三讲的所有示例代码均基于 Go 1.19.1 版本。
例子:返回切片中值最大的元素
正如小标题写的那样,我们这个例子要实现一个函数,该函数接受一个切片作为输入参数,然后返回该切片中值最大的那个元素。题目并没有明确使用什么元素类型的切片,我们就先以最常见的整型切片为例,实现一个 maxInt 函数:
maxInt 的逻辑十分简单。我们使用第一个元素值 (max := sl[0]) 作为 max 变量初值,然后与切片后面的元素 (sl[1:]) 进行逐一比较,如果后面的元素大于 max,则将其值赋给 max,这样到切片遍历结束,我们就得到了这个切片中值最大的那个元素(即变量 max)。
我们现在给它加一个新需求:能否针对元素为 string 类型的切片返回其最大(按字典序)的元素值呢?
答案肯定是能!我们来实现这个 maxString 函数:
maxString 实现了返回 string 切片中值最大元素的需求。不过从实现上来看,maxString 与 maxInt 异曲同工,只是切片元素类型不同罢了。这时如果让你参考上述 maxInt 或 maxString 实现一个返回浮点类型切片中最大值的函数 maxFloat,你肯定“秒秒钟”就可以给出一个正确的实现:
问题来了!有代码洁癖的同学肯定已经嗅到了上面三个函数散发的“糟糕味道”:代码重复。上面三个函数除了切片的元素类型不同,其他逻辑都一样。
那么能否实现一个“通用”的函数,可以处理上面三种元素类型的切片呢?提到“通用”,你一定想到了 Go 语言提供的 any(interface{}的别名),我们来试试:
我们看到,maxAny 利用 any、type switch 和类型断言(type assertion)实现了我们预期的目标。不过这个实现并不理想,它至少有如下几个问题:
若要支持其他元素类型的切片,我们需对该函数进行修改;
maxAny 的返回值类型为 any(interface{}),要得到其实际类型的值还需要通过类型断言转换;
使用 any(interface{})作为输入参数的元素类型和返回值的类型,由于存在装箱和拆箱操作,其性能与 maxInt 等比起来要逊色不少,实测数据如下:
我们看到,基于 any(interface{}) 实现的 maxAny 其执行性能要比像 maxInt 这样的函数慢上数倍。
在 Go 1.18 版本之前,Go 的确没有比较理想的解决类似上述“通用”问题的手段,直到 Go 1.18 版本泛型落地后,我们可以用泛型语法实现 maxGenerics 函数:
我们看到,从功能角度看,泛型版本的 maxGenerics 实现了预期的特性,对于 ordered 接口中声明的那些原生类型以及以这些原生类型为底层类型(underlying type)的类型(比如示例中的 myString),maxGenerics 都可以无缝支持。并且,maxGenerics 返回的类型与传入的切片的元素类型一致,调用者也无需通过类型断言做转换。
此外,通过下面的性能基准测试我们也可以看出,与 maxAny 相比,泛型版本的 maxGenerics 性能要好很多,但与原生版函数如 maxInt 等还有差距。关于泛型的运行时性能损耗问题,我们在泛型篇第三讲中会有说明。性能测试如下:
通过这个例子,我们也可以看到 Go 泛型十分适合实现一些操作容器类型(比如切片、map 等)的算法,这也是Go 官方推荐的第一种泛型应用场景,此类容器算法的泛型实现使得容器算法与容器内元素类型彻底解耦!
不过看到这里,很多同学可能会抱怨:看不懂 maxGenerics 的语法!别急,接下来,我们就来基于这个例子进行泛型基本语法的学习。
类型参数(type parameters)
根据官方说法,由于泛型(generic)一词在 Go 社区中被广泛使用,所以官方也就接纳了这一说法。但 Go 泛型方案的实质是对类型参数(type parameter)的支持,包括:
泛型函数(generic function):带有类型参数的函数;
泛型类型(generic type):带有类型参数的自定义类型;
泛型方法(generic method):泛型类型的方法。
下面我们先以泛型函数为例来具体说明一下什么是类型参数。
泛型函数
我们回顾一下上面的示例,maxGenerics 就是一个泛型函数,我们看一下 maxGenerics 的函数原型:
我们看到,maxGenerics 这个函数与我们之前学过的普通 Go 函数(ordinary function)相比,至少有两点不同:
maxGenerics 函数在函数名称与函数参数列表之间多了一段由方括号括起的代码:[T ordered];
maxGenerics 参数列表中的参数类型以及返回值列表中的返回值类型都是 T,而不是某个具体的类型。
maxGenerics 函数原型中多出的这段代码[T ordered]就是 Go 泛型的类型参数列表(type parameters list),示例中这个列表中仅有一个类型参数 T,ordered 为类型参数的类型约束(type constraint)。类型约束之于类型参数,就好比常规参数列表中的类型之于常规参数。关于类型约束,我们还会在下一讲中详细说明。
Go 语言规范规定:函数的类型参数列表位于函数名与函数参数列表之间,由方括号括起的固定个数的、由逗号分隔的类型参数声明组成,其一般形式如下:
函数一旦拥有类型参数,就可以用该参数作为常规参数列表和返回值列表中修饰参数和返回值的类型。我们继续 maxGenerics 泛型函数为例分析,它拥有一个类型参数 T,在常规参数列表中,T 被用作切片的元素类型;在返回值列表中,T 被用作返回值的类型。
按 Go 惯例,类型参数名的首字母通常采用大写形式,并且类型参数必须是具名的,即便你在后续的函数参数列表、返回值列表和函数体中没有使用该类型参数,也是这样。比如下面例子中的类型参数 T:
和常规参数列表中的参数名唯一一样,在同一个类型参数列表中,类型参数名字也要唯一,下面这样的代码将会导致 Go 编译器报错:
常规参数列表中的参数有其特定作用域,即从参数声明处开始到函数体结束。和常规参数类似,泛型函数中类型参数也有其作用域范围,这个范围从类型参数列表左侧的方括号[开始,一直持续到函数体结束,如下图所示:
类型参数的作用域也决定了类型参数的声明顺序并不重要,也不会影响泛型函数的行为,于是下面的泛型函数声明与上图中的函数是等价的:
到这里,泛型函数的结构我们已经了解完了,接下来我们来看一下如何调用泛型函数。
调用泛型函数
在前面的讲解中,我一直使用“类型参数”这个名称。但在学习调用泛型函数之前,我们需要对“类型参数”做一下细分。
和普通函数有形式参数与实际参数一样,类型参数也有类型形参(type parameter)和类型实参(type argument)之分。其中类型形参就是泛型函数声明中的类型参数,以前面示例中的 maxGenerics 泛型函数为例,如下面代码,maxGenerics 的类型形参就是 T,而类型实参则是在调用 maxGenerics 时实际传递的类型 int:
从上面这段代码我们也可以看出调用泛型函数与调用普通函数的区别。在调用泛型函数时,除了要传递普通参数列表对应的实参之外,还要显式传递类型实参,比如这里的 int。并且,显式传递的类型实参要放在函数名和普通参数列表前的方括号中。
在反复揣摩上面代码和说明后,你可能会提出这样的一个问题:如果泛型函数的类型形参较多,那么逐一显式传入类型实参会让泛型函数的调用显得十分冗长,比如:
这样的写法对开发者而言显然谈不上十分友好。其实不光大家想到了这个问题,Go 团队的泛型实现者们也考虑了这个问题,并给出了解决方法:函数类型实参的自动推断(function argument type inference)。
顾名思义,这个机制就是通过判断传递的函数实参的类型来推断出类型实参的类型,从而允许开发者不必显式提供类型实参,下面是以 maxGenerics 函数为例的类型实参推断过程示意图:
我们看到,当 maxGenerics 函数传入的实际参数为[]int{…}时,Go 编译器会将其类型[]int 与泛型函数参数列表中对应参数的类型([]T)作比较,并推断出 T == int 这一结果。当然这个例子的推断过程较为简单,那些有难度的,甚至无法肉眼可见的就交给 Go 编译器去处理吧,我们没有必要过于深入。
不过,这个类型实参自动推断有一个前提,你一定要记牢,那就是它必须是函数的参数列表中使用了的类型形参,否则就会像下面的示例中的代码,编译器将报无法推断类型实参的错误:
在编译器无法推断出结果时,我们可以给予编译器“部分提示”,比如既然编译器无法推断出 T 的实参类型,那我们就显式告诉编译器 T 的实参类型,即在泛型函数调用时,在类型实参列表中显式传入 T 的实参类型,但 E 的实参类型依然由编译器自动推断,示例代码如下:
那么,除了函数参数列表中的参数类型可以作为类型实参推断的依据外,函数返回值的类型是否也可以呢?我们看下面示例:
我们看到,这个函数仅在返回值中使用了类型参数,但编译器没能推断出 T 的类型,所以我们切记:不能通过返回值类型来推断类型实参。
有了函数类型实参推断后,在大多数情况下,我们调用泛型函数就无须显式传递类型实参了,开发者也因此获得了与普通函数调用几乎一致的体验。
其实泛型函数调用是一个不同于普通函数调用的过程,为了揭开其中的“奥秘”,接下来我们就把镜头放慢,看看泛型函数调用过程究竟发生了什么。
泛型函数实例化(instantiation)
我们还以 maxGenerics 为例来演示一下这个过程:
上面代码是对 maxGenerics 泛型函数的一次调用,Go 对这段泛型函数调用代码的处理分为两个阶段,如下图所示:
我们看到,Go 首先会对泛型函数进行实例化(instantiation),即根据自动推断出的类型实参生成一个新函数(当然这一过程是在编译阶段完成的,不会对运行时性能产生影响),然后才会调用这个新函数对输入的函数参数进行处理。
我们也可以用一种更形象的方式来描述上述泛型函数的实例化过程。实例化就好比一家生产“求最大值”机器的工厂,它会根据要比较大小的对象的类型将这样的机器生产出来。以上面的例子来说,整个实例化过程如下:
工厂接单:调用 maxGenerics([]int{…}),工厂师傅发现要比较大小的对象类型为 int;
模具检查与匹配:检查 int 类型是否满足模具的约束要求,即 int 是否满足 ordered 约束,如满足,则将其作为类型实参替换 maxGenerics 函数中的类型形参 T,结果为 maxGenerics[int];
生产机器:将泛型函数 maxGenerics 实例化为一个新函数,这里将其起名为 maxGenericsInt,其函数原型为 func([]int)int。本质上 maxGenericsInt := maxGenerics[int]。
我们实际的 Go 代码也可以真实得到这台新生产出的“机器”,如下面代码所示:
一旦针对 int 对象的“求最大值”的机器被生产出来了,它就可以对目标对象进行处理了,这和普通的函数调用没有区别。这里就相当于调用如下代码:
整个过程只需检查传入的函数实参([]int{1, 2, …})的类型与 maxGenericsInt 函数原型中的形参类型([]int)是否匹配即可。
另外要注意,当我们使用相同类型实参对泛型函数进行多次调用时,Go 仅会做一次实例化,并复用实例化后的函数,比如:
好了,关于泛型函数的讲解就先告一段落,接下来我们再来看 Go 对类型参数的另一类支持:带有类型参数的自定义类型,即泛型类型。
泛型类型
所谓泛型类型,就是在类型声明中带有类型参数的 Go 类型,比如下面代码中的 maxableSlice:
顾名思义,maxableSlice 是一个自定义切片类型,这个类型的特点是总可以获取其内部元素的最大值,其唯一的要求是其内部元素是可排序的,它通过带有 ordered 约束的类型参数来明确这一要求。像这样在定义中带有类型参数的类型就被称为泛型类型(generic type)。
从例子中的 maxableSlice 类型声明中我们可以看到,在泛型类型中,类型参数列表放在类型名字后面的方括号中。和泛型函数一样,泛型类型可以有多个类型参数,类型参数名通常是首字母大写的,这些类型参数也必须是具名的,且命名唯一。其一般形式如下:
和泛型函数中类型参数有其作用域一样,泛型类型中类型参数的作用域范围也是从类型参数列表左侧的方括号[开始,一直持续到类型定义结束的位置,如下图所示:
这样的作用域将方便我们在各个字段中灵活使用类型参数,下面是一些自定义泛型类型的示例:
我们看到,泛型类型中的类型参数可以用来作为类型声明中字段的类型(比如上面的 element 类型)、复合类型的元素类型(比如上面的 Set 和 Map 类型)或方法的参数和返回值类型(如 NumericAbs 接口类型)等。
如果要在泛型类型声明的内部引用该类型名,必须要带上类型参数,如上面的 element 结构体中的 next 字段的类型:*element[T]。按照泛型设计方案,如果泛型类型有不止一个类型参数,那么在其声明内部引用该类型名时,不仅要带上所有类型参数,类型参数的顺序也要与声明中类型参数列表中的顺序一致,比如:
不过从实测结果来看,Go 1.19 版本对于下面不符合技术方案的泛型类型声明也并未报错:
了解了如何声明一个泛型类型后,我们再来看看如何使用这些泛型类型。
使用泛型类型
和泛型函数一样,使用泛型类型时也会有一个实例化(instantiation)过程,比如:
Go 会根据传入的类型实参(int)生成一个新的类型并创建该类型的变量实例,sl 的类型等价于下面代码:
看到这里你可能会问:泛型类型是否可以像泛型函数那样实现类型实参的自动推断呢?很遗憾,目前的 Go 1.19 尚不支持,下面代码会遭到 Go 编译器的报错:
不过这一特性在 Go 的未来版本中可能会得到支持。
既然涉及到了类型,你肯定会想到诸如类型别名、类型嵌入等 Go 语言机制,那么这些语言机制对泛型类型的支持情况又是如何呢?我们逐一来看一下。
泛型类型与类型别名
在专栏前面的讲解中,我们学习过类型别名(type alias)。我们知道类型别名与其绑定的原类型是完全等价的,但这仅限于原类型是一个直接类型,即可直接用于声明变量的类型。那么将类型别名与泛型类型绑定是否可行呢?我们来看一个示例:
在上述代码中,我们为泛型类型 foo 建立了类型别名 fooAlias,但编译这段代码时,编译器还是报了错误!
这是因为,泛型类型只是一个生产真实类型的“工厂”,它自身在未实例化之前是不能直接用于声明变量的,因此不符合类型别名机制的要求。泛型类型只有实例化后才能得到一个真实类型,例如下面的代码就是合法的:
也就是说,我们只能为泛型类型实例化后的类型创建类型别名,实际上上述 fooAlias 等价于实例化后的类型 fooInstantiation:
泛型类型与类型嵌入
类型嵌入是运用 Go 组合设计哲学的一个重要手段。引入泛型类型之后,我们依然可以在泛型类型定义中嵌入普通类型,比如下面示例中 Lockable 类型中嵌入的 sync.Mutex:
在泛型类型定义中,我们也可以将其他泛型类型实例化后的类型作为成员。现在我们改写一下上面的 Lockable,为其嵌入另外一个泛型类型实例化后的类型 Slice[int]:
我们看到,代码使用泛型类型名(Slice)作为嵌入后的字段名,并且 Slice[int]的方法 String 被提升为 Lockable 实例化后的类型的方法了。同理,在普通类型定义中,我们也可以使用实例化后的泛型类型作为成员,比如让上面的 Slice[int]嵌入到一个普通类型 Foo 中,示例代码如下:
此外,Go 泛型设计方案支持在泛型类型定义中嵌入类型参数作为成员,比如下面的泛型类型 Lockable 内嵌了一个类型 T,且 T 恰为其类型参数:
不过,Go 1.19 版本编译上述代码时会针对嵌入 T 的那一行报如下错误:
泛型方法
在专栏基础篇的学习中,我们知道 Go 类型可以拥有自己的方法(method),泛型类型也不例外,为泛型类型定义的方法称为泛型方法(generic method),接下来我们就来讲讲如何定义和使用泛型方法。
我们用一个示例,给 maxableSlice 泛型类型定义 max 方法,看一下泛型方法的结构:
我们看到,在定义泛型类型的方法时,方法的 receiver 部分不仅要带上类型名称,还需要带上完整的类型形参列表(如 maxableSlice[T]),这些类型形参后续可以用在方法的参数列表和返回值列表中。
不过在 Go 泛型目前的设计中,泛型方法自身不可以再支持类型参数了,不能像下面这样定义泛型方法:
关于泛型方法未来是否能支持类型参数,目前 Go 团队倾向于否,但最终结果 Go 团队还要根据 Go 社区在使用泛型过程中的反馈而定。
在泛型方法中,receiver 中某个类型参数如果没有在方法参数列表和返回值中使用,可以用“_”代替,但不能不写,比如:
另外,泛型方法中的 receiver 中类型参数名字可以与泛型类型中的类型形参名字不同,位置和数量对上即可。我们还以上面的泛型类型 foo 为例,可以为它添加下面方法:
小结
好了,今天的课讲到这里就结束了,现在我们一起来回顾一下吧。
在这一讲中,我们一起学习了 Go 泛型的基本语法:类型参数。类型参数是 Go 泛型方案的具体实现,通过类型参数,我们可以定义泛型函数、泛型类型以及对应的泛型方法。
泛型函数是带有类型参数的函数,在函数名称与参数列表之间声明的类型参数列表使得泛型函数的运行逻辑与参数 / 返回值类型解耦。调用泛型函数与普通函数略有不同,泛型函数需要进行实例化后才能生成真正执行的、带有类型信息的函数。同时,Go 泛型支持的类型实参推断也使得开发者在大多数情况下无需显式传递类型实参,获得与普通函数调用几乎一致的体验。
泛型类型是带有类型参数的类型,泛型类型的类型参数放在类型名称后面的类型参数列表中声明,类型参数后续可以在泛型类型声明中用作成员字段的类型或复合类型成员元素的类型。不过目前(Go 1.19 版本)Go 尚不支持泛型类型的类型实参的自动推断,我们在泛型类型实例化时需要显式传入类型实参。
与泛型类型绑定的方法被称为泛型方法,泛型方法的参数列表和返回值列表中可以使用泛型类型的类型参数,但泛型方法目前尚不支持声明自己的类型参数列表。
Go 泛型的引入,使得 Go 开发人员在 interface{}之后又拥有了一种编写“通用代码”的手段,并且这种新手段因其更多在编译阶段的检查而变得更加安全,也因其减少了运行时的额外开销使得代码性能更好。
思考题
使用过其他编程语言泛型语法特性的小伙伴们可能会问:为什么 Go 在方括号“[]”中声明类型参数,而不是使用其他语言都用的尖括号“<>”呢?你可以思考一下。
欢迎在评论区写下你的想法,我们泛型篇的第二讲见。
分享给需要的人,Ta购买本课程,你将得18元
生成海报并分享
赞 3
提建议
© 版权归极客邦科技所有,未经许可不得传播售卖。 页面已增加防盗追踪,如有侵权极客邦将依法追究其法律责任。
上一篇
加餐|聊聊最近大热的Go泛型
下一篇
40|驯服泛型:定义泛型约束
精选留言(6)
- 文武木子2022-11-04 来自北京沙发🛋️
作者回复: 👍
2 - return2022-11-17 来自北京白老师一如既往的超高质量,感谢老师的无私奉献。
作者回复: 👍
- 那时刻2022-11-10 来自北京go语言范型不使用 <>,我想到一个点,是不是解析的时候 容易与大于 或者小于 符号混淆?
作者回复: 👍
共 3 条评论 - 江楠大盗2022-11-08 来自北京还好时不时复习一下老师的课,又等到老师更新了,意外之喜
作者回复: 欢迎常回来看看:)
- 罗杰2022-11-06 来自北京最近打算看看泛型,然后就看到了老师的更新,非常及时。不过,看起来并没有那么容易,老师写的很详细,需要好好消化一下。
作者回复: 哈哈,居然是及时雨:)
- Calvin2022-11-05 来自北京终于等到你,还好你没放弃。😂 白老师的课程一如既往的高质量,这篇文章补充了我很多关于泛型的未知知识点。
作者回复: 👍
新人学习立返 50% 购课币