Go 博客

何时使用泛型

伊恩·兰斯·泰勒
2022 年 4 月 12 日

介绍

这是我在 Google Open Source Live 上的演讲的博客文章版本

和 GopherCon 2021

Go 1.18 版本添加了一个主要的新的语言功能：对泛型编程的支持。在本文中，我不会描述泛型是什么以及如何使用它们。这篇文章是关于何时在 Go 代码中使用泛型以及何时不使用泛型。

为了明确起见，我将提供一般指南，而不是硬性规则。请使用自己的判断。但如果您不确定，我建议您使用此处讨论的指南。

编写代码

让我们从 Go 编程的一般指南开始：通过编写代码而不是定义类型来编写 Go 程序。在泛型方面，如果您从定义类型参数约束开始编写程序，那么您可能走错了方向。从编写函数开始。在明确它们将有用时，添加类型参数很容易。

何时使用类型参数有用？

话虽如此，让我们看看类型参数可能会有用的情况。

使用语言定义的容器类型时

一种情况是编写操作语言定义的特殊容器类型的函数：切片、映射和通道。如果一个函数具有这些类型的参数，并且函数代码没有对元素类型做出任何特定假设，那么使用类型参数可能很有用。

例如，以下函数返回任何类型映射中所有键的切片

// MapKeys returns a slice of all the keys in m.
// The keys are not returned in any particular order.
func MapKeys[Key comparable, Val any](m map[Key]Val) []Key {
    s := make([]Key, 0, len(m))
    for k := range m {
        s = append(s, k)
    }
    return s
}

此代码不假设关于映射键类型的任何内容，并且根本不使用映射值类型。它适用于任何映射类型。这使得它成为使用类型参数的良好候选者。

对于此类函数，类型参数的替代方法通常是使用反射，但这是一种更笨拙的编程模型，在构建时不会进行静态类型检查，并且在运行时通常速度较慢。

通用数据结构

另一个类型参数可能会有用的情况是通用数据结构。通用数据结构类似于切片或映射，但不是内置到语言中的，例如链表或二叉树。

今天，需要此类数据结构的程序通常执行以下两种操作之一：使用特定元素类型编写它们，或使用接口类型。用类型参数替换特定元素类型可以生成更通用的数据结构，可以在程序的其他部分或其他程序中使用。用类型参数替换接口类型可以更有效地存储数据，从而节省内存资源；它还可以允许代码避免类型断言，并在构建时进行完全类型检查。

例如，以下是二叉树数据结构使用类型参数可能的样子

// Tree is a binary tree.
type Tree[T any] struct {
    cmp  func(T, T) int
    root *node[T]
}

// A node in a Tree.
type node[T any] struct {
    left, right  *node[T]
    val          T
}

// find returns a pointer to the node containing val,
// or, if val is not present, a pointer to where it
// would be placed if added.
func (bt *Tree[T]) find(val T) **node[T] {
    pl := &bt.root
    for *pl != nil {
        switch cmp := bt.cmp(val, (*pl).val); {
        case cmp < 0:
            pl = &(*pl).left
        case cmp > 0:
            pl = &(*pl).right
        default:
            return pl
        }
    }
    return pl
}

// Insert inserts val into bt if not already there,
// and reports whether it was inserted.
func (bt *Tree[T]) Insert(val T) bool {
    pl := bt.find(val)
    if *pl != nil {
        return false
    }
    *pl = &node[T]{val: val}
    return true
}

树中的每个节点都包含类型参数 T 的值。当树用特定类型参数实例化时，该类型的将直接存储在节点中。它们不会作为接口类型存储。

这是类型参数的合理使用，因为 Tree 数据结构（包括方法中的代码）在很大程度上独立于元素类型 T。

Tree 数据结构需要知道如何比较元素类型 T 的值；它为此使用传递的比较函数。您可以在 find 方法的第四行看到这一点，在调用 bt.cmp 时。除此之外，类型参数完全无关紧要。

对于类型参数，优先使用函数而不是方法

Tree 示例说明了另一个一般指南：当您需要类似于比较函数的东西时，优先使用函数而不是方法。

我们可以定义 Tree 类型，以便元素类型需要具有 Compare 或 Less 方法。这将通过编写一个需要方法的约束来完成，这意味着用于实例化 Tree 类型的任何类型参数都需要具有该方法。

一个结果是，任何想要使用 Tree 和简单数据类型（如 int）的人都需要定义自己的整数类型并编写自己的比较方法。如果我们定义 Tree 来获取比较函数，如上面的代码所示，那么传入所需的函数很容易。编写比较函数与编写方法一样容易。

如果 Tree 元素类型恰好已经具有 Compare 方法，那么我们可以简单地使用方法表达式（如 ElementType.Compare）作为比较函数。

换句话说，将方法转换为函数比向类型添加方法要简单得多。因此，对于通用数据类型，优先使用函数，而不是编写需要方法的约束。

实现通用方法

类型参数可能会有用的另一个情况是，当不同的类型需要实现一些通用方法时，而不同类型的实现都看起来一样。

例如，考虑标准库的 sort.Interface。它要求类型实现三个方法：Len、Swap 和 Less。

以下是一个通用类型 SliceFn 的示例，它为任何切片类型实现 sort.Interface

// SliceFn implements sort.Interface for a slice of T.
type SliceFn[T any] struct {
    s    []T
    less func(T, T) bool
}

func (s SliceFn[T]) Len() int {
    return len(s.s)
}
func (s SliceFn[T]) Swap(i, j int) {
    s.s[i], s.s[j] = s.s[j], s.s[i]
}
func (s SliceFn[T]) Less(i, j int) bool {
    return s.less(s.s[i], s.s[j])
}

对于任何切片类型，Len 和 Swap 方法完全相同。Less 方法需要比较，这是 SliceFn 名称中的 Fn 部分。与前面的 Tree 示例一样，我们将在创建 SliceFn 时传入一个函数。

以下是如何使用 SliceFn 使用比较函数对任何切片进行排序

// SortFn sorts s in place using a comparison function.
func SortFn[T any](s []T, less func(T, T) bool) {
    sort.Sort(SliceFn[T]{s, less})
}

这类似于标准库函数 sort.Slice，但比较函数使用值而不是切片索引编写。

对于此类代码使用类型参数是合适的，因为所有切片类型的方法看起来完全相同。

（我应该提到，Go 1.19（不是 1.18）很可能会包含一个通用函数来使用比较函数对切片进行排序，并且该通用函数很可能不会使用 sort.Interface。请参见 提案 #47619。但即使这个特定示例可能不再有用，一般要点仍然成立：当您需要为所有相关类型实现看起来相同的方法时，使用类型参数是合理的。）

何时不使用类型参数？

现在让我们讨论一下问题的另一方面：何时不使用类型参数。

不要用类型参数替换接口类型

众所周知，Go 具有接口类型。接口类型允许一种泛型编程。

例如，广泛使用的 io.Reader 接口提供了一种通用机制，用于从包含信息（例如文件）或生成信息（例如随机数生成器）的任何值读取数据。如果您对某类型的值要做的就是调用该值上的方法，请使用接口类型，而不是类型参数。io.Reader 易于阅读、高效且有效。无需使用类型参数来读取通过调用 Read 方法的值。

例如，更改此处第一个函数签名（仅使用接口类型）到第二个版本（使用类型参数）可能很诱人。

func ReadSome(r io.Reader) ([]byte, error)

func ReadSome[T io.Reader](r T) ([]byte, error)

不要做这样的改变。省略类型参数使函数更容易编写、更容易阅读，并且执行时间很可能相同。

值得强调最后一点。虽然可以用几种不同的方式实现泛型，并且实现会随着时间的推移而发生变化和改进，但在 Go 1.18 中使用的实现将在许多情况下将类型为类型参数的值视为与类型为接口类型的值非常相似。这意味着使用类型参数通常不会比使用接口类型更快。因此，不要仅仅为了速度而从接口类型更改为类型参数，因为它可能不会运行得更快。

如果方法实现不同，请不要使用类型参数

在决定是使用类型参数还是接口类型时，请考虑方法的实现。之前我们说过，如果方法的实现对所有类型都相同，请使用类型参数。相反，如果实现对每个类型都不同，那么请使用接口类型并编写不同的方法实现，不要使用类型参数。

例如，从文件读取 Read 的实现与从随机数生成器读取 Read 的实现完全不同。这意味着我们应该编写两个不同的 Read 方法，并使用类似于 io.Reader 的接口类型。

在适当的情况下使用反射

Go 具有 运行时反射。反射允许一种泛型编程，因为它允许您编写适用于任何类型的代码。

如果某些操作必须支持甚至没有方法的类型（以便接口类型无济于事），并且如果该操作对每个类型都不同（因此类型参数不合适），请使用反射。

一个例子是 encoding/json 包。我们不想要求我们编码的每个类型都具有 MarshalJSON 方法，因此我们不能使用接口类型。但是，编码接口类型与编码结构类型不同，因此我们不应该使用类型参数。相反，该包使用反射。代码并不简单，但它有效。有关详细信息，请参见 源代码.

一条简单指南

最后，关于何时使用泛型的讨论可以简化为一条简单的指南。

如果您发现自己多次编写完全相同的代码，其中副本之间唯一的区别是代码使用了不同的类型，请考虑您是否可以使用类型参数。

换句话说，除非你发现自己要写完全相同的代码多次，否则应该避免使用类型参数。