大家好，这里是每周都在陪你一起进步的网管～！今天继续学习设计模式---备忘录模式
备忘录模式（Memento Pattern）又叫作快照模式（Snapshot Pattern）, 或令牌模式（Token Pattern）， 指在不破坏封装的前提下， 捕获一个对象的内部状态， 并在对象之外保存这个状态。 这样以后就可将该对象恢复到原先保存的状态， 属于行为型设计模式。
备忘录模式主要适用于以下应用场景。
- 需要保存历史快照的场景。
- 希望在对象之外保存状态，且除了自己，其他类对象无法访问状态保存的具体内容。
备忘录模式是一种行为型设计模式。这种模式允许我们保存对象在某些关键节点时的必要信息，以便于在适当的时候可以将之恢复到之前的状态。通常它可以用来帮助设计撤销/恢复操作。
备忘录模式的类结构
下面是备忘录模式的类图，
图片来自refactoringguru.cn/design-patt...
备忘录模式中主要有这三个角色的类
- Originator（发起者）：Originator是当前的基础对象，它会将自己的状态保存进备忘录，此角色可以类比博客系统中的文章对象
- 发起者中要有保存方法和从备忘录中恢复状态的方法，保存方法会返回当时状态组成的备忘录对象
- Memento（备忘录） ： 存储着Originator的状态的对象，类比理解即为文章对象的不同版本。
- Caretaker（管理人）：Caretaker是保存着多条备忘录的对象，并维护着备忘录的索引，在需要的时候会返回相应的备忘录 -- 类比理解为博客系统中的编辑器对象
- 管理者的保存和恢复操作，会代理其持有的发起者对象的保存和恢复操作，在这些代理方法中会增加对备忘录对象列表、当前备忘录版本的维护。
上面这个类图结构是实现备忘录模式的最简单方式，真实使用的时候，Caretaker，Originator、memento 这些角色可以继续抽象出对应的接口和实现。这里就不搞那么复杂了，要举的例子比较简单，这么一拆显得这个模式用起来特别费事儿。
其实其他设计模式也是一样，学习的时候大家知道了它的结构后，在实现应用的环节不必完完全全按照结构一板一眼地全部进行实现，有的应用场景并不复杂，能合并的角色可以按需进行合并。
应用举例
场景
某线上博客平台, 需为用户提供在线编辑文章功能，文章主要包括标题 - title 和内容 - content等信息。为最大程度防止异常情况导致编辑内容的丢失, 需要提供版本暂存和Undo, Redo功能。
"版本暂存"问题可以应用备忘录模式, 将编辑器的状态完整保存起来(主要就是编辑内容)，Undo和Redo的本质, 是在历史版本中前后移动把当时保存的内容加载到文章对象上。
方案设计
- IEditor: 定义编辑器接口
- EditorMemento: 定义编辑器的备忘录, 也就是编辑器的内部状态数据模型, 同时也对应一个历史版本
- Editor: 编辑器类, 实现IEditor接口
这个例子里我们把原发器和管理人两个角色集中在Editor类型上一起实现，例子比较简单，就没有单独实现一个Article类型作为原发器角色，如果你想完全按照备忘录模式的结构实现，把Title、Content这写属性和Save方法抽离到单独的Article类型上，再让Editor嵌套组合Article即可。
下面我们根据UML类图实现一下这个带Undo、Redo功能的编辑器。
代码实现
首先在IEditor 接口里定义编辑器对象要实现的行为
go
// 编辑器接口定义
type IEditor interface {
Title(title string)
Content(content string)
Save()
Undo() error
Redo() error
Show()
}接下来定义编辑器的备忘录, 也就是编辑器的内部状态数据模型, 同时也对应一个历史版本。
go
"本文使用的完整可运行源码
去公众号「网管叨bi叨」发送【设计模式】即可领取"
type Memento struct {
title string
content string
createTime int64
}
func newMemento(title string, content string) *Memento {
return &Memento{
title, content, time.Now().Unix(),
}
}然后是最复杂的Editor实现，它会实现上面IEditor接口中定义的所有行为，其中的Undo、Redo方法即回退、前进方法在实现的时候就是依赖的它内部记录的一组Memento对象，通过指向不同的Memento对象来实现回退和前进功能。
go
"本文使用的完整可运行源码
去公众号「网管叨bi叨」发送【设计模式】即可领取"
// 编辑器类, 实现IEditor接口
type Editor struct {
title string
content string
versions []*Memento
index int
}
func NewEditor() IEditor {
return &Editor{
"", "", make([]*Memento, 0), 0,
}
}
func (editor *Editor) Title(title string) {
editor.title = title
}
func (editor *Editor) Content(content string) {
editor.content = content
}
func (editor *Editor) Save() {
it := newMemento(editor.title, editor.content)
editor.versions = append(editor.versions, it)
editor.index = len(editor.versions) - 1
}
func (editor *Editor) Undo() error {
return editor.load(editor.index - 1)
}
func (editor *Editor) load(i int) error {
size := len(editor.versions)
if size <= 0 {
return errors.New("no history versions")
}
if i < 0 || i >= size {
return errors.New("no more history versions")
}
it := editor.versions[i]
editor.title = it.title
editor.content = it.content
editor.index = i
return nil
}
func (editor *Editor) Redo() error {
return editor.load(editor.index + 1)
}
func (editor *Editor) Show() {
fmt.Printf("MockEditor.Show, title=%s, content=%s\n", editor.title, editor.content)
}最后我们来测试一下Editor的版本记录功能
go
"本文使用的完整可运行源码
去公众号「网管叨bi叨」发送【设计模式】即可领取"
func main() {
editor := NewEditor()
// test save()
editor.Title("唐诗")
editor.Content("白日依山尽")
editor.Save()
editor.Title("唐诗 登鹳雀楼")
editor.Content("白日依山尽, 黄河入海流. ")
editor.Save()
editor.Title("唐诗 登鹳雀楼 王之涣")
editor.Content("白日依山尽, 黄河入海流。欲穷千里目, 更上一层楼。")
editor.Save()
// test show()
fmt.Println("-------------Editor 当前内容-----------")
editor.Show()
fmt.Println("-------------Editor 回退内容-----------")
for {
e := editor.Undo()
if e != nil {
break
} else {
editor.Show()
}
}
fmt.Println("-------------Editor 前进内容-----------")
for {
e := editor.Redo()
if e != nil {
break
} else {
editor.Show()
}
}
}运行程序后会有类似下面的显示
本文的完整源码，已经同步收录到我整理的电子教程里啦，可向我的公众号「网管叨bi叨」发送关键字【设计模式】领取。
最后请大家多多支持，转发点赞在看，后面还有三个模式咱们的设计模式大业就要完成啦～！