走马观花-Dagger2 - @Module 和 @Provides

@Module@Provides

对于所需依赖都可操控的情况下,使用 @Inject@Component 组合已经可以达到依赖注入的目的,具体可参考这里。但是当所依赖对象是 Framework 层类型或一些第三方 jar 文件类型,我们无法在其构造器上添加 @Inject 注解,就无法使用 @Inject@Component 来完成依赖注入。而 @Module@Provides 就是用来解决这个问题的。

@Module 使用在类上,是专门用来提供依赖的。但是真正的依赖是通过其标注有 @Provides 的方法来提供的

@Provides 使用在方法上,是用来提供依赖的。

@Module@Provides是需要配合使用的。

@Component:

@Component(modules = {BicycleModules.class})
public interface Mobai {
    void inject(MainActivity mainActivity);
}

@Module:

@Module
public class BicycleModules {
    @Provides
    public Bicycle getBicycle(){
        return new Bicycle();
    }
}

MainActivity:

public class MainActivity extends AppCompatActivity {
    @Inject
    Bicycle mBicycle;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        DaggerMobai.builder().build().inject(this);
        Log.d("MainActivity", mBicycle.toString());
    }
}

编译,带有注解 @Component 的类有生成类 DaggerMobai :

public final class DaggerMobai implements Mobai {
    private BicycleModules bicycleModules;

    private DaggerMobai(Builder builder) {
        initialize(builder);
    }

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

    public static Mobai create() {
        return new Builder().build();
    }

    @SuppressWarnings("unchecked")
    private void initialize(final Builder builder) {
        this.bicycleModules = builder.bicycleModules;
    }

    @Override
    public void inject(MainActivity mainActivity) {
        injectMainActivity(mainActivity);
    }

    private MainActivity injectMainActivity(MainActivity instance) {
        MainActivity_MembersInjector.injectMBicycle(
                instance, BicycleModules_GetBicycleFactory.proxyGetBicycle(bicycleModules));
        return instance;
    }

    public static final class Builder {
        private BicycleModules bicycleModules;

        private Builder() {}

        public Mobai build() {
            if (bicycleModules == null) {
                this.bicycleModules = new BicycleModules();
            }
            return new DaggerMobai(this);
        }

        public Builder bicycleModules(BicycleModules bicycleModules) {
            this.bicycleModules = Preconditions.checkNotNull(bicycleModules);
            return this;
        }
    }
}

该类还是很容易看懂的,就是将 @Component 包含的 @Module 进行实例化,这样的话,就可以通过其对象来调用方法,得到对应的依赖。例如:本例中将 BicycleModules 进行了实例化,而 BicycleModules 中有提供 Bicycle 实例的方法,需要该实例时,直接调用 bicycleModules.getBicycle() 即可。这也正是可以通过使用@Module@Provides 组合来获取依赖的原因,因为依赖其实就是我们直接 new 出来的,只不过提供了获取的方法,生成类中直接调用该方法即可获取到依赖实例。

MainActivity 中进行调用时,可以这样写:

  DaggerMobai.builder()
                .bicycleModules(new BicycleModules()) // 注意这一行
                .build()
                .inject(this);

在上面的代码中可知,其实 build() 方法会自动 new BicycleModules(),所以这一句加不加无所谓了。

增加了@Module@Provides,在 \build\generated\source\apt\debug\com\oliver\test 多生成一个文件BicycleModules_GetBicycleFactory:

public final class BicycleModules_GetBicycleFactory implements Factory<Bicycle> {
    private final BicycleModules module;

    public BicycleModules_GetBicycleFactory(BicycleModules module) {
        this.module = module;
    }

    @Override
    public Bicycle get() {
        return provideInstance(module);
    }

    public static Bicycle provideInstance(BicycleModules module) {
        return proxyGetBicycle(module);
    }

    public static BicycleModules_GetBicycleFactory create(BicycleModules module) {
        return new BicycleModules_GetBicycleFactory(module);
    }

    public static Bicycle proxyGetBicycle(BicycleModules instance) {
        return Preconditions.checkNotNull(
                instance.getBicycle(), "Cannot return null from a non-@Nullable @Provides method");
    }
}





2019-03-11

通过 proxyGetBicycle() 方法可知,正如我们上面所说,依赖的获取其实就是通过 @Module 实例直接调用对应方法获取。然后通过 @ComponentinjectXxx() 对依赖进行注入。

注:对于 @Module 而言,有几个呗 @Provider 标注的方法,就会生成几个对应的 XxxModule_方法名Factory 类;例如:

@Module
public class AppModule {

    @Singleton
    @Provides
    public Bicycle providerBicycle(){
        return new Bicycle();
    }

    @Singleton
    @Provides
    public Car providerCar(){
        return new Car("兰博基尼");
    }

     public String haha(){
          return "哈哈";
    }
}
会自动生成  AppModule_ProviderBicycleFactory 和 AppModule_ProviderCarFactory 两个类,但是不会生成 AppModule_HahaFactory 
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,937评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,503评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,712评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,668评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,677评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,601评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,975评论 3 396
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,637评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,881评论 1 298
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,621评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,710评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,387评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,971评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,947评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,189评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,805评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,449评论 2 342

推荐阅读更多精彩内容