Паттерн проектирования Memento в Python
В этом уроке вы с помощью паттерна Memento будете сохранять и восстанавливать состояние объекта, как в функции отмены (undo).
Введение
Какую задачу это решает
Отмена действий, контрольные точки в играх, сброс настроек - всё это требует сохранить состояние объекта и потом вернуть его. При этом другой код не должен лезть во внутренности объекта.
Пример из жизни
Шаблон Memento (снимок) похож на сохранение игры. Игра создаёт файл сохранения со своим состоянием. Вы храните этот файл, и вам не нужно понимать, что внутри. Позже вы загружаете сохранение, и игра возвращается ровно туда, где была.
editor.save()💾 Создать файл сохраненияSnapshot(text)🔒 Запечатанное сохранение, которое нельзя правитьeditor.text = "changed"🎮 Играть дальше и что-то менятьeditor.restore(saved)⏪ Загрузить сохранение: снова draftШаблон Memento сохраняет состояние объекта в объекте-снимке, из которого это состояние потом можно восстановить. При этом код, который хранит снимок, не видит внутренних деталей объекта.
Главное
Snapshot- замороженный dataclass, поэтому сохранённый снимок нельзя изменить после создания.save()создаётSnapshotс текущим текстом.- Затем текст меняется на
"changed". restore(saved)возвращает сохранённый текст, поэтому выводится"draft".
Когда это нужно?
- Отмена и повтор в редакторах и графических инструментах.
- Контрольные точки и сохранения в играх.
- Откат после неудачной операции.
Когда это не нужно
- Очень большие состояния, которые часто сохраняются: снимки займут много памяти, лучше храните только изменения.
- Простые значения: хватит сохранить копию переменной.
Пример кода
from dataclasses import dataclass
@dataclass(frozen=True)
class Snapshot:
# Memento: store a restorable snapshot without exposing internals.
text: str
class Editor:
def __init__(self): self.text = ""
def save(self): return Snapshot(self.text)
def restore(self, snapshot):
# Restore state without exposing representation details.
self.text = snapshot.text
editor = Editor()
editor.text = "draft"
saved = editor.save()
editor.text = "changed"
editor.restore(saved)
print(editor.text)
Результат выполнения
draft
Разбор кода
Метод save() класса Editor создаёт снимок с текущим содержимым, draft. После того как содержимое меняется на changed, метод restore() возвращает содержимое из сохранённого снимка, поэтому на экран выводится draft.
Измените значения и запустите программу в онлайн-компиляторе Python CodeUtility без локальной установки Python.
Упражнения для практики
Попробуйте изменить код по подсказкам ниже. Если менять код и смотреть на результат, урок запомнится гораздо лучше, чем при простом чтении.
- Замените предметную область примера, сохранив структуру паттерна.
- Сравните паттерн с более простой реализацией и объясните компромиссы.
- Напишите тесты для каждого участника перед добавлением новой реализации.
Частые ошибки
Сохранение ссылки на изменяемое состояние
Если снимок хранит тот же список, который редактор продолжает менять, сохранённое состояние тоже меняется.
def save(self):
return Snapshot(self.lines) # same list
def save(self):
return Snapshot(list(self.lines)) # a copy
Закончили этот урок?
Отметьте его как изученный, чтобы следить за прогрессом.