Android 神兵利器Dagger2使用詳解（四）Scope注解的使用及源碼分析

前言

本系列所有文章：

Android 神兵利器Dagger2使用詳解（一）基礎使用
 Android 神兵利器Dagger2使用詳解（二）Module&Component源碼分析
 Android 神兵利器Dagger2使用詳解（三）MVP架構下的使用
 Android 神兵利器Dagger2使用詳解（四）Scope注解的使用及源碼分析
 告別Dagger2模板代碼：DaggerAndroid使用詳解
 告別Dagger2模板代碼：DaggerAndroid原理解析
該系列首發于我的CSDN專欄：
Android開發：Dagger2詳解

在我的上一篇文章中，我們以簡單的案例對Dagger2依賴注入庫在實際開發中的使用方法進行了學習。

本文內容：

1.@Singleton 全局單例 注解的使用

2.自定義@Scope 局部單例 注解的使用

3.通過 **源碼分析 **@Singleton和@Scope注解是 如何實現單例 的。

一.@Singleton:全局單例注解

承接上文，我們在AppModule中提供了以下對象的初始化：

@Module
public class AppModule {

    private MyApplication application;

    public AppModule(MyApplication application) {
        this.application = application;
    }

    //提供sp對象
    @Provides
    SharedPreferences provideSharedPreferences(){
        return application.getSharedPreferences("spfile", Context.MODE_PRIVATE);
    }

    //提供Application對象
    @Provides
    MyApplication provideApplication(){
        return application;
    }
}

我們肯定會有這樣一種需求，類似于SharedPreferences對象，我們可能在整個App的生命周期中只需要一個單例，而不需要每次都通過application.getSharedPreferences("spfile", Context.MODE_PRIVATE)獲得新的對象，那么怎么辦呢，我們只需要在你需要單例的對象提供方法上加一個注解@Singleton ,類似這樣：

@Module
public class AppModule {

    private MyApplication application;

    public AppModule(MyApplication application) {
        this.application = application;
    }
    
    //全局單例SharedPreferences
    @Provides
    @Singleton
    SharedPreferences provideSharedPreferences() {
        return application.getSharedPreferences("spfile", Context.MODE_PRIVATE);
    }

    @Provides
    MyApplication provideApplication() {
        return application;
    }
 }

只需要一個@Singleton,無論我們在多少個Activity容器中通過@Inject獲取這個SharedPreferences對象的實例，該對象都是同一個對象，從而實現了全局單例的效果。

非常簡單的使用方式，你需要什么對象全局單例，就在提供該對象方法的@Provides注解旁加上一個@Singleton,并且在該module關聯的Component中加上同樣的注解：

@Singleton      //不要忘了還要在關聯的Component接口中聲明，否則會編譯報錯
@Component(modules = AppModule.class)
public interface AppComponent {

    SharedPreferences sharedPreferences();

    MyApplication myApplication();

}

ok，使用方式很簡單。

二.自定義@Scope 局部單例注解

事實上，除了全局單例，我們可能在開發中更多的是需要局部單例，比如，我在ActivityA中需要實例化兩個Student對象，在ActivityB中也需要一個Student對象，但我希望ActivityA中的兩個Student都叫小明，但ActivityB中的Student對象叫小剛。

這樣的需求，全局單例注解@Singleton是不行的，因為如果在AppModule中通過@Singleton注解提供Student，兩個Activity中的Student都是小明（全局單例）了，而如果不用@Singleton注解，那么兩個Activity中的Student是三個不同的對象，這樣又不滿足“ActivityA中的兩個Student都叫小明”的需求。

這時我們就需要自定義@Scope注解實現局部單例了。

1.自定義@Scope注解

實現方式很簡單，首先這樣自定義一個接口ActivityScope，聲明這個注解可以使對象在同一個Activity中實現單例:

@Scope  //聲明這是一個自定義@Scope注解
@Retention(RUNTIME)
public @interface ActivityScope {
}

2.未使用@Scope注解效果展示：

我們先聲明2個Activity及相關代碼：
兩個小明的Activity:

public class A03Activity extends AppCompatActivity {

    @BindView(R.id.btn_login)
    Button btnLogin;
    @BindView(R.id.tv_student1)
    TextView tvStudent1;
    @BindView(R.id.tv_student2)
    TextView tvStudent2;

    @Inject
    Student student1;
    @Inject
    Student student2;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_a03);
        ButterKnife.bind(this);
        DaggerA03Component.builder()
                .a03Module(new A03Module(this))
                .build()
                .inject(this);

        //打印兩個Student類
        tvStudent1.setText(student1.toString());
        tvStudent2.setText(student2.toString());
    }

    @OnClick(R.id.btn_login)
    public void onViewClicked() {
        startActivity(new Intent(this, A04Activity.class));
    }
}

小剛的Activity:

public class A04Activity extends AppCompatActivity {

    @BindView(R.id.tv_student)
    TextView tvStudent;

    @Inject
    Student student;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_a04);
        ButterKnife.bind(this);
        DaggerA04Component.builder()
                .a04Module(new A04Module(this))
                .build()
                .inject(this);
        //打印Student
        tvStudent.setText(student.toString());
    }
}

相關的兩個Module:

@Module
public class A03Module {

    private A03Activity activity;

    public A03Module(A03Activity activity) {
        this.activity = activity;
    }

    @Provides
    Student provideStudent() {
        return new Student();
    }
}

@Module
public class A04Module {

    private A04Activity activity;

    public A04Module(A04Activity activity) {
        this.activity = activity;
    }

    @Provides
    Student provideStudent() {
        return new Student();
    }

}

相關的Component:

@Component(modules = A03Module.class)
public interface A03Component {

    void inject(A03Activity activity);

}

@Component(modules = A04Module.class)
public interface A04Component {

    void inject(A04Activity activity);

}

編譯成功后運行，結果如下：

這里寫圖片描述

可以看到，未使用自定義@Scope注解，每次@Inject注解獲取的Student對象都是一個新的對象。

這樣展示在界面的效果是3個不同的Student：

ActivityA中的兩個Student是小明和小紅（并未實現Activity局部單例）
ActivityB中的Student是小剛

3.使用自定義@Scope注解：

下面我們稍作幾行代碼的改變，實現Activity局部單例：

(1).在Module中添加@ActivityScope注解：

@Module
public class A03Module {

    private A03Activity activity;

    public A03Module(A03Activity activity) {
        this.activity = activity;
    }

    @Provides
    @ActivityScope//添加注解實現局部單例
    Student provideStudent() {
        return new Student();
    }

}

(2).在Component中同樣添加@ActivityScope注解，否則會編譯報錯：

@ActivityScope//添加注解實現局部單例
@Component(modules = A03Module.class, dependencies = AppComponent.class)
public interface A03Component {

    void inject(A03Activity activity);

}

好的，僅僅添加兩行注解代碼，我們接下來運行看結果：

這里寫圖片描述

成功！我們可以看到我們成功實現了這樣的效果：

ActivityA中的兩個Student都是小明（Activity局部單例）
ActivityB中的Student是小剛（換了Activity，生成另外一個對象）

也就是說,在添加@ActivityScope后，該Activity中通過@Inject依賴注入生成的Student對象全部唯一，但單例范圍僅僅是該Activity中，出了該Activity，生成的Student仍然是非單例的。

三.@Singleton@Scope注解原理分析

這樣實在太神奇了，我們不禁想到，僅僅通過這樣一個聲明，就能實現對象的生成和Activity的生命周期綁定嗎？只要該Activity存在，里面的Student對象就是單例？

僅僅通過這樣的聲明,就能實現”同生共死“嗎：

@Scope
@Retention(RUNTIME) //Activity局部單例
public @interface ActivityScope {

}

@Scope
@Retention(RUNTIME) //Fragment局部單例
public @interface FragmentScope {

}

分析源碼前先公布答案：

自定義的@Singleton、@ActivityScope注解根本就沒有這些功能,它的作用僅僅是”標記“。**

是不是難以置信，事實上的確如此，以小明的Activity為例，我們查看編譯器為我們生成的源碼目錄：

這里寫圖片描述

我們發現，無論是否添加@ActivityScope注解，自動生成的文件目錄中文件的數量都沒有改變，如上圖，也就是說：

自定義@Scope注解并沒有生成任何文件。

那么自定義@Scope注解是如何實現單例的呢

（1）A03Activity_MembersInjector.java

我們輕車熟路（如果您仔細閱讀了前幾篇文章的話）打開這個文件，發現無論是否添加了@Scope注解，代碼皆如下：

public final class A03Activity_MembersInjector implements MembersInjector<A03Activity> {
  private final Provider<Student> student1AndStudent2Provider;

  public A03Activity_MembersInjector(Provider<Student> student1AndStudent2Provider) {
    assert student1AndStudent2Provider != null;
    this.student1AndStudent2Provider = student1AndStudent2Provider;
  }

  public static MembersInjector<A03Activity> create(Provider<Student> student1AndStudent2Provider) {
    return new A03Activity_MembersInjector(student1AndStudent2Provider);
  }

  @Override
  public void injectMembers(A03Activity instance) {
    if (instance == null) {
      throw new NullPointerException("Cannot inject members into a null reference");
    }
    //請注意該行
    instance.student1 = student1AndStudent2Provider.get();
    instance.student2 = student1AndStudent2Provider.get();
  }

  public static void injectStudent1(A03Activity instance, Provider<Student> student1Provider) {
    instance.student1 = student1Provider.get();
  }

  public static void injectStudent2(A03Activity instance, Provider<Student> student2Provider) {
    instance.student2 = student2Provider.get();
  }
}

需要注意的是，當我們依賴注入Activity時，最重要的其實是這兩行代碼：

  //請注意該行
  instance.student1 = student1AndStudent2Provider.get();
  instance.student2 = student1AndStudent2Provider.get();

無論是否添加了@ActivityScope注解，Activity中的倆個Student對象，都是通過student1AndStudent2Provider.get()進行實例化的，也就是說，當添加了@ActivityScope之后，get（）方法會生成單例，否則就沒有單例，我們來看一下student1AndStudent2Provider對象是如何實例化的：

 private final Provider<Student> student1AndStudent2Provider;

 public A03Activity_MembersInjector(Provider<Student> student1AndStudent2Provider) {
 //2.構造方法中實例化student1AndStudent2Provider
    assert student1AndStudent2Provider != null;
    this.student1AndStudent2Provider = student1AndStudent2Provider;
  }

  public static MembersInjector<A03Activity> create(Provider<Student> student1AndStudent2Provider) {
  //1.有對象執行了該方法，然后執行構造方法
    return new 
    A03Activity_MembersInjector(student1AndStudent2Provider);
  }

可以看到student1AndStudent2Provider是通過有對象執行create（）方法，將student1AndStudent2Provider作為參數傳進來進行的初始化，我們找到執行create（）方法的地方：DaggerA03Component.java

（2）DaggerA03Component.java

通過對比DaggerA03Component.java，在Provider初始化的地方，我們發現了端倪：

a.未添加@ActivityScope:

  @SuppressWarnings("unchecked")
  private void initialize(final Builder builder) {
    //注意這行代碼
    this.provideStudentProvider = A03Module_ProvideStudentFactory.create(builder.a03Module);

    this.a03ActivityMembersInjector = A03Activity_MembersInjector.create(provideStudentProvider);
  }

b.添加了@ActivityScope:

  @SuppressWarnings("unchecked")
  private void initialize(final Builder builder) {
   //注意這行代碼，多了一個DoubleCheck.provider()方法
    this.provideStudentProvider =
        DoubleCheck.provider(A03Module_ProvideStudentFactory.create(builder.a03Module));

    this.a03ActivityMembersInjector = A03Activity_MembersInjector.create(provideStudentProvider);
  }

我們恍然大悟： @ActivityScope注解改變的只是做一個標記，然后Component將有標記的對象工廠類（本文為Student工廠）進行了一次”DoubleCheck“單例加工！

我們有理由進行這樣的猜測：

1.未添加自定義@Scope：每次Activity初始化對象，直接讓工廠類初始化一個對象給Activty（activity.student = new Student()）;

2.添加了自定義@Scope：每次Activity初始化對象，直接讓工廠類將單例對象給Activty（
activity.student1 = factory.student(單例)；
activity.student2 = factory.student(單例)；）;

是不是有一點恍然大悟的感覺？我們為了驗證我們猜測的正確性，我們打開DoubleCheck類進行分析：

（3*）DoubleCheck.java

public final class DoubleCheck<T> implements Provider<T>, Lazy<T> {
  private static final Object UNINITIALIZED = new Object();

  private volatile Provider<T> provider;
  private volatile Object instance = UNINITIALIZED;

  private DoubleCheck(Provider<T> provider) {
    assert provider != null;
    this.provider = provider;
  }

 // 單例獲取對象
  @Override
  public T get() {
    Object result = instance;
    if (result == UNINITIALIZED) {
      synchronized (this) {
        result = instance;
        if (result == UNINITIALIZED) {
          result = provider.get();
          Object currentInstance = instance;
          if (currentInstance != UNINITIALIZED && currentInstance != result) {
            throw new IllegalStateException("Scoped provider was invoked recursively returning "
                + "different results: " + currentInstance + " & " + result);
          }
          instance = result;
          provider = null;
        }
      }
    }
    return (T) result;
  }
  
  public static <T> Provider<T> provider(Provider<T> delegate) {
    checkNotNull(delegate);
    if (delegate instanceof DoubleCheck) {
      return delegate;
    }
    return new DoubleCheck<T>(delegate);
  }

  public static <T> Lazy<T> lazy(Provider<T> provider) {
    if (provider instanceof Lazy) {
      @SuppressWarnings("unchecked")
      final Lazy<T> lazy = (Lazy<T>) provider;
    }
    return new DoubleCheck<T>(checkNotNull(provider));
  }
}

其中：

public final class DoubleCheck<T> implements Provider<T>, Lazy<T>

看到這行，我們明白了，其實和普通的Provider工廠類一樣，DoubleCheck也是實現了Provider<T>接口，這樣通過調用get（），就能獲得對象的實例了，只不過稍微有所區別的是：

通過DoubleCheck.get（）獲得的對象，是單例的。

至于DoubleCheck.get（）是如何實現單例的（似乎和我們普通實現單例的方式所有不同），篇幅所限，就不過多介紹，有興趣的同學看看這篇博客多線程問題與double-check小結 @usher，相信會有所收獲。

總結

看到最后，相信大家已經對于@Scope和@Singleton的原理了解的差不多了，其實并沒有什么魔力，能夠真正通過一個注解，實現對Application生命周期或者Activity/Fragment生命周期進行綁定，無非做出一個標記的作用，檢查到標記后，Component將對應的工廠實現單例模式，這樣我們的容器去獲取對象時就能實現對應的單例效果。

而對于其他的Activity，因為ActivityA和ActivityB是同一層級互不干擾的，ActivityA的Component和ActivityB的Component互不聯系，當然不可能相互共享單例：

這里寫圖片描述

借用@MarkZhai 大神的圖和一句話：位于上層的component是看不到下層的，而下層則可以使用上層的，但不能引用同一層相鄰component內的實例。

同時，當我們的容器（Application/Activity/Fragment等）銷毀時，對應的Component當然也不復存在，這就是為什么我們看起來@Scope能夠實現”同生共死“效果的原因。

至此，Dagger2相關的知識點我們已經了解的差不多了，我們需要的就是更多的去使用它，通過它實現快速開發和代碼解耦。

代碼已托管Github，源碼傳送門，點我查看

2017/8/24日更新

事實上，Android開發中使用Dagger,開發人員仍然需要面對一些問題。

google工程師們嘗試彌補Dagger的問題，于是Dagger2-Android,基于Dagger2，應用于Android開發，由google開發的的拓展庫應運而生：

最后編輯于：2017.12.10 15:44:24

?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明：文章內容（如有圖片或視頻亦包括在內）由作者上傳并發布，文章內容僅代表作者本人觀點，簡書系信息發布平臺，僅提供信息存儲服務。

人面猴
序言：七十年代末，一起剝皮案震驚了整個濱河市，隨后出現的幾起案子，更是在濱河造成了極大的恐慌，老刑警劉巖，帶你破解...
沈念sama閱讀 229,460評論 6贊 538
死咒
序言：濱河連續發生了三起死亡事件，死亡現場離奇詭異，居然都是意外死亡，警方通過查閱死者的電腦和手機，發現死者居然都...
沈念sama閱讀 99,067評論 3贊 423
救了他兩次的神仙讓他今天三更去死
文/潘曉璐我一進店門，熙熙樓的掌柜王于貴愁眉苦臉地迎上來，“玉大人，你說我怎么就攤上這事。” “怎么了？”我有些...
開封第一講書人閱讀 177,467評論 0贊 382
道士緝兇錄：失蹤的賣姜人
文/不壞的土叔我叫張陵，是天一觀的道長。經常有香客問我，道長，這世上最難降的妖魔是什么？我笑而不...
開封第一講書人閱讀 63,468評論 1贊 316
?港島之戀（遺憾婚禮）
正文為了忘掉前任，我火速辦了婚禮，結果婚禮上，老公的妹妹穿的比我還像新娘。我一直安慰自己，他們只是感情好，可當我...
茶點故事閱讀 72,184評論 6贊 410
惡毒庶女頂嫁案：這布局不是一般人想出來的
文/花漫我一把揭開白布。她就那樣靜靜地躺著，像睡著了一般。火紅的嫁衣襯著肌膚如雪。梳的紋絲不亂的頭發上，一...
開封第一講書人閱讀 55,582評論 1贊 325
城市分裂傳說
那天，我揣著相機與錄音，去河邊找鬼。笑死，一個胖子當著我的面吹牛，可吹牛的內容都是我干的。我是一名探鬼主播，決...
沈念sama閱讀 43,616評論 3贊 444
雙鴛鴦連環套：你想象不到人心有多黑
文/蒼蘭香墨我猛地睜開眼，長吁一口氣：“原來是場噩夢啊……” “哼！你這毒婦竟也來了？” 一聲冷哼從身側響起，我...
開封第一講書人閱讀 42,794評論 0贊 289
萬榮殺人案實錄
序言：老撾萬榮一對情侶失蹤，失蹤者是張志新（化名）和其女友劉穎，沒想到半個月后，有當地人在樹林里發現了一具尸體，經...
沈念sama閱讀 49,343評論 1贊 335
?護林員之死
正文獨居荒郊野嶺守林人離奇死亡，尸身上長有42處帶血的膿包…… 初始之章·張勛以下內容為張勛視角年9月15日...
茶點故事閱讀 41,096評論 3贊 356
?白月光啟示錄
正文我和宋清朗相戀三年，在試婚紗的時候發現自己被綠了。大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
茶點故事閱讀 43,291評論 1贊 371
活死人
序言：一個原本活蹦亂跳的男人離奇死亡，死狀恐怖，靈堂內的尸體忽然破棺而出，到底是詐尸還是另有隱情，我是刑警寧澤，帶...
沈念sama閱讀 38,863評論 5贊 362
?日本核電站爆炸內幕
正文年R本政府宣布，位于F島的核電站，受9級特大地震影響，放射性物質發生泄漏。R本人自食惡果不足惜，卻給世界環境...
茶點故事閱讀 44,513評論 3贊 348
男人毒藥：我在死后第九天來索命
文/蒙蒙一、第九天我趴在偏房一處隱蔽的房頂上張望。院中可真熱鬧，春花似錦、人聲如沸。這莊子的主人今日做“春日...
開封第一講書人閱讀 34,941評論 0贊 28
一樁弒父案，背后竟有這般陰謀
文/蒼蘭香墨我抬頭看了看天上的太陽。三九已至，卻和暖如春，著一層夾襖步出監牢的瞬間，已是汗流浹背。一陣腳步聲響...
開封第一講書人閱讀 36,190評論 1贊 291
情欲美人皮
我被黑心中介騙來泰國打工，沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留，地道東北人。一個月前我還...
沈念sama閱讀 52,026評論 3贊 396
代替公主和親
正文我出身青樓，卻偏偏與公主長得像，于是被迫代替她去往敵國和親。傳聞我的和親對象是個殘疾皇子，可洞房花燭夜當晚...
茶點故事閱讀 48,253評論 2贊 375

三个男躁一个女,国精产品一区一手机的秘密,麦子交换系列最经典十句话,欧美国产综合欧美视频

Android 神兵利器Dagger2使用詳解（四）Scope注解的使用及源碼分析

Android 神兵利器Dagger2使用詳解（四）Scope注解的使用及源碼分析

前言

本系列所有文章：

一.@Singleton:全局單例注解

二.自定義@Scope 局部單例注解

1.自定義@Scope注解

2.未使用@Scope注解效果展示：

3.使用自定義@Scope注解：

(1).在Module中添加@ActivityScope注解：

(2).在Component中同樣添加@ActivityScope注解，否則會編譯報錯：

三.@Singleton@Scope注解原理分析

（1）A03Activity_MembersInjector.java

（2）DaggerA03Component.java

（3*）DoubleCheck.java

總結

2017/8/24日更新

推薦閱讀更多精彩內容

三个男躁一个女,国精产品一区一手机的秘密,麦子交换系列最经典十句话,欧美 国产 综合 欧美 视频

Android 神兵利器Dagger2使用詳解（四）Scope注解的使用及源碼分析

前言

本系列所有文章：

一.@Singleton:全局單例注解

二.自定義@Scope 局部單例注解

1.自定義@Scope注解

2.未使用@Scope注解效果展示：

3.使用自定義@Scope注解：

(1).在Module中添加@ActivityScope注解：

(2).在Component中同樣添加@ActivityScope注解，否則會編譯報錯：

三.@Singleton@Scope注解原理分析

（1）A03Activity_MembersInjector.java

（2）DaggerA03Component.java

（3*）DoubleCheck.java

總結

2017/8/24日更新

推薦閱讀更多精彩內容

三个男躁一个女,国精产品一区一手机的秘密,麦子交换系列最经典十句话,欧美国产综合欧美视频