Design Pattern ใน Python

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

ในบทเรียนนี้ คุณจะใช้แพตเทิร์น Template Method กำหนดขั้นตอนของกระบวนการให้ตายตัว แต่ให้คลาสย่อยปรับบางขั้นได้

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

บทนำ

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

หลายกระบวนการมีลำดับขั้นตอนเหมือนกัน แต่ต่างกันอยู่ขั้นเดียว เช่น data pipeline ทุกตัวต้องอ่าน ประมวลผล แล้วบันทึก แต่การประมวลผล CSV ต่างจาก JSON ถ้าคัดลอกทั้งกระบวนการไปทำแต่ละแบบ ลำดับขั้นตอนจะซ้ำกันหลายที่และผิดพลาดได้ง่าย

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

แพตเทิร์น Template Method เหมือนการ์ดสูตรอาหารที่มีบรรทัดว่างหนึ่งบรรทัด การ์ดกำหนดลำดับไว้ตายตัว: เตรียม ทำไส้ แล้วเสิร์ฟ คนครัวแต่ละคนแค่เติมไส้ของตัวเองลงในบรรทัดว่าง และไม่มีใครเปลี่ยนลำดับขั้นตอนได้

จากการ์ดสูตรอาหารสู่โค้ด
run()📇 การ์ดสูตรที่มีขั้นตอนตายตัว
"read", ..., "save"🔒 ขั้นตอนที่ไม่เคยเปลี่ยน
self.process()✏️ บรรทัดว่างที่คนครัวแต่ละคนเติม
CsvPipeline🧑‍🍳 ขั้นตอนนั้นในแบบของคนครัวคนหนึ่ง
คลาสฐานกำหนดลำดับ คลาสลูกเติมหนึ่งขั้นตอน
สรุปในประโยคเดียว

แพตเทิร์น Template Method กำหนดขั้นตอนของอัลกอริทึมไว้ในเมธอดของคลาสฐาน และให้คลาสลูก override (เขียนทับ) บางขั้นตอนได้ โดยลำดับโดยรวมไม่เปลี่ยน

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

  1. DataPipeline.run() กำหนดลำดับตายตัว: อ่าน ประมวลผล บันทึก
  2. process ถูกกำกับด้วย @abstractmethod ทุกคลาสลูกจึงต้องเขียนเมธอดนี้
  3. CsvPipeline override แค่ process
  4. CsvPipeline().run() คงลำดับตายตัวไว้และใช้ขั้นตอนของ CSV

ใช้เมื่อไร?

  • ขั้นตอนการทำงานที่มีลำดับตายตัวและมีไม่กี่ขั้นที่เปลี่ยน: pipeline การ export หรือการเล่นแต่ละตาในเกม
  • เฟรมเวิร์กที่เรียกโค้ดของเราตามจุดที่กำหนดไว้
  • ลดโค้ดควบคุมลำดับขั้นตอนที่ซ้ำกันในคลาสที่คล้ายกัน

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

  • มีแค่ขั้นตอนเดียวที่เปลี่ยนและง่าย: ส่งฟังก์ชันเข้าไป (Strategy) แทนการทำ subclass
  • แต่ละแบบเรียงลำดับขั้นตอนไม่เหมือนกัน

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

รันโค้ด →
main.py
from abc import ABC, abstractmethod


class DataPipeline(ABC):
    # Template Method: fix the workflow and customize selected steps.
    def run(self):
        # Keep the algorithm order stable.
        return ["read", self.process(), "save"]

    @abstractmethod
    def process(self): pass


class CsvPipeline(DataPipeline):
    def process(self): return "process CSV"


print(" -> ".join(CsvPipeline().run()))
สร้างปุ่ม Run สำหรับตัวอย่างนี้

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

read -> process CSV -> save

อธิบายโค้ด

เมธอด run() ของ DataPipeline กำหนดลำดับ read, process, save ไว้ ขั้น process() มี @abstractmethod กำกับ คลาสย่อยทุกตัวจึงต้องเขียนขั้นนี้ CsvPipeline ใส่การประมวลผลของตัวเอง process CSV และผลลัพธ์คือ read -> process CSV -> save

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

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

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

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

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

override run ในคลาสลูก

การเขียน run ใหม่ทำให้ลำดับขั้นตอนซ้ำซ้อน และอาจทำให้ลำดับผิดไป

ปัญหา
class CsvPipeline(DataPipeline):
    def run(self):
        return ["process CSV", "save"]  # read was forgotten
วิธีแก้
class CsvPipeline(DataPipeline):
    def process(self):
        return "process CSV"

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

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