Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hmlongco/Resolver

Swift Ultralight Dependency Injection / Service Locator framework
https://github.com/hmlongco/Resolver

Last synced: 10 days ago
JSON representation

Swift Ultralight Dependency Injection / Service Locator framework

Awesome Lists containing this project

README 

        
# Resolver ![icon](https://user-images.githubusercontent.com/709283/32858974-cce8282a-ca12-11e7-944b-c8046156290b.png)



An ultralight Dependency Injection / Service Locator framework for Swift 5.x on iOS.



**Note: Resolver is now officially deprecated and replaced by my new dependency injection system, [Factory](https://github.com/hmlongco/Factory). Factory is a true container-based dependency injection system that's compile-time safe and is smaller, lighter, and faster than Resolver. As good as Resolver is, Factory is better.**



## Introduction



Dependency Injection frameworks support the [Inversion of Control](https://en.wikipedia.org/wiki/Inversion_of_control) design pattern. Technical definitions aside, dependency injection pretty much boils down to:



| **Giving an object the things it needs to do its job.**



That's it. Dependency injection allows us to write code that's loosely coupled, and as such, easier to reuse, to mock, and  to test.



For more, see: [A Gentle Introduction to Dependency Injection.](./Documentation/Introduction.md)



## Dependency Injection Strategies



There are six classic dependency injection strategies:



1. [Interface Injection](./Documentation/Injection.md#interface)

2. [Property Injection](./Documentation/Injection.md#property)

3. [Constructor Injection](./Documentation/Injection.md#constructor)

4. [Method Injection](./Documentation/Injection.md#method)

5. [Service Locator](./Documentation/Injection.md#locator)

6. [Annotation](./Documentation/Injection.md#annotation) (NEW)



Resolver supports them all. Follow the links for a brief description, examples, and the pros and cons of each.



## Property Wrappers



Speaking of Annotations, Resolver now supports resolving services using the new property wrapper syntax in Swift 5.1.



```swift

class BasicInjectedViewController: UIViewController {

    @Injected var service: XYZService

    @LazyInjected var service2: XYZLazyService

    @WeakLazyInjected var service3: XYZAnotherLazyService?

}

```

Just add the Injected keyword and your dependencies will be resolved automatically. See the [Annotation](./Documentation/Annotation.md) documentation for more on this and other strategies.



There's also an `@InjectedObject` wrapper that can inject Observable Objects in SwiftUI views.



## Features



Resolver is implemented in just over 700 lines of actual code in a single file, but it packs a ton of features into those 700 lines.



* [Automatic Type Inference](./Documentation/Types.md)

* [Scopes: Application, Cached, Graph, Shared, and Unique](./Documentation/Scopes.md)

* [Protocols](./Documentation/Protocols.md)

* [Optionals](./Documentation/Optionals.md)

* [Named Instances](./Documentation/Names.md) (Resolver 1.3 now supports safe name spaces!)

* [Argument Passing](./Documentation/Arguments.md) (Resolver 1.2 now has built in support for multiple arguments!)

* [Custom Containers & Nested Containers](./Documentation/Containers.md)

* [Cyclic Dependency Support](./Documentation/CyclicDependencies.md)

* [Storyboard Support](./Documentation/Storyboards.md)



TLDR: If nothing else, make sure you read about [Automatic Type Inference](./Documentation/Types.md), [Scopes](./Documentation/Scopes.md), and [Optionals](./Documentation/Optionals.md).



## Using Resolver



Using Resolver is a simple, three-step process:



1. [Add Resolver to your project.](./Documentation/Installation.md)

2. [Register the classes and services your app requires.](./Documentation/Registration.md)

3. [Use Resolver to resolve those instances when needed.](./Documentation/Resolving.md)



## Why Resolver?



As mentioned, Resolver is an ultralight Dependency Injection system, implemented in just over 700 lines of code and contained in a single file.



Resolver is also designed for performance. [SwinjectStoryboard](https://github.com/Swinject/SwinjectStoryboard), for example, is a great dependency injection system, but Resolver clocks out to be about 800% faster at resolving dependency chains than Swinject.



And unlike some other systems, Resolver is written in 100% Swift 5, with no Objective-C code, method swizzling, or internal dependencies on the Objective-C runtime.



Further, Resolver:



* Is tested in production code.

* [Is thread safe (assuming your objects are thread safe).](./Documentation/Threads.md) (Updated in 1.4.)

* Has a complete set of unit tests.

* Is well-documented.



Finally, with  [Automatic Type Inference](./Documentation/Types.md) you also tend to write about 40-60% less dependency injection code using Resolver.



## Installation



Resolver supports CocoaPods and the Swift Package Manager.

```swift

pod "Resolver"

```

Resolver itself is just a single source file (Resolver.swift), so it's also easy to simply download the file and add it to your project.



Note that the current version of Resolver (1.4) supports Swift 5.3 and that the minimum version of iOS currently supported with this release is iOS 11.



Read the [installation guide](./Documentation/Installation.md) for information on supporting earlier versions.



## Demo Application



I've made my [Builder](https://github.com/hmlongco/Builder) repositiory public. It's a simple master/detail-style iOS application that contains examples of...



1. Using the Resolver dependency injection system to construct MVVM architectures.

2. Using Resolver to mock user data for application development.

3. Using Resolver to mock user data for unit tests.



I also use it to play with some new code that uses SwiftUI-style builder patterns to constructing the user interface construction and to construct network requests. Check it out.



## Resolver Update Notes



It's possible that recent updates to Resolver could cause breaking changes in your code base.



* Resolver 1.4 improved thread safety and performance. No breaking changes, though accessing Resolver's scopes directly is now deprecated. See: [Scopes](./Documentation/Scopes.md).



* Resolver 1.3 adds Name spaces to Resolver. Registering names allows for better autocompletion and makes your code safer by reducing potential runtime evaluation errors. This is a possible breaking change.  See: [Named Instances](./Documentation/Names.md)



* Resolver 1.2 changed how arguments are passed to the registration factory in order to provide better support for passing and handling both single and multiple arguments. This is a breaking change. See: [Passing and Handling Multiple Arguments](./Documentation/Arguments.md#multiple)



* Resolver 1.5 updated several of the registration and caching mechanisms used within Resolver. This one probably isn't an issue unless you wrote something that depended upon Resolver's internal behavior.



## Sponsor Resolver



If you want to support my work on Factory and Resolver, consider a [GitHub Sponsorship](https://github.com/sponsors/hmlongco)! Many levels exist for increased support and even for mentorship and company training. 



Or you can just buy me a cup of coffee!



## Author



Resolver is designed, implemented, documented, and maintained by [Michael Long](https://www.linkedin.com/in/hmlong/), a Lead iOS Software Engineer and a Top 1,000 Technology Writer on Medium.



* LinkedIn: [@hmlong](https://www.linkedin.com/in/hmlong/)

* Medium: [@michaellong](https://medium.com/@michaellong)

* Twitter: @hmlco



Michael was also one of Google's [Open Source Peer Reward](https://opensource.googleblog.com/2021/09/announcing-latest-open-source-peer-bonus-winners.html) winners in 2021 for his work on Resolver.



## License



Resolver is available under the MIT license. See the LICENSE file for more info.



## Additional Resouces



* [Factory: A Swift Dependency Injection System](https://github.com/hmlongco/Factory)

* [Resolver for iOS Dependency Injection: Getting Started | Ray Wenderlich](https://www.raywenderlich.com/22203552-resolver-for-ios-dependency-injection-getting-started)

* [API Documentation](./Documentation/API/Classes/Resolver.html)

* [Inversion of Control Design Pattern ~ Wikipedia](https://en.wikipedia.org/wiki/Inversion_of_control)

* [Inversion of Control Containers and the Dependency Injection pattern ~ Martin Fowler](https://martinfowler.com/articles/injection.html)

* [Nuts and Bolts of Dependency Injection in Swift](https://cocoacasts.com/nuts-and-bolts-of-dependency-injection-in-swift/)

* [Dependency Injection in Swift](https://cocoacasts.com/dependency-injection-in-swift)

* [SwinjectStoryboard](https://github.com/Swinject/SwinjectStoryboard)

* [Swift 5.1 Takes Dependency Injection to the Next Level](https://medium.com/better-programming/taking-swift-dependency-injection-to-the-next-level-b71114c6a9c6)

* [Builder Demo Application](https://github.com/hmlongco/Builder)[ (Now uses Factory)](https://github.com/hmlongco/Factory)