设计模式之一：单例模式（Singleton Pattern）

写这个系列的文章，只为把所学的设计模式再系统的整理一遍。错误和不周到的地方欢迎大家批评。点击这里下载源代码。

什么时候使用单例模式

在程序运行时，某种类型只需要一个实例时，一般采用单例模式。为什么需要一个实例？第一，性能，第二，保持代码简洁，比如程序中通过某个配置类A读取配置文件，如果在每处使用的地方都new A()，才能读取配置项，一个是浪费系统资源（参考.NET垃圾回收机制），再者重复代码太多。

单例模式的实现

实现单例模式，方法非常多，这里我把见过的方式都过一遍，来体会如何在支持并发访问、性能、代码简洁程度等方面不断追求极致。（单击此处下载代码）

实现1：非线程安全

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading;
using System.Threading.Tasks;

namespace SingletonPatternNotTheadSafe
{
    public sealed class Singleton
    {
        private static Singleton instance = null;

        private Singleton()
        {
        }

        public static Singleton Instance
        {
            get
            {
                if (instance == null)
                {
                    Thread.Sleep(1000);
                    instance = new Singleton();
                    Console.WriteLine(string.Format(
                        "[{0}]创建Singleton {1}" , Thread.CurrentThread.ManagedThreadId, instance.GetHashCode()));
                }

                Console.WriteLine(string.Format(
                        "[{0}]获得Singleton {1}", Thread.CurrentThread.ManagedThreadId, instance.GetHashCode()));
                return instance;
            }
        }
    }
}

为了能够在下面的测试代码中展示上面代码的问题，这里在创建对象前，让线程休息1秒，并且在控制台打印出当前线程ID、对象的hashcode（一般不同对象的hashcode是不一样的，但可能重复）。

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading;
using System.Threading.Tasks;

namespace SingletonPatternNotTheadSafe
{
    class Program
    {
        private static void Main(string[] args)
        {
            Thread t1 = new Thread(new ThreadStart(Compute));

            t1.Start();

            Compute();

            Console.ReadLine();  // 阻止主线程结束
        }

        private static void Compute()
        {
            Singleton o1 = Singleton.Instance;
        }
    }
}

执行结果如下：

分析：

Singleton.Instance的get方法中创建instance并未考虑并发访问的情况，导致可能重复创建Singleton对象。下面的实现方法修复了此问题。

实现2：简单线程安全

要解决上面的问题，最简单的方法就是在创建对象的时候加锁。

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading;
using System.Threading.Tasks;

namespace SingletonSimpleThreadSafe
{
    public sealed class Singleton
    {
        private static Singleton instance = null;
        private static readonly object _lock = new object();

        private Singleton()
        {
        }

        public static Singleton Instance
        {
            get
            {
                lock (_lock)
                {
                    if (instance == null)
                    {
                        Thread.Sleep(1000);
                        instance = new Singleton();
                        Console.WriteLine(string.Format(
                            "[{0}]创建Singleton {1}", Thread.CurrentThread.ManagedThreadId, instance.GetHashCode()));
                    }
                }

                Console.WriteLine(string.Format(
                            "[{0}]获得Singleton {1}", Thread.CurrentThread.ManagedThreadId, instance.GetHashCode()));
                return instance;
            }
        }
    }
}

测试代码如下：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading;
using System.Diagnostics;
using System.Threading.Tasks;

namespace SingletonSimpleThreadSafe
{
    class Program
    {
        private static void Main(string[] args)
        {
            SingletonTest();
        }

        private static void SingletonTest()
        {
            Thread t1 = new Thread(new ThreadStart(Compute));

            t1.Start();

            Compute();

            Console.ReadLine();  // 阻止主线程结束
        }

        private static void Compute()
        {
            Singleton o1 = Singleton.Instance;
        }
    }
}

我们再看看执行效果：

创建Singleton只执行一次。但是这种写法性能并不高，每次通过Singleton.Instance获得实例对象都需要判断锁是否别别的线程占用。

这里我们修改一下Singleton，把代码中的Thread.Sleep和Console.Writeline都去掉，这里我重新创建了一个Singleton2 class，两个线程中循环调用100000000次，看一下这么实现的性能：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading;
using System.Threading.Tasks;

namespace SingletonSimpleThreadSafe
{
    public sealed class Singleton2
    {
        private static Singleton2 instance = null;
        private static readonly object _lock = new object();

        private Singleton2()
        {
        }

        public static Singleton2 Instance
        {
            get
            {
                lock (_lock)
                {
                    if (instance == null)
                    {
                        instance = new Singleton2();
                    }
                }

                return instance;
            }
        }
    }
}

测试代码如下：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading;
using System.Diagnostics;
using System.Threading.Tasks;

namespace SingletonSimpleThreadSafe
{
    class Program
    {
        private static void Main(string[] args)
        {
            Singleton2Test();
        }

        private static void Singleton2Test()
        {
            Thread t1 = new Thread(new ThreadStart(Compute2));

            t1.Start();

            Compute2();

            Console.ReadLine();  // 阻止主线程结束
        }

        private static void Compute2()
        {
            Stopwatch sw1 = new Stopwatch();

            sw1.Start();

            for (int i = 0; i < 100000000; i++)
            {
                Singleton2 instance = Singleton2.Instance;
            }

            sw1.Stop();

            Console.WriteLine(string.Format("[{0}]耗时：{1}毫秒",
                Thread.CurrentThread.ManagedThreadId,
                sw1.ElapsedMilliseconds));
        }
    }
}

执行结果：

我们先不讨论结果，接着往下看看双检锁方式的性能。

实现3：双检锁实现的线程安全

Singleton双检锁实现：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading;
using System.Threading.Tasks;

namespace SingletonDoubleCheckThreadSafe
{
    public sealed class Singleton2
    {
        private static Singleton2 instance = null;
        private static readonly object _lock = new object();

        private Singleton2()
        {
        }

        public static Singleton2 Instance
        {
            get
            {
                if (instance == null)
                {
                    lock (_lock)
                    {
                        if (instance == null)
                        {
                            instance = new Singleton2();
                        }
                    }
                }

                return instance;
            }
        }
    }
}

测试代码和上面的一样，结果如下：

性能提高了（7571+7465-1410-1412）/ (7571+7465) * 100% = 81.2%。（实际项目中为了减少误差，应该跑多遍测试得到多个结果的平均值和方差，这里为了方便，我只把一次测试结果贴出来。）

双检锁机制在lock外又检查了一次instance是否为null，这样在第一次访问使instance创建后，后面的调用都无需检查lock是否被占用。

一名程序员要了解到这里算基本合格，如果想达到更高的水平，继续往下看。这种方式有什么缺点呢？

• 上面的代码在Java中不能正常工作。这是因为Java的Memory Model实现和.NET不一样，并不保证一定在构造函数执行完成后才返回对象的引用。虽然Java 1.5版本重构了Memory Model，但是双检锁机制在不给instance field加volatile关键字时，依然不能正常工作。
• Microsoft的.net memory model并不是按照标准的ECMA CLI规范实现，而是在标准上做了一些“增强”工作。MS .net CLR memory model中所有的写操作都是VolatileWrite（参考《CLR via C#》第二版的第24章）。所以我们的代码中不加volatile也能在IA64CPU 架构的机器上正常执行。但是如Jeffrey建议，最好还是遵循ECMA标准。
• 实现复杂。

实现4：非懒加载，无锁实现线程安全

.NET中的static变量在class被第一次实例化的时候创建，且保证仅执行一次创建。利用这个特点，可以像如下实现：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace SingletonNotUsingLock
{
    public class Singleton
    {
        private volatile static Singleton instance = new Singleton();

        // Explicit static constructor to tell C# compiler
        // not to mark type as beforefieldinit
        static Singleton()
        {
            Console.WriteLine("execute static constructor");
        }

        private Singleton()
        {
            Console.WriteLine("execute private constructor");
        }

        public static Singleton Instance
        {
            get
            {
                Console.WriteLine("instance get");
                return instance;
            }
        }
    }
}

上面的代码可以更简化一些，去掉Instance属性，将私有的instance变量改成public的：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace SingletonNotUsingLock
{
    public class Singleton2
    {
        public volatile static Singleton2 instance = new Singleton2();

        // Explicit static constructor to tell C# compiler
        // not to mark type as beforefieldinit
        static Singleton2()
        {
            Console.WriteLine("execute static constructor");
        }

        private Singleton2()
        {
            Console.WriteLine("execute private constructor");
        }
    }
}

代码非常简洁。但是为什么有个静态构造函数呢，我们看看下面的测试代码：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace SingletonNotUsingLock
{
    class Program
    {
        static void Main(string[] args)
        {
            Console.WriteLine("begin create singleton");

            Singleton s1 = Singleton.Instance;

            Console.WriteLine("after create singleton");

            Singleton2 s2 = Singleton2.instance;

            Console.WriteLine("after create singleton2");
        }
    }
}

执行结果如下：

把静态构造函数去掉后执行结果如下：

这是因为没有静态构造函数的类，编译时会被标记称beforefieldinit，那么，beforefieldinit究竟表示什么样的语义呢？Scott Allen对此进行了详细的解释：beforefieldinit为CLR提供了在任何时候执行.cctor的授权，只要该方法在第一次访问类型的静态字段之前执行即可。

实现5：无锁懒加载

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace SingletonNotUsingLockAndLazyLoad
{
    public class Singleton
    {
        private Singleton()
        {
            Console.WriteLine("execute Singleton private constructor");
        }

        public static Singleton Instance
        {

            get
            {
                Console.WriteLine("execute Singleton.Instance get");
                return Nested.instance;
            }
        }

        private class Nested
        {
            // Explicit static constructor to tell C# compiler
            // not to mark type as beforefieldinit
            static Nested()
            {
                Console.WriteLine("execute Nested static constructor");
            }

            internal static readonly Singleton instance = new Singleton();
        }
    }
}

实现6：使用.NET 4.0中的Lazy<T>

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace SingletonUsingLazyType
{
    public sealed class Singleton
    {
        private static readonly Lazy<Singleton> lazy =
            new Lazy<Singleton>(() => new Singleton());

        public static Singleton Instance { get { return lazy.Value; } }

        private Singleton()
        {
        }
    }
}

参考：

1. Exploring the Singleton Design Pattern
2. C#设计模式（7）－Singleton Pattern
3. Implementing the Singleton Pattern in C#
4. c#静态构造函数
5. C# and beforefieldinit
6. 《研磨设计模式》
7. 关于Type Initializer和 BeforeFieldInit的问题，看看大家能否给出正确的解释
8. [你必须知道的.NET]第二十三回：品味细节，深入.NET的类型构造器