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注解我還沒弄懂，有時間繼續探索。。。

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

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

推薦閱讀更多精彩內容

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