iOS 设计模式之十九（备忘录模式）

一、概念

1、备忘录模式的动机

​ "曾经有一段真挚的爱情放在我面前，我没有珍惜，等到失去了才后悔莫及，如果上天再给我一次机会，我会对她说三个字，我爱你，如果非得加一个期限，我希望是一万年。"有没有很熟悉这句台词，这句话出自周星驰主演的电影《大话西游之月光宝盒》。人生没有“后悔药”，但是我们可以实现软件中的“后悔药”，这就需要了解备忘录模式了。

2、备忘录模式的定义

​ 备忘录模式（Memento Pattern）：在不破坏封装的前提下，捕获一个对象的内部状态，并在该对象之外保存这个状态，这样可以在以后将对象恢复到原先保存的状态。它是一种对象行为型模式，其别名为Token。

3、备忘录模式的3个角色

1）Originator（原发器）：它是一个普通类，可以创建一个备忘录，并存储它的当前内部状态，也可以使用备忘录来恢复其内部状态，一般将需要保存内部状态的类设计为原发器。

2）Memento（备忘录）：存储原发器的内部状态，根据原发器来决定保存哪些内部状态。备忘录的设计一般可以参考原发器的设计，根据实际需要确定备忘录类中的属性。需要注意的是，除了原发器本身与负责人类之外，备忘录对象不能直接供其他类使用，原发器的设计在不同的编程语言中实现机制会有所不同。

3）Caretaker（负责人）：负责人又称为管理者，它负责保存备忘录，但是不能对备忘录的内容进行操作或检查。在负责人类中可以存储一个或多个备忘录对象，它只负责存储对象，而不能修改对象，也无须知道对象的实现细节。

4、结构图

备忘录模式

二、示例

​ 备忘录模式的核心是备忘录类以及用于管理备忘录的负责人类的设计。

1）先创建一个象棋棋子类Chessman，类中有一些属性、保存状态和恢复状态的方法，表示原发器；

2）然后创建棋子备忘录ChessmanMemento类，表示备忘录；

3）最后创建MementoCaretaker类，类中有添加备忘录和获取指定的备忘录的方法，表示负责人；

具体代码如下：

Chessman类：

// 象棋棋子类：原发器
@interface Chessman : NSObject
@property(nonatomic, copy) NSString *name;
@property(nonatomic, assign) NSInteger x;
@property(nonatomic, assign) NSInteger y;
- (instancetype)initWithName:(NSString *)name x:(NSInteger)x y:(NSInteger)y;
- (ChessmanMemento *)save; //保存状态
- (void)restore:(ChessmanMemento *)memento; //恢复状态
@end

@implementation Chessman
- (instancetype)initWithName:(NSString *)name x:(NSInteger)x y:(NSInteger)y {
    self = [super init];
    if (self) {
        _name = name;
        _x = x;
        _y = y;
    }
    return self;
}

- (ChessmanMemento *)save {
    return [[ChessmanMemento alloc] initWithName:self.name x:self.x y:self.y];
}

- (void)restore:(ChessmanMemento *)memento {
    self.name = memento.name;
    self.x = memento.x;
    self.y = memento.y;
}
@end

ChessmanMemento类：

// 象棋棋子备忘录类
@interface ChessmanMemento : NSObject
@property(nonatomic, copy) NSString *name;
@property(nonatomic, assign) NSInteger x;
@property(nonatomic, assign) NSInteger y;
- (instancetype)initWithName:(NSString *)name x:(NSInteger)x y:(NSInteger)y;
@end

@implementation ChessmanMemento
- (instancetype)initWithName:(NSString *)name x:(NSInteger)x y:(NSInteger)y {
    self = [super init];
    if (self) {
        _name = name;
        _x = x;
        _y = y;
    }
    return self;
}
@end

MementoCaretaker类：

// 象棋棋子备忘录管理类
@interface MementoCaretaker : NSObject
- (void)addMemento:(ChessmanMemento *)memento;
- (ChessmanMemento *)getMemento:(NSInteger)index;
@end

@interface MementoCaretaker ()
@property(nonatomic, strong) NSMutableArray *mementoList;
@end
@implementation MementoCaretaker
- (instancetype)init
{
    self = [super init];
    if (self) {
        _mementoList = [NSMutableArray array];
    }
    return self;
}

- (void)addMemento:(ChessmanMemento *)memento {
    [self.mementoList addObject:memento];
}

- (ChessmanMemento *)getMemento:(NSInteger)index {
    if (index < self.mementoList.count) {
        return self.mementoList[index];
    }
    return nil;
}
@end

运行代码：

@interface ViewController ()
@property(nonatomic, assign) NSInteger index; //备忘录索引
@property(nonatomic, strong) MementoCaretaker *caretaker; //负责人
@end

@implementation ViewController
- (void)viewDidLoad {
    [super viewDidLoad];
    
    self.index = -1;
    self.caretaker = [MementoCaretaker new];
    
    Chessman *chess = [[Chessman alloc] initWithName:@"车" x:1 y:1];
    [self playWithChess:chess];
    
    chess.y = 8;
    [self playWithChess:chess];
    
    chess.x = 6;
    [self playWithChess:chess];
    
    NSLog(@"------------------");
    [self undoWithChess:chess];
    [self undoWithChess:chess];
}

// 下棋
- (void)playWithChess:(Chessman *)chess {
    ChessmanMemento *memento = [chess save];
    [self.caretaker addMemento:memento]; //保存备忘录
    self.index ++; //序号加1
    NSLog(@"下棋啦，%@当前位置：x = %ld, y = %ld", chess.name, chess.x, chess.y);
}

// 悔棋
- (void)undoWithChess:(Chessman *)chess {
    self.index --; //序号减1
    ChessmanMemento *memento = [self.caretaker getMemento:self.index];
    [chess restore:memento]; //恢复备忘录
    NSLog(@"悔棋啦，%@当前位置：x = %ld, y = %ld", chess.name, chess.x, chess.y);
}
@end

打印结果：

下棋啦，车当前位置：x = 1, y = 1
下棋啦，车当前位置：x = 1, y = 8
下棋啦，车当前位置：x = 6, y = 8
------------------
悔棋啦，车当前位置：x = 1, y = 8
悔棋啦，车当前位置：x = 1, y = 1

三、总结

​ 备忘录模式在很多软件的使用过程中普遍存在，如果需要为软件提供撤销功能，备忘录模式无疑是一种很好的解决方案。

1、优点

1、它提供了一种状态恢复的实现机制，使得用户可以方便地回到一个特定的历史步骤，当新的状态无效或者存在问题时，可以使用暂时存储起来的备忘录将状态复原。

2、备忘录实现了对信息的封装，一个备忘录对象是一种原发器对象状态的表示，不会被其他代码所改动。备忘录保存了原发器的状态，采用列表、堆栈等集合来存储备忘录对象可以实现多次撤销操作。

2、缺点

​ 如果需要保存的原发器类的成员变量太多，就不可避免需要占用大量的存储空间，每保存一次对象的状态都需要消耗一定的系统资源。

3、适用场景

1、保存一个对象在某一个时刻的全部状态或部分状态，这样以后需要时它能够恢复到先前的状态，实现撤销操作。

2、防止外界对象破坏一个对象历史状态的封装性，避免将对象历史状态的实现细节暴露给外界对象。

4、iOS应用举例

​ Cocoa Touch框架在归档解档、属性列表序列化和CoreData中采用了备忘录模式。

Demo地址：iOS-Design-Patterns