Dagger and android
Dagger2가 다른 의존성주입 프레임웍들에 비해 주요장점중에 하나는 엄격하게 만들어졌다는것이며 이는 안드로이드앱에서도 사용될 수 있음을 의미한다. 하지만 대거를 안드로이드 앱에서 사용하기 위해서는 고려할것들이 있다.
안드로이드가 자바로 작성이 되지만 스타일면에서 꽤 다르다. 보통 이런 차이점은 모바일의 성능고려를 수용하기 위해 존재한다.
하지만 많은 패턴들이 이와는 반대인 경우가 많다. Effective Java의 많은 어드바이스들이 안드로이드에 적절하게 적용가능하다.
이런 목표를 달성하기 위해 대거는 컴파일된 바이트코드를 후처리하기 위해 프로가드에 의존한다. 이는 대거가 코드를 서버와 안드로이드 둘다 자연스럽게 코드를 만들어낼 수 있게 한다. 서로 다른 툴체인과 바이트코드를 만들어냄에도 불구하고…
대거는 이른 보장하기 위해 프로가드 최적화에 호환되는 코드를 만들어낸다.
따라서 대거는 프로가드를 사용해야 한다.
Recommended ProGuard Settings
dagger.android
대거를 사용하는 안드로이드앱을 작성하는 가장 큰 어려움중에 하나는 액티비티나 프래그먼트같은 안드로이드 프래임웍 클래스들이 OS에 의해서 인스턴스화되지만 대거는 삽입된 모든 객체를 생성할 수 있는 경우 가장 잘동작한다는것이다. 대신에 생명주기 메서드내에서 멤버주입을 수행해야 한다. 이는 많은 클래스들이 다음의 형태와 같다는것을 의미한다.
public class FrombulationActivity extends Activity {
@Inject Frombulator frombulator;
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
//이 작업을 먼저 하지 않으면 frombulator가 null일것이다.
((SomeApplicationBaseType) getContext().getApplicationContext())
.getApplicationComponent()
.newActivityComponentBuilder()
.activity(this)
.build()
.inject(this);
// ... now you can write the exciting code
}
}
이는 몇가지 문제가 있다.
- 복사붙이기가 나중에 리팩터링하기 힘들다. 많은 개바자들이 그렇게들 하는데 일부만 멀하는지 이해한다.
- 더 근본적으로 이는 타입요청 주입이다. 이는 인젝터가 타입을 알아야 한다. 각각 타입이 아니라 인터페이스를 통해 이른 해결한다 해도 이는 의존성주입의 핵심원리를 깬다. 클래스는 어떻게 주입되는지 아무것도 몰라야 한다.
dagger.android의 클래스들은 이 패턴을 단순화하기 위한 하나의 접근법을 제공한다.
Injecting Activity objects
- 애플리케이션 구성요소에 AndroidInjectionModule을 설치해서 이러한 기본 유형에 필요한 모든 바인딩을 사용할수 있도록 하라.
- AndroidInjector<YoutActivity>를 구현하는 @Subcomponent작성을 시작해라. AndroidInjector.Factory<YourActivity>를 확장한 @Subcomponent.Factory가 있다.
@Subcomponent(modules = ...)
public interface YourActivitySubcomponent extends AndroidInjector<YourActivity> {
@Subcomponent.Factory
public interface Factory extends AndroidInjector.Factory<YourActivity> {}
}
3. 서브콤포넌트를 정의하고 나서 모듈을 정의하여 콤포넌트 구조를 추가해라. 모듈은 서브콤포넌트 팩토리를 바인딩하여 애플리케이션에 주입할 콤포넌트를 추가한다.
@Module(subcomponents = YourActivitySubcomponent.class)
abstract class YourActivityModule {
@Binds
@IntoMap
@ClassKey(YourActivity.class)
abstract AndroidInjector.Factory<?>
bindYourActivityInjectorFactory(YourActivitySubcomponent.Factory factory);
}
@Component(modules = {..., YourActivityModule.class})
interface YourApplicationComponent {}
2단계에서와 달리 서브콤포넌트와 팩토리가 메서드나 수퍼타입을 갖고 있지 않은 경우 @ContributesAndroidInjector를 사용할 수 있다. 2, 3단계대신에 abstract모듈 메세드를 @ContributesAndroidInjector와 함께 추가하여 당신의 액티비티를 반환할 수 있다. 그리고 서브콤포넌트에 설치하고자 하는 모듈을 기술하라.
서브콤포넌트가 스콥이 필요하면 스콥주석을 사용할수 있다
@ActivityScope
@ContributesAndroidInjector(modules = { /* modules to install into the subcomponent */ })
abstract YourActivity contributeYourActivityInjector();
4. 이제 당신의 애플리케이션에 HasActivityInjector를 구현하고 @Inject에 DispatchingAndroidInjector<Activity>를 지정하여 activityInjector()로부터 반환한다.
public class YourApplication extends Application implements HasActivityInjector {
@Inject DispatchingAndroidInjector<Activity> dispatchingActivityInjector;
@Override
public void onCreate() {
super.onCreate();
DaggerYourApplicationComponent.create()
.inject(this);
}
@Override
public AndroidInjector<Activity> activityInjector() {
return dispatchingActivityInjector;
}
}
5. 마지막으로 Activity.onCreate()메서드에서 AndroidInjection.inject(this)를 super.onCreate()호출전에 호출한다.
public class YourActivity extends Activity {
public void onCreate(Bundle savedInstanceState) {
AndroidInjection.inject(this);
super.onCreate(savedInstanceState);
}
}
어떻게 동작하나?
AndroidInjection.inject()는 Application으로부터 DispatchingAndroidInjector<Activity>를 얻고 inject(Activity)로 액티비티에 전달된다.
DispatchingAndroidInjector는 당신의 액티비티의 클래스(YourActivitySubcomponent.Factory)를 위해 AndroidInjector.Factory를 찾고, AndroidInjector(YourActivitySubComponent)를 생성하고, inject(yourActivity)로 당신의 액티비티를 전달한다.
프래그먼트 객체의 주입
프래그먼트를 주입하는것은 액티비티를 주입하는것 만큼 단순하다. 같은 방식으로 서브콤포넌트를 정의하고 HasActivityInjector를 HasFragmentInjector로 변경하면 된다.
onCreate()에서 액티비티를 주입하는것 대신에 onAttach(..)에서 주입하면 된다.
액티비티에 정의된 모듈과 달리, 프래그먼트에 모듈을 설치할 위치를 선택할수 있다. 당신의 프래그먼트콤포넌트를 다른 프래그먼트 콤포넌트, 액티비티 콤포넌트 또는 애플리케이션 콤포넌트의 서브콤포넌트로 만들수 있다. 이는 당신의 프래그먼트를 필요로 하는 다른 바인딩에 의존한다. 콤포넌트의 위치를 결정하고 나서 대응되는 타입의 HasFragmentInjector를 구현한다. 예를 들어 당신의 프래그먼트가 YourActivitySubcomponent에서 바인딩이 필요하면 다음과 같이 코딩할것이다.
public class YourActivity extends Activity
implements HasFragmentInjector {
@Inject DispatchingAndroidInjector<Fragment> fragmentInjector;
@Override
public void onCreate(Bundle savedInstanceState) {
AndroidInjection.inject(this);
super.onCreate(savedInstanceState);
// ...
}
@Override
public AndroidInjector<Fragment> fragmentInjector() {
return fragmentInjector;
}
}
public class YourFragment extends Fragment {
@Inject SomeDependency someDep;
@Override
public void onAttach(Activity activity) {
AndroidInjection.inject(this);
super.onAttach(activity);
// ...
}
}
@Subcomponent(modules = ...)
public interface YourFragmentSubcomponent extends AndroidInjector<YourFragment> {
@Subcomponent.Factory
public interface Factory extends AndroidInjector.Factory<YourFragment> {}
}
@Module(subcomponents = YourFragmentSubcomponent.class)
abstract class YourFragmentModule {
@Binds
@IntoMap
@ClassKey(YourFragment.class)
abstract AndroidInjector.Factory<?>
bindYourFragmentInjectorFactory(YourFragmentSubcomponent.Factory factory);
}
@Subcomponent(modules = { YourFragmentModule.class, ... }
public interface YourActivityOrYourApplicationComponent { ... }
Base Framework Types
DispatchingAndroidInjector가 런타임에 해당클래스가 전용 AndroidInjector.Factory를 찾기 때문에 기반클래스는 AndroidInjection.inject()를 호출하고 HasActivityInjector/HasFragmentInjector/등을 구현해야 한다. 모든 서브클래스들이 해야 하는 일은 대응되는 @Subcomponent를 바인딩해야 하는것이다. 대거는 복잡한 클래스구조가 없다면 DaggerActivity와 DaggerFragment같은 몇가지 기반클래스를 제공한다. 대거는 같은 목적으로 DaggerApplication도 제공한다. 당신이 해야 할 일은 이를 확장하고 applicationInjector()메서드를 오버라이드하여 application을 주입하는 콤포넌트를 반환한다.
다음 타입들 또한 제공된다
- DaggerService 와 DaggerIntentService
- DaggerBroadcastReceiver
- DaggerContentProvider
DaggerBroadcastReceiver는 AndroidManifest.xml에 등록되어 있어야 한다.
코드로 BroadcastReceiver가 생성되면 대신에 생성자주입을 선호합니다.
지원라이브러리는 dagger.android.support 패키지이다
Build.gradle에 다음을 추가해야 한다.
dependencies {
compile 'com.google.dagger:dagger-android:2.x'
compile 'com.google.dagger:dagger-android-support:2.x' // if you use the support libraries
annotationProcessor 'com.google.dagger:dagger-android-processor:2.x'
}
When to inject
생성자 주입은 가능하면 더 선호된다. javac는 셋팅되기전에 필드가 참조되지 않아서 널포인트를 피할수 있도록 해주기 때문에 선호된다.
멤버주입이 필요한 경우(위에서 언급된) 가능하면 빨리 주입하는것이 선호된다. DaggerActivity가 super.onCreate()가 호출되기 전에 AndroidInjection.inject()를 바로 호출하기 때문에 선호된다. 프래그먼트의 경우는 onAttach()에서 한다.
super.onCreate()보다 전에 AndroidInjection.inject()를 먼저 호출하는것이 중요하다. 반대로 하면 컴파일에러가 발생한다.
