使用static和readonly关键字构造饿汉式日志单例

一）使用static和readonly关键字构造单例的原由

使用这两个关键字的原因主要基于它们有以下几个特征，虽然它们还有其他很多特征，但是理解以下几个特征会更容易理解如何构造单例。

1.static关键字的几个重要特征：

1）静态成员只被创建一次，静态成员是属于类而不是实例对象

2）一个类即使被创建多个实例，它的静态成员都只有一个

3）静态方法只能被重载，而不能被重写

2.readonly关键字的重要特征

1）当用readonly标记引用类型的字段时，不可改变字段的引用，而引用的对象是可以被改变的

所以使用static和readonly修饰一个成员就可以理解为：这个成员只被创建一次，并且它指向的地址被固定不可被更改，但地址上的对象是可以被更改的。

二）代码示例测试

1.创建一个LogHelper类，这个类拥有一个队列成员，一个添加队列数据的方法，一个循环输出队列数据的任务，代码如下：

 public class LogHelper
    {
        Queue<string> _queue;
        public LogHelper()
        {
            _queue = new Queue<string>();
            Task.Run(() => OutLog());//开启一个线程输出队列数据
        }
        public static LogHelper instance = new LogHelper();
        public void AddLog(string logstr)
        {
            _queue.Enqueue(logstr);
        }
        private async Task OutLog()
        {
            
            while (true)
            {
                string tid = Thread.CurrentThread.ManagedThreadId.ToString();//当前线程id
                string outstr = _queue.Dequeue();//取出队列中的日志
                Console.WriteLine(DateTime.Now.ToString() + " 线程id:" + tid + " 日志剩余数量：" + _queue.Count + ":" + outstr);
                await Task.Delay(2000);//等待两秒
            }
        }
    }

注意这一行： public static LogHelper instance = new LogHelper();并没有添加readonly关键字。

2.再创建几个测试类，类提供添加日志队列的方法，代码如下

1）Person类

    public class Person
    {
        LogHelper logHelper = LogHelper.instance;
        public void AddLog(string name)
        {
            logHelper.AddLog($"here is Person({name}) log");
        }
    }

2）Dog类

    public class Dog
    {
        LogHelper logHelper = LogHelper.instance;
        public void AddLog(string dogame)
        {
            logHelper.AddLog($"here is Dog({dogame}) log");
        }
    }

3）House类

    public static class House
    {
        static LogHelper logHelper = LogHelper.instance;
        public static void AddLog(string address)
        {
            logHelper.AddLog($"here is House({address}) log");
        }
    }

3.控制台创建实例对象，代码如下：

        static void Main(string[] args)
        {

            Person person1 = new Person();
            person1.AddLog("张三");
            Person person2 = new Person();
            person2.AddLog("李四");

            Dog dog1 = new Dog();
            dog1.AddLog("旺财");

            House.AddLog("北京市海淀区");

            Console.ReadKey();

        }

综上，示例化了两个Person类，一个Dog类，还有一个静态House类。总共会有四条日志数据，运行后队列里应该是四条数据，测试结果如下：

从上面结果可以看出队列中的总数据数量的变化，而这些数据在同一个队列中实则是static关键字的功劳。那么readonly关键字的功劳在哪里？从以上结果看不同的类添加的日志数据都添加到了同一个队列中。是不是readonly关键字就可以省略了？其实不然，假如把Person类加一个方法，重新new一个日志也是可以，Person类修改后的代码如下：

    public class Person
    {
        LogHelper logHelper = LogHelper.instance;
        public void AddLog(string name)
        {
            logHelper.AddLog($"here is Person({name}) log");
        }
        public void ChangeLog(string name)
        {
            LogHelper.instance = new LogHelper();
            LogHelper.instance.AddLog($"the log has changed{name}");
        }
    }

在控制台执行如下代码：

        static void Main(string[] args)
        {

            Person person1 = new Person();
            person1.AddLog("张三");
            Person person2 = new Person();
            person2.ChangeLog("李四");

            Console.ReadKey();

        }

得到结果如图：

 

从运行结果看，这是两个队列在输出数据，也就是日志并不是单例。而加上关键字readonly,把public static LogHelper instance = new LogHelper();变成public static readonly LogHelper instance = new LogHelper();之后Person类中的ChangLog方法的LogHelper.instance = new LogHelper();这句就会报错提醒不能这样写。

4.多线程访问单例

上面的代码虽然解决了不同实例中调用同一个日志队列的问题，但是还有一个问题是假如多线程的话就会有新的问题，假如在控制台执行如下代码：

        static void Main(string[] args)
        {
            for (int i = 0; i < 10; i++)
            {
                Thread t = new Thread(new ParameterizedThreadStart(CreateNewThread));// 创建新线程执行CreateNewThread方法
                t.Start(i);//启动新的线程
            }

            Console.ReadKey();
        }

        private static void CreateNewThread(object n)
        {
            Person person1 = new Person();
            person1.AddLog("王五" + n);
        }

执行结果如图：

从结果中得知，队列中的数据应有数据和实际数据不匹配，所以得给队列入队和出队都加上锁，修改成如下代码即可：

    public class LogHelper
    {
        Queue<string> _queue;
        private readonly Task _taskloop;
        public static object a = new object();
        public LogHelper()
        {
            _queue = new Queue<string>();
            _taskloop = Task.Run(() => OutLog());//开启一个线程输出队列数据
        }
        public static readonly LogHelper instance = new LogHelper();
        public void AddLog(string logstr)
        {
            lock (a)
            {
                _queue.Enqueue(logstr);
            }
        }
        private async Task OutLog()
        {

            while (true)
            {
                lock (a)
                {
                    string str = _queue.Dequeue();
                    string tid = Thread.CurrentThread.ManagedThreadId.ToString();//当前线程id
                    Console.WriteLine(DateTime.Now.ToString() + " 线程id:" + tid + " 日志剩余数量：" + _queue.Count + ":" + str);
                }
                await Task.Delay(2000);//等待两秒
            }
        }
    }