Day 23: Behavioral patterns - Memento

目的

当系统需要提供「复原功能」、「取消复原功能」、「回复到上一个步骤」等需要将这些资料暂时存放在记忆体内，可以采纳的设计模式。

说明

要思考的是，在确保资料不会「任意被他者」复制、备份，且同时能有顺序地备份资料，供使用者想要「复原」时使用。

作法是：

定义好需要备份的物件（称作：Originator），这边可以采集中式一个物件或是多个小物件。
1. 提供储存的方式，使用 Memento 物件达到此功能。
2. 提供复原的方式，使用 Memento 物件达到此功能。
建立负责储存资料的物件（称作：Memento）
1. 该物件的属性会跟 Originator 一致，确保没有资料遗漏。
2. 该物件只会储存一次 Originator 的资料，如果要再次储存就重新实体化一个新的 Memento 物件。
建立负责储存多个 Memento 物件的看守者物件（称作：Caretaker），Originator 要执行储存、复原时，都是跟 Caretaker 沟通。

以下范例以「音乐模拟器」为核心制作。

UML 图

Memento Pattern UML Diagram

使用 Java 实作

制作将被储存的资料：Solfege

public class Solfege {
    private String name;

    public Solfege(String name) {
        this.name = name;
    }

    public String getName() {
        return name;
    }
}

制作音乐模拟器：MusicSimulator（Originator 物件）

public class MusicSimulator {
    private List<Solfege> inputs = new ArrayList<>();

    public void showInputs() {
        System.out.println("输入的音阶有：");

        for (Solfege solfege : inputs) {
            System.out.print(solfege.getName());
        }

        System.out.println("\n");
    }

    public void inputSolfege(Solfege solfege) {
        inputs.add(solfege);
    }

    public MusicSimulatorMemento saveInputs() {
        System.out.println("开始备份\n");
        StringBuilder stringBuilder = new StringBuilder();

        for (Solfege input : inputs) {
            stringBuilder.append(input.getName());
        }

        return new MusicSimulatorMemento(Base64.getEncoder().encodeToString(stringBuilder.toString().getBytes()));
    }

    public void restore(MusicSimulatorMemento musicSimulatorMemento) {
        System.out.println("开始还原\n");

        if (musicSimulatorMemento == null) {
            System.out.println("没有记录");
        } else {
            String decodedString = new String(Base64.getDecoder().decode(musicSimulatorMemento.getBackup().getBytes()));
            inputs.clear();

            for (String inputString : decodedString.split("")) {
                inputs.add(new Solfege(inputString));
            }
        }
    }
}

制作负责储存资料的物件：MusicSimulatorMemento（Memento物件）

public class MusicSimulatorMemento {
    private String backup;

    public MusicSimulatorMemento(String backup) {
        this.backup = backup;
    }

    public String getBackup() {
        return backup;
    }
}

制作建立负责储存多个 Memento 的物件：MusicSimulatorCareTaker（Caretaker物件）

public class MusicSimulatorCareTaker {
    private List<MusicSimulatorMemento> saves = new ArrayList<>();

    public MusicSimulatorMemento getUndo() {
        if (saves.isEmpty()) {
            return null;
        } else {
            return saves.get(saves.size() - 1);
        }
    }

    public void setSave(MusicSimulatorMemento memento) {
        saves.add(memento);
    }
}

测试，在模拟器上输入音符後，还原到上个状态：MusicSimulatorMementoSample

public class MusicSimulatorMementoSample {

    public static void main(String[] args) {
        MusicSimulator musicSimulator = new MusicSimulator();

        // 输入音阶
        musicSimulator.inputSolfege(new Solfege("C"));
        musicSimulator.inputSolfege(new Solfege("D"));
        musicSimulator.inputSolfege(new Solfege("E"));
        musicSimulator.inputSolfege(new Solfege("F"));

        // 确认输入的音阶
        musicSimulator.showInputs();

        // 储存
        MusicSimulatorCareTaker musicSimulatorCareTaker = new MusicSimulatorCareTaker();
        musicSimulatorCareTaker.setSave(musicSimulator.saveInputs());

        // 输入新的音阶
        musicSimulator.inputSolfege(new Solfege("G"));
        musicSimulator.inputSolfege(new Solfege("A"));
        musicSimulator.inputSolfege(new Solfege("B"));

        // 确认输入的音阶
        musicSimulator.showInputs();

        // 复原到上个状态
        musicSimulator.restore(musicSimulatorCareTaker.getUndo());

        // 确认输入的音阶
        musicSimulator.showInputs();
    }

}

使用 JavaScript 实作

制作将被储存的资料：Solfege

class Solfege {
  constructor(name) {
    /** @type {string} */
    this.name = name;
  }

  getName() {
    return this.name;
  }
}

制作音乐模拟器：MusicSimulator（Originator 物件）

class MusicSimulator {
  constructor() {
    /** @type {Solfege[]} */
    this.inputs = [];
  }

  showInputs() {
    console.log("输入的音阶有：");

    let solfegeList = ""

    for (const solfege of this.inputs) {
      solfegeList += solfege.getName();
    }

    console.log(`${solfegeList}\n`);
  }

  /** @param {Solfege} solfege */
  inputSolfege(solfege) {
    this.inputs.push(solfege);
  }

  saveInputs() {
    console.log("开始备份\n");

    let currentInputs = "";

    for (const solfege of this.inputs) {
      currentInputs += solfege.getName();
    }

    return new MusicSimulatorMemento(Buffer.from(currentInputs, 'utf8').toString('base64'));
  }

  /** @param {MusicSimulatorMemento} musicSimulatorMemento */
  restore(musicSimulatorMemento) {
    console.log("开始还原\n");

    if (musicSimulatorMemento === null) {
      console.log("没有记录");
    } else {
      const decodedString = Buffer.from(musicSimulatorMemento.getBackup(), 'base64').toString('utf8');
      this.inputs = [];

      for (const inputString of decodedString.split("")) {
        this.inputs.push(new Solfege(inputString));
      }
    }
  }
}

制作负责储存资料的物件：MusicSimulatorMemento（Memento物件）

class MusicSimulatorMemento {
  constructor(backup) {
    /** @type {string} */
    this.backup = backup;
  }

  getBackup() {
    return this.backup;
  }
}

制作建立负责储存多个 Memento 的物件：MusicSimulatorCareTaker（Caretaker物件）

class MusicSimulatorCareTaker {
  constructor() {
    /** @type {MusicSimulatorMemento[]} */
    this.saves = [];
  }

  getUndo() {
    if (this.saves.length === 0) {
      return null;
    } else {
      return this.saves[this.saves.length - 1];
    }
  }

  /** @param {MusicSimulatorMemento} */
  setSave(memento) {
    this.saves.push(memento);
  }
}

测试，在模拟器上输入音符後，还原到上个状态：MusicSimulatorMementoSample

const musicSimulatorMementoSample = () => {
  const musicSimulator = new MusicSimulator();

  // 输入音阶
  musicSimulator.inputSolfege(new Solfege("C"));
  musicSimulator.inputSolfege(new Solfege("D"));
  musicSimulator.inputSolfege(new Solfege("E"));
  musicSimulator.inputSolfege(new Solfege("F"));

  // 确认输入的音阶
  musicSimulator.showInputs();

  // 储存
  const musicSimulatorCareTaker = new MusicSimulatorCareTaker();
  musicSimulatorCareTaker.setSave(musicSimulator.saveInputs());

  // 输入新的音阶
  musicSimulator.inputSolfege(new Solfege("G"));
  musicSimulator.inputSolfege(new Solfege("A"));
  musicSimulator.inputSolfege(new Solfege("B"));

  // 确认输入的音阶
  musicSimulator.showInputs();

  // 复原到上个状态
  musicSimulator.restore(musicSimulatorCareTaker.getUndo());

  // 确认输入的音阶
  musicSimulator.showInputs();
}

musicSimulatorMementoSample();