[Design Pattern] Singleton Pattern - 싱글톤 패턴 & Metaclass

Singleton Pattern

Singleton 패턴은 클래스의 인스턴스가 하나만 생성되도록 보장하고, 그 인스턴스에 접근할 수 있는 전역 접근점을 제공하는 패턴입니다.

• 그리고 특정 클래스의 인스턴스가 애플리케이션 전체에서 하나만 존재해야 할 때 사용됩니다.
• 또한 특징들을 아래에 적어보자면.
  • 클래스에 대한 단일 객체를 생성합니다.
  • 전역 객체를 제공합니다.
  • 공유된 리소스에 대한 동시 접근 제어가 가능합니다.
  • 글로벌 엑세스 지점을 제공하는, 단점이 거이 없는 검증된 패턴입니다.

• 위의 다이어그램을 예시로 보면, 생성자를 private로 선언하고, 객체를 초기화 하는 static 함수를 만들어 구현할 수 있습니다.
• 첫 호출에 객체가 생성되고, 그후 클래스는 동일한 객체를 계속 반환합니다.

class Singleton(object):
    def __new__(cls):

        if not hasattr(cls, 'instance'):
            print('create')
            cls.instance = super(Singleton, cls).__new__(cls)
        else:
            print('recycle')
        return cls.instance

s1 = Singleton()
print(s1)

s2 = Singleton()
print(s1)

print(s1 is s2)

실행결과 입니다.

• 위의 코드를 보면 한 개의 Singleton 클래스 인스턴스를 생성합니다.
• 이미 생성된 인스턴스가 있다면 재사용 합니다.

 

핵심 개념

1. 고유한 인스턴스 보장: Singleton 클래스는 인스턴스가 하나만 생성되도록 합니다.
2. 전역 접근점 제공: Singleton 클래스는 애플리케이션 전체에서 인스턴스에 접근할 수 있는 방법을 제공합니다.
3. 게으른 초기화: 인스턴스가 실제로 필요할 때까지 인스턴스를 생성하지 않는 방식을 사용합니다.

 

장점

• 고유 인스턴스 보장: 특정 클래스의 인스턴스가 하나만 존재함을 보장할 수 있습니다.
• 전역 상태 공유: 애플리케이션 전역에서 접근 가능한 인스턴스를 통해 상태를 공유할 수 있습니다.
• 인스턴스 관리 용이: 인스턴스의 생성과 접근을 중앙에서 관리할 수 있습니다.

 

단점

• 글로벌 상태 사용: 전역 인스턴스를 사용하므로, 상태를 공유하는 방식이 바람직하지 않은 경우 문제가 될 수 있습니다.
• 테스트 어려움: 싱글톤 인스턴스는 전역 상태를 가지므로, 유닛 테스트에서 다른 테스트 간의 상태 공유로 인해 테스트가 어려울 수 있습니다.
• 멀티스레드 환경 문제: 멀티스레드 환경에서 동기화 문제로 인해 인스턴스가 여러 개 생성될 수 있습니다.

---

Singleton & Metaclass

Metaclass를 간단히 설명하자면, 클래스를 만드는 클래스라고 할 수 있습니다.

• type은 객체의 클래스 종류를 알아낼 때도 사용되지만, 클래스를 만들어 낼 수도 있습니다.
• type을 상속받게 되면, 메타클래스가 되며, 주로 클래스의 동작을 제어할 때 사용됩니다.
• 메타 클래스는 call 함수를 통하여 객체 생성에 관한 제어를 할 수 있습니다.

# example
class 메타클래스이름(type):
	def _new_(metacls, name, bases, namespace):
		code

 

 

MetaClass의 동작

class MyInt(type):

    def _call_(cls, *args, **kwds):
        print("myint", args)
        print("Now do whatever you want with these objects...")
        return type.__call__(cls, *args, **kwds)
    
class int(metaclass=MyInt):
    def _init_(self, x, y):
        self.x = x
        self.y = y

i = int(4, 5)

위 코드의 실행결과 입니다.

• call Method는 이미 존재하는 클래스의 객체를 생성할 때 호출되는 파이썬의 특수 Method 입니다.
• int 클래스를 생성하면 MyInt 메타클래스의 call Method가 호출됩니다.
• 객체 생성을 메타클래스가 제어한다는 의미입니다.

메타클래스가 클래스와 객체 생성을 제어 한다면 싱글톤을 생성하는 용도로 사용할 수 있다는 의미가 됩니다.

 

class MetaSingleton(type):
    _instances = {}

    def __call__(cls, *args, **kwds):
        if cls not in cls._instances:
            cls._instances[cls] = super(MetaSingleton, cls).__call__(*args, **kwargs)
        
        return cls._instances[cls]

class Box(metaclass=MetaSingleton):
    pass

b1 = Box()
b2 = Box()

print(b1 == b2)

• 메타클래스의 call 함수 내부에 인스턴스 생성여부를 확인하는 로직이 있으며, 메타클래스에 의해 Singleton으로 지정된 Box 클래스의 인스턴스를 생성될 때 Metaclass의 call 함수가 호출되면서 Box의 생성을 제어합니다.
• 이때, Singleton 성질을 가지게 됩니다.

---

Singleton Pattern 활용 사례

DB를 활용하는 클라우드 서비스를 생각해보겠습니다.

• 클라우드 서비스 내 DB에 접근하는 여러개의 모듈이 있을 수 있습니다.
• 여러 개의 서비스가 한 개의 DB를 공유하고 있는 구조를 떠올리면 됩니다.

import sqlite3

class MetaSingleton(type):
    _instances = {}

    def __call__(cls, *args, **kwds):
        if cls not in cls._instances:
            cls._instances[cls] = super(MetaSingleton, cls).__call__(*args, **kwargs)
        
        return cls._instances[cls]

class Database(metaclass=MetaSingleton):
    connection = None
    def connest(self):
        if self.connection is None:
            self.connection = sqlite3.connect('db.sqlite3')
            self.cursorobj = self.connection.cursor()
        return self.cursorobj

db1 = Database().connect()
db2 = Database().connect()

print(db1, db2)

---

Monostate Singleton Pattern

Monostate Sington Pattern은 모든 객체가 같은 상태가 공유하는 패턴 입니다.

• Singleton Pattern의 정의는 반드시 한개의 클래스 객체만 존재해야함
• 하지만, Alex Martelli는 상태를 공유하는 인스턴스가 필요하다고 주장 했습니다.
  • 객체의 생성여부보다, 객체의 상태와 행위가 더 중요하다고 생각했기 때문입니다.

class MonoState:
    __shared_state = {}

    def __init__(self):
        self.__dict__ = self.__shared_state
        self.x = 1
        self.y = 2
        self.z = 3

        pass

ms1 = MonoState()
ms2 = MonoState()

print(ms1)
print(ms2)

ms2.x = 20
ms1.y = 20
ms2.z = 30

print(ms1.x, ms1.y, ms1.z)
print(ms2.x, ms2.y, ms2.z)
print(ms1.__dict__)
print(ms2.__dict__)

---

Python에서 모든 모듈들은 Singleton

Python의 import 방식 때문에 모든 모듈들을 기본적으로 singleton 입니다.

• 한번 파이썬의 작동방식을 살펴보면,
  • python module이 import 되었는지 확인합니다.
  • import되었다면 해당 객체를 반환하고 안되었다면 import를 instance화 합니다.
  • 모듈은 import와 동시에 초기화되지만, 같은 모듈을 다시 import하면 초기화되지 않습니다.
  • 그래서, 한 개의 객체만 유지하고 반환하는 Singleton 방식입니다.