Skip to content

hamzaahmedkhan/android-mvi-architecture-kotlin

 
 

Repository files navigation

Bazaar Android Architecture Template

Bazaar's Android Architecture

What is MVI

Like MVC, MVP or MVVM, MVI is an architectural design pattern that helps us better organize our code to create robust and maintainable applications. It is in the same family as Flux or Redux and was first introduced by André Medeiros. This acronym is formed by the contraction of the words Model, View and Intent.

Concept reference resources

The app has following purpose:

This application is a template repository for Android Application in "Bazaar Technologies". So whenever we want to create a new application from scratch we can create repository using this template.
We need to change package name
We need to add tokens, base url and other static content if needed
We need to replace google-services.json file with new Firebase project (If you are not using firebase, then remove its code)

Repository Model:

[RepoManager] -> [Repo Layers] -> [Service Layers] -> [Backend APIs]
[RepoManager] -> [Repo Layers] -> [Service Layers] -> [DataBase]
[RepoManager] -> [Repo Layers] -> [SharePreference]

Multiple Backend
Hide Repo, Service, DB, Backend layers from View and ViewModel. View has no knowledge whether we are storing data in Shared preference or calling api Documentation Easy

All layers are interfaces, so multiple implementations
Mock implementation can easily be made for integration testing

Why Manager:
View Model will doesn't have to know about repo layers and further.
Will help in converting it into SDK
If we remove any repo layer, No effects on ViewModel

Why Repo Layer:
Repo layer can integrate multiple services in it.
Remapping of data is easy

Why Service Layer:
To hide backend layer from Repo Layers
Single responsibility for each service
No data manipulation and mapping

Objectives

We set off with the objective of creating a minimalistic template, simple yet with all the capabilities you need.

Simple

The library introduces few - if any - new concepts outside MVI, Kotlin coroutines, and Kotlin flows.

If you are familiar with those concepts, you can start using the library without a problem; if you are new to some of these concepts, you will be able to apply those concepts outside this library too.

Coroutines and flows as powerful abstractions

We believe that coroutines and flows are extremely powerful concepts that can be applied to the MVI architecture. They enable us to build a very powerful API with a small and simple surface.

Here are some advantages that they bring:

  • Coroutines make asynchronous calls very simple to write and easy to reason about;

  • Flows are a great abstraction to represent user events (clicks) and updates from background work;

  • Coroutine scopes make handling the lifecycle of requests very simple

Inspiration

This library got a lot of inspiration from other libraries. We would like to thank:

If this project helps you in anyway, show your love ❤️ by putting a ⭐ on this project ✌️ ........ ALSO FEEL FREE TO FORK AND CONTRIBUTE!!

About

Bazaar's MVI Architecture Kotlin

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Kotlin 99.9%
  • Java 0.1%