c#

位置:IT落伍者 >> c# >> 浏览文章

Singleton设计模式的C#实现


发布日期:2019年10月29日
 
Singleton设计模式的C#实现
Singleton模式

Singleton(译为单件或单态)模式是设计模式中比较简单而常用的模式

有些时候在整个应用程序中会要求某个类有且只有一个实例这个时候可以采用Singleton模式进行设计用Singleton模式设计的类不仅能保证在应用中只有一个实例而且提供了一种非全局变量的方法进行全局访问称为全局访问点这样对于没有全局变量概念的纯面向对象语言来说是非常方便的比如C#

本文用一个计数器的例子来描述在C#中如何使用Singleton模式计数的值设计为计数器类的一个私有成员变量它被个不同的线程进行读写操作为保证计数的正确性在整个应用当中必然要求计数器类的实例是唯一的

Singleton的实现方式

首先看看教科书方式的Singleton标准实现的两种方法以下用的是类C#伪代码

方法一

using System;

namespace csPatternSingleton

{

public class Singleton

{

static Singleton uniSingleton = new Singleton();

private Singleton() {}

static public Singleton instance()

{

return uniSingleton;

}

}

}

方法二

using System;

namespace csPatternSingleton

{

public class Singleton

{

static Singleton uniSingleton;

private Singleton() {}

static public Singleton instance()

{

if (null == uniSingleton)

{

uniSingleton = new Singleton _lazy();

}

return uniSingleton;

}

}

}

Singleton模式的实现有两个技巧一是使用静态成员变量保存全局的实例确保了唯一性使用静态的成员方法instance() 代替 new关键字来获取该类的实例达到全局可见的效果二是将构造方法设置成为private如果使用new关键字创建类的实例则编译报错以防编程时候笔误

上面方法二的初始化方式称为lazy initialization是在第一次需要实例的时候才创建类的实例与方法一中类的实例不管用不用一直都有相比方法二更加节省系统资源但是方法二在多线程应用中有时会出现多个实例化的现象

假设这里有个线程主线程和线程在创建类的实例的时候可能会遇到一些原因阻塞一段时间(比如网络速度或者需要等待某些正在使用的资源的释放)此时的运行情况如下

主线程首先去调用instance()试图获得类的实例instance()成员方法判断该类没有创建唯一实例于是开始创建实例由于一些因素主线程不能马上创建成功而需要等待一些时间此时线程也去调用instance()试图获得该类的实例因为此时实例还未被主线程成功创建因此线程又开始创建新实例结果是两个线程分别创建了两次实例对于计数器类来说就会导致计数的值被重置与Singleton的初衷违背解决这个问题的办法是同步

下面看看本文的计数器的例子的实现

使用方法一

using System;

using SystemThreading;

namespace csPatternSingleton

{

public class Counter

{

static Counter uniCounter = new Counter(); //存储唯一的实例

private int totNum = ; //存储计数值

private Counter()

{

ThreadSleep(); //这里假设因为某种因素而耽搁了毫秒

//在非lazy initialization 的情况下 不会影响到计数

}

static public Counter instance()

{

return uniCounter;

}

public void Inc() { totNum ++;} //计数加

public int GetCounter() { return totNum;} //获得当前计数值

}

}

以下是调用Counter类的客户程序在这里我们定义了四个线程同时使用计数器每个线程使用最后得到的正确结果应该是

using System;

using SystemIO;

using SystemThreading;

namespace csPatternSingletonMutileThread

{

public class MutileClient

{

public MutileClient() {}

public void DoSomeWork()

{

Counter myCounter = Counterinstance(); //方法一

//Counter_lazy myCounter = Counter_lazyinstance(); //方法二

for (int i = ; i < ; i++)

{

myCounterInc();

ConsoleWriteLine(线程{}报告: 当前counter为: {} ThreadCurrentThreadNameToString() myCounterGetCounter()ToString());

}

}

public void ClientMain()

{

Thread thread = ThreadCurrentThread;

threadName = Thread ;

Thread thread =new Thread(new ThreadStart(thisDoSomeWork));

threadName = Thread ;

Thread thread =new Thread(new ThreadStart(thisDoSomeWork));

threadName = Thread ;

Thread thread =new Thread(new ThreadStart(thisDoSomeWork));

threadName = Thread ;

threadStart();

threadStart();

threadStart();

DoSomeWork(); //线程也只执行和其他线程相同的工作

}

}

}

以下为Main函数本程序的测试入口

using System;

namespace csPatternSingleton

{

public class RunMain

{

public RunMain() {}

static public void Main(string[] args)

{

MutileThreadMutileClient myClient = new MutileThreadMutileClient();

myClientClientMain();

SystemConsoleReadLine();

}

}

}

执行结果如下

线程Thread 报告: 当前counter为:

线程Thread 报告: 当前counter为:

线程Thread 报告: 当前counter为:

线程Thread 报告: 当前counter为:

线程Thread 报告: 当前counter为:

线程Thread 报告: 当前counter为:

线程Thread 报告: 当前counter为:

线程Thread 报告: 当前counter为:

线程Thread 报告: 当前counter为:

线程Thread 报告: 当前counter为:

线程Thread 报告: 当前counter为:

线程Thread 报告: 当前counter为:

线程Thread 报告: 当前counter为:

线程Thread 报告: 当前counter为:

线程Thread 报告: 当前counter为:

线程Thread 报告: 当前counter为:

由于系统线程调度的不同每次的执行结果也不同但是最终结果一定是

方法一中由于实例一开始就被创建所以instance()方法无需再去判断是否已经存在唯一的实例而返回该实例所以不会出现计数器类多次实例化的问题

使用方法二

using System;

using SystemThreading;

using SystemRuntimeCompilerServices;

namespace csPatternSingleton

{

public class Counter_lazy

{

static Counter_lazy uniCounter;

private int totNum = ;

private Counter_lazy()

{

ThreadSleep(); //假设多线程的时候因某种原因阻塞毫秒

}

[MethodImpl(MethodImplOptionsSynchronized)] //方法的同步属性

static public Counter_lazy instance()

{

if (null == uniCounter)

{

uniCounter = new Counter_lazy();

}

return uniCounter;

}

public void Inc() { totNum ++;}

public int GetCounter() { return totNum;}

}

}

不知道大家有没有注意到instance()方法上方的[MethodImpl(MethodImplOptionsSynchronized)] 语句他就是同步的要点他指定了instance()方法同时只能被一个线程使用这样就避免了线程调用instance()创建完成实例前线程就来调用instance()试图获得该实例

根据MSDN的提示也可以使用lock关键字进行线程的加锁代码如下

using System;

using SystemThreading;

namespace csPatternSingleton

{

public class Counter_lazy

{

static Counter_lazy uniCounter;

static object myObject = new object();

private int totNum = ;

private Counter_lazy()

{

ThreadSleep(); //假设多线程的时候因某种原因阻塞毫秒

}

static public Counter_lazy instance()

{

lock(myObject)

{

if (null == uniCounter)

{

uniCounter = new Counter_lazy();

}

return uniCounter;

}

}

public void Inc() { totNum ++;}

public int GetCounter() { return totNum;}

}

}

lock()是对一个对象加互斥锁只允许一个线程访问其后大括号中语句块直到该语句块的代码执行完才解锁解锁后才允许其他的线程执行其语句块

还可以使用Mutex类进行同步定义private static Mutex mut = new Mutex();后修改instance()如下同样可以得到正确的结果

static public Counter_lazy instance()

{

mutWaitOne();

if (null == uniCounter)

{

uniCounter = new Counter_lazy();

}

mutReleaseMutex();

return uniCounter;

}

注意的是本例中使用方法二要更改方法一的客户程序去掉Counter_lazyintance()的注释并将Counterintance()注释

singleton模式还可以拓展只要稍加修改就可以限制在某个应用中只能允许m个实例存在而且为m个实例提供全局透明的访问方法               

上一篇:浅谈C#闭包的相关原理

下一篇:C# .Net中的类型转换