Design Pattern ใน Python

ดีไซน์แพตเทิร์น Memento ใน Python

ในบทเรียนนี้ คุณจะใช้แพตเทิร์น Memento บันทึกและกู้คืนสถานะของออบเจกต์ เหมือนฟังก์ชันย้อนกลับ (undo)

  • ระดับสูง
  • อ่าน 3 นาที
  • ตัวอย่างที่รันได้ 1 ตัวอย่าง

บทนำ

ปัญหาที่ต้องแก้

การ undo จุดเซฟในเกม และปุ่มรีเซ็ตเป็นค่าเริ่มต้น ล้วนต้องบันทึกสถานะของอ็อบเจกต์ไว้แล้วนำกลับมาทีหลัง โดยไม่ให้โค้ดอื่นเข้าไปยุ่งกับข้อมูลภายในของอ็อบเจกต์

ลองนึกภาพแบบนี้

แพตเทิร์น Memento เหมือนการเซฟเกม เกมจะสร้างไฟล์เซฟที่เก็บสถานะของเกมไว้ เราเก็บไฟล์นั้นไว้ได้โดยไม่ต้องรู้ว่าข้างในมีอะไร พอโหลดเซฟทีหลัง เกมก็กลับไปอยู่ตรงจุดเดิมพอดี

จากการเซฟเกมสู่โค้ด
editor.save()💾 สร้างไฟล์เซฟ
Snapshot(text)🔒 เซฟที่ปิดผนึกและแก้ไขไม่ได้
editor.text = "changed"🎮 เล่นต่อและเปลี่ยนสิ่งต่าง ๆ
editor.restore(saved)⏪ โหลดเซฟ: กลับไปเป็น draft
บันทึก snapshot (ภาพสถานะ ณ ตอนนั้น) แก้ไขต่อ แล้วกู้สถานะคืนจาก snapshot
สรุปในประโยคเดียว

แพตเทิร์น Memento เก็บสถานะของอ็อบเจกต์ไว้ในอ็อบเจกต์ snapshot ซึ่งใช้กู้สถานะคืนได้ทีหลัง โดยโค้ดที่เก็บ snapshot ไม่ต้องเห็นรายละเอียดภายในของอ็อบเจกต์

ประเด็นสำคัญ

  1. Snapshot เป็น dataclass แบบ frozen เมื่อบันทึกแล้วจึงแก้ไขภายหลังไม่ได้
  2. save() สร้าง Snapshot ที่มีข้อความปัจจุบัน
  3. จากนั้นข้อความถูกเปลี่ยนเป็น "changed"
  4. restore(saved) นำข้อความที่บันทึกไว้กลับมา จึงพิมพ์ "draft"

ใช้เมื่อไร?

  • undo และ redo ในเอดิเตอร์และเครื่องมือวาดรูป
  • จุดเซฟและการบันทึกเกม
  • ย้อนสถานะกลับเมื่อการทำงานบางอย่างเกิดข้อผิดพลาด

เมื่อไรยังไม่จำเป็น

  • สถานะขนาดใหญ่มากที่บันทึกบ่อย: snapshot ใช้หน่วยความจำมาก ให้เก็บแค่การเปลี่ยนแปลงแทน
  • ค่าธรรมดา: แค่เก็บสำเนาของตัวแปรไว้ก็พอ

โค้ดตัวอย่าง

รันโค้ด →
main.py
from dataclasses import dataclass


@dataclass(frozen=True)
class Snapshot:
    # Memento: store a restorable snapshot without exposing internals.
    text: str


class Editor:
    def __init__(self): self.text = ""
    def save(self): return Snapshot(self.text)

    def restore(self, snapshot):
        # Restore state without exposing representation details.
        self.text = snapshot.text


editor = Editor()
editor.text = "draft"
saved = editor.save()
editor.text = "changed"
editor.restore(saved)
print(editor.text)
สร้างปุ่ม Run สำหรับตัวอย่างนี้

ผลลัพธ์จากการรัน

draft

อธิบายโค้ด

เมธอด save() ของ Editor สร้างภาพสถานะที่มีเนื้อหาปัจจุบันคือ draft หลังเนื้อหาเปลี่ยนเป็น changed เมธอด restore() จะดึงเนื้อหาจากภาพสถานะที่บันทึกไว้กลับมา ผลที่แสดงจึงเป็น draft

เปลี่ยนค่าและรันโปรแกรมด้วย คอมไพเลอร์ Python ออนไลน์ของ CodeUtility โดยไม่ต้องติดตั้ง Python

แบบฝึกหัดเพิ่มเติม

ลองแก้โค้ดตามคำแนะนำด้านล่าง การเปลี่ยนโค้ดแล้วดูผลลัพธ์จะช่วยให้เข้าใจบทเรียนได้ดีกว่าการอ่านอย่างเดียวมาก

  1. เปลี่ยนโดเมนของตัวอย่างโดยยังคงโครงสร้างของแพตเทิร์นไว้
  2. เปรียบเทียบแพตเทิร์นกับการเขียนแบบที่ง่ายกว่าและอธิบายข้อแลกเปลี่ยน
  3. เขียนการทดสอบให้ผู้มีส่วนร่วมแต่ละส่วนก่อนเพิ่มการเขียนแบบอื่น
รันในคอมไพเลอร์ Python →

ข้อผิดพลาดที่พบบ่อย

บันทึกแค่ reference ไปยังข้อมูลที่เปลี่ยนค่าได้

ถ้า snapshot ถือลิสต์ตัวเดียวกับที่เอดิเตอร์เปลี่ยนอยู่ สถานะที่บันทึกไว้ก็จะเปลี่ยนตาม

ปัญหา
def save(self):
    return Snapshot(self.lines)  # same list
วิธีแก้
def save(self):
    return Snapshot(list(self.lines))  # a copy

เรียนบทนี้จบแล้วใช่ไหม

ทำเครื่องหมายว่าเรียนแล้วเพื่อติดตามความคืบหน้า