Snowball

KO | EN

gitlite — search

#python #typescript #llm #android #machine-learning #linux #macos #nodejs #java #windows #awesome #kubernetes #vue #open-source

(★ 26)

Android Clean Code Sample Project

Snowball Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Snowball [![Build Status](https://travis-ci.org/lenguyenthanh/Snowball.svg?branch=master)](https://travis-ci.org/lenguyenthanh/Snowball) [![codecov.io](https://codecov.io/github/lenguyenthanh/Snowball/coverage.svg?branch=master)](https://codecov.io/github/lenguyenthanh/Snowball?branch=master)
It is a sample application which is desired as a showcase for how a clean Android Project should. It's still small and simple and need a lot of help to make it better. Please help me build it better and better. Cheers!

## Objectives
Biggest goal of this project is create a good sample Android project which has good architecture and quality. It is heavy inspired of two great projects [Android Clean Architecture](https://github.com/android10/Android-CleanArchitecture) and [Quality Matters](https://github.com/artem-zinnatullin/qualitymatters). Kudos [Fernando Cejas](https://twitter.com/fernando_cejas) and [Artem Zinnatullin](https://twitter.com/artem_zin) for their great jobs.

## Outline
- Application functionality
- Application architecture design
- Conclusion

## Application functionality
- Download list of items from rest api: [API](https://gist.githubusercontent.com/lenguyenthanh/5bb3bbd3404bb118bfc1/raw/91809efb7abbc43870465cb594cdfd0bce67bb26/videos).
- Displays items as a list.
- Display images from item

## Application architecture design
- General Architecture
- Dependency Injection
- Reactive framework
- Model-View-Presenter(MVP)
- Other practices

### Architecture
I follow [Clean Architecture](http://blog.8thlight.com/uncle-bob/2012/08/13/the-clean-architecture.html) in this project. I structure the project into 3 layers (3 packages):

##### Presentation package
This is presentation layer, its responsibility is to present data model into view which user interact with.

##### Domain package
This is business layer, we can look at this package and understand what application does. This module is Java module and it dependent with Android Framework.

##### Data package
This is data layer, its responsibility is loading data and caching data. All data comes from here. Other layers do not to care about where data is come from, they just ask Data layer to get data.

##### Layer rules:
Each layer expose its interfaces to another layers. They may dependent on other's abstraction not implementation that mean no layer knows other layers details.

### Dependency Injection
This sample uses dependency inject(DI) ([Dagger 2](http://google.github.io/dagger/)) to avoid boilerplate code and make project clean and follow [Single Responsibility principle](https://en.wikipedia.org/wiki/Single_responsibility_principle). Furthermore, DI give us power to create multiple build types for project. For example, this project has two build type: Release and Debug. For Debug build we have a lot of debug tools(such as: [Logging](https://github.com/square/okhttp/tree/master/okhttp-logging-interceptor), [Stetho](http://facebook.github.io/stetho/), [LeakCanary](https://github.com/square/leakcanary)) which should not contain in Release build. Without DI it's really hard to make it.

### Reactive Framework
This project uses reactive programming([RxJava](https://github.com/ReactiveX/RxJava)) for async job as well as app flow.

### Model-View-Presenter(MVP)
This project uses my small library [Nimble](https://github.com/lenguyenthanh/nimble) as an MVP library. You can read more about MVP here: [MVP best practices](http://lenguyenthanh.com/model-view-presentermvp-definitions-and-best-practices/).

### Other practices
I try hard to follow [SOLID](https://en.wikipedia.org/wiki/SOLID_(object-oriented_design)) in this project. It makes the application easier to maintain, test, and change. When using external dependencies (libraries), I prefer to write a wrapper interface for them, and hide all their implementations from my application. For example: [Image caching library wrapper](https://github.com/lenguyenthanh/Snowball/blob/master/app%2Fsrc%2Fmain%2Fjava%2Fcom%2Flenguyenthanh%2Fsnowball%2Fpresentation%2Fui%2Fnetwork%2FNetworkBitmapClient.java) or [Fake analytics tool library](https://github.com/lenguyenthanh/Snowball/blob/master/app%2Fsrc%2Fmain%2Fjava%2Fcom%2Flenguyenthanh%2Fsnowball%2Fpresentation%2Fui%2Fnetwork%2FTracker.java).

Snowball

Snowball Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Snowball

Snowball Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README