Dagger 2 系列（四） -- 基礎篇：@Named 和 @Qualifier

leeGYPlus發表於2018-09-21

Dagger2

  • 該系列部落格的最終目標： 搭建 MVP + Dagger2 框架
  • 該系列部落格包含以下幾篇內容：
  1. Dagger 2 系列（一） -- 前奏篇：依賴注入的基本介紹
  2. Dagger 2 系列（二） -- 基礎篇：@Inject、@Component
  3. Dagger 2 系列（三） -- 基礎篇：@Module 和@Provides
  4. Dagger 2 系列（四） -- 基礎篇：@Named 和 @Qualifier
  5. Dagger 2 系列（五） -- 進階篇：@Scope 和 @Singleton

在這篇文章中你會看到什麼：

  • @Named 是什麼
  • @Qualifier 是什麼
  • @Named 和 @Qualifier 用瞭解決什麼問題

也許你會遇到這樣的需求： 在同一個 Module 中 通過 @Provides 標記多個提供相同類的不同實現物件，那麼你在編譯時可以會遇到類似的報錯資訊：

錯誤: xxxx.UserThird is bound multiple times: @Provides xxxUserThird xxxxx.UserThirdModule.provideUserThird() @Provides xxx.UserThird xxx.UserThirdModule.provideUserThirdWithoutParams()

其大致資訊為 UserThird 類被繫結了多次，並列舉了繫結的資訊。出錯的原因是我們提供了返回值相同的建立類例項的方法，但是程式沒有那麼智慧，它是無法判斷出應該使用哪一個方法來建立例項，所以在編譯器就會丟擲異常，這種現象稱為 依賴注入迷失 。

但是這樣的操作在正常的業務中是在正常不過的了，是無法避免不去使用的。那麼此時 @Named 和 @Qualifier 可以用來解決此類問題。

@Named

其具體使用方法為：

  1. 使用 @Named 標記 Module 中生成類例項的方法
  2. 使用 @Named 標記目標類中相應類例項

兩步驟是缺一不可的。我們來看一下具體程式碼：

  • POJO 類
public class UserThird {

    private String mSex = "man";
    private int mCarNum = 7;
    
    public UserThird() {
    }
    public UserThird(String mSex, int mCarNum) {
        this.mSex = mSex;
        this.mCarNum = mCarNum;
    }
    // 變數的setter  和 getter 方法
    .....
}
複製程式碼
  • Module 類

@Module
public class UserThirdModule {

    @Named("a")
    @Provides
    UserThird provideUserThird(){
        return new UserThird("男",1243);
    }
    
    @Named("b")
    @Provides
    UserThird provideUserThirdWithoutParams() {
        return new UserThird();
    }
}
複製程式碼
  • 目標類
public class ThirdActivity extends AppCompatActivity {

    @Named("a")
    @Inject
    UserThird mUserTwoC;
    
    @Named("b")
    @Inject
    UserThird mUserTwoD;
    private static final String TAG = "SecondActivity";

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_second);
        DaggerUserThirdComponent.builder().userThirdModule(new UserThirdModule()).build().injectToThirdActivity(this);
        Log.e(TAG, "onCreate: " + "sex" + mUserTwoC.getSex() + " number：" + mUserTwoC.getCarNum());
        mUserTwoC.setCarNum(46);
        mUserTwoC.setSex("女");
        Log.e(TAG, "onCreate: " + "sex" + mUserTwoC.getSex() + " number：" + mUserTwoC.getCarNum());
        Log.e(TAG, "onCreate: " + "sex" + mUserTwoD.getSex() + " number：" + mUserTwoD.getCarNum());
    }
}
複製程式碼

以上程式碼需要重點關注的是 Module 類 中使用 @Named 註解方法和在 目標類 中使用 @Named 註解標記類的例項變數，並且 Module 中的 @Named("a") 和 目標類中的 @Named("a") 是一一對應的。

@Qualifier

以上通過 @Named 實現的標識功能 @Qualifier 同樣可以實現，但是需要我們自定義註解來完成，具體一個使用場景如下：

  • 自定義註解
@Qualifier
@Retention(RetentionPolicy.RUNTIME)
public @interface UserThirdQualifier {
    String value() default "";
}
複製程式碼

注意，這裡自定義註解需要使用 @Qualifier 進行標註。

  • Module 類中標記
@Module
public class UserThirdModule {

    @UserThirdQualifier("c")
    @Provides
    UserThird provideUserThird(){
        return new UserThird("男",1243);
    }

    @UserThirdQualifier("d")   
    @Provides
    UserThird provideUserThirdWithoutParams() {
        return new UserThird();
    }
}

複製程式碼
  • 目標類
public class ThirdActivity extends AppCompatActivity {
    @UserThirdQualifier("c")
    @Inject
    UserThird mUserTwoC;

    @UserThirdQualifier("d")
    @Inject
    UserThird mUserTwoD;

    private static final String TAG = "SecondActivity";

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_second);
        DaggerUserThirdComponent.builder().userThirdModule(new UserThirdModule()).build().injectToThirdActivity(this);
        Log.e(TAG, "onCreate: " + "sex" + mUserTwoC.getSex() + " number：" + mUserTwoC.getCarNum());
        mUserTwoC.setCarNum(46);
        mUserTwoC.setSex("女");
        Log.e(TAG, "onCreate: " + "sex" + mUserTwoC.getSex() + " number：" + mUserTwoC.getCarNum());
        Log.e(TAG, "onCreate: " + "sex" + mUserTwoD.getSex() + " number：" + mUserTwoD.getCarNum());
    }
}
複製程式碼

同樣的，以上程式碼需要重點關注的是 Module 類 中使用 @UserThirdQualifier 註解方法和在 目標類 中使用 @UserThirdQualifier 註解標記類的例項變數，並且 Module 中的 @UserThirdQualifier("c") 和 目標類中的 @UserThirdQualifier("c")是一 一對應的。

總結

通過 @Named 和 @Qualifier 兩個註解就可以做到標識在同一個 Module 中提供相同類例項物件而造成的 依賴注入迷失 問題 。

相關文章