Dagger2 | 一、入门 - @Inject

Dagger2 中最常用的是 @Inject,它来自 javax.inject 包,是依赖注入标准框架(JSR330)的成员。@Inject 一般用来注解字段,表示自动将依赖注入其中,也用来注解构造函数,表示自动创建其实例。

API 描述:

Identifies injectable constructors, methods, and fields. May apply to static as well as instance members. An injectable member may have any access modifier (private, package-private, protected, public). Constructors are injected first, followed by fields, and then methods. Fields and methods in superclasses are injected before those in subclasses. Ordering of injection among fields and among methods in the same class is not specified.

Injectable constructors are annotated with @Inject and accept zero or more dependencies as arguments. @Inject can apply to at most one constructor per class.

简单翻译:

标识可注入的构造函数、方法和字段。可以应用于静态成员,也可以应用于实例成员。一个可注入成员可以有任意的访问修饰符(private, package-private, protected, public)。首先注入构造函数,接着是字段,然后是方法。父类中的字段和方法是在子类之前注入的。同一个类中的字段之间以及方法之间的注入顺序没有规定。

可注入构造函数使用 @Inject 来注解,并接受零个或多个依赖项作为参数。@Inject 只能应用于每个类中最多一个构造函数上。

注意,由于 Dagger2 不支持反射,因此可注入成员的访问修饰符,并不包括 private 级别。

1.1 入门实战

假设我们需要开发一个主页,简单起见,它仅展示账户中的用户名和密码。

1.1.1 账户

创建 Account 类,使用 @Inject 注解在构造函数上,用来创建实例:

public class Account {

    private String username;
    private String password;

    @Inject
    public Account() {
        this.username = "fssd";
        this.password = "123456";
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }

    @NonNull
    @Override 
    public String toString() {
        return "Account{" +
            "username='" + username + '\'' +
            ", password='" + password + '\'' +
            '}';
    }
}

提示:使用 Alt + Insert 快捷键,可以一键生成 toString() 等模板方法。

使用 Ctrl + F9 快捷键进行编译:

账号工厂类

编译生成的 Account_Factory 类:

public final class Account_Factory implements Factory<Account> {

  @Override
  public Account get() {
    return newInstance();
  }

  public static Account_Factory create() {
    return InstanceHolder.INSTANCE;
  }

  public static Account newInstance() {
    return new Account();
  }

  private static final class InstanceHolder {
    private static final Account_Factory INSTANCE = new Account_Factory();
  }
}

可以看到,它实现 Factory 接口,get 方法返回的是 new 出来的 Account 实例。

1.1.2 主页

创建 activity_main.xml 布局,可以显示文字:

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout 
    xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context=".MainActivity">

    <TextView
        android:id="@+id/content_text"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="Hello World!"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintLeft_toLeftOf="parent"
        app:layout_constraintRight_toRightOf="parent"
        app:layout_constraintTop_toTopOf="parent" />

</androidx.constraintlayout.widget.ConstraintLayout>

创建 MainActivity 活动,使用 @Inject 注解在字段上,用来注入依赖:

public class MainActivity extends AppCompatActivity {

    @Inject 
    Account account;

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

        TextView contentText = findViewById(R.id.content_text);
        contentText.setText(account.toString());
    }
}

MainActivity 活动在 AndroidManifest.xml 中进行注册:

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.github.mrzhqiang.dagger2_example">

    <application
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:roundIcon="@mipmap/ic_launcher_round"
        android:supportsRtl="true"
        android:theme="@style/AppTheme">
        <activity android:name=".MainActivity">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />
                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>
    </application>
</manifest>

编译生成的 MainActivity_MembersInjector 类,关键内容如下:

public final class MainActivity_MembersInjector implements MembersInjector<MainActivity> {

  // ...

  @Override
  public void injectMembers(MainActivity instance) {
    injectAccount(instance, accountProvider.get());
  }

  @InjectedFieldSignature("com.github.mrzhqiang.dagger2_example.MainActivity.account")
  public static void injectAccount(MainActivity instance, Account account) {
    instance.account = account;
  }
}

可以看到,它实现 MembersInjector 接口,injectMembers 方法是直接给 MainActivity 活动实例的 account 字段赋值,和正常开发时一样的赋值操作,没有用到反射。

1.2 运行

启动程序,发现闪退,查看日志:

Caused by: java.lang.NullPointerException: Attempt to invoke virtual method 'java.lang.String com.github.mrzhqiang.dagger2_example.account.Account.toString()' on a null object reference

因为在空对象引用上调用 Account.toString() 方法导致空指针异常,说明依赖没有被注入。

1.3 总结

  • 注解在构造函数上,编译生成 Factory 接口的实现,每次获取都是 new 出来的实例
  • 注解在字段上,编译生成 MembersInjector 接口的实现,直接给目标字段赋值
  • 仅使用 @Inject,无法完成依赖注入,运行会抛出 NullPointerException 异常

下一章,讨论 Dagger2 的 @Component,它可以构建依赖图谱,完成依赖注入。

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