Android Dagger2 MVP架构下的使用（三）

一、前言：

上一篇文章：Android Dagger2 Module&Component源码分析（二）https://www.jianshu.com/p/299ef153d546中，我们通过一点点分析@Module、@Inject以及@Component注解生成的源码，了解了Dagger2依赖注入魔法的根源：

1、 @Inject 注解构造 生成“大众”工厂类 或者 @Module +@Providers 提供注入“私有”工厂类
2、通过Component 创建获得Activity,获得工厂类Provider，统一交给Injector
3、Injector将Provider的get()方法提供的对象，注入到Activity容器对应的成员变量中
我们就可以直接使用容器（Activity）中对应的成员变量了

借用一张图更形象一些：（图片来源地址）感谢@牛晓伟

gitHub 地址：https://github.com/lyyRunning/DaggerDemo

二、全局类 AppComponent & AppModule：

我们先简单将我们开发时需要依赖注入的对象进行简单的分类：

1、全局变量
这类变量一般为单例模式存在，比如SharedPerferences对象、Application对象，还有ServiceManager（网络请求API管理类）等等，这些东西也许我们只想初始化一次，之后处处使用就好了。
2、局部变量
这些变量可能我们只想在某个地方使用，比如Student对象，我们一般也不会只声明一次。

开发中，局部变量尚还好说，我们在没有Dagger的时候，用的时候new一个就可以了，类似于SharedPerferences这种对象我们就比较头疼，也没有必要每次都去context.getSharedPerferences()吧，但是我们有了Dagger，我们可以通过依赖注入的方式，仅仅初始化一次，之后每次想使用，只需要@Inject注解，就能直接使用了，是不是很方便呀。

说干就干，我们创建一个全局的AppComponent 和 AppModule：

1. 首先创建一个自定义的Application类：

public class MyApplication extends Application{
    @Override
    public void onCreate() {
        super.onCreate();
    }
}

记得在清单文件中配置这个类哦 ~

2. 创建AppModule，提供你想要提供的全局变量

@Module
public class AppModule {

    private MyApplication application;

    public AppModule(MyApplication application) {
        this.application = application;
    }

    /**
     * 提供全局的sp对象
     * @return
     */
    @Provides
    SharedPreferences provideSharedPreferences(){
        return application.getSharedPreferences("spfile", Context.MODE_PRIVATE);
    }

    /**
     * 提供全局的Application对象
     * @return
     */
    @Provides
    MyApplication provideApplication(){
        return application;
    }
    //你还可以提供更多.......
}

3. 创建AppComponent，然后ctrl+F9编译

@Component(modules = AppModule.class)
public interface AppComponent {

    SharedPreferences sharedPreferences();
    MyApplication myApplication();
}

4. 编译成功后，修改Application类，把Component注入器注入你的Application中：

public class MyApplication extends Application {

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

    private void inject() {

        AppComponent appComponent = DaggerAppComponent.builder()
                .appModule(new AppModule(this))
                .build();

        ComponentHolder.setAppComponent(appComponent);

    }
}

5. ComponentHolder类，方便获取appComponent对象：

public class ComponentHolder {

    private static AppComponent myAppComponent;

    public static void setAppComponent(AppComponent component) {
        myAppComponent = component;
    }

    public static AppComponent getAppComponent() {
        return myAppComponent;
    }
}

ok，这样，无论何处，我们需要获得AppComponent对象时，只需要调用ComponentHolder.getAppComponent()就可以啦！

6. 注意：

我们需要知道刚才这些文件的作用：
1、AppModule：初始化全局变量
2、AppComponent：注入器，储存了我们要用到的全局变量对象
3、MyApplication: 在onCreate()方法中唯一一次初始化了AppComponent对象，并放入了ComponentHolder中。
MyApplication （作为参数初始化）-> AppModule(初始化全局变量) -> (注入) AppComponent ->(存储到)ComponentHolder

好的，现在我们已经把所有要用到的全局变量存到了AppComponent中，接下来我们创建一个普通的容器Activity。

三、Activity中使用：

1. 我们先创建一个普通的Module和Component

@Module
public class A02Module {
    private A02Activity activity;

    public A02Module(A02Activity activity) {
        this.activity = activity;
    }

    /**
     * 显然我们并不是很多地方都需要某对象，我们在需要用该对象的界面的Module中提供注入即可
     * @return
     */
    @Provides
    User provideUser() {
        return new User();
    }
}

2. A02Module类使用：

@Component(modules = A02Module.class, dependencies = AppComponent.class)
public interface A02Component {

    void inject(A02Activity activity);

}

请注意Component接口，我们发现多了这样一行代码：

dependencies = AppComponent.class

其实也很好理解，比如说我们需要User对象和SharedPerferences对象，前者是A02Component提供的，后者则需要「依赖（dependencies）」AppComponent提供，等于这次inject(A02Activity activity)依赖注入需要两个Component共同出力完成。

3. 编译成功后，在Activity中声明：

public class A02Activity extends Activity {

    @Inject
    User user;
    @Inject
    SharedPreferences sp;
    @BindView(R.id.btn1)
    Button btn1;

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_a02);
        ButterKnife.bind(this);
        inject();
    }


    private void inject() {
        DaggerA02Component.builder()
                //添加appComponent注入器
                .appComponent(ComponentHolder.getAppComponent())
                .a02Module(new A02Module(this))
                .build()
                .inject(this);

        Log.d("LUO", "注入完毕，User = " + user.toString());
        Log.d("LUO", "注入完毕，sp = " + sp.toString());
    }

    @OnClick(R.id.btn1)
    public void onViewClicked() {
        Toast.makeText(this,user.toString(),Toast.LENGTH_LONG).show();
    }

    public static void launch(Context mContext) {
        Intent intent = new Intent(mContext,A02Activity.class);
        mContext.startActivity(intent);
    }
}

查看一下结果，依赖注入成功：

D/LUO: 注入完毕，User = com.function.luo.simple.User@9d352fe
D/LUO: 注入完毕，sp = android.app.SharedPreferencesImpl@97d0111

是不是很神奇！试想一下，如果我们有很多类似的对象需要经常使用，我们再也不需要每次都去初始化，直接@Inject，然后直接使用就可以了;

4. SharedPreferences 使用：

更方便的是,如果我们需要修改（比如SharedPreferences文件的名字等等），只需要跑到提供它的Module文件中：

@Module
public class AppModule {

    private MyApplication application;

    public AppModule(MyApplication application) {
        this.application = application;
    }

    /**
     * 提供全局的sp对象
     * @return
     */
    @Provides
    SharedPreferences provideSharedPreferences(){
        //return application.getSharedPreferences("spfile", Context.MODE_PRIVATE);
        return application.getSharedPreferences("spfile", Context.MODE_PRIVATE);

    }

}

当然，你的Activity容器中代码也能变得更加赏心悦

四、源码分析：

简单分析下源码，如下为编译器自动生成的代码：

image.png

1. App全局类源码（global包下的三个类）

提供对象的工厂类：
AppModule_ProvideApplicationFactory.java
AppModule_ProvideSharedPreferencesFactory.java
注入器：
DaggerAppComponent.java

注入器的改变：

private void initialize(final Builder builder) {
    //2.初始化2个工厂类
    this.provideSharedPreferencesProvider =
        AppModule_ProvideSharedPreferencesFactory.create(builder.appModule);

    this.provideApplicationProvider = AppModule_ProvideApplicationFactory.create(builder.appModule);
  }

  //3.想要sp对象吗？appComponent调用一下这个方法就有了
  @Override
  public SharedPreferences sharedPreferences() {
    return provideSharedPreferencesProvider.get();
  }

  @Override
  public MyApplication myApplication() {
    return provideApplicationProvider.get();
  }

  public static final class Builder {
    //1、参数传入，初始化appModule
    private AppModule appModule;

    private Builder() {}

    public AppComponent build() {
      if (appModule == null) {
        throw new IllegalStateException(AppModule.class.getCanonicalName() + " must be set");
      }
      return new DaggerAppComponent(this);
    }

    public Builder appModule(AppModule appModule) {
      this.appModule = Preconditions.checkNotNull(appModule);
      return this;
    }
  }
}

还是老三样，三板斧，没什么难度。

2. A02Component源码分析：

提供User对象的工厂类：
A02Module_ProvideUserFactory.java
把对象注入到容器的Injcetor类：
A02Activity_MembersInjector.java
注入器：
DaggerA02Component.java

1、工厂略过不提，提供User对象的类而已；
2、Injector 我们上一篇文章中可以知道，通过Component把需要对象的容器(activity)、以及对象工厂（userProvider）给Injector后，Injector把对象赋值给容器中对应的属性而已，比如：

activity.user = userProvider.get();

3、DaggerA02Component，执行顺序参考代码中注释:

public final class DaggerA02Component implements A02Component {
  private Provider<User> provideUserProvider;

  private Provider<SharedPreferences> sharedPreferencesProvider;

  private MembersInjector<A02Activity> a02ActivityMembersInjector;

  private DaggerA02Component(Builder builder) {
    assert builder != null;
    initialize(builder);
  }

  public static Builder builder() {
    return new Builder();
  }

  @SuppressWarnings("unchecked")
  private void initialize(final Builder builder) {

    //3.初始化所有对象的工厂Provider
    //3.1 从builder中的Module中获得学生Student工厂
    this.provideUserProvider = A02Module_ProvideUserFactory.create(builder.a02Module);
    //3.2 从builder中的appComponent中获得SP工厂
    this.sharedPreferencesProvider =
        new Factory<SharedPreferences>() {
          private final AppComponent appComponent = builder.appComponent;

          @Override
          public SharedPreferences get() {
            return Preconditions.checkNotNull(
                appComponent.sharedPreferences(),
                "Cannot return null from a non-@Nullable component method");
          }
        };
    //4、把所有工厂都传到Injector中
    this.a02ActivityMembersInjector =
        A02Activity_MembersInjector.create(provideUserProvider, sharedPreferencesProvider);
  }

  @Override
  public void inject(A02Activity activity) {
    //5、把activity放入到Injector中（接下来结果很明显了...）
    a02ActivityMembersInjector.injectMembers(activity);
  }

  public static final class Builder {
    private A02Module a02Module;

    private AppComponent appComponent;

    private Builder() {}

    public A02Component build() {
      if (a02Module == null) {
        throw new IllegalStateException(A02Module.class.getCanonicalName() + " must be set");
      }
      if (appComponent == null) {
        throw new IllegalStateException(AppComponent.class.getCanonicalName() + " must be set");
      }
      return new DaggerA02Component(this);
    }
    //2.传入a02Module
    public Builder a02Module(A02Module a02Module) {
      this.a02Module = Preconditions.checkNotNull(a02Module);
      return this;
    }

    //1.传入appComponent
    public Builder appComponent(AppComponent appComponent) {
      this.appComponent = Preconditions.checkNotNull(appComponent);
      return this;
    }
  }
}

代码虽然变多了，但是，还是很好理解…

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 213,047评论 6赞 492
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 90,807评论 3赞 386
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 158,501评论 0赞 348
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 56,839评论 1赞 285
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 65,951评论 6赞 386
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 50,117评论 1赞 291
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 39,188评论 3赞 412
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 37,929评论 0赞 268
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 44,372评论 1赞 303
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,679评论 2赞 327
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,837评论 1赞 341
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 34,536评论 4赞 335
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 40,168评论 3赞 317
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,886评论 0赞 21
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,129评论 1赞 267
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 46,665评论 2赞 362
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 43,739评论 2赞 351