Go:用装饰器给通知发送加上日志

9 阅读5分钟

学装饰器模式时,我用了一个很具体的需求:邮件发送器已经写好了,现在希望每次发送前后都记录日志。 以后接入短信和 App 推送,它们也需要这两条日志。怎么写才能让三个发送器共用这段逻辑?

What · 装饰器模式是什么?

可以把它想成给礼物加包装。礼物已经准备好了,外面可以按需加礼盒和祝福卡片。

放到代码里,邮件发送器就是被包装的对象,日志装饰器是外面那一层。调用方仍然调用 Send,不过这次先进入装饰器。装饰器打印开始日志,让里面的邮件发送器工作,然后打印结束日志。

调用方调用 Send("订单已发货")
        ↓
日志装饰器打印「开始发送」
        ↓
邮件发送器执行 Send,返回结果
        ↓
日志装饰器打印「发送结束」,把结果交回调用方

Why · 为什么要另外包一层?

如果只有邮件需要日志,直接把两行日志写在邮件发送器里就可以。后来短信和推送也要相同的日志,每个发送器各写一遍,就要维护三份。比如日志格式有变化,三处都得改。

装饰器把这段逻辑集中起来。它保存的内层对象是 Notifier 接口,只要这个对象有符合约定的 Send 方法,就可以被包装。这样,同一个日志装饰器既能包邮件发送器,也能包短信发送器。

How · 用 Go 实现一个日志装饰器

这个示例用返回文字来模拟发送邮件。新建 main.go,写入下面的代码。

package main

import (
	"fmt"
	"io"
	"os"
)

// 邮件发送器和日志装饰器都满足这个接口。
type Notifier interface {
	Send(message string) string
}

type EmailNotifier struct{}

func (EmailNotifier) Send(message string) string {
	return "邮件通知:" + message
}

type LoggingNotifier struct {
	next Notifier  // 被包装的发送器
	log  io.Writer // 日志写到哪里
}

func (logger LoggingNotifier) Send(message string) string {
	fmt.Fprintln(logger.log, "[日志] 开始发送")

	result := logger.next.Send(message)

	fmt.Fprintln(logger.log, "[日志] 发送结束")
	return result
}

func main() {
	email := EmailNotifier{}

	var sender Notifier = LoggingNotifier{
		next: email,
		log:  os.Stdout, // 把日志打印到终端
	}

	fmt.Println(sender.Send("订单已发货"))
}

我读这段代码时,会从 next: email 开始看。它把邮件发送器放进装饰器的 next 字段。运行到 logger.next.Send(message) 时,logger 代表当前使用的装饰器,而 logger.next 就是刚才放进去的邮件发送器。是这行代码显式调用了内层的 Send,把工作交给了它。

EmailNotifier 和 LoggingNotifier 都有 Send(message string) string 方法,所以都可以赋给 Notifier 类型的变量。要不要加日志,在组装 sender 时决定,后面调用 sender.Send(...) 的写法相同。

在 Cursor 里运行

  1. 新建一个练习文件夹,例如 decorator-demo,用 Cursor 打开。
  2. 在左侧文件列表新建 main.go,输入代码,按 ⌘S 保存。
  3. 打开 Cursor 的集成终端,确认当前目录就是 decorator-demo,执行 go run main.go。

运行结果如下。

[日志] 开始发送
[日志] 发送结束
邮件通知:订单已发货

邮件结果排在最后,是因为 main 要等整个 sender.Send(...) 返回之后,才执行外层的 fmt.Println。

写一个测试观察两种结果

在同一目录新建 main_test.go。运行程序时,日志写到终端。测试时,把日志写进 bytes.Buffer,就能用代码检查日志内容。

package main

import (
	"bytes"
	"testing"
)

func TestLoggingNotifier(t *testing.T) {
	var logs bytes.Buffer
	email := EmailNotifier{}
	sender := LoggingNotifier{next: email, log: &logs}

	got := sender.Send("订单已发货")
	if got != "邮件通知:订单已发货" {
		t.Errorf("发送结果不正确:%q", got)
	}

	wantLogs := "[日志] 开始发送\n[日志] 发送结束\n"
	if logs.String() != wantLogs {
		t.Errorf("日志内容不正确:%q", logs.String())
	}
}

在同一个终端运行 go test -v main.go main_test.go。示例和测试均已运行通过。

Where · 在真实代码里怎么识别?

Go 标准库的 io.TeeReader 就体现了这种做法。它接收一个 io.Reader,返回的仍是 io.Reader。每当调用方读取数据,它就从原读取器读取,再把读到的数据额外写到指定位置。调用方依然使用 Read。 Go 标准库文档

装饰器也可以叠加。比如在邮件发送器外面包日志,再在日志外面包计时,那么计时会把日志的耗时算进去。如果反过来包,计时范围就会变小。层数越多,读代码时就越需要看清包装顺序。

和我之前学的适配器有什么区别?

两者都可能在结构体里保存另一个对象,所以只看字段容易混淆。我现在会直接看方法体里的那次调用。

模式对外提供的方法对内调用的方法本例想解决的问题
适配器Send(message)SendSMS(phone, message)把新程序的调用方式接到旧短信服务上
装饰器Send(message)Send(message)在发送过程前后加上日志

像是这个这个学习中的例子一样,我是要加上一个日志,就是为了方便以后在排查问题时更加的清晰。

学完这个例子,我再看 logger.next.Send(message),就知道这一行为什么放在两条日志之间了。调用 Send 时,程序先走到外层的日志装饰器,再进入内层的邮件发送器。内层返回结果后,外层补上结束日志,然后把结果交回调用方。

假如以后我只想给短信发送加日志,我可以在组装发送器时,只给短信包一层 LoggingNotifier。等邮件也需要同样的日志,再把同一个装饰器用到邮件上。这样,哪些发送器需要记录日志,可以按场景决定。

以后遇到类似的需求,我会先问自己:这段额外行为会不会被多个对象复用?是否需要按场景加上它? 如果答案是肯定的,我就有理由把它写成一个装饰器。