In software engineering, the singleton pattern is a design pattern that restricts the instantiation of a class to one object. This is useful when exactly one object is needed to coordinate actions across the system. The concept is sometimes generalized to systems that operate more efficiently when only one object exists, or that restrict the instantiation to a certain number of objects.
Example:
Window managers, print spoolers, and filesystems are prototypical examples. Typically, those types of objects — known as singletons — are accessed by disparate objects throughout a software system, and therefore require a global point of access.
The Singleton design pattern addresses all of the above concerns.
With the Singleton design pattern you can:
- Ensure that only one instance of a class is created
- Provide a global point of access to the object
- Allow multiple instances in the future without affecting a singleton class’s clients
Another must read:
- Java: Union of Two Arrays using Java Collection Class
- How to iterate through Java List? 4 way to iterate through loop?
Here is a singleton design pattern example.
Simple Singleton Pattern: (Lazy Initialization + ThreadSafe with synchronized block)
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 |
package com.crunchify.tutorials; public class CrunchifySingleton { private static CrunchifySingleton instance = null; protected CrunchifySingleton() { } // Lazy Initialization (If required then only) public static CrunchifySingleton getInstance() { if (instance == null) { // Thread Safe. Might be costly operation in some case synchronized (CrunchifySingleton.class) { if (instance == null) { instance = new CrunchifySingleton(); } } } return instance; } } |
It is clear from the example that the traditional approach is not thread-safe, as it’s possible that before a thread creates the Singleton instance, another thread proceeds to the instantiation part of the code (i.e. instance = new Object();), because the condition instance == null is still true.
Auto ThreadSafe Singleton Pattern:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
package com.crunchify.tutorials; public class ThreadSafeSingleton { private static final Object instance = new Object(); protected ThreadSafeSingleton() { } // Runtime initialization // By defualt ThreadSafe public static Object getInstance() { return instance; } } |
Through this approach we provide the necessary thread-safety, as the Singleton instance is created at class-load time. Any subsequent calls to the getInstance() method will return the already created instance. Furthermore, the implementation is optimized as we’ve eliminated the need for checking the value of the Singleton instance, i.e. instance == null.
More Java Collection Examples: https://crunchify.com/category/java-tutorials/
Would love to know what you think. Chime in and share it as a comment. Don’t forget to share this guide!
A real thread-safe Singleton can be created using an internal static class that acts as an object Holder.
Check the example.
package it.example.singleton;
import java.io.Serializable;
public class SingletonExample implements Serializable{
private final static class StaticHolder{
public final static SingletonExample INSTANCE = new SingletonExample();
}
private SingletonExample(){
//Initialize class if needed
;
}
public static SingletonExample get(){
return StaticHolder.INSTANCE;
}
private Object readResolve() {
return StaticHolder.INSTANCE;
}
}