Dagger2を活用してAndroid SDKの依存関係をクリーンにする

by kr9ly

Slide 1

Slide 1 text

Dagger2 を活用して Android SDK の依存関係をクリーンにする DroidKaigi 2018 Day2 14:00 ～ Room1 からくり（ @kr9ly ）

Slide 2

Slide 2 text

自己紹介からくり（ @kr9ly ） Ice Cream Sandwitch(4.0)くらいのころからの Androider です dely という五反田の会社で働いてますクラシルのアプリつくってます

Slide 3

Slide 3 text

DI 使ってますか？

Slide 4

Slide 4 text

Android での DI ライブラリ RoboGuice （ deprecated ） Dagger （ deprecated ） Dagger2 Kodein などなど

Slide 5

Slide 5 text

Android での DI ライブラリ RoboGuice （ deprecated ） Dagger （ deprecated ） Dagger2 Kodein などなど

Slide 6

Slide 6 text

DI を使う目的疎結合化依存関係を整理テスタビリティの向上インスタンスのライフタイム管理などなど

Slide 7

Slide 7 text

しかし Android アプリの場合

Slide 8

Slide 8 text

Android SDK への依存がいっぱい Context 依存 SDK 由来の機能（画面遷移、SystemSer vice、GPS 等々） FragmentManager Activity/Fragment のコールバック（ライフサイクルイベントとか）

Slide 9

Slide 9 text

DI コンテナの外の世界に依存しがち Activity/Fragment へ直接 Injection 神に近づいていくActivity/Fragment アーキテクチャ（ MVP, MVVM... ）を貫徹できない（この部分のコードは何のアーキテクチャ？） Robolectricがないとうまくテストできなかったり結局今までと変わらないのでは？

Slide 10

Slide 10 text

DI （うまく）使ってますか？

Slide 11

Slide 11 text

Dagger2 活用ベタープラクティス集目的ロジック部分から Context への依存を完全に排除するコードのほとんどの部分を DI コンテナの中で解決させる Robolectric なしで Presenter, ViewModel などなどをテストする ※ テストについては今日は話しませんサンプルリポジトリはこちら https://github.com/kr9ly/dagger2-sampleapp

Slide 12

Slide 12 text

注意 ViewModel は MVVM の ViewModel のことです（ Android Architecture Components の話ではない）なるべくいろいろなやり方のメリット / デメリットを紹介してますがあくまで一つのサンプルです個人的な好みが反映されている部分が多分にあります

Slide 13

Slide 13 text

目次 @Scope を活用する Context 依存を切り離す画面遷移を整理する Activity/Fragment のコールバックイベントを整理する

Slide 14

Slide 14 text

目次 @Scope を活用する Context 依存を切り離す画面遷移を整理する Activity/Fragment のコールバックイベントを整理する

Slide 15

Slide 15 text

@Scope を活用する @Scope @Retention(RetentionPolicy.RUNTIME) public @interface ViewScope { } 代表的なのは @Singleton

Slide 16

Slide 16 text

@Scope を活用すると @Singleton 以外のスコープ管理が可能に Activity/Fragmentごとにユニークなインスタンスを Provide できる Activity/Fragmentごとにユニークなインスタンスが管理できるとうれしいことの例 Rx の dispose 処理画面遷移 FragmentManager のコントロール Activity/Fragment のコールバックメソッドの呼び出し

Slide 17

Slide 17 text

@Scope を使ってアノテーションを定義する @Scope @Retention(RetentionPolicy.RUNTIME) public @interface ViewScope { }

Slide 18

Slide 18 text

Component 定義例 @ViewScope @Subcomponent(modules = {FragmentManagerDelegatedModule.class}) public interface ViewScopeComponent { ListViewModel listViewModel(); DetailViewModel detailViewModel(): } 自前 Scope 用の Component を定義する（ここから参照される Module の @Provides に自前 Scope のアノテーションを付与する）

Slide 19

Slide 19 text

Component 定義例 @Singleton @Component public interface ApplicationComponent { ViewScopeComponent viewScopeComponent( FragmentManagerDelegatedModule fragmentManagerModule ); } Singleton -> 自前 Scope の Component 生成は Subcomponentが楽

Slide 20

Slide 20 text

Subcomponent を作る方法の例 public class ApplicationComponentManager { private static final WeakHashMap components = new WeakHashMap<>(); public static synchronized ApplicationComponent get(Context context) { Context appContext = context.getApplicationContext(); ApplicationComponent component = components.get(appContext); if (component != null) { return component; } component = DaggerApplicationComponent.builder() .resourceProviderModule(new ResourceProviderModule(appContext)) .build(); components.put(context, component); return component; } }

Slide 21

Slide 21 text

Subcomponent を作る方法の例 public abstract class DaggerBaseActivity extends AppCompatActivity { @Override public void onCreate(@Nullable Bundle savedInstanceState) { super.onCreate(savedInstanceState); ViewScopeComponent viewScopeComponent = ApplicationComponentManager .get(this) .viewScopeComponent( new FragmentManagerDelegatedModule( new FragmentManagerActivityDelegate(this) ) ); onComponentPrepared(viewScopeComponent, savedInstanceState); } protected abstract void onComponentPrepared(ViewScopeComponent component, @Nullable Bundle savedInstanceState); }

Slide 22

Slide 22 text

Subcomponent の切り方いろいろ Activity/Fragment は別の Component Activity/Fragment で同一の Component ...

Slide 23

Slide 23 text

Activity/Fragment は別の Component メリット依存 Module をそれぞれで別のものにできるデメリット Component を二つ定義する必要があって面倒

Slide 24

Slide 24 text

Activity/Fragment で同一の Component メリット Component 定義が一つで済むデメリット依存 Module を切りかえられない

Slide 25

Slide 25 text

Component 分けどうする？依存対象クラスは Activity と Fragment であまり変わらない個人的には Component 定義が一つで済むほうがよさそうただし、Component 定義を一つで済ます場合は、依存対象の Module 内で処理を切り分ける必要がある

Slide 26

Slide 26 text

Module 内で処理を切り分ける方法 @Module public class FragmentManagerModule { @ViewScope @Provides FragmentManager provideFragmentManager() { // ActivityもFragmentもこのメソッドが呼ばれる return null; } } まずは Module を定義する

Slide 27

Slide 27 text

Module 内で処理を切り分ける方法 Delegate Pattern を適用する instanceof で分岐する

Slide 28

Slide 28 text

Delegate Pattern を適用する Delegate 用の interface を定義する @Module public class FragmentManagerDelegatedModule { private final FragmentManagerDelegate delegate; public FragmentManagerDelegatedModule(FragmentManagerDelegate delegate) { this.delegate = delegate; } @ViewScope @Provides FragmentManager provideFragmentManager() { // Delegate interfaceを呼び出す return delegate.provide(); } }

Slide 29

Slide 29 text

Delegate 用の interface public interface FragmentManagerDelegate { FragmentManager provide(); } 単に Provide 対象のインスタンスを返すだけここから Activity 用と Fragment 用で実装を分ける

Slide 30

Slide 30 text

Activity 用の interface 実装 public class FragmentManagerActivityDelegate implements FragmentManagerDelegate { private final FragmentActivity fragmentActivity; public FragmentManagerActivityDelegate(FragmentActivity fragmentActivity) { this.fragmentActivity = fragmentActivity; } @Override public FragmentManager provide() { return fragmentActivity.getSupportFragmentManager(); } } Activity への参照を持つ

Slide 31

Slide 31 text

Fragment 用の interface 実装 public class FragmentManagerFragmentDelegate implements FragmentManagerDelegate { private final Fragment fragment; public FragmentManagerFragmentDelegate(Fragment fragment) { this.fragment = fragment; } @Override public FragmentManager provide() { // うっかり親のFragmentManagerを参照してハマったりしない return fragment.getChildFragmentManager(); } } Fragment への参照を持つ

Slide 32

Slide 32 text

insntanceof で分岐する方法 public class FragmentManagerDynamicModule { private final Object scopeObject; public FragmentManagerDynamicModule(Object scopeObject) { this.scopeObject = scopeObject; } @ViewScope @Provides FragmentManager provideFragmentManager() { if (scopeObject instanceof FragmentActivity) { return ((FragmentActivity) scopeObject).getSupportFragmentManager(); } else if (scopeObject instanceof Fragment) { return ((Fragment) scopeObject).getChildFragmentManager(); } throw new IllegalStateException(); } } どちらが来てもいいように動的に切り分ける

Slide 33

Slide 33 text

どっちでも目的は達成できます静的に解決 or 動的に解決個人的には Delegate Pattern で実装したほうが安心（記述量は増えがち）

Slide 34

Slide 34 text

目次 @Scope を活用する Context 依存を切り離す画面遷移を整理する Activity/Fragment のコールバックイベントを整理する

Slide 35

Slide 35 text

Context に依存しがち Android はなんでも Context にあるついついContext をフィールドについついContext を引数に Context に密結合切り離していきましょう

Slide 36

Slide 36 text

二通りのやり方 Module のコンストラクタに Context の参照を渡すパターン Context 自体を Provide するパターン

Slide 37

Slide 37 text

コード例 public class ResourceProvider { private final Context context; public ResourceProvider(Context context) { this.context = context; } public String getString(@StringRes int resId) { return context.getString(resId); } public String getString(@StringRes int resId, Object... formatArgs) { return context.getString(resId, formatArgs); } } 例えば string 等の Resource にアクセスするクラス

Slide 38

Slide 38 text

Module のコンストラクタに Context の参照を渡すパターン @Module public class ResourceProviderModule { private final Context appContext; public ResourceProviderModule(Context appContext) { this.appContext = appContext; } @Singleton @Provides public ResourceProvider provideResourceProvider() { return new ResourceProvider(appContext); } }

Slide 39

Slide 39 text

Module のコンストラクタに Context の参照を渡すパターンメリット Context に直接依存すべきでないレイヤーからの Context 依存を避けられる（ Context インスタンス自体を隠ぺいできる）デメリット Context 依存が発生するたびに Module を定義する必要があり、若干面倒

Slide 40

Slide 40 text

Context 自体を Provide するパターン @Module public class AppContextModule { private final Context appContext; public AppContextModule(Context appContext) { this.appContext = appContext; } @Singleton @Provides public Context provide() { return appContext; } } こういった Module を定義しておく

Slide 41

Slide 41 text

Context 自体を Provide するパターン @Singleton public class ResourceProvider { private final Context context; @Inject public ResourceProvider(Context context) { this.context = context; } public String getString(@StringRes int resId) { return context.getString(resId); } public String getString(@StringRes int resId, Object... formatArgs) { return context.getString(resId, formatArgs); } } コンストラクタに @Inject, クラス定義に @Singleton

Slide 42

Slide 42 text

Context 自体を Provide するパターンメリット依存関係が簡単なのであればコンストラクタインジェクションのみで依存関係を定義できるデメリット Context に直接依存すべきでないレイヤーからも Context 依存が記述できてしまう（ Context インスタンス自体を隠ぺいできていない）

Slide 43

Slide 43 text

良し悪しあるのでプロジェクトにあったやり方を選びましょう

Slide 44

Slide 44 text

目次 @Scope を活用する Context 依存を切り離す画面遷移を整理する Activity/Fragment のコールバックイベントを整理する

Slide 45

Slide 45 text

Android の画面遷移 Intent Intent の生成に Contextが必要 Activity#startActivity, Fragment#startActivity と場所によって呼び出すべきメソッドが違う（特に startActivityForResult ）

Slide 46

Slide 46 text

画面遷移用の interface を定義する public interface TransitionHandler { void startActivity(IntentBuilder intentBuilder); } Intent についても生成用の interface を定義する public interface IntentBuilder { Intent build(Context context); }

Slide 47

Slide 47 text

Activity 用の実装を定義 public class ActivityTransitionHandler implements TransitionHandler { private final FragmentActivity activity; public ActivityTransitionHandler(FragmentActivity activity) { this.activity = activity; } @Override public void startActivity(IntentBuilder intentBuilder) { activity.startActivity(intentBuilder.build(activity)); } }

Slide 48

Slide 48 text

Fragment 用の実装を定義 public class FragmentTransitionHandler implements TransitionHandler { private final Fragment fragment; public FragmentTransitionHandler(Fragment fragment) { this.fragment = fragment; } @Override public void startActivity(IntentBuilder intentBuilder) { fragment.startActivity(intentBuilder.build(fragment.getContext())); } } Delegate Pattern 使うと簡単に Module 内で切り分けられます

Slide 49

Slide 49 text

Intent 生成に Contextが必要な問題を解決する public interface IntentBuilder { Intent build(Context context); } Intent 生成を interface で表現、引数に Context 依存を記述する Builder パターンは依存すべきでないレイヤーからの参照（この場合は ViewModelから Context ）を切り離せるのに結構使える

Slide 50

Slide 50 text

Intent 生成に Contextが必要な問題を解決する public class SimpleIntentBuilder implements IntentBuilder { private final Class extends Activity> targetActivityClass; public SimpleIntentBuilder(Class extends Activity> targetActivityClass) { this.targetActivityClass = targetActivityClass; } @Override public Intent build(Context context) { return new Intent(context, targetActivityClass); } } Contextが必要なパターンでも Intent 生成する側は Context に依存せずに済む

Slide 51

Slide 51 text

Intent にパラメータを設定したい場合 Intent#putExtra(String key, String value) Intent#putExtra(String key, int value) Intent#putExtra(String key, ㈭‹ oat value) 型ごとに呼び出すメソッドが違う、いい具合にパラメータを引き回しにくい場合の対応方法（ Bundle とかもそうですね）

Slide 52

Slide 52 text

型ごとに entry を抽象化 public interface ExtraEntry { void setExtra(Intent intent); } 例えばこんな interface を定義

Slide 53

Slide 53 text

型ごとに entry を抽象化 public class StringExtraEntry implements ExtraEntry { private final String key; private final String value; public StringExtraEntry(String key, String value) { this.key = key; this.value = value; } @Override public void setExtra(Intent intent) { intent.putExtra(key, value); } } 型ごとにそれぞれ実装

Slide 54

Slide 54 text

使う側はこんな感じに public class SimpleIntentBuilder implements IntentBuilder { private final List extras = new ArrayList<>(); private final Class extends Activity> targetActivityClass; public SimpleIntentBuilder(Class extends Activity> targetActivityClass) { this.targetActivityClass = targetActivityClass; } public void putExtra(String key, String value) { extras.add(new StringExtraEntry(key, value)); } @Override public Intent build(Context context) { Intent intent = new Intent(context, targetActivityClass); for (ExtraEntry extra : extras) { extra.setExtra(intent); } return intent; } } Fragment の Arguments 用の Bundle も同じような要領で

Slide 55

Slide 55 text

目次 @Scope を活用する Context 依存を切り離す画面遷移を整理する Activity/Fragment のコールバックイベントを整理する

Slide 56

Slide 56 text

Activity/Fragment のコールバックイベントのハンドリングを DI コンテナの中でやりたい Activity/Fragmentから DI コンテナの中の世界にアクセスする必要がよく出てくる @Override public void onStart() { // DIコンテナの外の世界に依存している viewModel.onStart(); } 結果ロジックが外に漏れがち（このくらいで済めばいいけども）

Slide 57

Slide 57 text

Activity/Fragment のコールバックイベントを整理するやり方二点 AAC(Android Architecture Components) Lifecycle を使う自前でコールバックを定義する

Slide 58

Slide 58 text

AAC Lifecycle を使う @Module public class AacLifecycleModule { // FragmentActivity/Fragment private final LifecycleOwner lifecycleOwner; public AacLifecycleModule(LifecycleOwner lifecycleOwner) { this.lifecycleOwner = lifecycleOwner; } @ViewScope @Provides Lifecycle provideAacLifecycle() { return lifecycleOwner.getLifecycle(); } } Lifecycle を Provide する Module を定義する

Slide 59

Slide 59 text

AAC Lifecycle を使う public class ListViewModel implements LifecycleObserver { @Inject public ListViewModel( Lifecycle lifecycle ) { lifecycle.addObserver(this); } @OnLifecycleEvent(Lifecycle.Event.ON_START) public void onStart() { // do something } } 使う側はこんな感じ詳しくは https://developer.android.com/topic/libraries/arc hitecture/lifecycle.html

Slide 60

Slide 60 text

AAC Lifecycle を使うメリット標準の安心感使うのは簡単デメリット別に全部網羅してるわけじゃない（ライフサイクル関連のみ）イベントが追加できない

Slide 61

Slide 61 text

自前でコールバックを定義するコールバック用の基底 interface を定義コールバックの interface を定義自前コールバックの呼び出しコードを追加

Slide 62

Slide 62 text

コールバックの interface を定義 public interface LifecycleCallback { // 基底インターフェースを用意しておくことで登録メソッドに何でもは入れられないようにしておく } public interface OnStartCallback extends LifecycleCallback { void onStart(); }

Slide 63

Slide 63 text

コールバック管理クラスを作る @ViewScope public class LifecycleCallbackController { private final List onStartCallbackList = new ArrayList<>(); ... @Inject public LifecycleCallbackController() { } public void register(LifecycleCallback callback) { if (callback instanceof OnStartCallback) { onStartCallbackList.add((OnStartCallback) callback); } ... } public void onStart() { for (OnStartCallback onStartCallback : onStartCallbackList) { onStartCallback.onStart(); } }

Slide 64

Slide 64 text

コールバック管理クラスを Activity/Fragment の Componentから生成 @ViewScope @Subcomponent( modules = { FragmentManagerDelegatedModule.class, AacLifecycleModule.class } ) public interface LifecycleComponent { LifecycleCallbackController lifecycleCallbackController(); }

Slide 65

Slide 65 text

Activity/Fragmentからコールバックを呼ぶ public abstract class DaggerBaseActivity extends AppCompatActivity { private LifecycleCallbackController lifecycleCallbackController; @Override public void onCreate(@Nullable Bundle savedInstanceState) { super.onCreate(savedInstanceState); // lifecycleComponentを初期化 lifecycleCallbackController = lifecycleComponent .lifecycleCallbackController(); } @Override protected void onStart() { super.onStart(); // コールバックを呼ぶ lifecycleCallbackController.onStart(); }

Slide 66

Slide 66 text

自前のコールバッククラスの使い方 public class DetailViewModel implements OnStartCallback { @Inject public DetailViewModel( LifecycleCallbackController lifecycleCallbackController ) { lifecycleCallbackController.register(this); } @Override public void onStart() { // なにかやる } } 各イベントに対して一つずつしかコールバック定義できない（十分だとは思うけども … ）

Slide 67

Slide 67 text

自前のコールバッククラスの使い方 public class DetailViewModel { @Inject public DetailViewModel( LifecycleCallbackController lifecycleCallbackController ) { lifecycleCallbackController.register(new OnStartCallback() { @Override public void onStart() { // なにかやる } }); } } ネスト深くなる & 余計な inner class 生成される

Slide 68

Slide 68 text

自前でコールバックを定義するメリット自分でイベントを増やすのが容易（例えばキーイベントをコントロールしたくなった場合とか）デメリットメソッドにアノテーション定義するのに比べるとコードが奇麗じゃない（ Annotation Processor 自前で書くという手もある？） Android Architecture Components の普及、改善次第では負債になりそう

Slide 69

Slide 69 text

以上ベタープラクティス集でした

Slide 70

Slide 70 text

サンプルリポジトリ https://github.com/kr9ly/dagger2-sampleapp 割愛したコードはすべて入ってます今日あげた内容の他にも色々書いてます AutoDispose を組み込む方法 Intent /Bundle に依存せずにデータを取り出す方法 Android Data Binding と RecyclerView の組み合わせ ... ご興味あればどうぞ見てください

Slide 71

Slide 71 text

あくまでベタープラクティスですより良い方法あったら是非共有してくださいもっと DI まみれになろうぜご清聴ありがとうございました