c#设计模式-行为型模式之备忘录模式

?简介

备忘录模式（Memento Pattern）是一种行为型设计模式，它保存一个对象的某个状态，以便在适当的时候恢复对象。所谓备忘录模式就是在不破坏封装的前提下，捕获一个对象的内部状态，并在该对象之外保存这个状态。这样我们就可以在需要的时候将该对象恢复到原先保存的状态。

备忘录模式的主要角色如下：

发起人（Originator）角色：记录当前时刻的内部状态信息，提供创建备忘录和恢复备忘录数据的功能，实现其他业务功能，它可以访问备忘录里的所有信息。
备忘录（Memento）角色：负责存储发起人的内部状态，在需要的时候提供这些内部状态给发起人。
管理者（Caretaker）角色：对备忘录进行管理，提供保存与获取备忘录的功能，但其不能对备忘录的内容进行访问与修改。

?案例

?发起人（Originator）角色

首先，我们创建一个Originator类，它有一个内部状态State和一个Memento对象来保存状态。

public class Originator
{
    private string _state;

    public void Set(string state)
    {
        _state = state;
    }

    public Memento SaveToMemento()
    {
        return new Memento(_state);
    }

    public void GetFromMemento(Memento memento)
    {
        _state = memento.GetState();
    }

    public string GetState()
    {
        return _state;
    }
}

?备忘录（Memento）角色

然后，我们创建一个Memento类，它包含一个内部状态State。

public class Memento
{
    private readonly string _state;

    public Memento(string state)
    {
        _state = state;
    }

    public string GetState()
    {
        return _state;
    }
}

?管理者（Caretaker）角色

接下来，我们创建一个Caretaker类，它负责保存和获取Memento对象。

public class Caretaker
{
    private readonly Stack<Memento> _mementoStack = new Stack<Memento>();

    public void Add(Memento state)
    {
        _mementoStack.Push(state);
    }

    public Memento Get()
    {
        return _mementoStack.Pop();
    }
}

?测试类

class MyClass
{
    public static void Main(string[] args)
    {
        Originator originator = new Originator();
        Caretaker caretaker = new Caretaker();

        originator.Set("State #1");
        caretaker.Add(originator.SaveToMemento());

        originator.Set("State #2");
        caretaker.Add(originator.SaveToMemento());

        originator.Set("State #3");
        caretaker.Add(originator.SaveToMemento());

        originator.GetFromMemento(caretaker.Get());
        Console.WriteLine("Current State: " + originator.GetState());

        originator.GetFromMemento(caretaker.Get());
        Console.WriteLine("Current State: " + originator.GetState());
    }
}

?运行结果！

?优缺点

优点：

提供了一种可以恢复状态的机制。当用户需要时能够比较方便地将数据恢复到某个历史的状态。
实现了内部状态的封装。除了创建它的发起人之外，其他对象都不能够访问这些状态信息。
简化了发起人类。发起人不需要管理和保存其内部状态的各个备份，所有状态信息都保存在备忘录中，并由管理者进行管理，这符合单一职责原则。

缺点：

资源消耗大。如果要保存的内部状态信息过多或者特别频繁，将会占用比较大的内存资源。

使用场景:

需要保存与恢复数据的场景，如玩游戏时的中间结果的存档功能。
需要提供一个可回滚操作的场景，如 Word、记事本、Photoshop，idea等软件在编辑时按Ctrl+Z 组合键，还有数据库中事务操作。