本文摘取自TerryLee(李会军)老师的设计模式系列文章,版权归TerryLee,仅供个人学习参考。转载请标明原作者TerryLee。部分示例代码来自DoFactory。
概述
Singleton模式要求一个类有且仅有一个实例,并且提供了一个全局的访问点。这就提出了一个问题:如何绕过常规的构造器,提供一种机制来保证一个类只有一个实例?客户程序在调用某一个类时,它是不会考虑这个类是否只能有一个实例等问题的,所以,这应该是类设计者的责任,而不是类使用者的责任。
从另一个角度来说,Singleton模式其实也是一种职责型模式。因为我们创建了一个对象,这个对象扮演了独一无二的角色,在这个单独的对象实例中,它集中了它所属类的所有权力,同时它也肩负了行使这种权力的职责!
意图
保证一个类仅有一个实例,并提供一个访问它的全局访问点。
适用性
大部分应用程序中的对象只负责操作其内部包含的数据并且操作也是在一个有限的范围之内。然而,有一些对象会负责一些全局对象的控制,如管理有限的资源或监控系统的全局状态。这些对象往往需要仅有一个实例提供服务,如缓存对象或队列对象。这就是需要单例模式出马的地方。单例模式也适合需要对不同资源的访问权限进行集中控制的场景。另一种适用场景是为了提高性能,可以使用单例对象取代反复创建、销毁的无状态对象(提示:当一个场景中不适合使用单例模式时,也可以使用静态方法达到同样的目的,单例模式常被过度使用!)。
全局变量通常被认为是不好编程习惯,但适度使用也是有必要的。单例模式最适合与全局变量一起使用,且非常容易,这样正是其最常出现的地方。
-
当类只能有一个实例而且客户可以从一个众所周知的访问点访问它时。
-
当这个唯一实例应该是通过子类化可扩展的,并且客户应该无需更改代码就能使用一个扩展的实例时。
UML
图1.单例模式UML图
参与者
这个模式涉及的类或对象:
-
Singleton
-
定义一个实例化操作以让客户端访问其唯一实例。Instance是一个类上的操作。
-
负责创建并维护其唯一实例。
实现要点
-
Singleton模式是限制而不是改进类的创建。
-
Singleton类中的实例构造器可以设置为Protected以允许子类派生。
-
Singleton模式一般不要支持ICloneable接口,因为这可能导致多个对象实例,与Singleton模式的初衷违背。
-
Singleton模式一般不要支持序列化,这也有可能导致多个对象实例,这也与Singleton模式的初衷违背。
-
Singleton只考虑了对象创建的管理,没有考虑到销毁的管理,就支持垃圾回收的平台和对象的开销来讲,我们一般没必要对其销毁进行特殊的管理。
-
理解和扩展Singleton模式的核心是"如何控制用户使用new对一个类的构造器的任意调用"。
-
可以很简单的修改一个Singleton,使它有少数几个实例,这样做是允许的而且是有意义的。
优点
-
实例控制:Singleton会阻止其他对象实例化其自己的Singleton对象的副本,从而确保所有对象都访问唯一实例。
-
灵活性:因为类控制了实例化过程,所以类可以更加灵活修改实例化过程。
缺点
-
开销:虽然数量很少,但如果每次对象请求引用时都要检查是否存在类的实例,将仍然需要一些开销。可以通过使用静态初始化解决此问题,下文的五种实现方式中将有具体说明。
-
可能的开发混淆:使用singleton对象(尤其在类库中定义的对象)时,开发人员必须记住自己不能使用new关键字实例化对象。因为可能无法访问库源代码,因此应用程序开发人员可能会意外发现自己无法直接实例化此类。
-
对象的生存期:Singleton不能解决删除单个对象的问题。在提供内存管理的语言中(例如基于 .NET Framework 的语言),只有Singleton类能够导致实例被取消分配,因为它包含对该实例的私有引用。在某些语言中(如C++),其他类可以删除对象实例,但这样会导致Singleton类中出现悬浮引用。
五种实现
1.简单实现
public sealed class Singleton { static Singleton instance = null; Singleton() { } public static Singleton Instance { get { if (instance == null) { instance = new Singleton(); } return instance; } } }
这种方式的实现对于线程来说并不是安全的,因为在多线程的环境下有可能得到Singleton类的多个实例。如果同时有两个线程去判断(instance == null),并且得到的结果为真,这时两个线程都会创建类Singleton的实例,这样就违背了Singleton模式的原则。实际上在上述代码中,有可能在计算出表达式的值之前,对象实例已经被创建,但是内存模型并不能保证对象实例在第二个线程创建之前被发现。
该实现方式主要有两个优点:
-
由于实例是在 Instance 属性方法内部创建的,因此类可以使用附加功能(例如,对子类进行实例化),即使它可能引入不想要的依赖性。
-
直到对象要求产生一个实例才执行实例化;这种方法称为"惰性实例化"。惰性实例化避免了在应用程序启动时实例化不必要的singleton。
2.安全的线程
public sealed class Singleton { static Singleton instance = null; static readonly object padlock = new object(); Singleton() { } public static Singleton Instance { get { lock (padlock) { if (instance == null) { instance = new Singleton(); } return instance; } } } }
这种方式的实现对于线程来说是安全的。我们首先创建了一个进程辅助对象,线程在进入时先对辅助对象加锁然后再检测对象是否被创建,这样可以确保只有一个实例被创建,因为在同一个时刻加了锁的那部分程序只有一个线程可以进入。这种情况下,对象实例由最先进入的那个线程创建,后来的线程在进入时,instance == null为假,不会再去创建对象实例了。但是这种实现方式增加了额外的开销,损失了性能。
3.双重锁定
public sealed class Singleton { static Singleton instance = null; static readonly object padlock = new object(); Singleton() { } public static Singleton Instance { get { if (instance == null) { lock (padlock) { if (instance == null) { instance = new Singleton(); } } } return instance; } } }
这种实现方式对多线程来说是安全的,同时线程不是每次都加锁,只有判断对象实例没有被创建时它才加锁,有了我们上面第一部分的里面的分析,我们知道,加锁后还得再进行对象是否已被创建的判断。它解决了线程并发问题,同时避免在每个Instance属性方法的调用中都出现独占锁定。它还允许你将实例化延迟到第一次访问对象时发生。实际上,应用程序很少需要这种类型的实现。大多数情况下我们会用静态初始化。这种方式仍然有很多缺点:无法实现延迟初始化。
4.静态初始化
public sealed class Singleton { static readonly Singleton instance = new Singleton(); static Singleton() { } Singleton() { } public static Singleton Instance { get { return instance; } } }
看到上面这段富有戏剧性的代码,我们可能会产生怀疑,这还是Singleton模式吗?在此实现中,将在第一次引用类的任何成员时创建实例。公共语言运行时负责处理变量初始化。该类标记为sealed以阻止发生派生,而派生可能会增加实例。此外,变量标记为readonly,这意味着只能在静态初始化期间(此处显示的示例)或在类构造函数中分配变量。
该实现与前面的示例类似,不同之处在于它依赖公共语言运行库来初始化变量。它仍然可以用来解决Singleton模式试图解决的两个基本问题:全局访问和实例化控制。公共静态属性为访问实例提供了一个全局访问点。此外,由于构造函数是私有的,因此不能在类本身以外实例化Singleton类;因此,变量引用的是可以在系统中存在的唯一的实例。
由于Singleton实例被私有静态成员变量引用,因此在类首次被对Instance 属性的调用所引用之前,不会发生实例化。
这种方法唯一的潜在缺点是,您对实例化机制的控制权较少。在Design Patterns形式中,您能够在实例化之前使用非默认的构造函数或执行其他任务。由于在此解决方案中由.NET Framework负责执行初始化,因此你没有这些选项。在大多数情况下,静态初始化是在.NET中实现Singleton的首选方法。
5.延迟初始化
public sealed class Singleton { Singleton() { } public static Singleton Instance { get { return Nested.instance; } } class Nested { static Nested() { } internal static readonly Singleton instance = new Singleton(); } }
这里,初始化工作由Nested类的一个静态成员来完成,这样就实现了延迟初始化,并具有很多的优势,是值得推荐的一种实现方式。
示例代码
如下是一个简单的计数器例子,四个线程同时进行计数。
using System; using System.Threading; namespace SigletonPattern.SigletonCounter { /// <summary> /// 功能:简单计数器的单件模式 编写:Terrylee 日期:2005年12月06日 /// </summary> public class CountSigleton { ///存储唯一的实例 static CountSigleton uniCounter = new CountSigleton(); ///存储计数值 private int totNum = 0; private CountSigleton() { ///线程延迟2000毫秒 Thread.Sleep(2000); } static public CountSigleton Instance() { return uniCounter; } ///计数加1 public void Add() { totNum++; } ///获得当前计数值 public int GetCounter() { return totNum; } } /// <summary> /// 功能:创建一个多线程计数的类 /// 编写:Terrylee /// 日期:2005年12月06日 /// </summary> public class CountMutilThread { public CountMutilThread() { } /// <summary> /// 线程工作 /// </summary> public static void DoSomeWork() { ///构造显示字符串 string results = ""; ///创建一个Sigleton实例 CountSigleton MyCounter = CountSigleton.Instance(); ///循环调用四次 for (int i = 1; i < 5; i++) { ///开始计数 MyCounter.Add(); results += "线程"; results += Thread.CurrentThread.Name + "——〉"; results += "当前的计数:"; results += MyCounter.GetCounter().ToString(); results += " "; Console.WriteLine(results); ///清空显示字符串 results = ""; } } public void StartMain() { Thread thread0 = Thread.CurrentThread; thread0.Name = "Thread 0"; Thread thread1 = new Thread(new ThreadStart(DoSomeWork)); thread1.Name = "Thread 1"; Thread thread2 = new Thread(new ThreadStart(DoSomeWork)); thread2.Name = "Thread 2"; Thread thread3 = new Thread(new ThreadStart(DoSomeWork)); thread3.Name = "Thread 3"; thread1.Start(); thread2.Start(); thread3.Start(); ///线程0也只执行和其他线程相同的工作 DoSomeWork(); } } /// <summary> /// 功能:实现多线程计数器的客户端 /// 编写:Terrylee /// 日期:2005年12月06日 /// </summary> public class CountClient { public static void Main(string[] args) { CountMutilThread cmt = new CountMutilThread(); cmt.StartMain(); Console.ReadLine(); } } }
DoFactory GoF代码
// Singleton Desing Pattern // Structural example using System; namespace DoFactory.GangOfFour.Singleton.Structural { class MainApp { static void Main() { // Constructor is protected -- cannot use new Singleton s1 = Singleton.Instance(); Singleton s2 = Singleton.Instance(); // Test for same instance if (s1 == s2) { Console.WriteLine("Objects are the same instance"); } // Wait for user Console.ReadKey(); } } // "Singleton" class Singleton { private static Singleton _instance; // Constructor is 'protected' protected Singleton() { } public static Singleton Instance() { // Uses lazy initialization. // Note: this is not thread safe. if (_instance == null) { _instance = new Singleton(); } return _instance; } } }
这个例子中使用单例模式实现一个负载均衡对象。每个对服务器的请求都需要经过这个单例对象,因为只有其掌握Web farm中服务器的状态。
// Singleton Desing Pattern // RealWorld example using System; using System.Collections.Generic; namespace DoFactory.GangOfFour.Singleton.RealWorld { class MainApp { static void Main() { LoadBalancer b1 = LoadBalancer.GetLoadBalancer(); LoadBalancer b2 = LoadBalancer.GetLoadBalancer(); LoadBalancer b3 = LoadBalancer.GetLoadBalancer(); LoadBalancer b4 = LoadBalancer.GetLoadBalancer(); // Same instance? if (b1 == b2 && b2 == b3 && b3 == b4) { Console.WriteLine("Same instance "); } // Load balance 15 server requests LoadBalancer balancer = LoadBalancer.GetLoadBalancer(); for (int i = 0; i < 15; i++) { string server = balancer.Server; Console.WriteLine("Dispatch Request to: " + server); } // Wait for user Console.ReadKey(); } } // The 'Singleton' class class LoadBalancer { private static LoadBalancer _instance; private List<string> _servers = new List<string>(); private Random _random = new Random(); // Lock synchronization object private static object syncLock = new object(); // Constructor (protected) protected LoadBalancer() { // List of available servers _servers.Add("ServerI"); _servers.Add("ServerII"); _servers.Add("ServerIII"); _servers.Add("ServerIV"); _servers.Add("ServerV"); } public static LoadBalancer GetLoadBalancer() { // Support multithreaded applications through 'Double checked locking' pattern which (once // the instance exists) avoids locking each time the method is invoked if (_instance == null) { lock (syncLock) { if (_instance == null) { _instance = new LoadBalancer(); } } } return _instance; } // Simple, but effective random load balancer public string Server { get { int r = _random.Next(_servers.Count); return _servers[r]; } } } }
这个例子完成了与上述例子相同的任务。但使用了一些.NET的特性是代码更优雅。模式实现中使用了私有构造函数与静态只读变量。编译器保证静态变量的线程安全。
// Singleton Desing Pattern // .NET Optimized example using System; using System.Collections.Generic; namespace DoFactory.GangOfFour.Singleton.NETOptimized { class MainApp { static void Main() { var b1 = LoadBalancer.GetLoadBalancer(); var b2 = LoadBalancer.GetLoadBalancer(); var b3 = LoadBalancer.GetLoadBalancer(); var b4 = LoadBalancer.GetLoadBalancer(); // Confirm these are the same instance if (b1 == b2 && b2 == b3 && b3 == b4) { Console.WriteLine("Same instance "); } // Next, load balance 15 requests for a server var balancer = LoadBalancer.GetLoadBalancer(); for (int i = 0; i < 15; i++) { string serverName = balancer.NextServer.Name; Console.WriteLine("Dispatch request to: " + serverName); } // Wait for user Console.ReadKey(); } } // The 'Singleton' class sealed class LoadBalancer { // Static members are 'eagerly initialized', that is, // immediately when class is loaded for the first time. // .NET guarantees thread safety for static initialization private static readonly LoadBalancer _instance = new LoadBalancer(); // Type-safe generic list of servers private List<Server> _servers; private Random _random = new Random(); // Note: constructor is 'private' private LoadBalancer() { // Load list of available servers _servers = new List<Server> { new Server{ Name = "ServerI", IP = "120.14.220.18" }, new Server{ Name = "ServerII", IP = "120.14.220.19" }, new Server{ Name = "ServerIII", IP = "120.14.220.20" }, new Server{ Name = "ServerIV", IP = "120.14.220.21" }, new Server{ Name = "ServerV", IP = "120.14.220.22" }, }; } public static LoadBalancer GetLoadBalancer() { return _instance; } // Simple, but effective load balancer public Server NextServer { get { int r = _random.Next(_servers.Count); return _servers[r]; } } } /// <summary> /// Represents a server machine /// </summary> class Server { // Gets or sets server name public string Name { get; set; } // Gets or sets server IP address public string IP { get; set; } } }
应用场景
-
每台计算机可以有若干个打印机,但只能有一个Printer Spooler,避免两个打印作业同时输出到打印机。
-
PC机中可能有几个串口,但只能有一个COM1口的实例。
-
系统中只能有一个窗口管理器。
-
.NET Remoting中服务器激活对象中的Singleton对象,确保所有的客户程序的请求都只有一个实例来处理。
.NET Framework中的应用
.NET Framework中的.NET Remoting和WCF的服务对象都有一种名为Singleton的激活方式,表示同一时间只有一个服务端对象来处理客户端的请求。这正是单例模式的应用。
总结
Singleton设计模式是一个非常有用的机制,可用于在面向对象的应用程序中提供单个访问点。用一句广告词来概括Singleton模式就是"简约而不简单"。