备忘录模式是一种行为型设计模式,核心目标是捕获一个对象的内部状态并在外部保存,同时不暴露对象本身的实现细节,后续可以通过保存的状态将对象恢复到之前的某一时刻。在Golang中实现该模式管理历史状态和数据回滚,需要明确三个核心角色的职责。

备忘录模式核心角色
备忘录模式包含三个核心角色,每个角色的职责边界清晰,共同配合完成状态保存和恢复的功能:
- 发起人(Originator):需要保存状态的对象,负责创建备忘录存储当前内部状态,也可以通过备忘录恢复自身状态。
- 备忘录(Memento):存储发起人对象的内部状态,防止除发起人外的其他对象访问备忘录的内部数据。
- 管理者(Caretaker):负责保存备忘录对象,但是不能对备忘录的内容进行操作或者检查,仅做存储管理。
Golang实现基础示例
下面通过一个文本编辑器的场景来演示基础实现,编辑器需要支持输入内容、保存历史状态、撤销回滚到上一版本的功能。
定义备忘录结构
备忘录仅存储发起人需要保存的状态数据,这里存储文本内容:
package main
// Memento 备忘录结构,存储发起人的状态
type Memento struct {
content string // 保存的文本内容
}
// GetContent 获取备忘录中存储的内容
func (m *Memento) GetContent() string {
return m.content
}
定义发起人结构
发起人是实际的业务对象,负责创建备忘录和恢复状态:
// Originator 发起人,对应文本编辑器
type Originator struct {
content string // 当前文本内容
}
// SetContent 设置当前文本内容
func (o *Originator) SetContent(content string) {
o.content = content
}
// GetContent 获取当前文本内容
func (o *Originator) GetContent() string {
return o.content
}
// CreateMemento 创建备忘录,保存当前状态
func (o *Originator) CreateMemento() *Memento {
return &Memento{content: o.content}
}
// RestoreFromMemento 从备忘录恢复状态
func (o *Originator) RestoreFromMemento(m *Memento) {
o.content = m.GetContent()
}
定义管理者结构
管理者维护一个备忘录列表,负责存储和提供备忘录:
// Caretaker 管理者,管理备忘录集合
type Caretaker struct {
mementos []*Memento // 存储所有历史备忘录
}
// AddMemento 添加新的备忘录到历史记录
func (c *Caretaker) AddMemento(m *Memento) {
c.mementos = append(c.mementos, m)
}
// GetMemento 获取指定索引的备忘录,用于回滚
func (c *Caretaker) GetMemento(index int) *Memento {
if index < 0 || index >= len(c.mementos) {
return nil
}
return c.mementos[index]
}
// GetLastMemento 获取最后一个备忘录,用于撤销操作
func (c *Caretaker) GetLastMemento() *Memento {
if len(c.mementos) == 0 {
return nil
}
return c.mementos[len(c.mementos)-1]
}
// RemoveLastMemento 移除最后一个备忘录,撤销后移除当前状态
func (c *Caretaker) RemoveLastMemento() {
if len(c.mementos) == 0 {
return
}
c.mementos = c.mementos[:len(c.mementos)-1]
}
功能测试
通过以下代码测试整个状态保存和回滚流程:
package main
import "fmt"
func main() {
// 创建发起人和管理者
editor := &Originator{}
history := &Caretaker{}
// 第一次编辑内容,保存状态
editor.SetContent("第一版内容")
history.AddMemento(editor.CreateMemento())
fmt.Println("当前内容:", editor.GetContent())
// 第二次编辑内容,保存状态
editor.SetContent("第二版内容,新增了部分描述")
history.AddMemento(editor.CreateMemento())
fmt.Println("当前内容:", editor.GetContent())
// 第三次编辑内容,不保存状态直接修改
editor.SetContent("第三版内容,调整了格式")
fmt.Println("修改后未保存的内容:", editor.GetContent())
// 执行撤销操作,回滚到上一保存的状态
lastMemento := history.GetLastMemento()
if lastMemento != nil {
editor.RestoreFromMemento(lastMemento)
history.RemoveLastMemento()
}
fmt.Println("撤销后回滚的内容:", editor.GetContent())
// 回滚到第一版内容
firstMemento := history.GetMemento(0)
if firstMemento != nil {
editor.RestoreFromMemento(firstMemento)
}
fmt.Println("回滚到第一版的内容:", editor.GetContent())
}
运行上述代码会输出如下结果:
当前内容: 第一版内容 当前内容: 第二版内容,新增了部分描述 修改后未保存的内容: 第三版内容,调整了格式 撤销后回滚的内容: 第二版内容,新增了部分描述 回滚到第一版的内容: 第一版内容
实际业务中的优化方向
上述是基础实现,在实际业务中可以根据需求做进一步优化:
- 如果历史状态较多,管理者可以限制存储的备忘录数量,避免内存占用过高,比如只保留最近10条历史记录。
- 可以给备忘录增加时间戳、操作人等附加信息,方便后续做状态变更审计。
- 如果状态数据较大,备忘录可以只存储状态变更的差量,而不是全量数据,减少存储开销。
- 对于需要持久化历史状态的场景,管理者可以将备忘录存储到数据库或者文件中,而不是仅存在内存里。
注意事项
使用备忘录模式时需要注意几个问题:
- 备忘录的访问权限要控制好,除了发起人之外,其他对象不应该能修改备忘录的内容,Golang中可以通过小写字段、只提供只读方法的方式实现。
- 如果对象的状态数据非常大,频繁创建备忘录会带来较大的内存开销,需要评估状态存储的成本。
- 管理者存储备忘录时不需要关心备忘录的内部结构,只需要做存储和取出的操作,避免管理者和备忘录产生强耦合。
备忘录模式的核心优势是保持了对象的封装性,状态保存和恢复的逻辑都由对象自身处理,外部只需要调用对应方法即可,符合单一职责原则。