網上關于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注解我還沒弄懂,有時間繼續探索。。。
第一次寫源碼分析的文章,語言組織可能不盡人意,以後會慢慢提高。。。