Uber Go 语言编程规范：避免在公共结构体中嵌入类型

最新推荐文章于 2023-03-16 09:07:50 发布

原创最新推荐文章于 2023-03-16 09:07:50 发布 · 217 阅读

0 ·

CC 4.0 BY-SA版权

Uber技术研究专栏收录该内容

48 篇文章

订阅专栏

本文探讨了在GO语言中使用结构体嵌入与接口委托的设计模式，对比了它们在实现细节暴露、类型演变及代码维护方面的优缺点。

这些嵌入的类型会泄露实现细节，阻止类型演变，并模糊文档。

假设您已经使用一个共享的AbstractList，实现了各种列表类型，避免在具体的列表实现中嵌入AbstractList，相反的，只手写那些将会委托给抽象列表的具体列表中的方法。

type AbstractList struct {}

//以下是定义公共结构体的方法

// Add adds an entity to the list.
func (l *AbstractList) Add(e Entity) {
  // ...
}

// Remove removes an entity from the list.
func (l *AbstractList) Remove(e Entity) {
  // ...
}

Bad

// ConcreteList 是一个列表实体.
type ConcreteList struct {
  *AbstractList
}

Good

// ConcreteList 是一个实体列表.
type ConcreteList struct {
  list *AbstractList
}

//以下方法都是委托给抽象列表实现

// Add adds an entity to the list.
func (l *ConcreteList) Add(e Entity) {
  l.list.Add(e)
}

// Remove removes an entity from the list.
func (l *ConcreteList) Remove(e Entity) {
  l.list.Remove(e)
}

GO语言允许type embedding ，作为在继承和组合之间的一种折衷方案。外部类型会获取嵌入类型方法的隐式的副本，默认情况下，这些方法会委托给嵌入实例的相同的方法去实现。

该结构体还会获得一个与类型同名的字段。因此，如果的嵌入的类型是Public的，那么这个字段也是Public的，为了保持向后兼容性，外部类型的每一个未来版本都必须保持这个嵌入的类型。

嵌入的类型很少是必需的。但是，它可以帮助您避免编写冗长的委托方法。

即使是嵌入一个兼容的AbstractList接口，而不是一个结构体，也会为开发人员提供更多的灵活性，以便在将来进行改变。但是，此种方式，仍然泄露了具体列表使用抽象实现的细节。

Bad

// AbstractList 是一个通用的实现针对各种类型的实体列表
type AbstractList interface {
  Add(Entity)
  Remove(Entity)
}

// 具体实现的List
type ConcreteList struct {
  AbstractList
}

Good

// ConcreteList 具体列表的实现.
type ConcreteList struct {
  list AbstractList
}

//只实现委托给AbstractList中的方法
// Add adds an entity to the list.
func (l *ConcreteList) Add(e Entity) {
  l.list.Add(e)
}

// Remove removes an entity from the list.
func (l *ConcreteList) Remove(e Entity) {
  l.list.Remove(e)
}

无论是使用嵌入结构体还是嵌入接口，嵌入的类型都限制了类型的发展演化。