[Design Pattern] Prototype Pattern - 프로토타입 패턴

Prototype Pattern

객체를 생성할 때 미리 정의된 다른 객체를 복제(clone)하여 새로운 객체를 생성하는 방법입니다

• 아래의 경우 클래스로부터 인스턴스를 만드는 것이 아니라 인스턴스를 복사해서 새로운 인스턴스를 만드는것이 좋습니다.
  • 종류가 너무 많아서 클래스로 정리되지 않는 경우
  • 클래스로부터 인스턴스 생성이 어려운 경우
  • framework 와 생성하는 인스턴스를 분리하고 싶은 경우

---

장점

• 객체 생성 비용 절감: 복제(clone) 메서드를 사용하여 객체를 생성하므로, 객체를 처음부터 생성하는 것보다 비용이 적게 듭니다.
• 객체 초기화의 단순화: 객체를 생성하고 초기화하는 과정이 복잡할 경우, 미리 초기화된 객체를 복제하여 사용할 수 있습니다.
• 동적인 객체 생성: 런타임에 객체를 생성하고 수정할 수 있습니다.

 

단점

• 깊은 복사와 얕은 복사: 객체를 복제할 때, 깊은 복사와 얕은 복사의 개념을 명확히 이해하고 사용해야 합니다. 잘못된 복제 방식은 예상치 못한 동작을 초래할 수 있습니다.
• 복제의 복잡성: 객체 내부에 참조형 필드가 많을 경우, 복제 메서드의 구현이 복잡해질 수 있습니다.

---

Example

• 내부 property로 눈, 코, 몸, 꼬리 색깔, 이름을 지정할 수 있는 고양이 Class

class Cat:
    def __init__(self):
        self.color = None
        self.eye_color = None
        self.nose_color = None
        self.tail_color = None
        self.name = None

• 눈, 코, 몸, 꼬리 색깔 모두 white이며 이름은 kitty인 고양이

kitty = Cat()
kitty.color = "white"
kitty.eye_color = "white"
kitty.nose_color = "white"
kitty.tail_color = "white"
kitty.name = "Kitty"

 

• 눈, 코, 몸, 꼬리 색깔 모두 white이며 이름은 nabi인 고양이

nabi = Cat()
nabi.color = "white"
nabi.eye_color = "white"
nabi.nose_color = "white"
nabi.tail_color = "white"
nabi.name = "Nabi"

 

• 여기서 우리가 주의깊게 봐야할 점이 있습니다.
• 눈, 코, 몸, 꼬리 색깔 모두 동일하며 이름만 다른 고양이를 만들기 위해 모든 property를 하나씩 따로 지정하는 것은 비효율적 입니다
• 고양이를 복제해서 만들어낼 수 있는 방법이 있다면 더 쉽게 두 번째 고양이 nabi를 만들 수 있을것 입니다.
• 한번 만들어 보겠습니다.

import copy

class Cat:
    def __init__(self):
        self.color = None
        self.eye_color = None
        self.nose_color = None
        self.tail_color = None
        self.name = None
    
    def clone(self):
        return copy.deepcopy(self)

kitty = Cat()
kitty.color = "white"
kitty.eye_color = "white"
kitty.nose_color = "white"
kitty.tail_color = "white"
kitty.name = "Kitty"

nabi = kitty.clone()
nabi.name = "Nabi"

• 정의한 Cat class 안에 동일한 고양이를 생성해주는 Clone 기능을 통해 두 번째 고양이 property를 하나씩 지정할 필요없이 clone한 다음 nabi이름만 지정하면 됩니다.
• kitty → clone을 통해 nabi 를 복제 합니다.
• 근데, nabi = kitty 식으로 복사만 할 경우는?

• Reference 기반 언어는 Object가 Reference로 동작하기 때문에 이와 같이 복사만 할 경우, 하나의 Object를 가리키는 Reference가 2개 생길 뿐입니다.
• 따라서 deepcopy를 통해 고양이 전체를 복사해 줘야 합니다.

Prototype design pattern의 의도는 object가 copy되기 전까지 상태를 prototype으로 가지고 있으라는 것입니다.

import copy

class Cat:
    def __init__(self):
        self.color = None
        self.eye_color = None
        self.nose_color = None
        self.tail_color = None
        self.name = None
    
    def clone(self):
        return copy.deepcopy(self)

class BlackCat(Cat):
    def __init__(self):
        super().__init__()
        self.color = 'black'

class WhiteCat(Cat):
    def __init__(self):
        super().__init__()
        self.color = 'white'

• 여기서 Cat class는 Base class입니다.
• BlackCat, WhiteCat class는 Cat class를 상속 받아서 고양이 몸 색깔만 각각 black, white로 초기화 합니다.

black_cat = BlackCat()

• black_cat은 몸 색깔만 지정되어 있는 상태입니다.
• 그 다음 코, 꼬리 색을 지정합니다.

이렇게 만들어진 object를 prototype으로 사용해서 kitty & nabi를 만듭니다.

kitty = black_cat.clone()
kitty.eye_color = "white"
kitty.name = 'kitty'

nabi = black_cat.clone()
nabi.eye_color = "blue"
nabi.name = 'nabi'

• 즉, kitty는 black_cat을 clone후, 눈 색깔, 이름을 지정해서 미완성된 prototpye object를 사용해서 원하는 kitty object를 쉽게 만들어냅니다. (nabi 또한 동일)

중간 단계의 object를 prototype으로 만들고 이를 deepcopy해서 object를 만들어가는 디자인 패턴입니다.

---

Prototype의 핵심 개념 

• Prototype(원형)의 역할
  • Prototype은 인스턴스를 복사하여 새로운 인스턴스를 만들기 위한 메소드를 결정합니다.
• ConcretePrototpye (구체적인 원형)의 역할
  • ConcretePrototpye은 인스턴스를 복사해서 새로운 인스턴스를 만드는 메소드를 길제로 구현합니다.
• Client(이용자)의 역할
  • Client는 인스턴스를 복사하는 메소드를 이용해서 새로운 인스턴스를 만듭니다.

 

 

Example

# prototype

from abc import *
class Product(metaclass=ABCMeta):
    @abstractmethod
    def use(self):
        pass
    @abstractmethod
    def clone(self):
        pass

# Concrete

class UnderlinePen(Product):

    def use(self, s:str)
        n = len(s)
        print(s)
        for i in range(n):
            print("~", end="")
        print()
    
    def clone(self):
        return copy.deepcopy(self)

# Concrete

class MessageBox(Product):

    def _init_(self, deco:str):
        self.deco = deco
    
    def use(self, s:str):
        n = len(s) + 4

        for i in range(n):
            print(self.deco, end="")
        print()
        print(self.deco, s, self.deco)
        for i in range(n):
            print(self.deco, end="")
        print()
    
    def clone(self):
        return copy.deepcopy(self)

# Manager

class Manager:
    def _init_(self):
        self.showcase = {"a":1}
    
    def register(self, name:str, proto:Product):
        self.showcase[name] = proto
    
    def create(self, protoname:str):
        p = self.showcase[protoname]
        return p.clone()

# Client

manager = Manager()
m1 = MessageBox("*")
m2 = MessageBox("#")
p1 = UnderlinePen()

manager.register("msg", m1)
manager.register("msg#", m2)
manager.register("pen", p1)
msg1 = manager.create("msg")
msg2 = manager.create("msg#")
pen = manager.create("pen")

word = "hello"
msg1.use(word)
word = "world"
msg2.use(word)
pen.use(word)