备忘录Memento模式

动机（Motivation）

在软件构建过程中，某些对象的状态在转换过程中，可能由于某种需要，要求程序能够回溯到对象之前处于某个点时的状态。如果使用一些公有接口来让其他对象得到对象的状态，会暴露对象的实现细节。

如何实现对象状态的良好保存与恢复？但同时又不会因此而破坏对象本身的封装性？

意图（Intent）

在不破坏封装性的前提下，捕获一个对象的内部状态，并在该对象之外保存这个状态。这样以后就可以将该对象恢复到原先保存的状态。

结构（Structure）

其中，

Memento备忘录：负责存储Originator对象的内部状态（不一定是全部的状态，可以是一部分），并可防止Originator以外的其他对象访问备忘录Memento。备忘录有两个接口，Caretaker只能看到备忘录的窄接口，它只能将备忘录传递给其他对象。Originator可以看到一个宽接口，允许它访问返回到先前状态所需的所有数据。

Originator发起人：负责创建一个备忘录（CreateMemento），用以记录当前时刻它的内部状态，并可以使用备忘录恢复内部状态（SetMemento恢复内部状态）。Originator可根据需要决定Memento存储Originator的哪些内部状态。

Caretaker管理者：负责保存好备忘录Memento，不能对备忘录的内容进行操作或检查。

代码实现（Example）

背景实例

游戏的某个场景，游戏角色有生命力、攻击力、防御力等数据，允许玩家觉得与BOSS决斗效果不理想的情况下，保存一些数据，之后可以恢复到与BOSS决战前的进度，重新大战Boss。

游戏角色类：相当于结构图中的Originator发起人，有 Vitality生命力，Attack攻击力和 Defense防御力3个属性。

    class GameRoles
    {
        //生命力
        private int vit;
        public int Vitality
        {
            get { return vit; }   set { vit = value; }
        }
        //攻击力...防御力...  
        public void StateDisplay()
        {
             //状态显示
        }
        //获得初始状态
        public void GetInitState()
        {
            this.vit = 100;
            this.atk = 100;
            this.def = 100;
        }
        //战斗,在与大Boss大战后游戏数据损耗为0
        public void Fight()
        {
            this.vit = 0;
            this.atk = 0;
            this.def = 0;
        }
    }

该类中还有创建备忘录的方法，恢复到原来状态的方法。

保存角色状态,将游戏角色的三个状态值通过实例化“角色状态存储箱”返回

        public RoleStateMemento SaveState()
        {
            return (new RoleStateMemento(vit, atk,def));
        }

恢复角色状态,可以将外部的“角色状态存储箱”中的状态值恢复给游戏角色

        public void RecoveryState(RoleStateMemento memento)
        {
            this.vit = memento.Vatality;
            this.atk = memento.Attack;
            this.def = memento.Defense;
        }

角色状态存储箱类：相当于结构图中的Memento备忘录，将生命力、攻击力、防御力存入状态存储箱对象中

     class RoleStateMemento
    {
        //生命力
        private int vit;
        public int Vatality
        {
            get { return vit; }  set { vit = value; }
        }
        //攻击力...防御力...
        public RoleStateMemento(int vit, int atk, int def)
        {
            this.vit = vit;
            this.atk = atk;
            this.def = def;
        }
    }

角色状态管理者类:相当于结构图中的Caretaker管理者，负责保存好备忘录Memento，不能对备忘录的内容进行操作或检查。

     class RoleStateCaretaker
    {
        private RoleStateMemento memento;
        public RoleStateMemento Memento
        {
            get { return memento; }
            set { memento = value; }
        }
    }

客户端代码

实例化一个游戏角色。游戏角色初始状态，生命力，攻击力和防御力都是100，获得初始状态，显示初始状态

 GameRoles tongtong = new GameRoles();
 tongtong.GetInitState();
 tongtong.StateDisplay();

保存进度，保存进度时，由于封装在Memento中，因此我们并不知道保存了哪些具体的角色数据

 RoleStateCaretaker stateAdmin = new RoleStateCaretaker();
 stateAdmin.Memento = tongtong.SaveState();

大战Boss之后，各项标准值都变为0

tongtong.Fight();
tongtong.StateDisplay();

恢复之前状态，也就是恢复备忘录中保存的状态

tongtong.RecoveryState(stateAdmin.Memento);
tongtong.StateDisplay();

运行结果

Memento模式的几个要点

1.备忘录（Memento）存储源发器（Originator）对象的内部状态，在需要时恢复原发器状态。Memento模式适用于“由原发器管理，却又必须存储在原发器之外的信息”。

2.在实现Memento模式中，要防止原发器以外的对象访问备忘录对象。备忘录对象有两个接口，一个为原发器使用的宽接口；一个为其他对象使用的窄接口。

3.在实现Memento模式时，要考虑拷贝对象状态的效率问题，如果对象开销较大，可以采用某种增量式改变来改建Memento模式。