Repository pattern in Android Kotlin

Introduction

The Repository pattern helps keep your app organized by separating data access from the rest of your code. It acts like a middleman between your app and data sources.

When you want to get data from different places like a database or the internet without mixing code.

When you want to make your app easier to test by isolating data logic.

When you want to change where data comes from without changing the app's main code.

When you want to keep your code clean and easy to understand.

When you want to handle caching data smoothly.

Syntax

Android Kotlin

interface UserRepository {
    suspend fun getUser(userId: String): User
}

class UserRepositoryImpl(
    private val remoteDataSource: RemoteDataSource,
    private val localDataSource: LocalDataSource
) : UserRepository {
    override suspend fun getUser(userId: String): User {
        // Implementation to get user from local or remote
        TODO("Not yet implemented")
    }
}

The repository is usually an interface with one or more implementations.

It hides where the data comes from, so the rest of the app just asks the repository.

Examples

Defines a repository interface for products.

Android Kotlin

interface ProductRepository {
    suspend fun getProducts(): List<Product>
}

Implements the repository to get products from an API.

Android Kotlin

class ProductRepositoryImpl(
    private val apiService: ApiService
) : ProductRepository {
    override suspend fun getProducts(): List<Product> {
        return apiService.fetchProducts()
    }
}

Repository implementation that checks local cache first, then fetches from API if needed.

Android Kotlin

class ProductRepositoryImpl(
    private val apiService: ApiService,
    private val localDb: ProductDao
) : ProductRepository {
    override suspend fun getProducts(): List<Product> {
        val cached = localDb.getAll()
        return if (cached.isNotEmpty()) cached else {
            val fresh = apiService.fetchProducts()
            localDb.insertAll(fresh)
            fresh
        }
    }
}

Sample App

This example shows a UserRepository that first tries to get a user from local cache. If not found, it fetches from remote and saves locally. The main function fetches the same user twice to show caching.

Android Kotlin

data class User(val id: String, val name: String)

interface UserRepository {
    suspend fun getUser(userId: String): User
}

class RemoteDataSource {
    suspend fun fetchUser(userId: String): User {
        return User(userId, "Remote User")
    }
}

class LocalDataSource {
    private val cache = mutableMapOf<String, User>()
    suspend fun getUser(userId: String): User? {
        return cache[userId]
    }
    suspend fun saveUser(user: User) {
        cache[user.id] = user
    }
}

class UserRepositoryImpl(
    private val remoteDataSource: RemoteDataSource,
    private val localDataSource: LocalDataSource
) : UserRepository {
    override suspend fun getUser(userId: String): User {
        val localUser = localDataSource.getUser(userId)
        if (localUser != null) {
            return localUser
        }
        val remoteUser = remoteDataSource.fetchUser(userId)
        localDataSource.saveUser(remoteUser)
        return remoteUser
    }
}

suspend fun main() {
    val remote = RemoteDataSource()
    val local = LocalDataSource()
    val repo = UserRepositoryImpl(remote, local)

    val user1 = repo.getUser("123")
    println("First fetch: ${user1.name}")

    val user2 = repo.getUser("123")
    println("Second fetch: ${user2.name}")
}

Important Notes

Use suspend functions for repository methods when working with coroutines.

Repository pattern helps you swap data sources easily without changing UI code.

Keep repository methods simple and focused on data retrieval or saving.

Summary

The Repository pattern separates data logic from UI and business logic.

It acts as a single source of truth for data in your app.

It makes your app easier to maintain, test, and extend.

Practice

1. What is the main purpose of the Repository pattern in Android Kotlin development?

easy

A. To separate data access logic from UI and business logic

B. To handle user interface animations

C. To manage app navigation between screens

D. To store UI layout XML files

Solution

1. Step 1: Understand the role of Repository

   The Repository pattern is designed to manage data operations and provide a clean API to the rest of the app.

2. Step 2: Identify separation of concerns

   It separates data handling from UI and business logic, making the app easier to maintain and test.

3. Final Answer:

   To separate data access logic from UI and business logic -> Option A

4. Quick Check:

   Repository pattern = separation of data logic [OK]

Hint: Repository separates data logic from UI logic [OK]

Common Mistakes:

• Confusing Repository with UI components
• Thinking Repository manages navigation
• Assuming Repository stores layout files

2. Which of the following is the correct way to declare a Repository interface in Kotlin?

easy

A. interface UserRepository { fun getUser(id: Int): User }

B. class UserRepository { fun getUser(id: Int): User }

C. fun UserRepository() { return User }

D. val UserRepository = object { fun getUser(id: Int): User }

Solution

1. Step 1: Identify interface syntax in Kotlin

   Interfaces in Kotlin are declared with the interface keyword followed by function signatures without bodies.

2. Step 2: Match the correct declaration

   interface UserRepository { fun getUser(id: Int): User } correctly declares an interface with a function signature. class UserRepository { fun getUser(id: Int): User } is a class, not an interface. Options A, B, and C have incorrect syntax.

3. Final Answer:

   interface UserRepository { fun getUser(id: Int): User } -> Option A

4. Quick Check:

   Interface declaration uses interface keyword [OK]

Hint: Interfaces use 'interface' keyword with function signatures [OK]

Common Mistakes:

• Using class instead of interface for Repository
• Incorrect function syntax inside interface
• Trying to instantiate interface directly

3. Given this Kotlin code snippet, what will be printed?

class UserRepository {
  fun getUserName(id: Int): String = if (id == 1) "Alice" else "Unknown"
}

fun main() {
  val repo = UserRepository()
  println(repo.getUserName(1))
  println(repo.getUserName(2))
}

medium

A. Unknown\nAlice

B. Alice\nUnknown

C. 1\n2

D. Alice\nAlice

Solution

1. Step 1: Analyze getUserName function logic

   The function returns "Alice" if id is 1, otherwise "Unknown".

2. Step 2: Trace the calls in main()

   Calling getUserName(1) returns "Alice". Calling getUserName(2) returns "Unknown".

3. Final Answer:

   Alice\nUnknown -> Option B

4. Quick Check:

   id==1 returns Alice, else Unknown [OK]

Hint: Check condition for id==1 to get 'Alice' [OK]

Common Mistakes:

• Mixing up return values for different ids
• Assuming both calls return 'Alice'
• Confusing id with returned string

4. Identify the error in this Repository implementation:

class UserRepository {
  fun getUser(id: Int): User {
    return User(id, name)
  }
}

Assuming name is not defined anywhere.

medium

A. User class is not imported

B. Missing return type for getUser function

C. Variable 'name' is undefined causing a compilation error

D. Function getUser should be abstract

Solution

1. Step 1: Check variables used in return statement

   The function returns User(id, name), but name is not declared or passed.

2. Step 2: Identify compilation error

   Using an undefined variable causes a compilation error in Kotlin.

3. Final Answer:

   Variable 'name' is undefined causing a compilation error -> Option C

4. Quick Check:

   Undefined variables cause compile errors [OK]

Hint: Check all variables are defined before use [OK]

Common Mistakes:

• Ignoring undefined variables
• Assuming missing imports cause error here
• Thinking function must be abstract

5. You want to create a Repository that fetches user data from both a local database and a remote API. Which approach best follows the Repository pattern principles?

hard

A. Call the local database and remote API directly from the UI layer

B. Store all user data in the UI components for quick access

C. Create separate Repository classes for local and remote and call both from UI

D. Create a Repository class that decides whether to fetch from local or remote and exposes a single method to get user data

Solution

1. Step 1: Understand Repository responsibility

   The Repository should act as a single source of truth and hide data sources from the UI.

2. Step 2: Choose approach that centralizes data logic

   Create a Repository class that decides whether to fetch from local or remote and exposes a single method to get user data centralizes data fetching logic inside the Repository, deciding between local and remote sources.

3. Step 3: Avoid direct data calls in UI

   Options A and C expose data sources to UI, breaking separation of concerns. Store all user data in the UI components for quick access mixes data with UI, which is bad practice.

4. Final Answer:

   Create a Repository class that decides whether to fetch from local or remote and exposes a single method to get user data -> Option D

5. Quick Check:

   Repository centralizes data access [OK]

Hint: Repository hides data sources behind one interface [OK]

Common Mistakes:

• Calling data sources directly from UI
• Splitting data logic across UI and multiple classes
• Storing data inside UI components