Android cleanarchitecture
62 likes22,365 views
This slide explains how to develop better Android app with Android Clean Architecture
Android cleanarchitecture
- 1. Android Clean Architecture ことはじめ Mercari, Inc. Tomoaki Imai 08/08/2015 Android All Stars @Shibuya dots.
- 2. Tomoaki Imai Mercari, Inc. twitter: @tomoaki_imai github: tomoima525
- 6. Androidにおける設計の難しさ • Life Cycle(画面再生成 etc) • 数多く存在するApi • OSごとのバージョン管理
- 8. “Android Clean Architecture” という考え方 The Clean Architecture by Uncle Bob http://blog.8thlight.com/uncle-bob/2012/08/13/the-clean-architecture.html
- 9. “Android Clean Architecture” という考え方 The Clean Architecture (Enterprise Application) (Web Service) + = Android Clean Architecture
- 11. 今日みなさんに持って返って もらいたいもの • Android Clean Architectureの思想をさっくり 理解する • Android Clean Architectureの実際的な実装方 法を理解する • 既存の設計と比べてどういうメリットがある か理解する
- 13. MVC Architecture Model アプリケーションデータ ビジネスロジック View Modelをレンダリングする Controller ユーザーイベントをハンドルする View Model Controller User usessees
- 15. Android Frameworks Activity Life Cycle MVC Architecture on Android Model アプリケーションデータ (http, DB, memory色々) ビジネスロジック View Modelをレンダリングする (端末の状態を意識しながら) Controller ユーザーイベントをハンドルする (端末状態をハンドルする) (色んなViewもハンドルする) View Model Controller User usessees
- 16. MVCでアプリ
- 17. Sample App • GithubからFollowerを取って くるアプリ • Followerのrepository見れる • 選択したFollowerはメモリに キャッシュし、2回目以降は トーストで通知する https://github.com/tomoima525/CleanArchitectureSample /app配下 -> MVC で実装 /cleanarchitecture配下 -> Clean Architecture で実装
- 18. private GithubApi mApi; private UserMemoryCache mUserMemoryCache; … mApi = createApi(); mUserMemoryCache = UserMemoryCache.getInstance(); … public void HogeTask(…){ //ビジネスロジック… mApi.listFollowersAsync(…); mUserMemoryCache.put(…); } Models • Modelのデータ元は多様 • ModelとControllerのインタラクション(ビジネスロジック)がテストしにく い
- 19. public class MainActivity { @Override protected void onCreate(Bundle savedInstanceState) { // create views... } @Override protected void onResume(){ // resume/update views when system state is resumed } @Override protected void onPause(){ // pause views when system state is paused } } Views • Viewの状態管理が必要
- 20. public class MainActivity { // User events public void onClick(){} public void afterTextChanged(){} // System events public void onSaveInstanceState(Bundle outState){} public void onRestoreInstanceState(Bundle inState){} // View events public void gotoUserDetailActivity(Context context){} } Controllers • ViewとControllerがActivity上に混在している • 画面再生成などのシステムの状態もハンドルする必要がある
- 21. MVC Architecture on Android における課題 View(の状態管理)とControllerがActivity上に混在している ModelとController間のインタラクション(ビジネスロジック)が システム状態(LifeCycle)に影響を受ける/テストしにくい Modelのデータ・ソースが多様 各層の依存関係が強い
- 22. Clean Way…?
- 23. MVC Architecture on Android における課題 View(の状態管理)とControllerがActivity上に混在している ModelとController間のインタラクション(ビジネスロジック)が システム状態(LifeCycle)に影響を受ける/テストしにくい Modelのデータ・ソースが多様 各層の依存関係が強い
- 24. MVP Architecture
- 25. MVP Architecture • Presenterを介してModelを制御する設計 View Presenterからの情報を レンダリングする -> 端末の状態は配慮不要 になる Presenter - Activityから分割 - ユーザーイベントを ハンドルする - Modelの結果をViewに 返すAndroid Frameworks Activity View Model Presenter User usessees
- 26. public interface ShowUserListView { // UI として表示したい処理を定義する void showLoading(); void hideLoading(); void showNoResultCase(); void hideNoResultCase(); void showResult(Collection<User> usersCollection); } Views
- 27. public abstract class Presenter { // Activity LifeCycle public abstract void initialize(); public abstract void resume(); public abstract void pause(); public abstract void destroy(); } Presenters public class ShowUserListPresenter extends Presenter { public void setShowUserListView(ShowUserListView view){ mShowUserListView = view; //Viewを監視できるようにする } public void getFollowerList(String user){ mShowUserListView.showLoading(); // Activity側にCallbackする } }
- 28. Activity public class MainActivity implements ShowUserListView{ @Override public void onCreate(){ mShowUserListPresenter = new ShowUserListPresenter(…); mShowUserListPresenter.setShowUserListView(this); } @Override public void showLoading() { //実際のUI処理はActivityで実行できる! mListView.setVisibility(View.GONE); mProgress.setVisibility(View.VISIBLE); } @Override public void showResult(Collection<User> usersCollection) { mListView.setVisibility(View.VISIBLE); mUserAdapter.refresh(usersCollection); } }
- 29. MVC Architecture on Android における課題 MVP Architecture ModelとController間のインタラクション(ビジネスロジック)が システム状態(LifeCycle)に影響を受ける/テストしにくい Modelのデータ・ソースが多様 各層の依存関係が強い
- 30. MVC Architecture on Android における課題 MVP Architecture ModelとController間のインタラクション(ビジネスロジック)が システム状態(LifeCycle)に影響を受ける/テストしにくい Modelのデータ・ソースが多様 各層の依存関係が強い
- 31. Domain Layer
- 32. • Domain Layerにビジネスロジック (interactorまたはuse casesと呼ぶ)を 集約する • Modelとの処理はDomain経由で行う • 処理は非同期で実行する • Pure Java Domain Layer Domain Android Frameworks Activity View Model Presenter User usessees
- 33. Domain Layer UseCase <<abstract>> ベースとなるスレッド処理を実装 ConcreteUseCase UseCaseを継承 ロジック処理の実行、Presenterへのコールバック PostExecutionThread (UIThread) スレッド実行後の処理 • Domain層は大まかにUseCase, Threadにより成立 • 設計方法は多くの手法がある
- 34. public abstract class UseCase<T> { // スレッドをキュー処理できるようにする private ExecutorService mExecutorService = Executors.newSingleThreadExecutor(); public void start(final T params) { mExecutorService.submit(new Runnable() { @Override public void run() { call(params); } }); } //スレッド内でcallされるメソッド abstract protected void call(T params); } UseCase https://github.com/kgmyshin/Android-archを参考
- 35. public class FollowerListUseCase extends UseCase<String> { @Override public void execute(String user, FollowerListUseCaseCallback callback){ mCallback = callback; this.start(user); // (1) ExecutorServiceのスレッド経由でcall()が呼ばれる } @Override protected void call(String user) { // (2) Modelからデータ取得、バリデーション等のロジック処理。 // …省略 // (3) 処理後はUIThread( PostExecutionThread )にCallbackを返す mPostExecutionThread.post(() -> {mCallback.onUserListLoaded(usersCollection);}); } // UIThreadに返すCallbackのinterface interface FollowerListUseCaseCallback { onUserListLoaded(final Collection<User> usersCollection); onError(); } } ConcreteUseCase
- 36. Presenter public class ShowUserListPresenter extends Presenter implements FollowerListUseCaseCallback { private FollowerListUseCase mFollowerListUseCase; public void getFollowerList(String user){ // (1) usecaseを実行 -> 別スレッドへ mFollowerListUseCase.execute(user, this); } // (2) FollowerListUseCaseCallback経由で処理結果を受け取る @Override onUserListLoaded(final Collection<User> usersCollection){ // Viewへ結果を渡す } @Override onError(){ // error handling } }
- 37. MVC Architecture on Android における課題 MVP Architecture Domain Layer Modelのデータ・ソースが多様 各層の依存関係が強い
- 38. MVC Architecture on Android における課題 MVP Architecture Domain Layer Modelのデータ・ソースが多様 各層の依存関係が強い
- 39. Data Layer
- 40. Android Frameworks Data Layer • データをEntity(メソッドやデー タ構造体のかたまり)として扱う • Domain Layerにデータ元を意識 させないためにRepository パ ターンで実装する Domain Android Frameworks Activity View Data Presenter User usessees
- 41. Repository Pattern • ドメイン駆動開発で利用されるデザインパターン • UseCaseで必要なデータソースを集約した Repositoryクラスを実装する Data UserRepository DocsRepository XXRepository
- 42. public class UserRepository { private GithubApi mApi; // Github API用のインスタンス private UserMemoryCache mUserMemoryCache; //メモリキャッシュ用インスタンス public UserRepository(){ mUserMemoryCache = UserMemoryCache.getInstance(); mApi = createGithubApi(); } public void getFollowers(String user,UserListCallback callback) { mApi.listFollowersAsync( ... // Networkから取得 } public void putUser(User user){ mUserMemoryCache.put(… // メモリにキャッシュ } } Repository
- 43. MVC Architecture on Android における課題 MVP Architecture Domain Layer Data Layer(Repository Pattern) 各層の依存関係が強い
- 44. MVC Architecture on Android における課題 MVP Architecture Domain Layer Data Layer(Repository Pattern) 各層の依存関係が強い
- 46. Dependency Inversion Principle • 依存関係逆転の原則 • 上位モジュールは下位モジュー ルに依存しない 例) PresenterはDomainの実装が どのようになってても影響を受 けない • interfaceを各層の間に置く Android Frameworks Domain Android Frameworks Activity View Data Presenter User usessees interface interface
- 47. public interface UserRepository { // Domain層(UseCase)側はこの interfaceの仕様だけ知っていればOK void getFollowers(String userId, UserRepositoryCallback callback); void getUser(String userId, UserRepositoryCallback callback); void putUser(User user); } Dependency Inversion //実際の実装は interfaceを継承する public class UserRepositoryImpl implements UserRepository { @Override public void getFollowers(String userId, UserRepositoryCallback callback){ //データ取得 … } @Override public void putUser(User user) { } //… }
- 48. MVC Architecture on Android における課題 MVP Architecture Domain Layer Data Layer(Repository Pattern) Dependency Inversion Principle
- 49. どう変わった？
- 51. なんか難しい…?
- 52. 少しずつ手をつけると よいかも
- 53. どこから手を付けるべきか 手法 実現難易度 MVP Architecture ☆ Domain Layer ☆☆☆ Data Layer(Repository Pattern) ☆☆ Dependency Inversion Principle ☆☆
- 54. Next step… • Dependency Injection • 簡潔に書ける • モジュールの載せ替えが容易
- 55. Next step… • Implementing Observer Pattern • Domain Layerの煩雑なスレッド処理, Callback地獄か らの開放 参考例: https://github.com/android10/Android-CleanArchitecture
- 56. – Clean Architecture, Uncle Bob Architecture is about Intents, not Frameworks
- 57. – Clean Architecture, Uncle Bob 設計とは(良いコードが書きたいっていう) 意志である! フレームワークなんて関係ねぇ!(意訳)