大话设计模式-备忘录模式-2020-10-20

定义

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

结构图

image.png

• 可以这样理解，Originator是使用者，而Caretaker是协助者。这两者相互协作，达到”悔棋“，也就是”备忘录“，的效果。

• Memento可以理解为需要保存的数据结构对象。Originator保存数据的时候，就存成这样一个Memento对象。然后，Caretaker就帮忙持有这个Memento对象。
  当需要恢复的时候，Originator从Caretaker那里拿到所需要的Memento对象，进行恢复。

• Caretaker和Memento之间是”聚合“关系是很合理的。一个Caretaker可以持有n个Memento，也就是可以”悔棋很多步“，或者可以保留多个“数据备份”

使用场景

• Memento模式比较适用于功能比较复杂的，但需要维护或记录属性
  历史的类，或者需要保存的属性只是众多属性的一部分时，Originator可
  以根据保存的Memento信息还原到前一状态

• 如果在某个系统中使用命令模式时，需要实现命令的内部撤销功
  能，那么命令模式可以使用备忘录模式来存储可撤销操作的状态。有时一
  些对象的内部信息必须保存在对象以外的地方，但是必须要由对象自己读
  取，这时，使用备忘录可以把复杂的对象内部信息对其他的对象屏蔽起
  来，从而可以适当地保持封装的边界。

• 当角色的状态改变的时候，有可能这个状态无效，这时候就可以使用暂时存储起来的备忘录将状态复原。

游戏进度备忘录的例子

• 场景描述
  用程序模拟一个场景：游戏的某个场景，一游戏角色有生命力、攻击力、防御力等数据，在打boss前后一定会不一样，我们允许玩家如果感觉与boss决斗的效果不理想可以让游戏恢复到决斗前。

• 结构图

image.png

• 参考文章

• GameRole类（Originator）

/**
 * 游戏角色；就是Originator类
 */
class GameRole {
    private int vitality;//生命力
    private int attack;//攻击力
    private int defense;// 防御力
    final private int limit = 30; // 判断标准
    private boolean flag;

    /**
     * 状态显示
     */
    public String display() {
        String state = "角色当前状态：" + "\n"
                + "体力:"+ vitality + "\n"
                + "攻击力:"+ attack + "\n"
                + "防御力:"+ defense + "\n";
        if (flag == true) {
            state += "状态良好，可以继续战斗";
        } else {
            state += "状态糟糕，请注意";
        }
        Log.v("GameRole", state);
        return state;
    }

    /**
     * 获得初始状态
     */
    public void initState() {
        vitality = 100;
        attack = 100;
        defense = 100;
        flag = true;
    }

    /**
     * 战斗，与大boss决战，损耗; 这里简单表示为[0 ~ 100)之间的随机数
     */
    public void fight() {
        vitality = new Random().nextInt(100);
        attack = new Random().nextInt(100);
        defense = new Random().nextInt(100);
        if ((vitality > limit) && (attack > limit) && (defense > limit)) {
            flag = true;
        } else {
            flag = false;
        }
    }

    /**
     * 保存角色状态，将三个值通过实例化：角色状态存储箱返回
     */
    public RoleStateMemento saveState() {
        return new RoleStateMemento(vitality, attack, defense);
    }

    /**
     * 恢复角色状态
     */
    public void recoveryState(RoleStateMemento memento) {
        if (memento != null) {
            this.vitality = memento.getVitality();
            this.attack = memento.getAttack();
            this.defense = memento.getDefense();
            if ((vitality > limit) && (attack > limit) && (defense > limit)) {
                flag = true;
            } else {
                flag = false;
            }
        }
    }
}

• RoleStateCaretaker类，（Caretaker）

/**
 * 角色状态存储箱类, 就是Caretaker类
 */
class RoleStateCaretaker {
    private RoleStateMemento memento;

    public void setMemento(RoleStateMemento memento) {
        this.memento = memento;
    }

    public RoleStateMemento getMemento() {
        return memento;
    }
}

• RoleStateMemento类，（Memento），就是“需要备份的数据结构”

/**
 * 角色状态存储箱类; Memento类
 */
class RoleStateMemento {
    private int vitality;//生命力
    private int attack;//攻击力
    private int defense;// 防御力

    /**
     * 将生命力、攻击力、防御力存入状态存储箱对象中
     */
    public RoleStateMemento(int vitality, int attack, int defense) {
        this.vitality = vitality;
        this.attack = attack;
        this.defense = defense;
    }

    /**
     * getter
     */
    public int getVitality() {
        return vitality;
    }

    public int getAttack() {
        return attack;
    }

    public int getDefense() {
        return defense;
    }
}

• 测试界面

image.png

• 客户端程序

public class MementoActivity extends AppCompatActivity {

    public static void launch(Context context) {
        if (null != context) {
            Intent intent = new Intent();
            intent.setClass(context, MementoActivity.class);
            if (!(context instanceof Activity)) {
                intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
            }
            context.startActivity(intent);
        }
    }

    GameRole gameRole;
    RoleStateCaretaker caretaker;
    TextView stateTextView;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_memento);
        setTitle("备忘录模式");

        stateTextView = findViewById(R.id.textViewState);
        gameRole = new GameRole();
        caretaker = new RoleStateCaretaker();

        // 初始状态是满血复活的状态
        gameRole.initState();
        stateTextView.setText(gameRole.display());
    }

    public void onInitialButtonClick(View view) {
        gameRole.initState();
        stateTextView.setText(gameRole.display());
    }

    public void onSaveButtonClick(View view) {
        caretaker.setMemento(gameRole.saveState());
    }

    public void onRecoveryButtonClick(View view) {
        gameRole.recoveryState(caretaker.getMemento());
        stateTextView.setText(gameRole.display());
    }

    public void onFightButtonClick(View view) {
        gameRole.fight();
        stateTextView.setText(gameRole.display());
    }
}

Demo地址

https://gitee.com/zhangxusong888/Android/tree/master/design_pattern