An Android Application interacting with Star Wars API. It enabling users to search for Star Wars Characters and get their Details from the Star Wars Universe.
- Android Studio: Arctic Fox Canary 4 or Higher
- Language: Kotlin
- Build System: Gradle
- Clean Architecture + Model View Model Model Pattern + Repository Pattern.
- Jetpack Libraries and Architecture Component
- Github Action for CI
- Kotlin Gradle DSL
Clean architecture helps organizing the project into different layers so that it's easy to understand, scale and debug when need arises. There are Multiple ways of defining Clean Architecture layers. In this application i have used Clean Architecture per module.
The project is divided into 3 layers
- domain
- data
- app
This is the layer that contains all the business logic. It contains all the abstract definition and the inner most. It is completely made of java/kotlin module In this project the domain layers holds the definitions of use-cases/iteractors, domain data models and repository interfaces.
usecases/ interactors they are the business logic executors that converts and passes user actions like fetch data from data source either remote or local and gives it back to the requester, in this case its the presenter (app).
the act as mediators between the repository and data layer
repository interface interface that must be implemented by data layer
The data module consists of network models, mappers, API services, and repository implementations. This is the layer that repository patter is implemented. Repository pattern is used to abstract away concrete implementation of data source
mappers they are used to convert/maps one data type to the other eg network model to domain model
In this project, i have only implemented the network data source where data is only fetched from the internet.
This layer contains the implementation of the three inner layers. This layers contains User Interface, mainly Android Stuff like Activities, Fragments, ViewModel,
Testing is done in each layer. Thats one of the advantages of Clean Architecture
domain in the domain layer test is done using JUnit4 to the use cases. Fake data is used to test the Repository to interact with the use case to assert that the correct data is returned.
data in this layer test to the repository implementation and mappers. The mappers test is used to certify that the mapper maps the correct data and returns the correct type.
The Repository is tested using webmockserver. This enables us to test if the converter and the correct data is returned in each case.
app in this layer both instrumental and unit test are done. ViewModels are tested to assert that the usecase interact with the repository to fetch data from the repository in the data layer
Fake Data are used to test the Viewmodel. Mappers are also tested to verify the domain data model is converted to presentation layer correctly. UI test are done to verify that the correct data is presented to the user and that the user interaction are handled.
- Android Jetpack
- Data Binding The Data Binding Library is a support library that allows you to bind UI components in your layouts to data sources in your app using a declarative format rather than programmatically.
- Live Data LiveData is lifecycle-aware, meaning it respects the lifecycle of other app components updating app component observers that are in an active lifecycle state.
- Navigation Android Jetpack's Navigation component helps you implement effective navigation.
- Hilt Hilt provides a standard way to incorporate Dagger dependency injection into an Android application.
- Kotlin coroutines Executing code asynchronously.
- Retrofit Type-safe HTTP client for Android and Java and Kotlin by Square, Inc.
- Moshi Moshi is a modern JSON library for Android and Java. It makes it easy to parse JSON into Java objects:
- OkHttp interceptor Logs HTTP requests and responses
- Material Design Build beautiful, usable products using Material Components for Android
- JUnit4 Unit Testing
- Espresso Automated testing UI test
- MockWebServer A scriptable web server for testing HTTP clients
|
|
|
|
|
|
#References