dagger2探索

網上關于Dagger2的博客很多,但自己還是覺得大多都講得稀里糊涂,大多只講了怎么用,但始終是沒怎么講其內部實現流程,懶得搜博客,干脆直接看源碼。

簡單的一個應用

首先從一個最最簡單的例子開始
一個user類,在其構造方法加個Inject注解,功能相當于表示此處提供User的實例化對象

public class User {
private String userName;
    private String password;

    @Inject
    public User() {
    // 暫時用無參,便于分析
        this.userName = " dfs";
        this.password = "fdsa ";
    }

    @Override
    public String toString() {
        return "User{" +
                "userName='" + userName + '\'' +
                ", password='" + password + '\'' +
                '}';
    }

    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;
    }
}

然后來個隨意的注射器MainActivityComponent,@Component()表示此接口為注射器,這里里面有一個往MainActivity注射的方法

@Component()
public interface MainActivityComponent {
    void inject(MainActivity mainActivity);
}

然后make下model,生成DaggerMainActivityComponent類,最后應用于MainActivity

public class MainActivity extends AppCompatActivity {
    private static final String TAG = "MainActivity>>>";
    @Inject
    User user;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        DaggerMainActivityComponent.builder()
                .build()
                .inject(this);
        Log.i(TAG, "onCreate: >>>>" + user);
    }
}

得到結果,顯而易見是注射成功了

I/MainActivity>>>: onCreate: >>>>User{userName=' dfs', password='fdsa '}

源碼分析

User類的構造方法加了注解Inject后,后面編譯時會生成一個對應的枚舉

@Generated("dagger.internal.codegen.ComponentProcessor")
public enum User_Factory implements Factory<User> {
INSTANCE;

  @Override
  public User get() {  
    return new User();
  }

  public static Factory<User> create() {  
    return INSTANCE;
  }
}

看了這個,我才知道枚舉也能像類一樣。。。之前看到書上說枚舉可以實現單例,還說是最安全的,但書上卻沒有給出例子,這里應該就是枚舉實現單例的一個應用。對于這個枚舉的理解就是工廠,專門生產實例
然后看下Factory這個接口,很簡單,就是繼承Provider接口

public interface Factory<T> extends Provider<T> {
}

provider里面呢,里面就一個get方法

public interface Provider<T> {
    T get();
}

然后MainActivity用了@Inject注解,然后我看到debug對應的目錄下生成了MainActivity_MembersInjector類


@Generated("dagger.internal.codegen.ComponentProcessor")
public final class MainActivity_MembersInjector implements MembersInjector<MainActivity> {
  private final MembersInjector<AppCompatActivity> supertypeInjector;
  private final Provider<User> userProvider;

  public MainActivity_MembersInjector(MembersInjector<AppCompatActivity> supertypeInjector, Provider<User> userProvider) {  
    assert supertypeInjector != null;
    this.supertypeInjector = supertypeInjector;
    assert userProvider != null;
    this.userProvider = userProvider;
  }

  @Override
  public void injectMembers(MainActivity instance) {  
    if (instance == null) {
      throw new NullPointerException("Cannot inject members into a null reference");
    }
    supertypeInjector.injectMembers(instance);
    instance.user = userProvider.get();
  }

  public static MembersInjector<MainActivity> create(MembersInjector<AppCompatActivity> supertypeInjector, Provider<User> userProvider) {  
      return new MainActivity_MembersInjector(supertypeInjector, userProvider);
  }
}

MainActivity_MembersInjector實現了接口MembersInjector里的injectMembers方法,先調用了supertypeInjector.injectMembers(instance)這里應該有個逐級遞歸,然后 instance.user = userProvider.get()把user實例賦給MainActivity的user成員變量。對MainActivity_MembersInjector理解就是用來具體實現注入的,并且可以注入多個成員

然后MainActivityComponent也對應生成了一個DaggerMainActivityComponent,其實是對MainActivityComponent的進一步封裝


@Generated("dagger.internal.codegen.ComponentProcessor")
public final class DaggerMainActivityComponent implements MainActivityComponent {
  private MembersInjector<MainActivity> mainActivityMembersInjector;
  private DaggerMainActivityComponent(Builder builder) {  
    assert builder != null;
    initialize(builder);
  }

  public static Builder builder() {  
    return new Builder();
  }

  public static MainActivityComponent create() {  
    return builder().build();
  }

  private void initialize(final Builder builder) {  
    this.mainActivityMembersInjector = MainActivity_MembersInjector.create((MembersInjector) MembersInjectors.noOp(), User_Factory.create());
  }

  @Override
  public void inject(MainActivity mainActivity) {  
    mainActivityMembersInjector.injectMembers(mainActivity);
  }

  public static final class Builder {
    private Builder() {  
    }
  
    public MainActivityComponent build() {  
      return new DaggerMainActivityComponent(this);
    }
  }
}

DaggerMainActivityComponent給MainActivityComponent加了個Builder,典型運用了Builder模式,便于鏈式調用,設置參數。這里Builder構造了MembersInjector<MainActivity>這個類型的成員,然后DaggerMainActivityComponent就可以利用mainActivityMembersInjector這個實例去給User變量注入實例。

擴展,User設置為單例注入

上述只是一種場景,注射器每次注入的都是一個全新的對象,并不是同一個對象,接下看看dagger是怎么實現單例注入的

簡單應用,在前面代碼的基礎上

在前面的User類上加了@Singleton

@Singleton
public class User {
    ...
}

然后MainActivityComponent加了個@Singleton注解

@Singleton
@Component
public interface MainActivityComponent {
void inject(MainActivity mainActivity);
}

最后編譯一下,應用

public class MainActivity extends AppCompatActivity {
    private static final String TAG = "MainActivity>>>";
    @Inject
    User user1;
    @Inject
    User user2;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        DaggerMainActivityComponent.builder()
                .build()
                .inject(this);

        Log.i(TAG, "onCreate: >>>>user1: " + user1.hashCode()+"  user2:"+user2.hashCode());
    }
}

結果:

onCreate: >>>>user1: 219956319  user2:219956319

可以看到user1和user2是同一個對象

可是為什么加兩個注解就可以實現單例注入呢!!
直接看生成的代碼和前一次的有什么不同

其實不同點就在于DaggerMainActivityComponent 里面的initialize方法


@Generated("dagger.internal.codegen.ComponentProcessor")
public final class DaggerMainActivityComponent implements MainActivityComponent {
  private Provider<User> userProvider;
  private MembersInjector<MainActivity> mainActivityMembersInjector;

  private DaggerMainActivityComponent(Builder builder) {  
    assert builder != null;
    initialize(builder);
  }

  public static Builder builder() {  
    return new Builder();
  }

  public static MainActivityComponent create() {  
    return builder().build();
  }

  private void initialize(final Builder builder) {  
    this.userProvider = ScopedProvider.create(User_Factory.create());
    this.mainActivityMembersInjector = MainActivity_MembersInjector.create((MembersInjector) MembersInjectors.noOp(), userProvider);
  }

  @Override
  public void inject(MainActivity mainActivity) {  
    mainActivityMembersInjector.injectMembers(mainActivity);
  }

  public static final class Builder {
    private Builder() {  
    }
  
    public MainActivityComponent build() {  
      return new DaggerMainActivityComponent(this);
    }
  }
}

構造mainActivityMembersInjector需要傳入userProvider,原來的userProvider是直接User_Factory.create()生成,然而現在mainActivityMembersInjector構造時傳入的userProvider是經ScopedProvider.create封裝過的userProvider,所以單例實現關鍵就是在里面

看一下ScopedProvider的源碼

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

  private final Factory<T> factory;
  private volatile Object instance = UNINITIALIZED;

  private ScopedProvider(Factory<T> factory) {
    assert factory != null;
    this.factory = factory;
  }

  @SuppressWarnings("unchecked") // cast only happens when result comes from the factory
  @Override
  public T get() {
    // double-check idiom from EJ2: Item 71
    Object result = instance;
    if (result == UNINITIALIZED) {
      synchronized (this) {
        result = instance;
        if (result == UNINITIALIZED) {
          instance = result = factory.get();
        }
      }
    }
    return (T) result;
  }

  /** Returns a new scoped provider for the given factory. */
  public static <T> Provider<T> create(Factory<T> factory) {
    if (factory == null) {
      throw new NullPointerException();
    }
    return new ScopedProvider<T>(factory);
  }
}

原來里面用了個單例模式,經典的雙重檢查DCL雙重檢查鎖定,這樣provider提供的實例就是同一個對象了

總結

通過這兩個例子,大致可以知道Dagger實現注入的基本流程,首先聲明的注解會對應生成對應的工具類,如xxx_Factory工廠類,xxx_MembersInjector成員注入工具類,DaggerXXXComponet注射器類,xxx_Factory提供對象實例,xxx_MembersInjector是將xxx_Factory提供的實例賦給目標變量,DaggerXXXComponet起連接作用,是目標類和注入工具類的中介者。

當然Dagger2還有其它用法,如Module的使用,但我粗虐的實驗了下,其中的流程也基本一樣,xxx_Factory類型由枚舉enum變成了class,其它不同點還有待細看

還有個Scope注解我還沒弄懂,有時間繼續探索。。。

第一次寫源碼分析的文章,語言組織可能不盡人意,以后會慢慢提高。。。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 229,885評論 6 541
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,312評論 3 429
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 177,993評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,667評論 1 317
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,410評論 6 411
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,778評論 1 328
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,775評論 3 446
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,955評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,521評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,266評論 3 358
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,468評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,998評論 5 363
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,696評論 3 348
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,095評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,385評論 1 294
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,193評論 3 398
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,431評論 2 378

推薦閱讀更多精彩內容

  • 部分內容參考自:[Android]使用Dagger 2依賴注入 - DI介紹(翻譯)[Android]使用Dagg...
    AItsuki閱讀 47,716評論 66 356
  • Spring Cloud為開發人員提供了快速構建分布式系統中一些常見模式的工具(例如配置管理,服務發現,斷路器,智...
    卡卡羅2017閱讀 134,823評論 18 139
  • 注:本文是小生自學時做(fanyi)的筆記,可能含有少兒不宜的誤導性內容,學習Dagger請移步原博。原博地址:h...
    烏龜愛吃肉閱讀 559評論 0 0
  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 172,715評論 25 708
  • 此文為本人學習guice的過程中,翻譯的官方文檔,如有不對的地方,歡迎指出。另外還有一些附件說明、吐槽、疑問點,持...
    李眼鏡閱讀 3,514評論 2 5