Dagger2Android技术知识Android开发经验谈

Android开发之dagger.android--Activi

2018-04-08  本文已影响852人  Jackson杰

前言

前几篇文章主要介绍了Dagger2的使用。对Dagger2不了解的朋友可以看一下下面的几篇文章。
Android开发之Dagger2的基本使用（一）
Android开发之Dagger2--源码角度分析inject过程（二）
Android开发之Dagger2--Module&Component（三）
Android开发之Dagger2--MVP模式中使用（四）
Android开发之Dagger2--其他注解符（五）

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
  }
}

这样做存在以下问题：

以上，所以基于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

@Singleton
@Component(modules = {AndroidInjectionModule.class,AppModule.class,})
public interface AppComponent {
    void inject(MyApplication application);
}

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

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

    }

}

@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();
    }
}


@Singleton
@Component(modules = {AndroidInjectionModule.class, AppModule.class, DaggerAndroidActModule.class})
public interface AppComponent {
    void inject(MyApplication application);
}

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

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;
    }
}


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。


有缺点吗

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

@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();

代码改进

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

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

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

}

@Module
public abstract class DaggerAndroidActModule {


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

@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。

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 {
}

@Subcomponent(modules = {AndroidInjectionModule.class})
public interface BaseActivityComponent extends AndroidInjector<BaseActivity>{

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

    }
}

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

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

}

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

总结

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

@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等其他组件的注入方式，下篇文章再讨论。

上一篇 下一篇

猜你喜欢

热点阅读