Clean Architecture, một design pattern ngày càng phổ biến và sử dụng rộng rãi trong Android. Và chúng ta sẽ đi thẳng vào ví dụ, để hiểu rõ hơn về design pattern này.
Trước hết, tôi xin nhắc lại ưu điẻm của Clean Architecture pattern:
- Độc lập với các framework.
- Testable.
- Đôcc lập với UI.
- Độc lập với database.
- Độc lập với bất kỳ external agent nào khác.
- Tổng quan
Ví dụ sẽ được tách làm 3 package : presentation, storage, domain.
2 package đầu thuộc về outer layer và package cuối cùng sẽ là inner/core layer.
Package Presentation chịu trách nhiệm cho tất cả mọi thứ liên quan đến việc hiển thị trên màn hình – nó bao gồm toàn bộ MVP stack (có nghĩa là nó cũng bao gồm cả các giao diện người dùng và các package Presenter mặc dù chúng thuộc các layer khác nhau).
- Tạo một Interactor mới (inner/core layer)
Bạn có thể bắt đầu từ bất kỳ layer nào của architecture, nhưng lời khuyên là nên bắt đầu từ logic core business đầu tiên. Bạn có thể code, test, và chắc rằng nó hoạt động mà không cần đến activity.
Vì vậy, chúng ta hãy bắt đầu bằng cách tạo ra một INteractor. Các INteractor là nơi logic chính của các use case cư trú. Tất cả Interactors đang chạy trong thread nền vì vậy không nên có bất kỳ ảnh hưởng đến hiệu suất UI. Hãy tạo ra một INteractor mới với tên WelcomingInteractor.
|
1 2 3 4 5 6 7 8 9 10 |
<span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">interface</span> <span class="hljs-title">WelcomingInteractor</span> <span class="hljs-keyword">extends</span> <span class="hljs-title">Interactor</span> </span>{ <span class="hljs-class"><span class="hljs-keyword">interface</span> <span class="hljs-title">Callback</span> </span>{ <span class="hljs-function"><span class="hljs-keyword">void</span> <span class="hljs-title">onMessageRetrieved</span><span class="hljs-params">(String message)</span></span>; <span class="hljs-function"><span class="hljs-keyword">void</span> <span class="hljs-title">onRetrievalFailed</span><span class="hljs-params">(String error)</span></span>; } } |
Callback sẽ trách nhiệm giao tiếp với UI trên các main thread, đặt nó vào giao diện của INteractor này vì vậy không cần phải đặt tên cho nó là WelcomingInteractorCallback – để phân biệt nó từ callbacks khác. Bây giờ chúng ta hãy thực hiện logic lấy một tin nhắn. Chúng ta có một MessageRepository có thể cung cấp các welcome message.
|
1 2 3 4 |
<span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">interface</span> <span class="hljs-title">MessageRepository</span> </span>{ <span class="hljs-function">String <span class="hljs-title">getWelcomeMessage</span><span class="hljs-params">()</span></span>; } |
Bây giờ hãy implement giao diện INteractor business logic trên. Điều quan trọng là implement extend của AbstractInteractor và chú ý tới việc chạy trên background thread.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 |
<span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">WelcomingInteractorImpl</span> <span class="hljs-keyword">extends</span> <span class="hljs-title">AbstractInteractor</span> <span class="hljs-keyword">implements</span> <span class="hljs-title">WelcomingInteractor</span> </span>{ ... <span class="hljs-function"><span class="hljs-keyword">private</span> <span class="hljs-keyword">void</span> <span class="hljs-title">notifyError</span><span class="hljs-params">()</span> </span>{ mMainThread.post(<span class="hljs-keyword">new</span> Runnable() { <span class="hljs-meta">@Override</span> <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">run</span><span class="hljs-params">()</span> </span>{ mCallback.onRetrievalFailed(<span class="hljs-string">"Nothing to welcome you with :("</span>); } }); } <span class="hljs-function"><span class="hljs-keyword">private</span> <span class="hljs-keyword">void</span> <span class="hljs-title">postMessage</span><span class="hljs-params">(<span class="hljs-keyword">final</span> String msg)</span> </span>{ mMainThread.post(<span class="hljs-keyword">new</span> Runnable() { <span class="hljs-meta">@Override</span> <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">run</span><span class="hljs-params">()</span> </span>{ mCallback.onMessageRetrieved(msg); } }); } <span class="hljs-meta">@Override</span> <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">run</span><span class="hljs-params">()</span> </span>{ <span class="hljs-comment">// retrieve the message</span> <span class="hljs-keyword">final</span> String message = mMessageRepository.getWelcomeMessage(); <span class="hljs-comment">// check if we have failed to retrieve our message</span> <span class="hljs-keyword">if</span> (message == <span class="hljs-keyword">null</span> || message.length() == <span class="hljs-number">0</span>) { <span class="hljs-comment">// notify the failure on the main thread</span> notifyError(); <span class="hljs-keyword">return</span>; } <span class="hljs-comment">// we have retrieved our message, notify the UI on the main thread</span> postMessage(message); } |
Điều này chỉ cố gắng để tải message và gửi message hoặc hiển thị các lỗi UI. Chúng ta xác định UI thông qua callback mà sẽ được thực hiện ở Presenter. Đó là mấu chốt của business logic ở đay. Tất cả mọi thứ mà chúng ta cần làm là framework dependence.
Dưới đây là 1 số phụ thuộc mà Interactor này có:
|
1 2 3 4 5 6 |
<span class="hljs-keyword">import</span> com.kodelabs.boilerplate.domain.executor.Executor; <span class="hljs-keyword">import</span> com.kodelabs.boilerplate.domain.executor.MainThread; <span class="hljs-keyword">import</span> com.kodelabs.boilerplate.domain.interactors.WelcomingInteractor; <span class="hljs-keyword">import</span> com.kodelabs.boilerplate.domain.interactors.base.AbstractInteractor; <span class="hljs-keyword">import</span> com.kodelabs.boilerplate.domain.repository.MessageRepository; |
Như bạn có thể thấy, ở đây không đề cập đến bất kỳ code Android nào. Đó là lợi ích chính của phương pháp này. Bạn có thể thấy được sự độc lập của framework. Ngoài ra, chúng ta không quan tâm đến chi tiết cụ thể của UI hoặc db, chúng ta chỉ cần gọi interface mà ở đâu đó outer layer sẽ implement. Do đó, chúng ta có sự độc lập về UI và db.
Bây giờ chúng ta có thể run và test Interactor không cần chạy emulator. Vì vậy, chúng ta hãy viết một test JUnit đơn giản để đảm bảo nó hoạt động:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 |
... <span class="hljs-meta">@Test</span> <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">testWelcomeMessageFound</span><span class="hljs-params">()</span> <span class="hljs-keyword">throws</span> Exception </span>{ String msg = <span class="hljs-string">"Welcome, friend!"</span>; when(mMessageRepository.getWelcomeMessage()) .thenReturn(msg); WelcomingInteractorImpl interactor = <span class="hljs-keyword">new</span> WelcomingInteractorImpl( mExecutor, mMainThread, mMockedCallback, mMessageRepository ); interactor.run(); Mockito.verify(mMessageRepository).getWelcomeMessage(); Mockito.verifyNoMoreInteractions(mMessageRepository); Mockito.verify(mMockedCallback).onMessageRetrieved(msg); } |
Một lần nữa, code Interactor này không có ý tưởng rằng nó sẽ sống bên trong một ứng dụng Android. Điều này chứng tỏ rằng business logic ở đây là Testable, đó là điểm thứ hai để thấy.
- Tạo presenter layer
Code Presenter thuộc outer layer trong Clean. Nó bao gồm các code phụ thuộc vào framework để hiển thị UI cho người dùng. Chúng ta sẽ sử dụng lớp MainActivity để hiển thị welcome message cho người sử dụng khi ứng dụng resume.
|
1 2 3 4 5 6 7 |
<span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">interface</span> <span class="hljs-title">MainPresenter</span> <span class="hljs-keyword">extends</span> <span class="hljs-title">BasePresenter</span> </span>{ <span class="hljs-class"><span class="hljs-keyword">interface</span> <span class="hljs-title">View</span> <span class="hljs-keyword">extends</span> <span class="hljs-title">BaseView</span> </span>{ <span class="hljs-function"><span class="hljs-keyword">void</span> <span class="hljs-title">displayWelcomeMessage</span><span class="hljs-params">(String msg)</span></span>; } } |
Vì vậy, làm thế nào và nơi nào chúng ta bắt đầu Interactor khi một ứng dụng resume? Tất cả mọi thứ mà liên quan đến stritly nên cho vào các lớp Presenter. Điều này giúp tách các mối quan hệ và ngăn ngừa các class Hoạt động cồng kềnh. Điều này bao gồm tất cả các code làm việc với Interactors.
Trong onResume của Mainactivity, chúng ta nên override hàm onResume():
|
1 2 3 4 5 6 7 |
<span class="hljs-meta">@Override</span> <span class="hljs-function"><span class="hljs-keyword">protected</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onResume</span><span class="hljs-params">()</span> </span>{ <span class="hljs-keyword">super</span>.onResume(); <span class="hljs-comment">// let's start welcome message retrieval when the app resumes</span> mPresenter.resume(); } |
Tất cả Presenter object implement hàm resume() khi chúng extend từ BasePresenter.
Chúng ta start Interactor bên trong MainPresenter class trong hàm resume() :
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
<span class="hljs-meta">@Override</span> <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">resume</span><span class="hljs-params">()</span> </span>{ mView.showProgress(); <span class="hljs-comment">// initialize the interactor</span> WelcomingInteractor interactor = <span class="hljs-keyword">new</span> WelcomingInteractorImpl( mExecutor, mMainThread, <span class="hljs-keyword">this</span>, mMessageRepository ); <span class="hljs-comment">// run the interactor</span> interactor.execute(); } |
Hàm execute() sẽ chạy hàm run() của WelcomingInteractorImpl bên trong background thread. Hàm run() có thể được thấy khi viết một Interactor mới.
MainPresenter của MainActivity sẽ implement Callback interface:
|
1 2 |
<span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MainPresenterImpl</span> <span class="hljs-keyword">extends</span> <span class="hljs-title">AbstractPresenter</span> <span class="hljs-keyword">implements</span> <span class="hljs-title">MainPresenter</span>, <span class="hljs-title">WelcomingInteractor</span>.<span class="hljs-title">Callback</span> </span>{ |
Đó là cách chúng ta lắng nghe sự kiện từ Interator. Và đây là code từ MainPresenter:
|
1 2 3 4 5 6 7 8 9 10 11 12 |
<span class="hljs-meta">@Override</span> <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onMessageRetrieved</span><span class="hljs-params">(String message)</span> </span>{ mView.hideProgress(); mView.displayWelcomeMessage(message); } <span class="hljs-meta">@Override</span> <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onRetrievalFailed</span><span class="hljs-params">(String error)</span> </span>{ mView.hideProgress(); onError(error); } |
Và MainActivity cũng se implement interface View của MainPresenter.
|
1 2 |
<span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MainActivity</span> <span class="hljs-keyword">extends</span> <span class="hljs-title">AppCompatActivity</span> <span class="hljs-keyword">implements</span> <span class="hljs-title">MainPresenter</span>.<span class="hljs-title">View</span> </span>{ |
|
1 2 3 4 5 |
<span class="hljs-meta">@Override</span> <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">displayWelcomeMessage</span><span class="hljs-params">(String msg)</span> </span>{ mWelcomeTextView.setText(msg); } |
- Tạo một storage layer
Đây là nơi respository được implement. Tất cả các code cụ thể của cơ sở dữ liệu nên ở đây. Các repository pattern chỉ abstract nơi dữ liệu đến từ đâu. Business logic chính ở đây là không biết gì về nguồn gốc của dữ liệu – có thể là từ một cơ sở dữ liệu, máy chủ hoặc các tập tin văn bản.
Đối với dữ liệu phức tạp, bạn có thể sử dụng ContentProviders hoặc các công cụ ORM như DBFlow. Nếu cần phải lấy dữ liệu từ các trang web, Retrofit sẽ giúp bạn. Nếu cần lưu trữ giá trị đơn giản, có thể sử dụng SharedPreferences. Nên sử dụng đúng công cụ cho từng công việc.
Database ở đây không hẳn là một database. Nó chỉ đơn giản là một class với một sự mô phong delay:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
<span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">WelcomeMessageRepository</span> <span class="hljs-keyword">implements</span> <span class="hljs-title">MessageRepository</span> </span>{ <span class="hljs-meta">@Override</span> <span class="hljs-function"><span class="hljs-keyword">public</span> String <span class="hljs-title">getWelcomeMessage</span><span class="hljs-params">()</span> </span>{ String msg = <span class="hljs-string">"Welcome, friend!"</span>; <span class="hljs-comment">// let's be friendly</span> <span class="hljs-comment">// let's simulate some network/database lag</span> <span class="hljs-keyword">try</span> { Thread.sleep(<span class="hljs-number">2000</span>); } <span class="hljs-keyword">catch</span> (InterruptedException e) { e.printStackTrace(); } <span class="hljs-keyword">return</span> msg; } } |
Chúng ta không cần quan tâm đến những gì là dưới MessageRepository miễn là nó thực hiện đúng giao diện.
- Tổng kết
Quy trình hoạt ddoognj của Clean Architecture sẽ như sau:
MainActivity ->MainPresenter -> WelcomingInteractor -> WelcomeMessageRepository -> WelcomingInteractor -> MainPresenter -> MainActivity
- Điều quan trọng cần nhớ về flow control:
Outer — Mid — Core — Outer — Core — Mid — Outer.
