Golang - Design Pattern #22: 備忘錄模式 (Memento)

💾 保存和恢復物件狀態 💾

你有沒有想過，當你在玩電子遊戲時，每次過關或失敗後，遊戲是如何保存你的遊戲進度的呢? 🎮 或者當你正在編輯文檔時，"Undo" 功能又是如何工作的? 这些都可以通過備忘錄模式來實現！

備忘錄模式 🔖

備忘錄模式允許一個物件保存其當前狀態，並在稍後的某個時刻恢復到這個狀態。這種模式主要由三個部分組成：

1. 發起者 (Originator): 它是我們希望保存狀態的物件。
2. 備忘錄 (Memento): 用於保存發起者物件的內部狀態。
3. 管理者 (Caretaker): 負責保存和恢復發起者的備忘錄。

摸摸 Go

↩️ 編輯器 Undo

假設我們有一個簡單的文本編輯器，並希望新增 Undo 功能。

// You can edit this code!
// Click here and start typing.
package main

import "fmt"

// Originator
type Editor struct {
	content string
}

func (e *Editor) SetContent(content string) {
	e.content = content
}

func (e *Editor) CreateMemento() *Memento {
	return &Memento{content: e.content}
}

func (e *Editor) Restore(m *Memento) {
	e.content = m.content
}

// Memento
type Memento struct {
	content string
}

// Caretaker
type History struct {
	mementos []*Memento
}

func (h *History) Push(m *Memento) {
	h.mementos = append(h.mementos, m)
}

func (h *History) Pop() *Memento {
	if len(h.mementos) == 0 {
		return nil
	}
	last := h.mementos[len(h.mementos)-1]
	h.mementos = h.mementos[:len(h.mementos)-1]
	return last
}

func main() {
	// Client code
	editor := &Editor{}
	history := &History{}

	editor.SetContent("Hello")
	history.Push(editor.CreateMemento())

	editor.SetContent("Hello, Go!")
	history.Push(editor.CreateMemento())

	editor.SetContent("Hello, Go! How are you?")
	// Oops! I didn't want to add that last part. Let's undo.
	editor.Restore(history.Pop())

	fmt.Println(editor.content) // Outputs: Hello, Go!

}

🎮​遊戲進度保存

假設我們有一個角色扮演遊戲，玩家可以保存和加載遊戲進度。

package main

import "fmt"

// Originator
type Game struct {
	level  int
	health int
}

func (g *Game) Play(levelAdvance int, healthChange int) {
	g.level += levelAdvance
	g.health += healthChange
}

func (g *Game) Save() *Memento {
	return &Memento{level: g.level, health: g.health}
}

func (g *Game) Load(m *Memento) {
	g.level = m.level
	g.health = m.health
}

// Memento
type Memento struct {
	level  int
	health int
}

// Caretaker
type GameSaves struct {
	saves []*Memento
}

func main() {
	// Client code
	game := &Game{level: 1, health: 100}
	saves := &GameSaves{}

	game.Play(1, -20)
	saves.saves = append(saves.saves, game.Save())

	game.Play(1, -50)
	// Oh no! I'm about to die. Let's load the last save.
	game.Load(saves.saves[len(saves.saves)-1])

	fmt.Println(game) // Outputs: &{level: 2 health: 80}

}

小結 📚

備忘錄模式提供了一種有效的方法，可以捕獲和儲存一個物件的當前狀態，以便稍後恢復。它對於實現如"Undo"或"Save / Load遊戲"等功能特別有用。