Share
Embed
Clean Architecture
A practical guide to making your code more readable, testable, and maintainable using clean architecture.
Michael Pardo
April 30, 2016
Transcript
131 slides
-
• MVP • Realm • RxJava • Dagger • Retrofit
• Gson NO! -
Tools • MVP • Realm • RxJava • Dagger •
Retrofit • Gson -
Entities Use Cases Controllers Gateways Presenters Devices Web DB UI
External Interfaces Enterprise Business Rules Application Business Rules Interface Adapters Frameworks & Drivers Presenter Controller Use Case Input Port Use Case Interactor Use Case Output Port Flow of Control -
Entities Use Cases Controllers Gateways Presenters Devices Web DB UI
External Interfaces Enterprise Business Rules Application Business Rules Interface Adapters Frameworks & Drivers Presenter Controller Use Case Input Port Use Case Interactor Use Case Output Port Flow of Control -
Use Cases Controllers Gateways Presenters Devices Web DB UI External
Interfaces Enterprise Business Rules Application Business Rules Interface Adapters Frameworks & Drivers Presenter Controller Use Case Input Port Use Case Interactor Use Case Output Port Flow of Control -
Controllers Gateways Presenters Devices Web DB UI External Interfaces Enterprise
Business Rules Application Business Rules Interface Adapters Frameworks & Drivers Presenter Controller Use Case Input Port Use Case Interactor Use Case Output Port Flow of Control -
Devices Web DB UI External Interfaces Enterprise Business Rules Application
Business Rules Interface Adapters Frameworks & Drivers Presenter Controller Use Case Input Port Use Case Interactor Use Case Output Port Flow of Control -
Entities Use cases Data sources, Presentation models Delivery mechanisms, databases
Core App Presentation Data Android Desktop CleanNews ├── android ├── app ├── core ├── data ├── desktop └── presentation -
Entities Use cases Data sources, Presentation models Delivery mechanisms, databases
Core App Presentation Data Android Desktop CleanNews ├── android ├── app ├── core ├── data ├── desktop └── presentation -
Entities Use cases Data sources, Presentation models Delivery mechanisms, databases
App Presentation Data Android Desktop CleanNews ├── android ├── app ├── core ├── data ├── desktop └── presentation -
Entities Use cases Data sources, Presentation models Delivery mechanisms, databases
Presentation Data Android Desktop CleanNews ├── android ├── app ├── core ├── data ├── desktop └── presentation -
Entities Use cases Data sources, Presentation models Delivery mechanisms, databases
Android Desktop CleanNews ├── android ├── app ├── core ├── data ├── desktop └── presentation -
app/src/main/kotlin/clean/news/app/ ├── item │ ├── GetChildren │ ├── GetItemById │
├── GetItemsByListType │ └── SaveItem └── user ├── GetUserById └── SaveUser -
app/src/main/kotlin/clean/news/app/ ├── item │ ├── GetChildren │ ├── GetItemById │
├── GetItemsByListType │ └── SaveItem └── user ├── GetUserById └── SaveUser -
“An entity is something that exists as itself, as a
subject or as an object, actually or potentially, concretely or abstractly, physically or not.” -
data class Item( val id: Long, val type: Type, val
by: String?, val time: Date, val text: String?, val url: String?, val title: String?) { enum class Type(val canComment: Boolean) { JOB(false), STORY(true), COMMENT(true), POLL(true), POLLOPT(true), NONE(false) } } -
data class Item( val id: Long, val type: Type, val
by: String?, val time: Date, val text: String?, val url: String?, val title: String?) { enum class Type(val canComment: Boolean) { JOB(false), STORY(true), COMMENT(true), POLL(true), POLLOPT(true), NONE(false) } } -
data class User( val id: String, val delay: Int, val
created: Date, val karma: Int, val about: String, val submitted: List<Long> ) -
Entities • Contain enterprise wide business rules • Encapsulate high-level
rules • Unaffected by external layers -
“A use case is a list of actions or event
steps, typically defining the interactions between a role and a system, to achieve a goal.” -
Title (goal) Primary Actor: … Scope: … Level: … (Story):
the body of the use case is simply a paragraph or two of text, informally describing what happens. -
Retrieve story details Primary Actor: Reader Scope: A Hacker News
client Level: User goal The reader invokes the client to retrieve the details for a story. This includes the children of a story, namely the comments. -
Entities Use Cases Controllers Gateways Presenters Devices Web DB UI
External Interfaces Enterprise Business Rules Application Business Rules Interface Adapters Frameworks & Drivers Presenter Controller Use Case Input Port Use Case Interactor Use Case Output Port Flow of Control -
Presenter Controller Use Case Input Port Use Case Interactor Use
Case Output Port Flow of Control -
interface UseCase<I : Request, O : Response> { fun
execute(request: I): Observable<O> interface Request interface Response } -
interface UseCase<I : Request, O : Response> { fun
execute(request: I): Observable<O> interface Request interface Response } -
interface UseCase<I : Request, O : Response> { fun
execute(request: I): Observable<O> interface Request interface Response } -
interface UseCase<I : Request, O : Response> { fun
execute(request: I): Observable<O> interface Request interface Response } -
interface UseCase<I : Request, O : Response> { fun
execute(request: I): Observable<O> interface Request interface Response } -
interface UseCase<I : Request, O : Response> { fun
execute(request: I): Observable<O> interface Request interface Response } -
interface UseCase<I : Request, O : Response> { fun
execute(request: I): Observable<O> interface Request interface Response } -
interface UseCase<I : Request, O : Response> { fun
execute(request: I): Observable<O> interface Request interface Response } -
interface UseCase2<A, B, R> {. fun execute(arg1: A, arg2:
B): Observable<R> }. -
interface UseCase3<A, B, C, R> {. fun execute(arg1: A,
arg2: B, arg3: C): Observable<R> }. -
app/src/main/kotlin/clean/news/app/ └── usecase ├── item │ ├── GetChildren.kt │ ├──
GetItemById.kt │ ├── GetItemsByListType.kt │ └── SaveItem.kt └── user ├── GetUserById.kt └── SaveUser.kt -
class GetChildren @Inject constructor( private val network: ItemNetworkDataSource) : UseCase<Request,
Response> { override fun execute(request: Request): Observable<Response> { return network.getChildren(request.item) .map { Response(it) } } class Request(val item: Item) : UseCase.Request class Response(val items: List<Item>) : UseCase.Response } -
class GetChildren @Inject constructor( private val network: ItemNetworkDataSource) : UseCase<Request,
Response> { override fun execute(request: Request): Observable<Response> { return network.getChildren(request.item) .map { Response(it) } } class Request(val item: Item) : UseCase.Request class Response(val items: List<Item>) : UseCase.Response } -
class GetChildren @Inject constructor( private val network: ItemNetworkDataSource) : UseCase<Request,
Response> { override fun execute(request: Request): Observable<Response> { return network.getChildren(request.item) .map { Response(it) } } class Request(val item: Item) : UseCase.Request class Response(val items: List<Item>) : UseCase.Response } -
class GetChildren @Inject constructor( private val network: ItemNetworkDataSource) : UseCase<Request,
Response> { override fun execute(request: Request): Observable<Response> { return network.getChildren(request.item) .map { Response(it) } } class Request(val item: Item) : UseCase.Request class Response(val items: List<Item>) : UseCase.Response } -
class GetChildren @Inject constructor( private val network: ItemNetworkDataSource) : UseCase<Request,
Response> { override fun execute(request: Request): Observable<Response> { return network.getChildren(request.item) .map { Response(it) } } class Request(val item: Item) : UseCase.Request class Response(val items: List<Item>) : UseCase.Response } -
class GetChildren @Inject constructor( private val network: ItemNetworkDataSource) : UseCase<Request,
Response> { override fun execute(request: Request): Observable<Response> { return network.getChildren(request.item) .map { Response(it) } } class Request(val item: Item) : UseCase.Request class Response(val items: List<Item>) : UseCase.Response } -
class GetChildren @Inject constructor( private val network: ItemNetworkDataSource) : UseCase<Request,
Response> { override fun execute(request: Request): Observable<Response> { return network.getChildren(request.item) .map { Response(it) } } class Request(val item: Item) : UseCase.Request class Response(val items: List<Item>) : UseCase.Response } -
app/src/main/kotlin/clean/news/app/ └── data ├── DataSource.kt ├── item │ ├── ItemDataSource.kt
│ ├── ItemDiskDataSource.kt │ ├── ItemMemoryDataSource.kt │ └── ItemNetworkDataSource.kt └── user ├── UserDataSource.kt ├── UserDiskDataSource.kt ├── UserMemoryDataSource.kt └── UserNetworkDataSource.kt -
interface DataSource<T, ID> { fun getAll(): Observable<List<T>> fun getById(id:
ID): Observable<T> fun save(t: T): Observable<Boolean> } -
interface ItemDataSource : DataSource<Item, Long> { fun getItems(listType: ListType): Observable<List<Item>>
fun getChildren(item: Item): Observable<List<Item>> } -
Use Cases • Contain application specific business rules • Orchestrate
the flow of data to and from entities • Unaffected by external systems like database or UI -
“a design pattern that allows the interface of an existing
class to be used as another interface.” -
apply plugin: 'java' dependencies { compile project(':app') } Core
App Presentation Data -
presentation/src/main/kotlin/clean/news/presentation/model/ ├── Model.kt ├── item │ ├── ItemDetailViewModel.kt │ ├──
ItemListViewModel.kt │ └── ItemUrlViewModel.kt └── main └── MainViewModel.kt -
class ItemDetailViewModel @Inject constructor( private val getChildren: GetChildren, private val
item: Item) : Model<Sources, Sinks> { private val children = getChildren.execute(Request(item)) .map { it.items } .replay(1) .autoConnect() } -
class ItemDetailViewModel @Inject constructor( private val getChildren: GetChildren, private val
item: Item) : Model<Sources, Sinks> { private val children = getChildren.execute(Request(item)) .map { it.items } .replay(1) .autoConnect() } -
class ItemDetailViewModel @Inject constructor( private val getChildren: GetChildren, private val
item: Item) : Model<Sources, Sinks> { private val children = getChildren.execute(Request(item)) .map { it.items } .replay(1) .autoConnect() } -
data/src/main/kotlin/clean/news/data/ ├── lru │ ├── ItemLruDataSource.kt │ └── UserLruDataSource.kt ├──
retrofit │ ├── ItemRetrofitDataSource.kt │ └── UserRetrofitDataSource.kt └── sqlite ├── ItemSqliteDataSource.kt └── UserSqliteDataSource.kt -
class ItemRetrofitDataSource @Inject constructor( private val itemService: ItemService) : ItemNetworkDataSource
{ override fun getById(id: Long): Observable<Item> { return itemService.getById(id) } } -
class ItemRetrofitDataSource @Inject constructor( private val itemService: ItemService) : ItemNetworkDataSource
{ override fun getById(id: Long): Observable<Item> { return itemService.getById(id) } } -
class ItemRetrofitDataSource @Inject constructor( private val itemService: ItemService) : ItemNetworkDataSource
{ override fun getById(id: Long): Observable<Item> { return itemService.getById(id) } } -
class ItemRetrofitDataSource @Inject constructor( private val itemService: ItemService) : ItemNetworkDataSource
{ override fun getById(id: Long): Observable<Item> { return itemService.getById(id) } } -
Interface Adapters • Convert data between uses cases and external
agencies • MVC, MVP, MVVM, RPM implementation • Database adapter • Network adapter -
“a universal, reusable software environment that provides particular functionality as
part of a larger software platform to facilitate development” -
apply plugin: 'com.android.application' dependencies { compile project(':presentation') compile project(':data')
} Core App Presentation Data Android Desktop -
class ItemDetailView : RelativeLayout { @Inject lateinit var model:
ItemDetailViewModel @JvmOverloads constructor(...) : super(context, attrs, defStyle) { ComponentService.getService<ItemDetailComponent>(context)?.inject(this) } } -
class ItemDetailView : RelativeLayout { @Inject lateinit var model: ItemDetailViewModel
@JvmOverloads constructor(...) : super(context, attrs, defStyle) { ComponentService.getService<ItemDetailComponent>(context)?.inject(this) } } -
class ItemDetailView : RelativeLayout { @Inject lateinit var model:
ItemDetailViewModel @JvmOverloads constructor(...) : super(context, attrs, defStyle) { ComponentService.getService<ItemDetailComponent>(context)?.inject(this) } } -
@Module class DataModule { @Provides @ApplicationScope fun itemService(retrofit: Retrofit):
ItemService { return retrofit.create(ItemService::class.java) } @Provides @ApplicationScope fun itemNetworkDataSource(itemService: ItemService): ItemNetworkDataSource { return ItemRetrofitDataSource(itemService) } } -
@Module class DataModule { @Provides @ApplicationScope fun itemService(retrofit: Retrofit):
ItemService { return retrofit.create(ItemService::class.java) } @Provides @ApplicationScope fun itemNetworkDataSource(itemService: ItemService): ItemNetworkDataSource { return ItemRetrofitDataSource(itemService) } } -
@Module class DataModule { @Provides @ApplicationScope fun itemService(retrofit: Retrofit):
ItemService { return retrofit.create(ItemService::class.java) } @Provides @ApplicationScope fun itemNetworkDataSource(itemService: ItemService): ItemNetworkDataSource { return ItemRetrofitDataSource(itemService) } } -
override fun onAttachedToWindow() { super.onAttachedToWindow() val sinks = model.setUp(Sources( toolbar.navigationClicks(),
Observable.empty(), toolbar.itemClicks() .filter {it.itemId == R.id.item_share } .map { Unit } )) } -
override fun onAttachedToWindow() { super.onAttachedToWindow() val sinks = model.setUp(Sources( toolbar.navigationClicks(),
Observable.empty(), toolbar.itemClicks() .filter {it.itemId == R.id.item_share } .map { Unit } )) } -
Frameworks and Drivers • Glue code to communicate inwards •
Delivery mechanism • Dependency providers