Dagger2 知识梳理(2) @Qulifier 和 @Named 解决依赖注入迷失

1、前言

在 Dagger2 知识梳理(1) - Dagger2 依赖注入的两种方式 中，咱们提到了两种实现依赖注入的方法：

• 在依赖类的构造函数上增长@Inject注解
• 提供一个Module类，在其中建立提供依赖类实例的方法

在使用第二种方法时，Dagger2 在寻找目标依赖类的建立方法时，是根据 Module 提供的方法的返回类型来肯定的，所以若是咱们提供了多个返回类型相同的建立方法时，那么Dagger2就没法判断使用哪一个函数来建立实例，将会在编译时抛出异常。对于这种状况，咱们称为 依赖注入迷失。

对于这种状况，咱们能够经过@Qualifier/@Named注解来解决，这篇文章的完整代码能够从 Dagger2Sample 的第二章获取。

2、示例

咱们仍是像 Dagger2 知识梳理(1) - Dagger2 依赖注入的两种方式 中介绍的同样，采用一个数据仓库DataReposity做为例子，它内部包含两个数据源，分别为LocalSource和RemoteSource，而这两个类都实现了Source接口，SourceModule用于提供这两个数据源，而SourceComponent则做为注入器。

• 本地数据源

public class LocalSource implements Source {

    @Override
    public String getData() {
        return "读取本地数据成功";
    }
}
复制代码

• 网络数据源

public class RemoteSource implements Source {

    @Override
    public String getData() {
        return "读取网络数据成功";
    }
}
复制代码

• 依赖注入接口，SourceComponent：

@Component(modules = SourceModule.class)
public interface SourceComponent {
    public void inject(DataRepository dataRepository);
}
复制代码

• 建立工厂类

@Module
public class SourceModule {

    @Provides
    public Source provideLocalSource() {
        return new LocalSource();
    }

    @Provides
    public Source providerRemoteSource() {
        return new RemoteSource();
    }
}
复制代码

• 注入目标类

public class DataRepository {

    @Inject
    Source mLocalSource;

    @Inject
    Source mRemoteSource;

    public DataRepository() {
        DaggerSourceComponent.create().inject(this);
    }

    public String getLocalData() {
        return mLocalSource.getData();
    }

    public String getRemoteData() {
        return mRemoteSource.getData();
    }

}
复制代码

这里所采用的就是咱们在第一节中介绍的第二种依赖注入的方式，可是若是咱们这时候点击make，那么会曝出下面的错误：

这是由于Dagger2在寻找mLocalSource的建立方法时，它会去Component关联的Module中（也就是SourceModule）寻找返回类型为Source的方法，可是在SourceModule中，provideLocalSource / providerRemoteSource这两个方法返回的类型都为SourceModule，致使没法肯定使用哪一个方法来建立mLocalSource。

这时候就须要咱们提供一个别名，让 目标类成员变量的类型 和 建立方法的返回类型 造成一对一的关系，通常来讲，使用@Qulifier是比较标准的方式。

咱们先利用@Qulifier建立两个别名，分别对应本地和远程数据源：

• 本地数据源别名

@Qualifier
@Retention(RetentionPolicy.RUNTIME)
public @interface Local {}
复制代码

• 网络数据源别名

@Qualifier
@Retention(RetentionPolicy.RUNTIME)
public @interface Remote {}
复制代码

接下来，为了创建惟一关系，咱们须要在两个地方加上这个别名：

• 目标类的成员变量
• 工厂Module中建立目标类的成员变量的方法

即下面的两个截图中红色框部分：

最后，咱们用一个例子演示最终的效果：

public class QualifierActivity extends AppCompatActivity {

    private static final String TAG = QualifierActivity.class.getSimpleName();
    private Button mBtnGetData;
    private Button mBtnGetNetData;

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

        mBtnGetData = (Button) findViewById(R.id.bt_get_data);
        mBtnGetData.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                DataRepository repository = new DataRepository();
                String data = repository.getLocalData();
                Toast.makeText(QualifierActivity.this, data, Toast.LENGTH_SHORT).show();
            }
        });
        mBtnGetNetData = (Button) findViewById(R.id.bt_get_net_data);
        mBtnGetNetData.setOnClickListener(new View.OnClickListener() {

            @Override
            public void onClick(View v) {
                DataRepository repository = new DataRepository();
                String data = repository.getRemoteData();
                Toast.makeText(QualifierActivity.this, data, Toast.LENGTH_SHORT).show();
            }
        });
    }
}
复制代码

运行结果：

3、使用 @Named

上面咱们使用的是@Qulifier注解来实现，@Named也能够达到相同的效果。仍是用上面的例子，咱们不须要从新定义两个注解@Local和@Remote，而是直接在须要加上别名的两个地方，添加@Named("Local")和@Named("Remote")，也就是将@Named后面括号中的字符串做为关联目标类型的成员变量和建立方法之间的别名。

---

更多文章，欢迎访问个人 Android 知识梳理系列：

• Android 知识梳理目录：www.jianshu.com/p/fd82d1899…
• 我的主页：lizejun.cn
• 我的知识总结目录：lizejun.cn/categories/