Design Pattern ใน Python

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

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

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

บทนำ

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

คุณมีชุดคลาสที่คงที่ เช่น รูปทรงหรือสินค้า และเพิ่มการดำเนินการใหม่อยู่เรื่อยๆ: ราคารวม ภาษี export เป็น JSON การเพิ่มแต่ละการดำเนินการเป็นเมธอดในทุกคลาสทำให้ฟีเจอร์เดียวกระจายไปหลายไฟล์

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

แพตเทิร์น Visitor เหมือนเจ้าหน้าที่ภาษีที่ไปเยี่ยมร้านต่างๆ แต่ละร้านแค่ให้เจ้าหน้าที่เข้ามาและบอกว่าเป็นร้านประเภทไหน เจ้าหน้าที่ถือกฎของร้านทุกประเภทไว้ กฎใหม่จึงหมายถึงเจ้าหน้าที่คนใหม่ ไม่ใช่การเปลี่ยนทุกร้าน

จากเจ้าหน้าที่ภาษีสู่โค้ด
item.accept(visitor)🚪 ร้านให้เจ้าหน้าที่เข้ามา
visitor.visit_book(self)🏷️ บอกว่าเป็นร้านประเภทไหน
PriceVisitor🧾 เจ้าหน้าที่ที่ถือกฎ
15💰 ยอดรวมของหนังสือและภาพยนตร์
การดำเนินการอยู่ใน visitor ไม่ใช่ในคลาสของสมาชิก
สรุปในประโยคเดียว

แพตเทิร์น Visitor ย้ายการดำเนินการออกจากกลุ่มคลาสของสมาชิกไปไว้ในอ็อบเจกต์ visitor แยก สมาชิกแต่ละตัวเรียกเมธอดของ visitor ที่ตรงกับชนิดของตัวเอง

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

  1. Book.accept เรียก visitor.visit_book(self) ส่วน Movie.accept เรียก visitor.visit_movie(self)
  2. PriceVisitor ถือกฎการตั้งราคาสำหรับทั้งสองชนิด
  3. sum(item.accept(visitor) for item in [Book(), Movie()]) บวก 10 และ 5
  4. การดำเนินการใหม่ เช่น ภาษี จะเป็นคลาส visitor ใหม่โดยไม่ต้องเปลี่ยน Book หรือ Movie

ใช้เมื่อไร?

  • การดำเนินการจำนวนมากบนชุดชนิดที่คงที่: การตั้งราคา การ export การวาด
  • ไล่โครงสร้างอย่าง syntax tree ในคอมไพเลอร์
  • เก็บโค้ดของฟีเจอร์หนึ่งไว้ในที่เดียว

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

  • มีการเพิ่มชนิดของสมาชิกใหม่บ่อย: visitor ทุกตัวต้องถูกอัปเดต
  • โค้ด Python ที่ dictionary ของฟังก์ชันต่อชนิดหรือ functools.singledispatch ง่ายกว่า

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

รันโค้ด →
main.py
class Book:
    # Visitor: move new operations outside stable element classes.
    def accept(self, visitor): return visitor.visit_book(self)


class Movie:
    def accept(self, visitor): return visitor.visit_movie(self)


class PriceVisitor:
    def visit_book(self, book): return 10
    def visit_movie(self, movie): return 5


# Each element dispatches to the matching visitor method.
visitor = PriceVisitor()
print(sum(item.accept(visitor) for item in [Book(), Movie()]))
สร้างปุ่ม Run สำหรับตัวอย่างนี้

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

15

อธิบายโค้ด

แต่ละองค์ประกอบมีเมธอด accept() ที่เรียกเมธอดที่ตรงกันของผู้เยี่ยม Book เรียก visit_book() และ Movie เรียก visit_movie() PriceVisitor เก็บตรรกะราคาไว้ทั้งหมด คลาส Book และ Movie จึงไม่ต้องรู้เรื่องราคาเลย ผลรวมคือ 10 + 5 = 15

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

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

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

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

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

เรียกเมธอดของ visitor ผิดตัว

สมาชิกต้องเรียกเมธอดสำหรับชนิดของตัวเอง ไม่อย่างนั้นจะได้กฎที่ผิด

ปัญหา
class Movie:
    def accept(self, visitor): return visitor.visit_book(self)
วิธีแก้
class Movie:
    def accept(self, visitor): return visitor.visit_movie(self)

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

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