cd2a2e7711
* Moves saga to Java 11 * Moves semaphore to Java 11 * Moves servant to Java 11 * Moves serverless to Java 11 * Moves service-layer to Java 11 * Moves service-locator to Java 11 * Moves sharding to Java 11 * Moves singleton to Java 11 * Moves spatial-partition to Java 11 * Moves specification to Java 11 * Moves state to Java 11 * Moves step-builder to Java 11 * Moves strategy to Java 11 * Moves subclass-sandbox to Java 11 * Fixes checkstyle issues
82 lines
2.6 KiB
Markdown
82 lines
2.6 KiB
Markdown
---
|
|
layout: pattern
|
|
title: Singleton
|
|
folder: singleton
|
|
permalink: /patterns/singleton/
|
|
categories: Creational
|
|
tags:
|
|
- Gang of Four
|
|
---
|
|
|
|
## Intent
|
|
Ensure a class only has one instance, and provide a global point of
|
|
access to it.
|
|
|
|
|
|
## Explanation
|
|
Real world example
|
|
|
|
> There can only be one ivory tower where the wizards study their magic. The same enchanted ivory tower is always used by the wizards. Ivory tower here is singleton.
|
|
|
|
In plain words
|
|
|
|
> Ensures that only one object of a particular class is ever created.
|
|
|
|
Wikipedia says
|
|
|
|
> In software engineering, the singleton pattern is a software 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.
|
|
|
|
**Programmatic Example**
|
|
|
|
Joshua Bloch, Effective Java 2nd Edition p.18
|
|
|
|
> A single-element enum type is the best way to implement a singleton
|
|
|
|
```java
|
|
public enum EnumIvoryTower {
|
|
INSTANCE;
|
|
}
|
|
```
|
|
|
|
Then in order to use
|
|
|
|
```java
|
|
var enumIvoryTower1 = EnumIvoryTower.INSTANCE;
|
|
var enumIvoryTower2 = EnumIvoryTower.INSTANCE;
|
|
assertEquals(enumIvoryTower1, enumIvoryTower2); // true
|
|
```
|
|
|
|
## Class diagram
|
|
|
|
|
|
## Applicability
|
|
Use the Singleton pattern when
|
|
|
|
* There must be exactly one instance of a class, and it must be accessible to clients from a well-known access point
|
|
* When the sole instance should be extensible by subclassing, and clients should be able to use an extended instance without modifying their code
|
|
|
|
## Typical Use Case
|
|
|
|
* The logging class
|
|
* Managing a connection to a database
|
|
* File manager
|
|
|
|
## Real world examples
|
|
|
|
* [java.lang.Runtime#getRuntime()](http://docs.oracle.com/javase/8/docs/api/java/lang/Runtime.html#getRuntime%28%29)
|
|
* [java.awt.Desktop#getDesktop()](http://docs.oracle.com/javase/8/docs/api/java/awt/Desktop.html#getDesktop--)
|
|
* [java.lang.System#getSecurityManager()](http://docs.oracle.com/javase/8/docs/api/java/lang/System.html#getSecurityManager--)
|
|
|
|
|
|
## Consequences
|
|
|
|
* Violates Single Responsibility Principle (SRP) by controlling their own creation and lifecycle.
|
|
* Encourages using a global shared instance which prevents an object and resources used by this object from being deallocated.
|
|
* Creates tightly coupled code. The clients of the Singleton become difficult to test.
|
|
* Makes it almost impossible to subclass a Singleton.
|
|
|
|
## Credits
|
|
|
|
* [Design Patterns: Elements of Reusable Object-Oriented Software](http://www.amazon.com/Design-Patterns-Elements-Reusable-Object-Oriented/dp/0201633612)
|
|
* [Effective Java (2nd Edition)](http://www.amazon.com/Effective-Java-Edition-Joshua-Bloch/dp/0321356683)
|