<p>If you want to create a modular system for your code, managing dependencies can become an issue. It’s a key point of your design. It&#8217;s crucial to decouple dependencies when developing Swift / iOS projects. Your code will be more readable, reliable, testable and of course modular. In this article, we&#8217;ll look at how to decouple dependencies in an iOS project.</p>
<h2>What is a dependency anyway?</h2>
<p>Dependency is what makes your specific code blocks dependent on other code blocks. So, your code depends on another part of your project to work properly. These dependencies can be <strong>3rd party libraries/frameworks</strong>, <strong>manager classes</strong>, <strong>some modules you create (SPM)</strong>, etc.</p>
<h2>How to make our code independent of other parts of the code base?</h2>
<p>As SOLID’s last principle “Dependency Inversion” suggest, “Classes should depend upon <strong>interfaces</strong> or <strong>abstract classes</strong> instead of concrete classes and functions.” So, the key is <strong>Abstraction</strong> here.</p>
<p>In Swift, we can define and confirm a <strong>Protocol</strong> to make a class abstract. This hides the target class’s implementation details and logic from other classes. Other classes only now what our class is capable of.</p>
<h2>Sample Project</h2>
<p>We will develop a sample project to make the topic we have covered in this article more detailed and understandable. You can find the source code <a href="https://github.com/Bugrayenidunya/Decoupling-Dependencies-Swift" target="_blank" rel="noopener nofollow">here</a>.</p>
<div id="attachment_3513" style="width: 684px" class="wp-caption aligncenter"><img aria-describedby="caption-attachment-3513" class="wp-image-3513 size-full" src="https://ac.appcircle.io/wp-content/uploads/2022/08/1EFMNMtxY-jPLS3sCDbWg0A.png" alt="Sample Project’s Folder Structure" width="674" height="660" srcset="https://ac.appcircle.io/wp-content/uploads/2022/08/1EFMNMtxY-jPLS3sCDbWg0A.png 674w, https://ac.appcircle.io/wp-content/uploads/2022/08/1EFMNMtxY-jPLS3sCDbWg0A-300x294.png 300w, https://ac.appcircle.io/wp-content/uploads/2022/08/1EFMNMtxY-jPLS3sCDbWg0A-36x36.png 36w" sizes="(max-width: 674px) 100vw, 674px" /><p id="caption-attachment-3513" class="wp-caption-text">Project’s Folder Structure</p></div>
<p>You&#8217;ll find two folders named “Coupled” and “Decoupled”. These determine the 2 stages of the project as their names explain. Under the “Decoupled” folder you will see “ProtocolBases” and “AdapterBased” folders. These contain 2 different approaches to the decoupling dependencies.</p>
<h2>Coupled Stage</h2>
<p>Now we are demonstrating two classes that are <strong>tightly coupled</strong> with each other. How are they tightly coupled in the first place? Well, the API class is initialized and used inside a ViewController directly. That means they are referencing each other and our ViewController is not able to work with API class at different modules. ViewController is knowing what exactly the implementation of the API class and we do not want it.</p>
<div id="attachment_3514" style="width: 640px" class="wp-caption aligncenter"><img aria-describedby="caption-attachment-3514" class="size-full wp-image-3514" src="https://ac.appcircle.io/wp-content/uploads/2022/08/1MoEIvcGACnW2vI33M4jZqg.png" alt="A API class that initialized by a ViewController directly." width="630" height="175" srcset="https://ac.appcircle.io/wp-content/uploads/2022/08/1MoEIvcGACnW2vI33M4jZqg.png 630w, https://ac.appcircle.io/wp-content/uploads/2022/08/1MoEIvcGACnW2vI33M4jZqg-300x83.png 300w" sizes="(max-width: 630px) 100vw, 630px" /><p id="caption-attachment-3514" class="wp-caption-text">A API class that initialized by a ViewController directly.</p></div>
<div id="attachment_3515" style="width: 415px" class="wp-caption aligncenter"><img aria-describedby="caption-attachment-3515" class="size-full wp-image-3515" src="https://ac.appcircle.io/wp-content/uploads/2022/08/1xShIzd6dDyAw_S4ym9gK1g.png" alt="A ViewController that initializes a API class inside itself." width="405" height="242" srcset="https://ac.appcircle.io/wp-content/uploads/2022/08/1xShIzd6dDyAw_S4ym9gK1g.png 405w, https://ac.appcircle.io/wp-content/uploads/2022/08/1xShIzd6dDyAw_S4ym9gK1g-300x179.png 300w" sizes="(max-width: 405px) 100vw, 405px" /><p id="caption-attachment-3515" class="wp-caption-text">A ViewController that initializes a API class inside itself.</p></div>
<p>What should we do to avoid creating tightly coupled classes? We will cover 2 different approaches in this article but of course, there are other good approaches.</p>
<h2>Decoupled Stage — Protocol Based Approach</h2>
<p>We will create an <strong>abstraction</strong> and <strong>Swift Protocols</strong> are the perfect fit for that purpose. Now our ViewContoller does not have any idea about the implementation details of an API class. This is what we achieve and we successfully <strong>decoupled</strong> these into classes by creating Protocol.</p>
<div id="attachment_3516" style="width: 639px" class="wp-caption aligncenter"><img aria-describedby="caption-attachment-3516" class="size-full wp-image-3516" src="https://ac.appcircle.io/wp-content/uploads/2022/08/1zLEfUPNdYLmPV1Gx1vef7g.png" alt="A Abstracted API class via Protocol." width="629" height="262" srcset="https://ac.appcircle.io/wp-content/uploads/2022/08/1zLEfUPNdYLmPV1Gx1vef7g.png 629w, https://ac.appcircle.io/wp-content/uploads/2022/08/1zLEfUPNdYLmPV1Gx1vef7g-300x125.png 300w" sizes="(max-width: 629px) 100vw, 629px" /><p id="caption-attachment-3516" class="wp-caption-text">A Abstracted API class via Protocol.</p></div>
<div id="attachment_3517" style="width: 458px" class="wp-caption aligncenter"><img aria-describedby="caption-attachment-3517" class="size-full wp-image-3517" src="https://ac.appcircle.io/wp-content/uploads/2022/08/1VJ80OUv25y73TIrlxYp7bQ.png" alt="A ViewController that implements abstracted API class" width="448" height="429" srcset="https://ac.appcircle.io/wp-content/uploads/2022/08/1VJ80OUv25y73TIrlxYp7bQ.png 448w, https://ac.appcircle.io/wp-content/uploads/2022/08/1VJ80OUv25y73TIrlxYp7bQ-300x287.png 300w" sizes="(max-width: 448px) 100vw, 448px" /><p id="caption-attachment-3517" class="wp-caption-text">A ViewController that implements abstracted API class</p></div>
<p>Now we have flexibility with our implementation. We can test our API class using mocks, fakes, stubs, etc. whatever it needs. We can extend our API class with new functionalities without breaking our ViewController implementation. Small but effective change made.</p>
<h2>Decoupled Stage — Adapter Based Approach</h2>
<p>Imagine that we are dealing with 2 different Databases or let’s say data stores. One of them is remote running <strong>REST API</strong> service and another one is <strong>local cache storage</strong>. With our previous implementation, we are not able to switch smoothly between two data stores. But if we create a <strong>middle layer</strong> between ViewController and target data stores, in this case, our API class, we can switch one to another or we can implement both of them at the same time without breaking two separate implementations.</p>
<div id="attachment_3518" style="width: 565px" class="wp-caption aligncenter"><img aria-describedby="caption-attachment-3518" class="size-full wp-image-3518" src="https://ac.appcircle.io/wp-content/uploads/2022/08/1YW1DC-iz_4k6PJBMSzTnqQ.png" alt="A Adapter class that connects any kind of data store with given ViewController." width="555" height="428" srcset="https://ac.appcircle.io/wp-content/uploads/2022/08/1YW1DC-iz_4k6PJBMSzTnqQ.png 555w, https://ac.appcircle.io/wp-content/uploads/2022/08/1YW1DC-iz_4k6PJBMSzTnqQ-300x231.png 300w" sizes="(max-width: 555px) 100vw, 555px" /><p id="caption-attachment-3518" class="wp-caption-text">A Adapter class that connects any kind of data store with given ViewController.</p></div>
<div id="attachment_3519" style="width: 545px" class="wp-caption aligncenter"><img aria-describedby="caption-attachment-3519" class="size-full wp-image-3519" src="https://ac.appcircle.io/wp-content/uploads/2022/08/1F2YfiW41i_3n0baQspjmlA.png" alt="A ViewContoller that uses Adapter implementation." width="535" height="395" srcset="https://ac.appcircle.io/wp-content/uploads/2022/08/1F2YfiW41i_3n0baQspjmlA.png 535w, https://ac.appcircle.io/wp-content/uploads/2022/08/1F2YfiW41i_3n0baQspjmlA-300x221.png 300w" sizes="(max-width: 535px) 100vw, 535px" /><p id="caption-attachment-3519" class="wp-caption-text">A ViewContoller that uses Adapter implementation.</p></div>
<p>This way, our ViewController does not care about which data store it’s connected to and does not know about implementation details. Flexible and testable abstracted implementation. Now we have fully decoupled classes and indeed managed dependencies.</p>
<h2>Conclusion</h2>
<p>I gave a brief demonstration on how to decouple dependencies by making small but effective changes. There are two considerations to have when managing dependencies in your project, abstraction and protocol-oriented programming. You can also explore various implementations by doing more detailed analyses and research on these topics.</p>


How to Decouple Dependencies in Swift / iOS Projects

Related Posts

Speed Up your Release Process with Appcircle’s Azure Bot for SwiftLint and Detekt

WWDC23: Meet mergeable libraries

WWDC23: Meet Push Notifications Console

WWDC23: Meet SwiftData

How to Decouple Dependencies in Swift / iOS Projects

Related Posts

Speed Up your Release Process with Appcircle’s Azure Bot for SwiftLint and Detekt

WWDC23: Meet mergeable libraries

WWDC23: Meet Push Notifications Console

WWDC23: Meet SwiftData

Subscribe to Appcircle Circle