Simplifying state capture and restoration

Have you ever played a video game and wished you could go back to a previous state before making a crucial decision or encountering a difficult challenge? Or maybe you've wanted to implement a handy "undo" feature in an application you're building. Well, the Memento design pattern is here to save the day!

What is the Memento Design Pattern?

The Memento pattern is like a time machine for objects. It allows you to capture the internal state of an object at a specific point in time, and then restore that state later if needed. This is particularly useful when you need to implement features like undo/redo operations, checkpointing, or transaction-based systems.

The pattern involves three main players:

Originator: The object whose state needs to be saved and restored. Think of it as the object you want to travel back in time for.
Memento: A snapshot or memento of the Originator's internal state at a particular point in time. This is like a time capsule containing all the information needed to restore the object to that state.
Caretaker: An object responsible for storing and retrieving Mementos. It's like a time-traveling storage facility that keeps all the time capsules safe.

Here's how it works:

The Originator creates a Memento, capturing its current internal state.
The Originator passes the Memento to the Caretaker for safekeeping.
When needed, the Originator can request the Caretaker to return the Memento, allowing it to restore its previous state.

By separating the responsibilities of state capture, storage, and restoration, the Memento pattern adheres to the principles of encapsulation and information hiding, keeping the internal workings of the objects hidden from the outside world.

Real-World Examples

The Memento pattern is used in various applications and domains, making our lives a little easier:

Video Games: Many video games implement checkpoints or save points using the Memento pattern, allowing players to save their progress and resume from that point later, without having to start from the beginning every time.
Undo/Redo Operations: Text editors, image editors, and other software applications often implement undo/redo functionality using the Memento pattern, allowing users to correct mistakes or explore different options easily.
Transaction-based Systems: In database systems, the Memento pattern can be used to implement transaction rollbacks or savepoints, ensuring data integrity and consistency.
Snapshots/Backups: Cloud platforms and virtualization tools frequently use the Memento pattern to capture and restore snapshots of virtual machine or container states, providing a safeguard against data loss or system failures.
Version Control Systems: Version control systems like Git use a similar approach to record and restore changes to source code files, allowing developers to travel back in time and see how their code evolved.

A Simple Example in TypeScript

To help you understand the Memento pattern better, let's look at a simple TypeScript example of a video game character:

// Originator
class GameCharacter {
  private health: number;
  private mana: number;
  private position: { x: number; y: number };

  constructor(health: number, mana: number, x: number, y: number) {
    this.health = health;
    this.mana = mana;
    this.position = { x, y };
  }

  public takeHit(damage: number): void {
    this.health -= damage;
  }

  public useMana(amount: number): void {
    this.mana -= amount;
  }

  public move(x: number, y: number): void {
    this.position.x = x;
    this.position.y = y;
  }

  public createMemento(): GameCharacterMemento {
    return new GameCharacterMemento(this.health, this.mana, this.position.x, this.position.y);
  }

  public restoreFromMemento(memento: GameCharacterMemento): void {
    this.health = memento.getHealth();
    this.mana = memento.getMana();
    this.position.x = memento.getX();
    this.position.y = memento.getY();
  }
}

// Memento
class GameCharacterMemento {
  private health: number;
  private mana: number;
  private x: number;
  private y: number;

  constructor(health: number, mana: number, x: number, y: number) {
    this.health = health;
    this.mana = mana;
    this.x = x;
    this.y = y;
  }

  public getHealth(): number {
    return this.health;
  }

  public getMana(): number {
    return this.mana;
  }

  public getX(): number {
    return this.x;
  }

  public getY(): number {
    return this.y;
  }
}

// Caretaker
class GameCharacterCaretaker {
  private mementos: GameCharacterMemento[] = [];

  public addMemento(memento: GameCharacterMemento): void {
    this.mementos.push(memento);
  }

  public getMemento(index: number): GameCharacterMemento {
    return this.mementos[index];
  }
}

// Usage
const character = new GameCharacter(100, 50, 0, 0);
const caretaker = new GameCharacterCaretaker();

caretaker.addMemento(character.createMemento());

character.takeHit(20);
character.useMana(10);
character.move(5, 5);

// Encounter a difficult enemy, restore to previous state
character.restoreFromMemento(caretaker.getMemento(0));
console.log(`Health: ${character.getHealth()}, Mana: ${character.getMana()}, Position: (${character.getX()}, ${character.getY()})`);
// Output: Health: 100, Mana: 50, Position: (0, 0)

In this example, the GameCharacter class is the Originator, responsible for creating and restoring Mementos. The GameCharacterMemento class represents the Memento, capturing the state (health, mana, and position) of the Originator. The GameCharacterCaretaker class acts as the Caretaker, storing and retrieving Mementos.

We start with an initial state for the game character, create a Memento, and store it in the Caretaker. Then, we simulate some gameplay actions, such as taking damage, using mana, and moving the character. When we encounter a difficult enemy, we use the Caretaker to retrieve the initial Memento and restore the character to its previous state, effectively undoing the actions taken since the last checkpoint.

Why Use the Memento Pattern?

The Memento pattern offers several benefits:

Encapsulation: The pattern ensures that the internal state of an object is not exposed, maintaining encapsulation and information hiding principles.
Separation of Concerns: The responsibilities of state capture, storage, and restoration are separated into different components, promoting loose coupling and code organization.
Undo/Redo Support: The pattern facilitates implementing undo/redo functionality in applications, providing a familiar and expected user experience.
State Rollback: In transaction-based systems or long-running processes, the Memento pattern enables rollbacks or checkpointing, ensuring data integrity and consistency.
Versioning and Backups: The pattern can be used to capture and restore snapshots or versions of objects, enabling features like version control or system backups.

However, it's important to consider potential drawbacks, such as increased memory usage for storing Mementos and the need for additional code complexity to implement the pattern effectively.

The Memento design pattern is a powerful tool for capturing and restoring object states, enabling features like undo/redo operations, checkpointing, and transaction rollbacks. By adhering to encapsulation principles and separating concerns, it provides a flexible and maintainable solution for managing object states in various applications, making our lives a little easier, one time capsule at a time!

The Memento Design Pattern: Capturing and Restoring Object States Made Easy

Comments

Design Pattern Capsules

The Mediator Design Pattern: Facilitating Object Communication

More from this blog

My Homelab Journey: Paperless-ngx - The Document Management Game-Changer - Part 5

BackPair: A Simple Solution for Local Backup Management

My Homelab Journey: Upgrading to a Lenovo M920 Tiny with Proxmox - Part 4

Tool Builders: Why Creating Developer Libraries Accelerates Learning and Collaboration

My Homelab Journey with Raspberry Pi: Immich for Photo Backup - Part 3

What is the Memento Design Pattern?

Real-World Examples

A Simple Example in TypeScript

Why Use the Memento Pattern?

Command Palette

Comments

Design Pattern Capsules

The Mediator Design Pattern: Facilitating Object Communication

More from this blog

What is the Memento Design Pattern?

Real-World Examples

A Simple Example in TypeScript

Why Use the Memento Pattern?