Android开发之dagger.android--Activity

·  阅读 604

Dagger2开发Android的问题

使用Dagger2开发Android的话,有一个困难就是android的一些框架类,如Activity和Fragment等,他们的实例化由操作系统完成,如果要想让Dagger2也能很好地注入这些对象,你不得不在生命周期里添加以下代码完成注入过程。

public class FrombulationActivity extends Activity {
  @Inject Frombulator frombulator;

  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    // DO THIS FIRST. Otherwise frombulator might be null!
    ((SomeApplicationBaseType) getContext().getApplicationContext())
        .getApplicationComponent()
        .newActivityComponentBuilder()
        .activity(this)
        .build()
        .inject(this);
    // ... now you can write the exciting code
  }
}
复制代码

这样做存在以下问题:

  • 1.上面的代码要复制粘贴到所有的Activity中,这就会给以后重构代码造成麻烦,你的团队越来越多的人复制上面的代码块,会有越来越少的人知道这块代码的真正用途。
  • 2.更重要的是,它要求请求注射类型(FrombulationActivity )知道它的注射器,既即使它可以通过接口而不是具体的类型完成,但是它打破了依赖注入的核心原则:一个类不应该知道任何关于它是如何注入的。

以上,所以基于Dagger2的,适用于Android开发的Dagger2-Android应运而生。

以上翻译以及以下的代码均来自Dagger2的官网, 官网传送门

代码传送门,已提交到Github

配置

要使用Dagger.Android的话,需要添加下面的依赖。

//If you're using classes in dagger.android you'll also want to include:

  compile 'com.google.dagger:dagger-android:2.15'
  compile 'com.google.dagger:dagger-android-support:2.15' // if you use the support libraries
  annotationProcessor 'com.google.dagger:dagger-android-processor:2.15'
复制代码

注入Activity

  • 1 在application component中注入 AndroidInjectionModule,以确保Android的类(Activity、Fragment、Service、BroadcastReceiver及ContentProvider等)都可以被绑定。
@Singleton
@Component(modules = {AndroidInjectionModule.class,AppModule.class,})
public interface AppComponent {
    void inject(MyApplication application);
}
复制代码
  • 2 创建子组件 - DaggerAndroidActSubComponent:其继承自 AndroidInjector<YourActivity>,在该子组件中含有一个抽象类Builder, 该Builder继承自AndroidInjector.Builder,并由@Subcomponent.Builder注解。
@Subcomponent(modules = AndroidInjectionModule.class)
public interface DaggerAndroidActSubComponent extends AndroidInjector<DaggerAndroidActivity>{

    @Subcomponent.Builder
     abstract class Builder extends AndroidInjector.Builder<DaggerAndroidActivity>{

    }

}
复制代码
    1. 创建Module - DaggerAndroidActModule:在定义了子组件DaggerAndroidActSubComponent后,定义该子组件的Module - DaggerAndroidActModule,并绑定DaggerAndroidActSubComponent.Builder,然后将DaggerAndroidActModule添加到组件层次中。
      在DaggerAndroidActModule里,提供了一个获取Student实例的方法。
@Module(subcomponents = DaggerAndroidActSubComponent.class)
public abstract class DaggerAndroidActModule {

    @Binds
    @IntoMap
    @ActivityKey(DaggerAndroidActivity.class)
    abstract AndroidInjector.Factory<? extends Activity> bindDaggerAndroidActivityInjectorFactory(DaggerAndroidActSubComponent.Builder builder);

    @Provides
    @Singleton
    static Student provideStudent() {
        return new Student();
    }
}

复制代码
  • 4 将上一步定义的DaggerAndroidActModule 添加到Application Component中。
@Singleton
@Component(modules = {AndroidInjectionModule.class, AppModule.class, DaggerAndroidActModule.class})
public interface AppComponent {
    void inject(MyApplication application);
}
复制代码

注意:
如果在Module中提供依赖实例,@Provides方法必须为静态方法,否则编译不通过。

  • 5 自定义Application,并实现HasActivityInjector接口,同时注入(@Inject)DispatchingAndroidInjector<Activity>实例,该实例在activityInjector()方法中返回。
public class MyApplication extends Application implements HasActivityInjector{

    @Inject
    DispatchingAndroidInjector<Activity> dispatchingActivityInjector;

    @Override
    public void onCreate() {
        super.onCreate();
        DaggerAppComponent.create()
                .inject(this);
    }

    @Override
    public AndroidInjector<Activity> activityInjector() {
        return dispatchingActivityInjector;
    }
}

复制代码
    1. 在DaggerAndroidActivity.onCreat()方法中,在调用super.onCreate()之前调用AndroidInjection.inject(this)。
      我在AppModule提供了一个LogUtil对象,在DaggerAndroidActModule中提供给了一个Student对象。
public class DaggerAndroidActivity extends AppCompatActivity {

    @Inject
    LogUtil mLogUtil;

    @Inject
    Student mStudent;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        AndroidInjection.inject(this);
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_dagger_android);

        Log.d("hbj--",mLogUtil.toString());
        Log.d("hbj--",mStudent.toString());
        mLogUtil.d("inject success!");
    }
}

复制代码

运行结果可以看到,都是inject成功的,mLogUtil对象也可以打印出log。


有缺点吗

上面是完全参照官网给出的流程,这样做是不是完美呢。

  • 1 我们每新建一个Activity,都要写一个DaggerYourActivityModule的Java文件,添加到AppComponent中,
    如果Activity够多,那这里实在太多了。
  • 2 每个DaggerYourActivityModule的Java文件要都有一个DaggerYourActivitySubComponent文件,同样也需要建立多个SubComponent文件。
  • 3 这些DaggerYourActivityModule是要添加到AppComponent中的,最终会造成AppComponent的代码如下所示:
@Component(modules = {AndroidInjectionModule.class, AppModule.class, DaggerAndroidActModule.class,
DaggerYourActivityModule.class,
DaggerYourActivity1Module.class,
DaggerYourActivity2Module.class,
DaggerYourActivity3Module.class,
DaggerYourActivity4Module.class,
.......})

public interface AppComponent {
    void inject(MyApplication application);
}
复制代码

在官网上有这么个专业提示:
···
Pro-tip: If your subcomponent and its builder have no other methods or supertypes than the ones mentioned in step #2, you can use @ContributesAndroidInjector to generate them for you. Instead of steps 2 and 3, add an abstract module method that returns your activity, annotate it with @ContributesAndroidInjector, and specify the modules you want to install into the subcomponent. If the subcomponent needs scopes, apply the scope annotations to the method as well.
···

如果您的subcomponent 及其构建器没有第2步中提到的其他方法或超类型,您可以使用@ContributesAndroidInjector为您生成它们。我们就不需要步骤2和3,取而代之的是添加一个抽象模块方法,该方法返回您的activity,使用@ContributesAndroidInjector对其进行注解,并指定要安装到子组件中的模块。 如果子组件需要scopes,则也可以用@scopes注解到该方法。
复制代码

代码如下:

@ActivityScope
@ContributesAndroidInjector(modules = { /* modules to install into the subcomponent */ })
abstract YourActivity contributeYourActivityInjector();
复制代码

代码改进

所以我们的代码改进如下:

  • 1 新建一个AllActivitysModule,在这里提供所有的ActivityModule,每个都用@ContributesAndroidInjector注解。
@Module(subcomponents = DaggerAndroidActSubComponent.class)
public abstract class AllActivitysModule {

    @ContributesAndroidInjector(modules = DaggerAndroidActModule.class)
    abstract DaggerAndroidActivity contributeDaggerAndroidActivityInjector();

}
复制代码
  • 2 修改DaggerAndroidActModule,变成一个普通的Module,和前文对比,删掉了(subcomponents = DaggerAndroidActSubComponent.class)以及bindDaggerAndroidActivityInjectorFactory()抽象方法。在这里可以根据需要提供实例。
@Module
public abstract class DaggerAndroidActModule {


    @Provides
    static Student provideStudent() {
        return new Student();
    }
}
复制代码
  • 3 修改AppComponent,删除原来的DaggerAndroidActModule,把AllActivitysModule.class放进modules中。
@Singleton
@Component(modules = {AndroidInjectionModule.class, AppModule.class, AllActivitysModule.class})
public interface AppComponent {
    void inject(MyApplication application);
}
复制代码

运行代码,同样inject成功。

进一步改进

看一下我们的AllActivitysModule的代码

@Module(subcomponents = DaggerAndroidActSubComponent.class)
public abstract class AllActivitysModule {

    @ContributesAndroidInjector(modules = DaggerAndroidActproModule.class)
    abstract DaggerAndroidActivity contributeDaggerAndroidActivityInjector();

}
复制代码

它是依赖于DaggerAndroidActSubComponent.class的,在查看DaggerAndroidActSubComponent的代码

@Subcomponent(modules = AndroidInjectionModule.class)
public interface DaggerAndroidActSubComponent extends AndroidInjector<DaggerAndroidActivity>{

    @Subcomponent.Builder
     abstract class Builder extends AndroidInjector.Builder<DaggerAndroidActivity>{

    }

}
复制代码

它AndroidInjector.Builder的是DaggerAndroidActivity,这样对于其他的Activity是不可以的,我们要求的是对所有Activity都通用。我们继续改进代码。
首先分析一下DaggerAndroidActSubComponent,AndroidInjector.Builder的是DaggerAndroidActivity,而DaggerAndroidActivity完成了什么呢,查看一下,在DaggerAndroidActivity完成的是注入,仅有一行代码:

 AndroidInjection.inject(this);
复制代码

所以我们猜想,我们可以抽取一个BaseActivity,所有的Activity都继承自BaseActivity。

  • 新建BaseActivity,在BaseActivity里执行 AndroidInjection.inject(this);
public class BaseActivity extends AppCompatActivity{
    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        AndroidInjection.inject(this);
        super.onCreate(savedInstanceState);
    }
}
复制代码

并将其他的Activity继承BaseActivity。

public class DaggerAndroidActivity extends BaseActivity {
}
复制代码
  • 新建BaseActivityComponent,在这里我们AndroidInjector.Builder的是上部新建的BaseActivity。
@Subcomponent(modules = {AndroidInjectionModule.class})
public interface BaseActivityComponent extends AndroidInjector<BaseActivity>{

    @Subcomponent.Builder
    abstract class Builder extends AndroidInjector.Builder<BaseActivity>{

    }
}
复制代码
  • 修改AllActivitysModule 代码,子部件换为上部新建的BaseActivityComponent。
@Module(subcomponents = BaseActivityComponent.class)
public abstract class AllActivitysModule {

    @ContributesAndroidInjector(modules = DaggerAndroidActproModule.class)
    abstract DaggerAndroidActivity contributeDaggerAndroidActivityInjector();

}
复制代码

编译运行,同样可以看到结果。

总结

经过改进,如果我们新添了新的Activity,我们只要下面的步骤:

  • 1.新Activity继承BaseActivity。
    1. 为新Activity建一个NewActivityModule,这是一个普通的Module,用@Module注解,在这提提供新Activity需要的实例。注意要用static关键字哦。
  • 3 新Activity添加到AllActivitysModule 中,类似于下面的代码。
@Module(subcomponents = BaseActivityComponent.class)
public abstract class AllActivitysModule {

    @ContributesAndroidInjector(modules = DaggerAndroidActproModule.class)
    abstract DaggerAndroidActivity contributeDaggerAndroidActivityInjector();
    // 新增一个Activity
    @ContributesAndroidInjector(modules = DaggerAndroid2ActModule.class)
    abstract DaggerAndroid2Activity contributeDaggerAndroid2ActivityInjector();

}
复制代码

参照官网,经过改进,注入过程更加简洁。
代码传送门
除了Activity之外,Dagger-Android还提供了Fragment,BroadcastReceiver,Service等其他组件的注入方式,下次再讨论。


分类:
Android
标签:
分类:
Android
标签:
收藏成功!
已添加到「」, 点击更改