Mẫu thiết kế: Mẫu Memento

Thứ Sáu, 13/03/2020

Tram Ho

I. Giới thiệu:

Memento là một Design Pattern thuộc loại Behavior. Nó cho phép chúng ta lưu trữ và khôi phục trạng thái của một đối tượng mà không tiết lộ chi tiết bên trong của nó.
Memento Pattern gồm các thành phần chính như sau:

Originator: là Object có trạng thái được lưu trữ hoặc khôi phục.
Mementor: là trạng thái (State) của Object khi đang được lưu trữ.
CareTaker: đóng vai trò lưu trữ và cấp phát các Memento. Nó có trách nghiệm lưu trữ các State ở dạng Memento và cấp phát các State cho các Object khi cần.

II. Cách thức hoạt động:

Memento Pattern sẽ cấu trúc các dữ liệu cần lưu của một Object thành một State, sau đó sẽ lưu lại State này. Các State sau khi được lưu lại sẽ được gọi là các Memento. CareTaker sẽ đóng vai trò lưu trữ các State thành Memento và xuất các Memento thành State để có thể sử dụng. Do trạng thái của các Object đều được lưu trữ trong State nên khi State này được truyền qua các Object khác nhau thì sẽ không để lộ các implement chi tiết của các Object đó.

III. Memento Pattern được sử dụng khi nào?

Memento Pattern được sử dụng bất cứ khi nào chúng ta muốn lưu và sau đó khôi phục trạng thái của một Object. Ví dụ như khi chúng ta chơi game, chúng ta muốn lưu lại tất cả những trạng thái chúng ta đã chơi trước đó để sau khi quit game và mở lại thì chúng ta có thể tiếp tục chơi, khi đó ta có thể áp dụng Memento Pattern để giải quyết bài toán này.

IV. Ví dụ:

Trong ví dụ, chúng ta sẽ sử dụng class Game với vai trò của Originator. Bên trong class Game sẽ chứa một State để lưu lại các trạng thái của nó. Trạng thái của Game sẽ được lưu vào trong UserDefault, vì vậy chúng ta cần adopt Codable protocol.

<span class="token comment">// MARK: - Originator</span>
<span class="token keyword">public</span> <span class="token keyword">class</span> <span class="token class-name">Game</span><span class="token punctuation">:</span> <span class="token builtin">Codable</span> <span class="token punctuation">{</span>
  
  <span class="token keyword">public</span> <span class="token keyword">class</span> <span class="token class-name">State</span><span class="token punctuation">:</span> <span class="token builtin">Codable</span> <span class="token punctuation">{</span>
    <span class="token keyword">public</span> <span class="token keyword">var</span> attemptsRemaining<span class="token punctuation">:</span> <span class="token builtin">Int</span> <span class="token operator">=</span> <span class="token number">3</span>
    <span class="token keyword">public</span> <span class="token keyword">var</span> level<span class="token punctuation">:</span> <span class="token builtin">Int</span> <span class="token operator">=</span> <span class="token number">1</span>
    <span class="token keyword">public</span> <span class="token keyword">var</span> score<span class="token punctuation">:</span> <span class="token builtin">Int</span> <span class="token operator">=</span> <span class="token number">0</span>
  <span class="token punctuation">}</span>
  <span class="token keyword">public</span> <span class="token keyword">var</span> state <span class="token operator">=</span> <span class="token function">State</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
  
  <span class="token keyword">public</span> <span class="token keyword">func</span> <span class="token function">rackUpMassivePoints</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
    state<span class="token punctuation">.</span>score <span class="token operator">+</span><span class="token operator">=</span> <span class="token number">9002</span>
  <span class="token punctuation">}</span>
  
  <span class="token keyword">public</span> <span class="token keyword">func</span> <span class="token function">monstersEatPlayer</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
    state<span class="token punctuation">.</span>attemptsRemaining <span class="token operator">-</span><span class="token operator">=</span> <span class="token number">1</span>
  <span class="token punctuation">}</span>
<span class="token punctuation">}</span>

// MARK: - Originator

public class Game: Codable {

public class State: Codable {

public var attemptsRemaining: Int = 3

public var level: Int = 1

public var score: Int = 0

}

public var state = State()

public func rackUpMassivePoints() {

state.score += 9002

}

public func monstersEatPlayer() {

state.attemptsRemaining -= 1

}

Object Game sẽ được lưu vào UserDefault ở dạng Data. Do vậy, Data trong Swift ở ví dụ này sẽ đóng vai trò là Memento.

<span class="token comment">// MARK: - Memento</span>
<span class="token keyword">typealias</span> <span class="token builtin">GameMemento</span> <span class="token operator">=</span> <span class="token builtin">Data</span>

// MARK: - Memento

typealias GameMemento = Data

Để quản lý việc lưu trữ các Memento, chúng ta sẽ cần tới CareTaker. GameSystem đóng vai trò là CareTaker. Class này sẽ có trách nghiệm lưu trữ hoặc lấy các Memento khi cần thiết.

<span class="token comment">// MARK: - CareTaker</span>
<span class="token keyword">public</span> <span class="token keyword">class</span> <span class="token class-name">GameSystem</span> <span class="token punctuation">{</span>
  
  <span class="token keyword">private</span> <span class="token keyword">let</span> decoder <span class="token operator">=</span> <span class="token function">JSONDecoder</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
  <span class="token keyword">private</span> <span class="token keyword">let</span> encoder <span class="token operator">=</span> <span class="token function">JSONEncoder</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
  <span class="token keyword">private</span> <span class="token keyword">let</span> userDefaults <span class="token operator">=</span> <span class="token builtin">UserDefaults</span><span class="token punctuation">.</span>standard
  
  <span class="token keyword">public</span> <span class="token keyword">func</span> <span class="token function">save</span><span class="token punctuation">(</span><span class="token number">_</span> game<span class="token punctuation">:</span> <span class="token builtin">Game</span><span class="token punctuation">,</span> title<span class="token punctuation">:</span> <span class="token builtin">String</span><span class="token punctuation">)</span> <span class="token keyword">throws</span> <span class="token punctuation">{</span>
    <span class="token keyword">let</span> data <span class="token operator">=</span> <span class="token keyword">try</span> encoder<span class="token punctuation">.</span><span class="token function">encode</span><span class="token punctuation">(</span>game<span class="token punctuation">)</span>
    userDefaults<span class="token punctuation">.</span><span class="token keyword">set</span><span class="token punctuation">(</span>data<span class="token punctuation">,</span> forKey<span class="token punctuation">:</span> title<span class="token punctuation">)</span>
  <span class="token punctuation">}</span>
  
  <span class="token keyword">public</span> <span class="token keyword">func</span> <span class="token function">load</span><span class="token punctuation">(</span>title<span class="token punctuation">:</span> <span class="token builtin">String</span><span class="token punctuation">)</span> <span class="token keyword">throws</span> <span class="token operator">-</span><span class="token operator">&gt;</span> <span class="token builtin">Game</span> <span class="token punctuation">{</span>
    <span class="token keyword">guard</span> <span class="token keyword">let</span> data <span class="token operator">=</span> userDefaults<span class="token punctuation">.</span><span class="token function">data</span><span class="token punctuation">(</span>forKey<span class="token punctuation">:</span> title<span class="token punctuation">)</span><span class="token punctuation">,</span>
      <span class="token keyword">let</span> game <span class="token operator">=</span> <span class="token keyword">try</span><span class="token operator">?</span> decoder<span class="token punctuation">.</span><span class="token function">decode</span><span class="token punctuation">(</span><span class="token builtin">Game</span><span class="token punctuation">.</span><span class="token keyword">self</span><span class="token punctuation">,</span> from<span class="token punctuation">:</span> data<span class="token punctuation">)</span>
      <span class="token keyword">else</span> <span class="token punctuation">{</span>
        <span class="token keyword">throw</span> <span class="token builtin">Error</span><span class="token punctuation">.</span>gameNotFound
    <span class="token punctuation">}</span>
    <span class="token keyword">return</span> game
  <span class="token punctuation">}</span>
  
  <span class="token keyword">public</span> <span class="token keyword">enum</span> <span class="token builtin">Error</span><span class="token punctuation">:</span> <span class="token builtin">String</span><span class="token punctuation">,</span> <span class="token builtin">Swift</span><span class="token punctuation">.</span><span class="token builtin">Error</span> <span class="token punctuation">{</span>
    <span class="token keyword">case</span> gameNotFound
  <span class="token punctuation">}</span>
<span class="token punctuation">}</span>

// MARK: - CareTaker

public class GameSystem {

private let decoder = JSONDecoder()

private let encoder = JSONEncoder()

private let userDefaults = UserDefaults.standard

public func save(_ game: Game, title: String) throws {

let data = try encoder.encode(game)

userDefaults.set(data, forKey: title)

}

public func load(title: String) throws -> Game {

guard let data = userDefaults.data(forKey: title),

let game = try? decoder.decode(Game.self, from: data)

else {

throw Error.gameNotFound

}

return game

}

public enum Error: String, Swift.Error {

case gameNotFound

}

Sử dụng:

<span class="token keyword">var</span> game <span class="token operator">=</span> <span class="token function">Game</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
game<span class="token punctuation">.</span><span class="token function">monstersEatPlayer</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
game<span class="token punctuation">.</span><span class="token function">rackUpMassivePoints</span><span class="token punctuation">(</span><span class="token punctuation">)</span>

<span class="token comment">// Save Game</span>
<span class="token keyword">let</span> gameSystem <span class="token operator">=</span> <span class="token function">GameSystem</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
<span class="token keyword">try</span> gameSystem<span class="token punctuation">.</span><span class="token function">save</span><span class="token punctuation">(</span>game<span class="token punctuation">,</span> title<span class="token punctuation">:</span> <span class="token string">"Best Game Ever"</span><span class="token punctuation">)</span>

<span class="token comment">// New Game</span>
game <span class="token operator">=</span> <span class="token function">Game</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
<span class="token function">print</span><span class="token punctuation">(</span><span class="token string">"New Game Score: <span class="token interpolation"><span class="token delimiter variable">(</span>game<span class="token punctuation">.</span>state<span class="token punctuation">.</span>score<span class="token delimiter variable">)</span></span>"</span><span class="token punctuation">)</span>

<span class="token comment">// Load Game</span>
game <span class="token operator">=</span> <span class="token keyword">try</span><span class="token operator">?</span> gameSystem<span class="token punctuation">.</span><span class="token function">load</span><span class="token punctuation">(</span>title<span class="token punctuation">:</span> <span class="token string">"Best Game Ever"</span><span class="token punctuation">)</span>
<span class="token function">print</span><span class="token punctuation">(</span><span class="token string">"Loaded Game Score: <span class="token interpolation"><span class="token delimiter variable">(</span>game<span class="token operator">?</span><span class="token punctuation">.</span>state<span class="token punctuation">.</span>score<span class="token delimiter variable">)</span></span>"</span><span class="token punctuation">)</span>

var game = Game()

game.monstersEatPlayer()

game.rackUpMassivePoints()

// Save Game

let gameSystem = GameSystem()

try gameSystem.save(game, title: "Best Game Ever")

// New Game

game = Game()

print("New Game Score: (game.state.score)")

// Load Game

game = try? gameSystem.load(title: "Best Game Ever")

print("Loaded Game Score: (game?.state.score)")

V. Tài liệu tham khảo:

Design Pattern by Tutorials – Raywenderlich
State Pattern by refactoring.guru

Chia sẻ bài viết ngay

Nguồn bài viết : Viblo

Mẫu thiết kế: Mẫu Memento

I. Giới thiệu:

II. Cách thức hoạt động:

III. Memento Pattern được sử dụng khi nào?

IV. Ví dụ:

V. Tài liệu tham khảo:

TikTok trở thành nền tảng mảng xã hội lớn thứ hai ở Nam Phi

Mất giá nhanh nhất sau 9 tháng ra mắt, iPhone 14 Pro Max tiếp tục phá đáy tại Việt Nam

Hướng dẫn sử dụng ngôn ngữ R cho người mới bắt đầu

10 plugin cần thiết của SublimeText dành cho các lập trình viên JavaScript