Python中的单例模式

2020 年 1 月 5 日
笔记

单例模式

单例模式（Singleton Pattern）是一种常用的软件设计模式，该模式的主要目的是确保某一个类只有一个实例存在。当你希望在整个系统中，某个类只能出现一个实例时，单例对象就能派上用场。

比如，某个服务器程序的配置信息存放在一个文件中，客户端通过一个 AppConfig 的类来读取配置文件的信息。如果在程序运行期间，有很多地方都需要使用配置文件的内容，也就是说，很多地方都需要创建 AppConfig 对象的实例，这就导致系统中存在多个 AppConfig 的实例对象，而这样会严重浪费内存资源，尤其是在配置文件内容很多的情况下。事实上，类似 AppConfig 这样的类，我们希望在程序运行期间只存在一个实例对象。

在 Python 中，我们可以用多种方法来实现单例模式：

使用模块
使用 new
使用装饰器（decorator）
使用元类（metaclass）

使用模块

其实，Python 的模块就是天然的单例模式，因为模块在第一次导入时，会生成 .pyc 文件，当第二次导入时，就会直接加载 .pyc 文件，而不会再次执行模块代码。因此，我们只需把相关的函数和数据定义在一个模块中，就可以获得一个单例对象了。如果我们真的想要一个单例类，可以考虑这样做：

#!/usr/bin/env python  # _*_ coding:utf-8 _*_  __author__ = 'junxi'      class MySingleton(object):      def foo(self):          pass    my_singleton = MySingleton()

将上面的代码保存在文件 mysingleton.py 中，然后这样使用：

from mysingleton import my_singleton  my_singleton.foo()

使用 new

为了使类只能出现一个实例，我们可以使用 new 来控制实例的创建过程，代码如下：

class Singleton(object):      _instance = None        def __new__(cls, *args, **kwargs):          if not cls._instance:              cls._instance = super(Singleton, cls).__new__(cls, *args, **kwargs)          return cls._instance      class MyClass(Singleton):      a = 1    one = MyClass()  two = MyClass()  print 'one == two: ', (one == two)  print 'id(one): ', id(one)  print 'id(two): ', id(two)

执行结果：

one == two:  True  id(one):  50662032  id(two):  50662032

使用装饰器

我们知道，装饰器（decorator）可以动态地修改一个类或函数的功能。这里，我们也可以使用装饰器来装饰某个类，使其只能生成一个实例，代码如下：

from functools import wraps      def singleton(cls):      instances = {}      @wraps(cls)      def getinstance(*args, **kwargs):          if cls not in instances:              instances[cls] = cls(*args, **kwargs)          return instances[cls]      return getinstance      @singleton  class MyClass(object):      a = 1

在上面，我们定义了一个装饰器 singleton，它返回了一个内部函数 getinstance，该函数会判断某个类是否在字典 instances 中，如果不存在，则会将 cls 作为 key，cls(args, *kw) 作为 value 存到 instances 中，否则，直接返回 instances[cls]。

使用 metaclass

元类（metaclass）可以控制类的创建过程，它主要做三件事：

拦截类的创建修改类的定义返回修改后的类使用元类实现单例模式的代码如下：

class Singleton(type):      _instances = {}      def __call__(cls, *args, **kwargs):          if cls not in cls._instances:              cls._instances[cls] = super(Singleton, cls).__call__(*args, **kwargs)          return cls._instances[cls]    # python2  class MyClass(object):      __metaclass__ = Singleton      a = 1      # python3  # class MyClass(metaclass=Singleton)  #    pass    a = MyClass()  b = MyClass()  print a.a  print 'a is b ? ', (a is b)

执行结果：

1  a is b ?  True