The final word VIPER structure tutorial

Swift design patterns and iOS architectures

A software program design sample is mainly a generic template of easy methods to clear up a specific – however normally native – scenario. Achitectural patterns have greater affect on the entire codebase, they’re excessive degree generic templates. Please bear in mind one factor:

there isn’t a such factor as a foul structure

The weapon of choise solely is determined by the scenario, however you realize every thing is relative. Let’s stroll via all of the iOS design patterns and architectures actual fast and begin studying VIPER. 🐍

Swift design patterns

Let’s begin with the fundamentals, proper? If we do not get into UIKit, we will discover that there are various design patterns invented, perhaps you realize a few of them already. However hey, since we do not have that a lot time and I might like to speak about VIPER, let’s try the essential precept of constructing UIKit apps utilizing the MVC sample.

MVC

The Mannequin-View-Controller (Huge-View-Controller) sample is a primary idea. You’ve gotten normally an enormous UIViewController subclass that controls all of the views and collects each mannequin that wanted to be displayed for the tip person. For instance you name an API endpoint utilizing URLSession or Alamofire from the controller, do the response knowledge validation and formatting then you definately implement your desk or assortment view delegates on the view controller, so mainly all the applying logic goes inside that single overstuffed depressing view controller class. Does this ring a bell for you? 🙄

MVVM

After realizing the issue, the very first thing that you are able to do is outsourcing the information remodeling or binding half to a sepearate class. That is how the good individuals at Miscrosoft invented the Mannequin-View-ViewModel structure sample. Now you are one step nearer, your knowledge fashions and the views can have their “get collectively” on an entire new degree inside shiny new recordsdata far-far away from controller land. Nonetheless this sample won’t clear up all of the leftovers contained in the view controller. Do not forget that you continue to should feed the view controller with knowledge, deal with all of the totally different states.

MVP

What if we transfer out all the information loading and presentation stuff from the view controller and put it into a brand new class magically known as the Presenter? Sounds good, the view controller can personal the brand new presenter occasion and we will dwell fortunately ever after. C’mon individuals we must always actually rename this to the Most Priceless Sample ever! 😉

The Coordinator sample

Say hi there to The coordinator by Soroush Khanlou. Or ought to I merely name this because the Inverse Mannequin View Presenter sample? Look, right here is the deal, coordinators are on an entire new degree within this evolution progress, however additionally they have an excessive amount of to do. It is towards the Single Duty precept, as a result of now you need to handle the presentation context, the information storage, the routing and all of the differnet states inside coordinators or sub-coordinators… however, lastly your view controller is free from all of the leftover baggage and it might focus straight on it is job, which is? 🙃

To be fucking dumb.

Presenting views utilizing UIKit associated stuff, and forwarding occasions.

I do not hate the design patters from above, I am simply merely attempting to level out (in a humorous / sarcastic means) why VIPER was born on the primary place. 😅

Are you continue to with me? 😬

The VIPER structure

To start with DO NOT imagine that VIPER is dangerous, simply because somebody misused it. I feel it is a freaking wonderful structure! You simply should study it correctly, which is difficult, due to the dearth of fine tutorials. Everyone seems to be evaluating architectures, however that is not what individuals ought to do. So far as I can see, an MVP is sweet for a small app with just a few screens, you must by no means use VIPER for these apps. The true drawback begins in case you app grows and increasingly elements get into the sport.

If you’re planning to write down a small app, simply begin with MVC. In a while you’ll be able to repair the huge view controller drawback with MVVM, however if you wish to take it one degree additional you’ll be able to at all times use MVP or the coordinator sample to maintain maintainability. Which is totally tremendous, till you notice sooner or later that your code is filled with utility courses, managers, handlers and all of the nonsense objects. Sounds acquainted? 😅

As I discussed this earlier than there isn’t a such factor as a foul structure. There are solely dangerous selections, which lead us to hardly maintainable codebases. So let me information you thru probably the most helpful design sample that you’re going to ever wish to know so as to write truely scalable iOS purposes: VIPER with module builders = VIPER(B)

Understanding VIPER

The VIPER structure relies on the only accountability precept (S.O.L.I.D.)) which leads us to the idea of a clear structure. The core elements or as an example layers of a VIPERB module are the next ones:

View

It is the interface layer, which implies UIKit recordsdata, largely UIViewController subclasses and all the opposite stuff. Views do not do something that is associated to enterprise logic, the’re only a presentation and occasion forwarding layer which is utilized by the presenter. As a result of the view is only a pure view controller, you should use MVVM rules or knowledge managers to make your challenge much more concise.

Interactor

The interactor is accountable for retrieving knowledge from the mannequin layer, and its implementation is totally unbiased of the person interface. It is vital to do not forget that knowledge managers (community, database, sensor) aren’t a part of VIPER, so they’re handled as separate elements (providers), coming outdoors from the VIPER module land and they are often injected as dependencies for interactors.

The Interactor can put together or rework knowledge, that is coming from the service layer. For instance it might do some sorting or filtering earlier than asking the right community service implementation to request or save the information. However do not forget that the Interactor doesn’t know the view, so it has no concept how the information must be ready for the view, that is the function of the Presenter. 🙄

Presenter

UIKit unbiased class that prepares the information within the format required by the view and take selections based mostly on UI occasions from the view, that is why typically it is referred as an occasion handler. It is the core class of a VIPER module, as a result of it additionally communicates with the Interactor and calls the router for wire-framing (aka. to current a brand new module or dismiss the present one).

It is the one class that communicates with virtually all the opposite elements. That is the ONLY job of the presenter, so it shouldn’t know something about UIKit or low degree knowledge fashions. Principally it is the guts of the applying, or some would say it is the place the place all of the enterprise logic will get applied. 💜

Entity

Plain mannequin courses used largely by the interactor. Often I am defining them outdoors the VIPER module construction (within the service layer), as a result of these entities are shared throughout the system. We may separate them by module, however normally I do not like that strategy as a result of eg. all of the CoreData fashions might be generated into one place. Similar factor applies in case you are utilizing Swagger or the same software.

Router

The navigation logic of the applying utilizing UIKit courses. For instance in case you are utilizing the identical iPhone views in a iPad software, the one factor which may change is how the router builds up the construction. This lets you preserve every thing else, however the Router untouched. It additionally listens for navigation stream adjustments from the presenter, so it will show the right display screen if wanted. Additionally if you must open an exterior URL name UIApplication.shared.openURL(url) contained in the Router as a result of that is additionally a routing motion, the identical logic applies for social media sharing utilizing UIActivityViewController.

Additionally if you need to cross knowledge between VIPER modules it seems like a proper place to do that within the router. I normally talk between two module utilizing a delegate sample, so I picked up this behavior of calling delegate features within the router. 📲

Builder

Some persons are utilizing the router to construct the entire module, however I do not like that strategy. That is why I am at all times utilizing a separate module builder class. It is solely accountability is to construct the whole module through the use of dependency injection for all of the extenal providers. It may additionally construct mock or different variations of the identical module. That is fairly useful if it involves unit testing. Completely is sensible. 👍

NOT every thing is a VIPER module

For instance if you wish to create a generic subclass from a UIViewWhatever please do not attempt to stuff that into the elements above. You need to create a spot outdoors your VIPER modules folder and put it there. There shall be some use instances with particular courses which might be higher to not be VIPERized! 😉

Companies and software particular code

I normally have 3 separate layers in my purposes. Modules, providers, and app. All of the VIPER modules are sitting contained in the Modules folder. Every part that is community or knowledge associated goes to the Companies folder (api service, core knowledge service, location service, and so forth.) and in a while will get used within the module builder relying the present surroundings (for instance mock implementation for testing). All of the remaining stuff like view subclassess, and different UI associated objects, app particular styling or design clever issues are positioned contained in the App listing.

How you can write VIPER code?

I can not emphase sufficient how vital is to study this structure earlier than you begin utilizing it. I imagine that issues can go actual dangerous if somebody misunderstands VIPER and begin placing view logic in a presenter for instance. Should you had a earlier dangerous expertise with VIPER, take into consideration this quote: do not blame the software, blame the carpenter (simply as Ilya Puchka correctly mentioned on a twitter dialog). 🔨

Each single element will simply get into the fitting place in case you observe the principles of VIPER.

Module technology

By no means begin to create a VIPER module by hand, you must at all times use a code generator, as a result of (sadly) you may want numerous boilerplate code for every module. That appears fairly unlucky at first sight, however that is what provides the true energy of this structure. All members of your developer group will know the place to search for if a selected subject happens. If it is a view subject, you need to repair the view, if it involves a navigation drawback then it is a router drawback.

There are lots of current code generator options (one of many famoust is generamba), however I made my very own little Swift software for producing VIPER modules. It is fairly rattling light-weight, nevertheless it’s actually heplful (it makes use of templates so as to generate a brand new module) i am calling it: VIPERA. (Hungarian identify of the viper snake… haha 😂)

You simply should clone / obtain the repository & run swift run set up --with-templates so as to make it work. Any more you’ll be able to merely run vipera MyModule to generate a brand new module based mostly on the default template. As a second argument you’ll be able to cross your individual template listing identify (you’ll be able to create your individual template beneath the ~/.vipera folder, or you’ll be able to change the default one too).

The anatomy of the bottom template is fairly easy, I am not creating subfolders for every layer, however I am separating the interfaces and the default implementation elsewhere. That provides me a little bit little bit of sanity, as a result of a lot of the VIPER templates appeared to be very deterrent simply due to the challenge construction.

Naming conventions

Protocols are outlined for nearly each VIPER element. Each protocol shall be prefixed with the module identify, and it will not have another suffix besides from the layer identify (like MyModuleRouter, MyModulePresenter).

Default implementation is used for the essential situation, each protocol implementation follows the ModuleName+Default+Layer naming conference. So for instance MyModuleDefaultRouter or MyModuleDefaultPresenter.

Inter-module communication utilizing delegates

The stream is one thing like this:

Router / Presenter

The presenter can ship occasions for the router utilizing the router protocol definition.

Presenter / Interactor

The interactor can notify the presenter via the presenter’s interface, and the presenter can name the interactor utilizing the outlined strategies contained in the interactor protocol.

Presenter / View

The view normally has setter strategies to replace it is contents outlined on the view protocol. It may additionally notify the presenter of incoming or load occasions via the presenter protocol.

Knowledge switch between modules

Think about a listing, you choose an merchandise and go to a brand new controller scene. You need to cross a minimum of a novel indentifier between VIPER modules to make this doable.

It is normally completed considerably like this:

• The view calls the didSelect technique on the presenter with the id
• The presenter forwards the id to the router utilizing the routeFor(id) technique
• The router calls the builder to construct a brand new module utilizing the id
• The builder builds the brand new module utilizing the id
• The router presents the brand new module utilizing it is view (controller)
• The brand new module passes the id for everybody who wants it (router, presenter)
• The brand new module’s presenter will get the id
• The brand new module’s interactor hundreds the information and offers it for the presenter
• The brand new module’s presenter provides the information for the view and presents it
• Element display screen seems with correct knowledge.

If you’re presenting a controller modally you may also cross the unique router as a delegate, so you can shut it correctly if it is wanted. 😎

Reminiscence administration

Lengthy story quick:

• The builder holds noone.
• The router retains a weak reference of the view and the presenter.
• The presenter holds the router and the interactor strongly
• The interactor retains a weak refernece of the presenter
• The view retains a robust refernece of the presenter
• UIKit holds the views.

You need to verify this within the supplied instance, no leaks – I hope so – every thing will get launched good and easily after you return or dismiss a module. 🤞

Remaining conclusion: ought to I study VIPER?

Though VIPER is very criticized due to it is complexity, all I can say it is well worth the effort to study its priciples correctly. You will see that there are far more advantages of utilizing VIPER as an alternative of ignoring it.

Benefits

• Simplicity – for big groups on advanced initiatives
• Scalability – simultaneous work seamlessly
• Reusability – decoupled app elements based mostly on roles
• Consistency – module skeletons, separation of issues
• Readability – Single tasks (SOLID)
• Testability – separated small courses, TDD, higher code protection
• Interfaces – module independence, effectively outlined scopes
• Bug fixing – simpler to trace points, find bugs and issues
• Supply management – smaller recordsdata, much less conflicts, cleaner code
• Simple – codebase seems to be comparable, quicker to learn others work

Drawbacks

• Verbosity – many recordsdata per module
• Complexity – many protocols and delegates
• On-boarding – lack of correct VIPER data
• Engagement – VIPER is dangerous, as a result of it is advanced, meh!

I made a follow-up article about VIPER greatest practices that I’ve study alongside the journey, you will discover the pattern repository on github. I hope that these tutorials will enable you to study this structure higher, when you have any questions, be happy to contact me on twitter. 👨‍💻