Dagger2学习之Hello Dagger

Dagger是Square公司的开源项目, 后来被Google fork下来, 继续开发, 诞生了Dagger2. 这个项目的主要作用是依赖注入.

新手觉得一个东西太难学, 主要原因是一下子暴露在太多难以理解的概念中, 无所适从. 而当你用了一遍 因此这一篇博客仅仅使用最简单的应用方式. 对Dagger2有了个最基本的认识之后, 慢慢深入学习就不那么困难.

gradle配置

先上使用方式, gradle文件配置相关

项目根目录gradle中buildscript的dependencies添加

classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'

module目录的gradle中, 添加

apply plugin: 'android-apt'

添加这个东西的作用是让AS能够识别Dagger2自动生成的代码并且能够跳转跟踪等.

添加依赖

compile 'com.google.dagger:dagger:2.0.2'
provided 'com.google.dagger:dagger-compiler:2.0.2'
provided 'javax.annotation:jsr250-api:1.0'

注1: 此时(16年4月11日)最新的dagger版本是2.0.3, 但请不要升级, 其引用的Guava版本有问题
注2: javax.annotation:jsr250-api:1.0, Android Api中没有这个包, 而Dagger中用到了@Generated注解, 不引入会报错

gradle配置至此完成

Hello Dagger2

依赖注入的各种原理各种导图看着就晕, 实实在在的先来个Hello World, 哦不, Hello Dagger吧

第一步, 创建一个很简单的JavaBean, 没什么好说的

public class HelloDagger {

    private String hello;

    public HelloDagger(String hello) {
        this.hello = hello;
    }

    public String getHello() {
        return hello;
    }
}

第二步, 创建Module, @Module注解, 在Dagger2中表示提供依赖的模块

@Module
public class ActivityModule {

    // 提供依赖的方法, 使用Provides注解, 告诉Dagger2到这里来找对象
    @Provides
    static HelloDagger provideHelloDagger(){
        return new HelloDagger("Hello Dagger!");
    }

}

第三步, 创建Component. 你应该注意到了, Component是个接口, 等于是Module与被注入的类(本例中是MainActivity)之间的桥梁.

// 这个注解表示Component要到ActivityModule中寻找依赖
@Component(modules = ActivityModule.class)
public interface ActivityComponent {

    // 注入具体的类中(方法名可随意取, 重要的是参数)
    void inject(MainActivity activity);

}

注: inject(MainActivity activity)中的参数必须是你要注入的那个类的对象, Dagger2生成的代码会调用该对象注入其中, 使用其父类(如Activity), 则毫无卵用

好了, 上面的都做完了, 需要运行一发让Dagger2生成代码, 以下三种方式:

1. 点击运行小按钮
2. 使用快捷键: mac使用Ctrl+R, win/linux使用Ctrl+Shift+F10
3. 在项目根目录使用命令行 ./gradlew build

最后, 注入到MainActivity

public class MainActivity extends AppCompatActivity {

    // Inject注解对应Module中的Provides注解
    // 声明依赖要注入给这个变量
    @Inject
    HelloDagger helloDagger;

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

        // DaggerActivityComponent是Dagger2自动生成的, 此处使用create静态方法创建对象
        ActivityComponent activityComponent = DaggerActivityComponent.create();
        // 注入
        activityComponent.inject(this);

        TextView saySomethingTV = (TextView) findViewById(R.id.tv_say_something);
        saySomethingTV.setText(helloDagger.getHello());
    }
}

运行结果

结语

至此, 我想这个Hello Dagger应该算是结束了. 如果你做了一遍, 应该对这个框架有了感性的认识. 接下来可以看看dagger2官网, 或者看看其他博客自己进行学习. 接下来我的博客也会继续更新这个系列, 尝试在项目中实际应用.

参考链接

dagger2官网

详解Dagger2

dagger on Android