forked from mikespook/Learning-Go-zh-cn
-
Notifications
You must be signed in to change notification settings - Fork 0
/
go-interfaces.tex
403 lines (359 loc) · 16.3 KB
/
go-interfaces.tex
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
\epi{我对外科手术般进入我的身体总是有恐惧。你知道我说的是什么。}{\textit{eXistenZ}\\\textsc{TED PIKUL}}
\noindent{}
\gomarginpar{The following text is from \cite{go_interfaces}.}
In Go, the word \first{\emph{interface}}{interface} is overloaded to mean several different
things. Every type has an interface, which is the \emph{set of methods
defined} for \index{interface!set of methods}
that type. This bit of code defines a struct type \type{S} with one field, and
defines two methods for \type{S}.
\begin{lstlisting}[caption=Defining a struct and methods on it,label=src:interface object]
type S struct { i int }
func (p *S) Get() int { return p.i }
func (p *S) Put(v int) { p.i = v }
\end{lstlisting}
也可以定义\first{接口类型}{interface!type},仅仅是方法的集合。
这里定义了一个有两个方法的接口 \type{I}:
\begin{lstlisting}
type I interface {
Get() int
Put(int)
}
\end{lstlisting}
\noindent 对于接口~\type{I},\type{S} 是合法的\emph{实现},因为它定义了~\type{I}
所需的两个方法。注意,即便是没有明确定义 \type{S} 实现了 \type{I},这也是正确的。
Go 程序可以利用这个特点来实现接口的另一个含义,就是
\first{接口值}{interface!value}:
\begin{lstlisting}
func f(p I) { |\longremark{定义一个函数接受一个接口类型作为参数;}|
fmt.Println(p.Get()) |\longremark{\var{p} 实现了接口 \type{I},\emph{必须}有 \func{Get()} 方法;}|
p.Put(1) |\longremark{\func{Put()} 方法是类似的。}|
}
\end{lstlisting}
\showremarks
这里的变量 \var{p} 保存了接口类型的值。因为
\type{S} 实现了 \type{I},可以调用 \func{f} 向其传递 \type{S} 类型的值的指针:
\begin{lstlisting}
var s S; f(&s)
\end{lstlisting}
获取 \type{s} 的地址,而不是 \type{S} 的值的原因,是因为在 \type{s}
的指针上定义了方法,参阅上面的代码 \ref{src:interface object}。
这并不是必须的——可以定义让方法接受值——但是这样的话 \func{Put} 方法就不会像期望的那样工作了。
实际上,无须明确一个类型是否实现了一个接口意味着 Go 实现了叫做
\first{duck typing}{duck typing}\cite{duck_typing} 的模式。
这不是纯粹的 duck typing,因为如果可能的话 Go 编译器将对类型是否实现了接口进行实现静态检查。
然而,Go 确实有纯粹动态的方面,如可将一个接口类型转换到另一个。
通常情况下,转换的检查是在运行时进行的。
如果是非法转换——当在已有接口值中存储的类型值不匹配将要转换到的接口——程序会抛出运行时错误。
在 Go 中的接口有着与许多其他编程语言类似的思路:
C++ 中的纯抽象虚基类,Haskell 中的 typeclasses 或者 Python 中的 duck typing。
然而没有其他任何一个语言联合了接口值、静态类型检查、运行时动态转换,以及无须明确定义类型适配一个接口。
这些给 Go 带来的结果是,强大、灵活、高效和容易编写的。
\subsection{到底是什么?}
来定义另外一个类型同样实现了接口 \type{I}:
\begin{lstlisting}
type R struct { i int }
func (p *R) Get() int { return p.i }
func (p *R) Put(v int) { p.i = v }
\end{lstlisting}
函数 \func{f} 现在可以接受类型为 \type{R} 或 \type{S} 的变量。
假设需要在函数 \func{f} 中知道实际的类型。在 Go 中可以使用
\first{type switch}{type switch} 得到。
\begin{lstlisting}
func f(p I) {
switch t := p.(type) { |\longremark{类型判断。在 \key{switch} 语句中使用 \key{(type)}。保存类型到变量 \var{t};}|
case *S: |\longremark{\var{p} 的实际类型是 \type{S} 的指针;}|
case *R: |\longremark{\var{p} 的实际类型是 \type{R} 的指针;}|
case S: |\longremark{\var{p} 的实际类型是 \type{S};}|
case R: |\longremark{\var{p} 的实际类型是 \type{R};}|
default: |\longremark{实现了 \type{I} 的其他类型。}|
}
}
\end{lstlisting}
\showremarks
在 \key{switch} 之外使用 \key{(type)} 是非法的。类型判断不是唯一的\emph{运行时}得到类型的方法。
为了在\emph{运行时}得到类型,同样可以使用``comma, ok''来判断一个接口类型是否实现了某个特定接口:
\begin{lstlisting}
if t, ok := something.(I); ok {
// 对于某些实现了接口 I 的
// t 是其所拥有的类型
}
+\end{lstlisting}
确定一个变量实现了某个接口,可以使用:
\begin{lstlisting}
t := something.(I)
\end{lstlisting}
\subsection{空接口}
由于每个类型都能匹配到空接口:
\type{interface\{\}}。我们可以创建一个接受空接口作为参数的普通函数:
\begin{lstlisting}[caption=用空接口作为参数的函数,label=src:interface empty]
func g(something interface{}) int {
return something.(I).Get()
}
\end{lstlisting}
在这个函数中的 \lstinline{return something.(I).Get()} 是有一点窍门的。
值 \var{something} 具有类型 \type{interface\{\}},这意味着方法没有任何约束:
它能包含任何类型。\lstinline{.(I)} 是 \first{类型断言}{type assertion},用于转换 \var{something} 到
\type{I} 类型的接口。如果有这个类型,则可以调用 \func{Get()} 函数。
因此,如果创建一个 \type{*S} 类型的新变量,也可以调用 \func{g()},
因为 \type{*S} 同样实现了空接口。
\begin{lstlisting}
s = new(S)
fmt.Println(g(s));
\end{lstlisting}
调用 \func{g} 的运行不会出问题,并且将打印 0。如果调用 \func{g()} 的参数没有实现 \type{I}
会带来一个麻烦:
\begin{lstlisting}[caption=实现接口失败,label=src:interface fail]
i := 5 |\coderemark{声明 i 是一个``该死的'' \texttt{int}}|
fmt.Println(g(i))
\end{lstlisting}
这能编译,但是当运行的时候会得到:
\noindent\error{panic: interface conversion: int is not main.I: missing
method Get}
\noindent{}这是绝对没问题,内建类型 \type{int} 没有 \func{Get()} 方法。
\section{方法}
方法就是有接收者的函数(参阅第 \ref{chap:functions} 章)。
可以在任意类型上定义方法(除了非本地类型,包括内建类型:\type{int} 类型不能有方法)。
然而可以新建一个拥有方法的整数类型。例如:
\begin{lstlisting}
type Foo int
func (self Foo) Emit() {
fmt.Printf("%v", self)
}
type Emitter interface {
Emit()
}
\end{lstlisting}
对那些非本地(定义在其他包的)类型也一样:
% Empty line here is critical, otherwise no new paragraph is created
\begin{minipage}{.5\textwidth}
\begin{lstlisting}[linewidth=.7\textwidth,caption=扩展内建类型错误]
func (i int) Emit() {
fmt.Printf("%d", i)
}
\end{lstlisting}
\noindent\error{不能定义新的方法\\ 在非本地类型 int 上}
\end{minipage}
\begin{minipage}{.5\textwidth}
\begin{lstlisting}[caption=扩展非本地类型错误]
func (a *net.AddrError) Emit() {
fmt.Printf("%v", a)
}
\end{lstlisting}
\noindent\error{不能定义新的方法\\ 在非本地类型 net.AddrError 上}
\end{minipage}
\paragraph{} %% needed otherwise the minipage flows over
\subsection{接口类型的方法}
接口定义为一个方法的集合。方法包含实际的代码。
换句话说,一个接口就是定义,而方法就是实现。
因此,接收者不能定义为接口类型,这样做的话会引起
\error{invalid receiver type ...} 的编译器错误。来自语言说明书 \cite{go_spec} 的权威内容:
\begin{quote}
接收者类型必须是 \type{T} 或 \type{*T},这里的 \type{T} 是类型名。
\type{T} 叫做接收者基础类型或简称基础类型。基础类型一定不能是指针或接口类型,
并且必须定义在与方法相同的包中。
\end{quote}
\begin{lbar}[Pointers to interfaces]
在 Go 中创建指向接口的指针是无意义的。
实际上创建接口值的指针也是非法的。在 \gorelease{2010-10-13} 的
发布日志中进行的描述,使得没有任何余地怀疑这一事实:
\begin{quote}
语言的改变是使用指针指向接口值不再自动反引用指针。指向接口值的指针通常是低级的错误,而不是正确的代码。
\end{quote}
这来自 \cite{go_faq}。如果不是这个限制,这个代码:
\begin{lstlisting}
var buf bytes.Buffer
io.Copy(buf, os.Stdin)
\end{lstlisting}
就会复制标准输入到 \var{buf} 的副本,而不是 \var{buf} 本身。
这看起来永远不会是一个期望的结果。
\end{lbar}
\section{接口名字}
根据规则,单方法接口命名为方法名加上 \emph{-er} 后缀:Read\emph{er},Writ\emph{er},Formatt\emph{er} 等。
有一堆这样的命名,高效的反映了它们职责和包含的函数名。
\func{Read},\func{Write},\func{Close},\func{Flush},\func{String} 等等有着规范的声明和含义。
为了避免混淆,除非有类似的声明和含义,否则不要让方法与这些重名。
相反的,如果类型实现了与众所周知的类型相同的方法,那么就用相同的名字和声明;
将字符串转换方法命名为 \func{String} 而不是 \func{ToString}。
\gomarginpar{文本复制于 \cite{effective_go}。}
\section{简短的例子}
\label{sec:a sorting example}
回顾那个冒泡排序的练习~Q\ref{ex:bubble}),对整型数组排序:
\begin{lstlisting}
func bubblesort(n []int) {
for i := 0; i < len(n)-1; i++ {
for j := i + 1; j < len(n); j++ {
if n[j] < n[i] {
n[i], n[j] = n[j], n[i]
}
}
}
}
\end{lstlisting}
排序字符串的版本是类似的,除了函数的声明:
\begin{lstlisting}
func bubblesortString(n []string) { /* ... */ }
\end{lstlisting}
基于此,可能会需要两个函数,每个类型一个。而通过使用接口可以让这个变得更加通用 \index{generic}。
来创建一个可以对字符串和整数进行排序的函数,这个例子的某些行是无法运行的:
\begin{lstlisting}
func sort(i []interface{}) { |\longremark{函数将接收一个空接口的 slice;}|
switch i.(type) { |\longremark{使用 type switch 找到输入参数实际的类型;}|
case string: |\longremark{然后排序;}|
// ...
case int:
// ...
}
return /* ... */ |\longremark{返回排序的 slice。}|
}
\end{lstlisting}
\showremarks
但是如果用 \lstinline|sort([]int{1, 4, 5})| 调用这个函数,会失败:
\noindent\error{cannot use i (type []int) as type []interface { } in function argument}
这是因为 Go 不能简单的将其转换为接口的 \emph{slice}。
转换到接口是容易的,但是转换到 slice 的开销就高了。
简单来说
\gomarginpar{关于这个话题完整的邮件列表讨论可以在 \cite{go_nuts_interfaces} 这里找到。}
:Go 不能(隐式)转换为 slice。
那么如何创建 Go 形式的这些``通用''函数呢?
用 Go 隐式的处理来代替 type switch 方式的类型推断吧。
下面的步骤是必须的:
\begin{enumerate}
\item 定义一个有着若干排序相关的方法的接口类型(这里叫做 \type{Sorter})。
至少需要获取 slice 长度的函数,比较两个值的函数和交换函数;
\begin{lstlisting}
type Sorter interface {
Len() int |\coderemark{\texttt{len()} 作为方法}|
Less(i, j int) bool |\coderemark{\texttt{p[j] $<$ p[i]} 作为方法}|
Swap(i, j int) |\coderemark{\texttt{p[i], p[j] = p[j], p[i]} 作为方法}|
}
\end{lstlisting}
\item 定义用于排序 slice 的新类型。注意定义的是 slice 类型;
\begin{lstlisting}
type Xi []int
type Xs []string
\end{lstlisting}
\item 实现 \type{Sorter} 接口的方法。
整数的:
\begin{lstlisting}
func (p Xi) Len() int {return len(p)}
func (p Xi) Less(i int, j int) bool {return p[j] < p[i]}
func (p Xi) Swap(i int, j int) {p[i], p[j] = p[j], p[i]}
\end{lstlisting}
和字符串的:
\begin{lstlisting}
func (p Xs) Len() int {return len(p)}
func (p Xs) Less(i int, j int) bool {return p[j] < p[i]}
func (p Xs) Swap(i int, j int) {p[i], p[j] = p[j], p[i]}
\end{lstlisting}
\item 编写作用于 \type{Sorter} 接口的\emph{通用}排序函数。
\begin{lstlisting}
func Sort(x Sorter) { |\longremark{\var{x} 现在是 \texttt{Sorter} 类型;}|
for i := 0; i < x.Len() - 1; i++ { |\longremark{使用定义的函数,实现了冒泡排序。}|
for j := i + 1; j < x.Len(); j++ {
if x.Less(i, j) {
x.Swap(i, j)
}
}
}
}
\end{lstlisting}
\showremarks
\end{enumerate}
现在可以像下面这样使用通用的 \func{Sort} 函数:
\begin{lstlisting}
ints := Xi{44, 67, 3, 17, 89, 10, 73, 9, 14, 8}
strings := Xs{"nut", "ape", "elephant", "zoo", "go"}
Sort(ints)
fmt.Printf("%v\n", ints)
Sort(strings)
fmt.Printf("%v\n", strings)
\end{lstlisting}
\subsection{在接口中列出接口}
看一下下面的接口定义,这个是来自包 \package{container/heap} 的:
\begin{lstlisting}
type Interface interface {
sort.Interface
Push(x interface{})
Pop() interface{}
}
\end{lstlisting}
这里有另外一个接口在 \type{heap.Interface} 的定义中被列出,这看起来有些古怪,但是这的确是正确的,%
要记得接口只是一些方法的列表。\type{sort.Interface} 同样是这样一个列表,因此将其包含在接口内是毫无错误的。
\subsection{自省和反射}
\label{sec:introspection and reflection}
在下面的例子中,了解一下定义在 \type{Person} 的定义中的 ``标签''(这里命名为``namestr'')。
为了做到这个,需要 \package{reflect}\index{package!reflect} 包(在 Go 中没有其他方法)。
要记得,查看标签意味着返回\emph{类型}的定义。因此使用 \package{reflect} 包来指出变量的类型,
\emph{然后}访问标签。
\input{fig/reflection.tex}
\showremarks
%% look at layout
为了让类型和值之间的区别更加清晰,看下面的代码:
\begin{lstlisting}[caption=反射类型和值]
func show(i interface{}) {
switch t := i.(type) {
case *Person:
t := reflect.TypeOf(i) |\coderemark{得到类型的元数据}|
v := reflect.ValueOf(i) |\coderemark{得到实际的值}|
tag := t.Elem().Field(0).Tag |\longremark{这里希望获得``标签''。因此需要 \func{Elem()} 重定向至其上,访问第一个字段来获取标签。%
注意将 \var{t} 作为一个 \type{reflect.Type} 来操作;}|
name := v.Elem().Field(0).String() |\longremark{现在需要访问其中一个成员的\emph{值},%
并让\newline\var{v} 上的 \lstinline{Elem()} 进行重定向。%
这样就访问到了结构。然后访问第一个字段 \lstinline{Field(0)} %
并且调用其上的 \lstinline{String()} 方法。%
\begin{figure}[H] %
\hskip3\baselineskip\parbox{0.7\textwidth}{\caption[使用反射去除层次关系]{用反射去除层次关系。%
通过 \mbox{\func{Elem()}} 访问 \type{*Person},使用 \prog{go doc reflect} 中描述的方法%
获得 \type{string} 内部包含的内容。}} %
\label{fig:reflection} %
\begin{center} %
\includegraphics[scale=0.75]{fig/reflection.pdf} %
\end{center}\end{figure} %
}|
}
}
\end{lstlisting}
\showremarks
设置值与获得值类似,但是仅仅工作在\emph{可导出}的成员上。这些代码:
\begin{minipage}{.5\textwidth}
\begin{lstlisting}[caption=私有成员的反射]
type Person struct {
name string |\coderemark{名称}|
age int
}
func Set(i interface{}) {
switch i.(type) {
case *Person:
r := reflect.ValueOf(i)
r.Elem(0).Field(0).SetString("Albert Einstein")
}
}
\end{lstlisting}
\end{minipage}
\hspace{2em}
\begin{minipage}{.5\textwidth}
\begin{lstlisting}[caption=公有成员的反射]
type Person struct {
Name string |\coderemark{\emph{N}ame}|
age int
}
func Set(i interface{}) {
switch i.(type) {
case *Person:
r := reflect.ValueOf(i)
r.Elem().Field(0).SetString("Albert Einstein")
}
}
\end{lstlisting}
\end{minipage}
左边的代码可以编译并运行,但是当运行的时候,将得到打印了栈的\emph{运行时}错误:
\noindent\error{panic: reflect.Value.SetString using value obtained using unexported field}
\noindent{}右边的代码没有问题,并且设置了成员变量 \var{Name}
为``Albert Einstein''。当然,这仅仅工作于调用 \func{Set()} 时传递一个指针参数。
\section{练习}
\input{ex-interfaces/ex-interfaces.tex}
\input{ex-interfaces/ex-pointers-and-reflect.tex}
\input{ex-interfaces/ex-minmax.tex}
\cleardoublepage
\section{答案}
\shipoutAnswer