wanzismail/Kotlin-MVVM-Architecture

Android Architecture Design Patterns using Kotlin, MVVM, Dagger2, LiveData, Room, MediatorLiveData, NetworkBoundResources, Retrofit, AndroidX, ViewModels, Dependency Injection using Dagger2, Repository pattern.

Kotlin MVVM Architecture

A sample app that display list of Google news. The purpose of this project to illustrate the usage of MVVM architecture design pattern that follow the best practices of Object Oriented Design Patterns using the following technology stack.

1. Architeture Design Pattern
2. MVVM
3. Dagger2 (Dependency Injection)
4. Live Data, MediatorLiveData
5. Room Database
6. Retrofit
7. Unit Testing (Espresso), Mockito (Coming soon)
8. Repository Pattern
9. AndroidX
10. Glide
11. NetworkBoundResource, NetworkAndDBBoundResource
12. Google News API
13. JetPack Libraries

Architecture

NetworkBoundResource

Mediator LiveData

Dependencies used

  // Kotlin
implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlinVersion"

// Support Libraries
implementation 'com.android.support:design:28.0.0'
implementation 'androidx.appcompat:appcompat:1.1.0'
implementation "com.android.support.constraint:constraint-layout:$constraintLayoutVersion"

// Retrofit
implementation "com.squareup.retrofit2:retrofit:$retrofitVersion"
implementation "com.squareup.retrofit2:converter-gson:$retrofitVersion"
implementation "com.squareup.okhttp3:logging-interceptor:$okHttpVersion"
testImplementation "com.squareup.okhttp3:mockwebserver:$okHttpVersion"

// Lifecycle (ViewModel + LiveData)
implementation "androidx.lifecycle:lifecycle-extensions:$lifecycleVersion"
kapt "androidx.lifecycle:lifecycle-compiler:$lifecycleVersion"
implementation "android.arch.core:core-testing:$lifecycleVersion"

// Room
implementation "android.arch.persistence.room:runtime:$roomVersion"
kapt "android.arch.persistence.room:compiler:$roomVersion"
androidTestImplementation "android.arch.persistence.room:testing:$roomVersion"

// Glide
implementation "com.github.bumptech.glide:glide:$glideVersion"

// Dagger core
implementation "com.google.dagger:dagger:$dagger_version"
kapt "com.google.dagger:dagger-compiler:$dagger_version"

//Dagger Android
implementation "com.google.dagger:dagger-android:$dagger_version"
implementation "com.google.dagger:dagger-android-support:$dagger_version"
kapt "com.google.dagger:dagger-android-processor:$dagger_version"

//RxJava
implementation 'io.reactivex.rxjava2:rxandroid:2.1.1'
implementation "io.reactivex.rxjava2:rxjava:2.2.7"
implementation 'com.jakewharton.retrofit:retrofit2-rxjava2-adapter:1.0.0'

// Testing
testImplementation "junit:junit:$jUnitVersion"
androidTestImplementation("com.android.support.test.espresso:espresso-core:$espressoVersion", {
    exclude group: 'com.android.support', module: 'support-annotations'
})

Other samples of MVVM using Kotlin

• View-ViewModel-Interaction - Sample shows View and ViewModel Interaction/Communication.
• Communication-ActivityFragment-ViewModel - Sample shows communication between Activity and Fragment using ViewModel
• ViewModel-ViewModel-Communication - Sample shows communication between ViewModels
• LocationUpdates-LiveData-ViewModel - Sample shows, to get location updates as LiveData in Kotlin.
• Kotlin-MVVM-Architecture - Sample of complete MVVM Architecture using Dagger2, Kotlin, MediatorLiveData, Retrofit etc.

Author

Waheed Nazir

Sources

1. Google's official doc
2. Google's Codelab
3. Architecture Components Samples
4. Jose Alcérreca's post at Medium