[Design Pattern] Memento Pattern - 메멘토 패턴

Memento Pattern

Memento 패턴은 객체의 상태를 저장하고 복원할 수 있게 하는 디자인 패턴입니다.

• 이 패턴은 객체의 내부 상태를 캡슐화하여 외부에 노출시키지 않고도 객체의 상태를 저장하고 복원할 수 있게 해줍니다.

일반적으로 어떤 Object의 히스토리를 관리하고 싶을 때 유용한 패턴입니다. → 게임에서 Save하는 것을 떠올리면 됩니다.

• 가령 텍스트 에디터 사용할 때 undo와 같은 기능을 사용하여 삭제 하기 전 상태로 텍스트 복원이 가능하고, 그 기능을 몇 단계로 실행해서 편집작업을 점점 과거로 돌리는 것도 가능함
• 객체지향프로그램에서 undo기능을 실행하려면 인스턴스를 가지고 있는 정보를 저장해 둘 필요가 있습니다.
  • 단, 저장만 해서는 안되고, 저장한 정보로부터 인스턴스를 원대래로 되돌릴 수 있어야 합니다.
• Mememto Pattern을 사용하면 어떤 시점의 인스턴스의 상태를 확실하게 기록해서 저장해 두면 나중에 인스턴스를 그 시점의 상태 되돌릴 수 있습니다.

• Originator: 작성자 역할, 자신의 현재 상태를 저장하고 싶을 때 Memento를 만들어 저장하고 불러오기도 함
• Memento: Originator 역할의 내부 정보를 정리 보관합니다.
• Caretaker: 미래의 필요에 대비하여 Memento 역할을 저장합니다.

 

Object

• Object를 나타내는 State가 존재합니다. (Memento에 들어가야 할 내용)
• createMemento(): State에 대한 memento를 만들어 주는 함수입니다.
• restore(): Memento Object로부터 State를 복원해 주는 함수입니다.

Memento

• Object의 stae를 그대로 저장하기 때문에 Object와 동일한 state를 property를 가지고 있습니다.
• Memento를 관리하기 위한 정보를 추가할 수 있습니다.

---

 

Memento Pattern Example

class Cat:
    def __init__(self, age, height):
        self.age = age
        self.height = height

    def speak(self):
        print(f'{self.age} year old, {self.height} cm, meow')

    def createMemento(self):
        cat_memento = CatMemento(self.age, self.height)
        return cat_memento

    def restore(self, memento):
        self.age = memento.age
        self.height = memento.height

• Cat 클래스
  • __init__: 내부 상태로 age와 height를 가집니다.
  • speak(): 현재 age와 height를 출력하는 함수입니다.
  • createMemento(): 현재 Cat의 상태를 Memento 객체로 만들어 반환하는 함수입니다.
  • restore(): 전달받은 Memento 객체를 사용하여 Cat의 상태를 복원하는 함수입니다.

 

import uuid
from datetime import datetime

class CatMemento:
    def __init__(self, age, height):
        self.uuid = uuid.uuid4()
        self.created_time = datetime.now()
        self.age = age
        self.height = height

• CatMemento 클래스
  • __init__: Memento 객체로 Cat의 age와 height를 저장합니다. 또한, 생성 시간(created_time)과 고유 ID(uuid)를 부여합니다.

cat_history = []

• cat_history: Memento 객체를 저장하는 리스트입니다.

cat = Cat(0, 10)
cat_history.append(cat.createMemento())

• Cat 객체 생성: age=0, height=10인 Cat 객체를 생성합니다.
• Cat의 state를 기억하기 위해 createMememto()를 통해 Memento를 생성, cat_hisotry

cat.age = 1
cat.height = 25
cat_history.append(cat.createMemento())

• Age=1, height=25가 된 상태에서 보겠습니다.
• 이 정보를 cat_history에 넣어주기 위해 createMemento()를 통해 Memento를 생성해서 리스트에 추가합니다.

cat.age = 2
cat.height = 50
cat_history.append(cat.createMemento())

• Age=2, height=50가 된 상태에서 보겠습니다.
• 이 정보를 cat_history에 넣어주기 위해 createMemento()를 통해 Memento를 생성해서 리스트에 추가합니다.

cat.restore(cat_history[0])

• cat_history의 0번째 과거 정보로 복구하고 싶다면 restore()을 호출하여 그 argument로 cat_history의 0번째 memento Object를 넘겨주면 됩니다.

cat.speak() -> # 0year old, 10cm, meow

• Cat의 speak() 호출하면 0번쨰 memento로 state 변경된 것을 확인했습니다.

Object의 state를 기억하기 위해 Memento 오브젝트 생성하고 그 오브젝트들을 히스토리 리스트에서 관리하는 Pattern 입니다.