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

2019年4月17日 227次阅读来源: 泽毛

Dagger2 系列文章

Dagger2 知识梳理(1) – Dagger2 依赖注入的两种方式
 Dagger2 知识梳理(2) – @Qulifier 和 @Named 解决依赖注入迷失
 Dagger2 知识梳理(3) – 使用 dependencies 和 @SubComponent 完成依赖注入
 Dagger2 知识梳理(4) – @Scope 注解的使用

一、前言

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

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

在使用第二种方法时，Dagger2 在寻找目标依赖类的创建方法时，是根据 Module 提供的方法的返回类型来确定的，因此如果我们提供了多个返回类型相同的创建方法时，那么Dagger2就无法判断使用哪个函数来创建实例，将会在编译时抛出异常。对于这种情况，我们称为 依赖注入迷失。

对于这种情况，我们可以通过@Qualifier/@Named注解来解决，这篇文章的完整代码可以从 Dagger2Sample 的第二章获取。

二、示例

我们还是像 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 知识梳理(2) - @Qulifier 和 @Named 解决依赖注入迷失》

这是因为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中创建目标类的成员变量的方法

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

《Dagger2 知识梳理(2) - @Qulifier 和 @Named 解决依赖注入迷失》 (1) 目标类的成员变量
(2) 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();
            }
        });
    }
}

运行结果：