建设景区网站要有的内容,厦门app制作,微信小程序第三方平台,中国互联网小心类型嵌入导致的问题
在定义结构体时#xff0c;Go语言支持通过类型嵌入的形式定义结构体字段。但是#xff0c;如果我们没有真正理解类型嵌入的意义#xff0c;有时可能会导致意想不到的行为。本文将主要分析如何嵌入类型#xff0c;类型嵌入的作用以及可能出现的问题…小心类型嵌入导致的问题
在定义结构体时Go语言支持通过类型嵌入的形式定义结构体字段。但是如果我们没有真正理解类型嵌入的意义有时可能会导致意想不到的行为。本文将主要分析如何嵌入类型类型嵌入的作用以及可能出现的问题。
在Go语言中如果定义的结构体字段没有名称则称该字段为嵌入字段。例如下面结构体Foo中的Bar是嵌入的。因为Bar类型被声明没有关联名称所以它是一个嵌入字段。
type Foo struct {Bar
}
type Bar struct {Baz int
}嵌入可以用来提升嵌入类型的字段和方法像上面的代码由于Bar包含一个Baz字段它被提升到Foo中就好像Foo中定义了一个Baz字段一样。 因此可以通过Foo直接访问Baz字段。
foo : Foo{}
foo.Baz 42注意Baz可从两个不同的路径获得。既可以使用Foo.Baz,也可以通过Bar采用Foo.Bar.Baz获得两种方式获取的效果是等价的。
NOTE: 本文仅讨论结构体中字段嵌入问题。嵌入也可以用于接口一个接口内部可以嵌入其他接口。例如io.ReadWriter由一个io.Reader和一个io.Writer组成。
type ReadWriter interface {ReaderWriter
}前面我们已分析了什么是类型嵌入下面来看一个错误使用类型嵌入的例子。该例子将实现一个结构体保存一些内存中的数据并且通过锁保护对它的并发访问。
type InMem struct {sync.Mutexm map[string]int
}
func New() *InMem {return InMem{m: make(map[string]int)}
}将结构体 InMem 中的map m定为小写限制调用方直接操作m, 而是通过导出的方法进行操作。互斥锁以内嵌的形式存在sync.Mutex), 获取结构体中数据的Get方法实现如下
func (i *InMem) Get(key string) (int, bool) {i.Lock()v, contains : i.m[key]i.Unlock()return v, contains
}由于互斥锁是嵌入的我们可以直接从接收器i访问Lock和Unlock方法。前面说了这是一个错误的例子错误在什么地方呢由于sync.Mutex是嵌入类型Lock和Unlock方法将被提升。因此使用InMem的调用方也可以看到这两个方法. 这种由于内嵌导致的方法提升可能不是我们希望的在大多数情况下互斥锁是我们希望封装在结构体内部并且使外部客户端不可见的内容。因此在这种情况下不应该将其设置为嵌入字段。
m : inmem.New()
m.Lock() // ??而应该是这样调整为非嵌入字段。由于mu不可导出它不能被外部客户端直接调用。
type InMem struct {mu sync.Mutexm map[string]int
}现在来看另外一个例子这次使用嵌入类型是一种正确的做法。例子描述的是实现一个自定义的日志记录功能它包含一个io.WriteCloser 并对外暴露Write和Close两个方法。如果io.WriteCloser不是嵌入的需要下面这样编码。
type Logger struct {writeCloser io.WriteCloser
}
func (l Logger) Write(p []byte) (int, error) {return l.writeCloser.Write(p)
}
func (l Logger) Close() error {return l.writeCloser.Close()
}
func main() {l : Logger{writeCloser: os.Stdout}_, _ l.Write([]byte(foo))_ l.Close()
}Logger必须提供一个Write和Close方法然后调用writeCloser进行真正的Write和Close. 但是如果将字段改为内嵌就不用为Logger创建Write和Close方法,实现代码如下。
type Logger struct {io.WriteCloser
}
func main() {l : Logger{WriteCloser: os.Stdout}_, _ l.Write([]byte(foo))_ l.Close()
}从客户端角度看调用方式没有任何差别都是调用Write和Close方法。但是采用内嵌不用对Logger再做一层包装Logger继承了io.WriteCloser的方法所以Logger满足了io.WriteCloser接口。
NOTE:嵌入和OOP子类化有人对嵌入和OOP子类化区分不清楚这两者之间的主要区别是方法的接收者不同。下图左侧表示类型X嵌入在类型Y中而右侧类型Y继承类型X。通过嵌入Foo的接收者仍然是X而不是Y. 但是通过子类化Foo的接收者是Y而不是X。Go中的嵌入是组合关系而不是继承关系。详细分析参考http://sd.jtimothyking.com/2018/06/25/subclassing-vs-embedding-in-golang/ 总结对于类型嵌入我们需要知道它不是必须的这意味着无论什么时候我们都可以在不使用类型嵌入的情况下解决问题。使用类型嵌入大多数情况下是为代码编写方便。如果决定使用类型嵌入我们需要牢记下面两个原则 类型嵌入不应该仅用作一些语法糖来简化对字段的访问例如调用Foo.Baz()而不是调用Foo.Bar.Baz()如果这是唯一的目的不用使用类型嵌入。 类型嵌入不应该提升我们想要对外部隐藏的数据字段和行为方法。例如像本文的例子允许调用方访问应该对结构体保持私有的互斥锁。
NOTE:有些人会说在可导出的结构体上使用类型嵌入可能会导致代码在维护方面需要付出额外的功夫。的确将类型嵌入到导出的结构体中意味着在这种类型演变时保持小心。例如如果我们向内部类型添加一个新方法应该确保它不会破坏上面的第二个原则。因此为了避免这种额外的工作开发人员要防止将类型嵌入到公共结构体中。
牢记上述使用类型嵌入的原则合理地使用类型嵌入可以帮助我们避免带有额外转发方法的代码像上面的Logger中类型嵌入。但是不要为了用而用不要将隐藏数据字段和方法约束丢给调用方使用时要有充分的理由。
