0.1、索引
https://waterflow.link/articles/1666171320273
1、概念
接口提供了一种指定对象行为的方法。 我们使用接口来创建多个对象可以实现的通用抽象。 Go 接口不同的原因在于它们是隐式的。 没有像 implements 这样的显式关键字来标记对象 A实现了接口B。
为了理解接口的强大,我们可以看下标准库中两个常用的接口:io.Reader 和 io.Writer。 io 包为 I/O 原语提供抽象。 在这些抽象中,io.Reader 从数据源读取数据,io.Writer 将数据写入目标。
io.Reader 包含一个 Read 方法:
type Reader interface {
Read(p []byte) (n int, err error)
}
io.Reader 接口的自定义实现应该接收一个字节切片p,把数据读取到p中并返回读取的字节数或错误。
io.Writer 定义了一个方法,Write:
type Writer interface {
Write(p []byte) (n int, err error)
}
io.Writer 的自定义实现应该将来自切片的数据p写入底层数据流并返回写入的字节数或错误。
因此,这两个接口都提供了基本的抽象:
io.Reader
从一个源对象读取数据io.Writer
将数据写到一个目标对象
假设我们需要实现一个将一个文件的内容复制到另一个文件的函数。 我们可以创建一个特定的函数copyFile,它将使用 io.Reader 和 io.Writer 抽象创建一个更通用的函数:
package main
import (
"io"
"log"
"os"
)
func main() {
// 1 打开一个源文件
source, err := os.Open("a.txt")
if err != nil {
log.Fatal(err)
}
defer source.Close()
// 2 创建一个目标文件
dest, err := os.Create("b.txt")
if err != nil {
log.Fatal(err)
}
defer dest.Close()
// 从把源数据复制到目标
err = CopyFile(source, dest)
if err != nil {
log.Fatal(err)
}
}
// 复制
func CopyFile(source io.Reader, dest io.Writer) error {
var buffer = make([]byte, 1024)
for {
n, err := source.Read(buffer)
if err == nil {
_, err = dest.Write(buffer[:n])
if err != nil {
return err
}
}
if err == io.EOF {
_, err = dest.Write(buffer)
if err != nil {
return err
}
return nil
}
return err
}
}
- 我们利用os.Open打开一个文件,该函数返回一个*os.File句柄,*os.File 实现了 io.Reader 和 io.Writer
- 我们使用os.Create创建一个新的文件,该函数返回一个*os.File句柄
- 我们使用copyFile函数,该函数有两个参数,source为一个实现io.Reader接口的参数,dest为一个实现 io.Writer接口的参数
该函数适用于 *os.File 参数(因为 *os.File 实现了 io.Reader 和 io.Writer)以及任何其他可以实现这些接口的类型。 例如,我们可以创建自己的 io.Writer 写入数据库,并且代码将保持不变。 它增加了函数的通用性; 因此,他是可重用的,这很重要。
此外,为这个函数编写单元测试更容易,因为我们可以使用提供有用实现的字符串和字节包,而不是处理文件:
package main
import (
"bytes"
"strings"
"testing"
)
func TestCopyFile(t *testing.T) {
input := "hahahha"
source := strings.NewReader(input)
dest := bytes.NewBuffer(make([]byte, 0))
err := CopyFile(source, dest)
if err != nil {
t.Fatal(err)
}
got := dest.String()
if got != input {
t.Errorf("input is %s, got is %s, want is %s", input, got, input)
}
}
在上面例子中,source 是 *strings.Reader,而 dest 是 *bytes.Buffer。 在这里,我们在不创建任何文件的情况下测试 CopyFile ,归功于CopyFile的参数使用的是接口,只要我们参数实现了这俩个接口就可以运行单元测试。
2、什么时候使用接口
我们什么时候应该在 Go 中创建接口? 让我们看一下通常认为接口带来价值的三个具体用例:
- 通用行为
- 解耦
- 限制行为
2.1、通用行为
在多种类型实现共同行为时使用接口。 在这种情况下,我们可以分解出接口内部的行为。 如果我们查看标准库,我们可以找到许多此类用例的示例。 例如,可以通过2个方法让共享资源变得安全:
- 给共享资源加锁
- 给共享资源释放锁
因此,sync包中添加了以下接口:
type Locker interface {
Lock()
Unlock()
}
该接口具有强大的可重用潜力,因为它包含对任何共享资源进行不同方式保护的常见行为。
我们都知道sync.Mutex是不支持锁的可重入的,但是有时我们希望同一个协程可以给资源重复上锁,而不会引起报错。因此,加锁和解锁就可以被抽象化,我们可以依赖 sync.Locker。
所以我们就可以很轻松的实现可重入锁,像下面这样:
package main
import (
"fmt"
"github.com/petermattis/goid"
"log"
"sync"
"sync/atomic"
)
type RecursiveMutex struct {
sync.Mutex
owner int64
recursion int32
}
// 1
func (m *RecursiveMutex) Lock() {
gid := goid.Get()
if atomic.LoadInt64(&m.owner) == gid {
m.recursion++
return
}
m.Mutex.Lock()
atomic.StoreInt64(&m.o