开放原子开发者工作坊

单件模式（C#）

2018-07-10 10:16

---

【原创】

本文地址：https://www.cnblogs.com/qiaoge0923/p/9282845.html

github示例代码地址：https://github.com/JoySino/DesignPatternStudy/tree/master/ConsoleDemo/ConsoleDemo/Singleton

1.前言

单件模式保证一个类只有唯一一个实例，并提供一个全局访问点。《设计模式——可复用面向对象软件的基础》中是这样定义的：

类自身保存了该类的实例对象（自己创建实例），通过截取创建新实例的请求保证没有其他新实例被创建(保证实例唯一)，并且提供一个全局访问该实例对象的方法（对外提供唯一访问点），这就是Singleton模式。

常用的场景如：

系统日志记录器，系统配置管理器，模态窗口等等。

单件模式也允许子类继承，目前未接触到实际应用，暂无具体了解，所以下面的介绍均不考虑 子类扩展的情况。

2.普通懒汉单例模式

2.1代码

    /// <summary>
    /// 多线程安全单例模式示例
    /// </summary>
    public sealed class LockSingleton
    {
        #region 单例

        private static LockSingleton _instance;
        /// <summary>
        /// 私有化构造函数，使得类不可通过new来创建实例
        /// </summary>
        private LockSingleton() { }

        //写法1：通过属性获取实例
        public static LockSingleton Instance
        {
            get
            {
                if (_instance == null)
                {
                    _instance = new LockSingleton();
                }
                return _instance;
            }
        }

        //写法2：通过方法获取实例
        public static LockSingleton GetInstance()
        {
            //这里可以copy属性Instance中的代码
            return Instance;
        }
        #endregion
    }

2.2说明

这种写法在多线程环境中会存在安全问题，两个线程同时访问时，都检测到单例对象为空，所以都会执行初始化操作，这样就会创建两个实例对象来，无法做到唯一，所以一般不建议如此写。

3.多线程安全单例模式

3.1代码

    /// <summary>
    /// 多线程安全单例模式示例
    /// </summary>
    public sealed class LockSingleton
    {
        #region 字段

        public int normalX = SetValue(staticX);

        public static int staticX = 1;

        #endregion

        #region 单例

        private static LockSingleton _instance;
        private static readonly object lockObj = new object();
        /// <summary>
        /// 私有化构造函数，使得类不可通过new来创建实例
        /// </summary>
        private LockSingleton()
        {
            Console.WriteLine($"normalX={normalX}");
            Console.WriteLine($"staticX={staticX}");
            Console.WriteLine($"normalY={normalY}");
            Console.WriteLine($"staticY={staticY}");
        }

        //写法1：通过属性获取实例
        public static LockSingleton Instance
        {
            get
            {
                if (_instance == null)
                {
                    lock (lockObj)
                    {
                        if (_instance == null)
                        {
                            _instance = new LockSingleton();
                        }
                    }
                }
                return _instance;
            }
        }

        //写法2：通过方法获取实例
        public static LockSingleton GetInstance()
        {
            //这里可以copy属性Instance中的代码
            return Instance;
        }
        #endregion

        #region 其他

        public int normalY = SetValue(staticY);

        public static int staticY = 1;

        private static int SetValue(int val)
        {
            return val;
        }

        #endregion
    }

3.2调用过程

     class Program
     {
         static void Main(string[] args)
         {
              Console.WriteLine("程序开始");
 
              Singleton.LockSingleton.GetInstance();
            
             Console.ReadKey();
         }
     }

3.3运行效果

3.4说明

 

normalX、staticX、normalY、staticY和Instance的执行顺序为：外部调用》staticX 》staticY》单例对象_instance》normalX》normalY》私有构造函数。

使用懒汉式单例模式时必须要考虑多线程环境下的线程安全问题，本例中直接使用了线程安全的单例模式，锁前锁后双重判断，可以有效避免多线程同时读到空单例对象可能导致创建多个实例对象的问题。

4.静态初始化单例类示例1

4.1代码

    /// <summary>
    /// 饿汉式单例类，静态初始化单例类示例1
    /// </summary>
    public sealed class ReadonlySingleton
    {
        #region 字段

        public int normalX = SetValue(staticX);

        public static int staticX = 1;

        #endregion

        #region 单例
        /// <summary>
        /// 静态初始化单例，只有通过这种写法并且调用这个字段方能是饿汉式单例
        /// </summary>
        public static readonly ReadonlySingleton Instance = new ReadonlySingleton();

        /// <summary>
        /// 私有化构造函数，使得类不可通过new来创建实例
        /// </summary>
        private ReadonlySingleton()
        {
            Console.WriteLine($"normalX={normalX}");
            Console.WriteLine($"staticX={staticX}");
            Console.WriteLine($"normalY={normalY}");
            Console.WriteLine($"staticY={staticY}");
        }

        #endregion

        #region 其他

        public int normalY = SetValue(staticY);

        public static int staticY = 1;

        public void ShowLog()
        {
            Console.WriteLine($"{Common.TimeHelper.PrintMillisecond()}：ReadonlySingleton ShowLog");
        }

        private static int SetValue(int val)
        {
            return val;
        }

        #endregion
    }

4.2调用过程

    class Program
    {
        static void Main(string[] args)
        {
            Console.WriteLine("程序开始");

            var tmp = Singleton.ReadonlySingleton.Instance;

            Console.ReadKey();
        }
    }

4.3运行效果

  

4.4说明

饿汉式单例类，在类加载的时候就会创建实例对象并一直存在于内存当中直至程序退出，所以，在Main函数的第一句执行前就已经执行了单例类的实例化。

normalX、staticX、normalY、staticY和Instance的执行顺序为：staticX 》Instance》normalX》normalY》构造函数》staticY》外部调用。

可以看出，对于静态字段，定义在单例字段前会先初始化，并在构造函数调用前执行，而定义在单例字段后会后初始化，并且在构造函数调用后执行；对于无修饰符的字段，无论位置在哪，都会在单例字段初始化后按顺序初始化，并且在构造函数调用前执行。所以，normalY、staticY都打印了0而不是1。

单例字段Instance是公有的，可以外部访问，只会实例化一次。这样写的单例类其字段会在类第一次使用前就初始化（具体时机由CLR决定），进而提前占用系统资源，如果想要在第一次访问时再实例化对象，那么只需要把单例字段变成私有的，并提供外部访问接口即可，或者定义内部类来实例化单例字段，详情见静态初始化单例类示例2、3、4。

5.静态初始化单例类示例2（单例私有化）

5.1代码

    public sealed class ReadonlySingleton2
    {
        #region 字段

        public int normalX = SetValue(staticX);

        public static int staticX = 1;

        #endregion

        #region 单例

        /// <summary>
        /// 静态初始化单例，只有通过这种写法并且调用这个字段方能是饿汉式单例
        /// </summary>
        private static readonly ReadonlySingleton2 _instance = new ReadonlySingleton2();
        /// <summary>
        /// 私有化构造函数，使得类不可通过new来创建实例
        /// </summary>
        private ReadonlySingleton2()
        {
            Console.WriteLine($"normalX={normalX}");
            Console.WriteLine($"staticX={staticX}");
            Console.WriteLine($"normalY={normalY}");
            Console.WriteLine($"staticY={staticY}");
        }

        //写法1：通过属性获取实例
        public static ReadonlySingleton2 Instance
        {
            get { return _instance; }
        }

        //写法2：通过方法获取实例
        public static ReadonlySingleton2 GetInstance()
        {
            return _instance;
        }

        #endregion

        #region 其他

        public int normalY = SetValue(staticY);
        public static int staticY = 1;

        private static int SetValue(int val)
        {
            return val;
        }

        #endregion
    }

5.2调用过程

    class Program
    {
        static void Main(string[] args)
        {
            Console.WriteLine("程序开始");

            var tmp = Singleton.ReadonlySingleton2.Instance;

            Console.ReadKey();
        }
    }

5.3运行效果

 

5.4说明

如此写便可避免类一加载就实例化对象。当然还可以有其他写法。

normalX、staticX、normalY、staticY和Instance的执行顺序为：外部调用》staticX 》Instance》normalX》normalY》构造函数》staticY。

可以看出，单例类字段都是在外部第一次调用之后才初始化执行的，这种写法实现了延迟加载。

6.静态初始化单例类示例3(静态构造函数)

6.1代码

    public sealed class ReadonlySingleton3
    {
        #region 字段

        public int normalX = SetValue(staticX);

        public static int staticX = 1;

        #endregion

        #region 单例
        /// <summary>
        /// 静态初始化单例，只有通过这种写法并且调用这个字段方能是饿汉式单例
        /// </summary>
        public static readonly ReadonlySingleton3 Instance = new ReadonlySingleton3();

        /// <summary>
        /// 定义一个静态构造函数，使得静态字段在调用的时候才被初始化
        /// </summary>
        static ReadonlySingleton3()
        {
            Console.WriteLine("ReadonlySingleton3____Static");
        }
        /// <summary>
        /// 私有化构造函数，使得类不可通过new来创建实例
        /// </summary>
        private ReadonlySingleton3()
        {
            Console.WriteLine($"normalX={normalX}");
            Console.WriteLine($"staticX={staticX}");
            Console.WriteLine($"normalY={normalY}");
            Console.WriteLine($"staticY={staticY}");
        }

        #endregion

        #region 其他

        public int normalY = SetValue(staticY);

        public static int staticY = 1;

        public void ShowLog()
        {
            Console.WriteLine($"{Common.TimeHelper.PrintMillisecond()}：ReadonlySingleton3 ShowLog");
        }

        private static int SetValue(int val)
        {
            return val;
        }

        #endregion
    }

6.2调用过程

    class Program
    {
        static void Main(string[] args)
        {
            Console.WriteLine("程序开始");

            var tmp = Singleton.ReadonlySingleton3.Instance;

            Console.ReadKey();
        }
    }

6.3运行效果

6.4说明

这里定义了一个静态构造函数，使得同为静态类型的单例类实例Instance在第一次调用时才进行初始化，也就达到了不提前占用系统资源的目的。不过在初始化单例类时，会先调用私有构造函数，然后再调用静态构造函数。

normalX、staticX、normalY、staticY和Instance的执行顺序为：外部调用》staticX 》Instance》normalX》normalY》私有构造函数》staticY》静态构造函数。

可以看出，这样写也能达到延迟加载的目的。

7.静态初始化单例类示例4(内部类)

7.1代码

    public sealed class ReadonlySingleton4
    {
        #region 字段

        public int normalX = SetValue(staticX);

        public static int staticX = 1;

        #endregion

        #region 单例
        private class InnerInstance
        {
            internal static ReadonlySingleton4 _instance = new ReadonlySingleton4();
        }

        private ReadonlySingleton4()
        {
            Console.WriteLine($"normalX={normalX}");
            Console.WriteLine($"staticX={staticX}");
            Console.WriteLine($"normalY={normalY}");
            Console.WriteLine($"staticY={staticY}");
        }

        public static ReadonlySingleton4 Instance
        {
            get { return InnerInstance._instance; }
        }

        public static ReadonlySingleton4 GetInstance()
        {
            return InnerInstance._instance;
        }
        #endregion

        #region 其他

        public int normalY = SetValue(staticY);

        public static int staticY = 1;

        public void ShowLog()
        {
            Console.WriteLine($"{Common.TimeHelper.PrintMillisecond()}：ReadonlySingleton4 ShowLog");
        }

        private static int SetValue(int val)
        {
            return val;
        }

        #endregion
    }

7.2调用过程

    class Program
    {
        static void Main(string[] args)
        {
            Console.WriteLine("程序开始");

            var tmp = Singleton.ReadonlySingleton4.Instance;

            Console.ReadKey();
        }
    }

7.3运行效果

7.4说明

normalX、staticX、normalY、staticY和Instance的执行顺序为：外部调用》staticX 》staticY》内部类_instance》normalX》normalY》私有构造函数》内部类静态构造函数（可以不用）。

内部类要不要构造函数和静态构造函数都不影响，都能够达到延迟加载的目的。

8.懒加载Lazy

8.1代码

    /// <summary>
    /// 使用Lazy创建单例类示例
    /// </summary>
    public sealed class LazySingleton
    {
        #region 字段

        public int normalX = SetValue(staticX);

        public static int staticX = 1;

        #endregion

        #region 单例
        private static readonly Lazy<LazySingleton> _instance = new Lazy<LazySingleton>(() => new LazySingleton());

        private LazySingleton()
        {
            Console.WriteLine($"normalX={normalX}");
            Console.WriteLine($"staticX={staticX}");
            Console.WriteLine($"normalY={normalY}");
            Console.WriteLine($"staticY={staticY}");
        }

        //写法1：通过属性获取实例
        public static LazySingleton Instance
        {
            get
            {
                return _instance.Value;
            }
        }

        //写法2：通过方法获取实例
        public static LazySingleton GetInstance()
        {
            return _instance.Value;
        }
        #endregion

        #region 其他

        public int normalY = SetValue(staticY);

        public static int staticY = 1;

        private static int SetValue(int val)
        {
            return val;
        }

        #endregion
    }

8.2调用过程

    class Program
    {
        static void Main(string[] args)
        {
            Console.WriteLine("程序开始");

            var tmp = Singleton.LazySingleton.Instance;

            Console.ReadKey();
        }
    }

8.3运行效果

8.4说明

normalX、staticX、normalY、staticY和Instance的执行顺序为：外部调用》staticX 》单例对象_instance》staticY》normalX》normalY》私有构造函数。

9.总结

单例模式实现方式很多种，上面只是常用的几种。我认为最适合使用的非"单例私有化"的写法，既避免了多线程安全问题，又能延迟加载，避免提前占用系统资源。

学习了单例模式，接下来继续工厂模式的学习。