Skip to main content

Singleton Class in C#

Singleton pattern is very popular pattern used by programmer. The idea behind the singleton pattern is to have only one instance of a class at any time. This kind of pattern is very useful for for heavy resources like Linq Data Context etc. It is also useful in multithreaded application where different thread of application try to crate instance of one class but it should be thread safe. It can be also useful for global resources and state objects. In singleton class there are two things required. One static variable which hold the instance of class and other is a static method which will return the instance of singleton class. Here is the example of singleton class

 public class MySingleTon
{
private static MySingleTon mySingleTonInstance = new MySingleTon();

private MySingleTon()
{
//private constructor
}
public static MySingleTon GetInstace()
{
return mySingleTonInstance;
}

}
Now we are done with calling single ton class like following.
 MySingleTon objSingleTon = MySingleTon.GetInstace(); 
The above example is not thread safe so it may be possible that different thread can create different instance of classes. To make above singleton class thread safe we need to change code like following.
   public class MySingleTon
{
private static MySingleTon mySingleTonInstance = new MySingleTon();

private MySingleTon()
{
//private constructor
}
public static MySingleTon GetInstace()
{
lock (typeof(MySingleTon))
{
if (mySingleTonInstance == null)
{
mySingleTonInstance = new MySingleTon();
}
return mySingleTonInstance;
}

}
}
Hope this will help you…

Shout it
kick it on DotNetKicks.com

Comments

  1. That thread safe solution is not very elegant. You are needlessly locking always GetInstance() is called, and locking to typeof(MySingleTon) may cause unwanted lost of performace or even deadlocks.

    ReplyDelete
  2. Can you please suggest other way of doing this? I don't think that there will be deadlock.

    ReplyDelete
  3. Last code must be

    public class MySingleTon

    private static MySingleTon mySingleTonInstance = new MySingleTon();

    private MySingleTon()
    {
    //private constructor
    }
    public static MySingleTon GetInstace()
    {
    if (mySingleTonInstance == null)
    {
    lock (typeof(MySingleTon))
    {
    if (mySingleTonInstance == null)
    {
    mySingleTonInstance = new MySingleTon();
    }
    return mySingleTonInstance;
    }
    }
    }
    }

    ReplyDelete
  4. You can refer to msdn article http://msdn.microsoft.com/en-us/library/ms998558.aspx that explains how to implement.

    In their article the lock is only done when there is no current instance created. The instance variable is declared as "volatile"

    ReplyDelete
  5. Other people may lock on typeof(MySingleton) as well, increasing the chances of a deadlock.

    On C# (and only on it, AFAIK) you can double check safely and so make something like this:

    public static MySingleTon GetInstace()
    {
    if (mySingleTonInstance == null)
    {
    lock (lockObj)
    {
    if (mySingleTonInstance == null)
    {
    mySingleTonInstance = new MySingleTon();
    }
    }
    }
    return mySingleTonInstance;
    }

    Also, leaving the instance creation to the CLR as in:

    private static readonly MySingleTon mySingleTonInstance = new MySingleTon();

    This is already thread-safe and good enough in most occasions.

    If you want full lazy instantiation this is the way to go:

    public sealed class Singleton
    {

    private Singleton() {}

    public static Singleton GetInstance()
    {
    return NestedSingleton.singleton;
    }

    class NestedSingleton
    {
    internal static readonly Singleton singleton = new Singleton();

    static NestedSingleton() {}
    }
    }

    ReplyDelete

Post a Comment

Your feedback is very important to me. Please provide your feedback via putting comments.

Popular posts from this blog

How to create Rest API(Web API) with ASP.NET Core 1.0

Recently Microsoft has released ASP.NET Core 1.0 RC2, I am getting lots of request from readers that about creating Web API. So I thought it will be a good idea to write a blog post about how to create Rest API(Web API) with ASP.NET Core 1.0.

So let’s get started via creating an ASP.NET Core 1.0 Web Application like following.



Once you click on ASP.NET Web Application, It will ask whether you need to create Web Application or Web API application. We are going to Web API so I am going to select Web API Application like following. Please note that in ASP.NET Core 1.0 there is no separate libraries or DLLs required for creating web APIs. This is just a project template.



Now once you click on OK It will create a Web API application with default values controller and program.cs.  As you know Program.cs is now starting point for the ASP.NET Core 1.0 application so It contains all the required configuration and startup items. Following is a code for that.
using System.IO; using Microsoft.Asp…

How to use migration with Entity Framework Core

Entity framework core is  the lightweight, extensible and cross-platform version of Entity Framework. Before some time, Microsoft has Released a new version of Entity Framework RC2. I have written a couple of blog post about Entity framework code first migration earlier for Entity framework 6.0. So there was a couple of request coming for writing a blog post about Entity Framework Core RC2 migration. So I thought it will be a good idea to give an overview how database migration works in Entity Framework Core RC2. This post will cover a basic scenario where we are going to create the database with existing ASP.NET Identity migration and then we are going to create a new model and have that migration applied in the database.

How to use Entity Framework Migrations: Let’s get started, To demonstrate entity framework core migrations, I am going to create a sample asp.net core web application like following.



Once we select asp.net core application it will appear the following dialog.



Now w…

Creating PDF with ASP.Net MVC and RazorPDF

Update: I have written a new blog post about better approach to create a PDF with asp.net mvc- You can find that following location.- A Better Solution to create PDF with Rotativa and ASP.NET MVC
In this post we are going to learn how we can easily create PDF from ASP.Net application with the help of Razor PDF NuGet package.

About Razor PDF:
This NuGet package is created by Al Nyveldt It internally uses ITextSharp an open source PDF convertor library. RazorPDF uses Razor View engine to create iTextXML which is in tern used to produce PDF file. You can get more information about that at below link.

https://www.nuget.org/packages/RazorPDF

Example(Creating PDF with ASP.Net MVC):
So what we are we waiting for ? Let’s create a simple example. To create example first thing we need to a create and ASP.Net MVC application.