Using a dispatch_once singleton model in Swift

by

tl;dr: Use the class constant approach if you are using Swift 1.2 or above and the nested struct approach if you need to support earlier versions.

From my experience with Swift there are three approaches to implement the Singleton pattern that support lazy initialization and thread safety.

Class constant

class Singleton  {
   static let sharedInstance = Singleton()
}

This approach supports lazy initialization because Swift lazily initializes class constants (and variables), and is thread safe by the definition of let. This is now officially recommended way to instantiate a singleton.

Class constants were introduced in Swift 1.2. If you need to support an earlier version of Swift, use the nested struct approach below or a global constant.

Nested struct

class Singleton {
    class var sharedInstance: Singleton {
        struct Static {
            static let instance: Singleton = Singleton()
        }
        return Static.instance
    }
}

Here we are using the static constant of a nested struct as a class constant. This is a workaround for the lack of static class constants in Swift 1.1 and earlier, and still works as a workaround for the lack of static constants and variables in functions.

dispatch_once

The traditional Objective-C approach ported to Swift. I’m fairly certain there’s no advantage over the nested struct approach but I’m putting it here anyway as I find the differences in syntax interesting.

class Singleton {
    class var sharedInstance: Singleton {
        struct Static {
            static var onceToken: dispatch_once_t = 0
            static var instance: Singleton? = nil
        }
        dispatch_once(&Static.onceToken) {
            Static.instance = Singleton()
        }
        return Static.instance!
    }
}

See this GitHub project for unit tests.

More Related Contents:

  1. Singleton in Swift
  2. Any reason not use use a singleton “variable” in Swift?
  3. How To make Label like below image in swift
  4. Set operations in swift
  5. Swift 3 incorrect string interpolation with implicitly unwrapped Optionals
  6. How does String substring work in Swift
  7. SwiftUI – Half modal?
  8. Is there a way to set associated objects in Swift?
  9. Overriding superclass property with different type in Swift
  10. SHA256 in swift
  11. Using Decodable in Swift 4 with Inheritance
  12. Is it possible to add type constraints to a Swift protocol conformance extension?
  13. Accessing an Enumeration association value in Swift
  14. SwiftUI iterating through dictionary with ForEach
  15. Choosing CoreData Entities from form picker
  16. Iterate over collection two at a time in Swift
  17. unwrapping multiple optionals in if statement
  18. How do you use .enumerated() with ForEach in SwiftUI?
  19. How to improve People Occlusion in ARKit 3.0
  20. Noop for Swift’s Exhaustive Switch Statements
  21. Multiple functions with the same name
  22. Programmatically detect Tab Bar or TabView height in SwiftUI
  23. Value of type ‘StorageMetadata’ has no member ‘downloadURL’
  24. SwiftUI Drag and Drop files
  25. How to pass one SwiftUI View as a variable to another View struct
  26. How to access NSWindow from @main App using only SwiftUI?
  27. How to remove “row” separators/dividers from a List in SwiftUI?
  28. Self in init params
  29. How to convert a binary to decimal in Swift?
  30. Remove element from collection during iteration with forEach

Leave a Comment