前言
上篇文章,我們聊完了簡單的Dagger2應用。
出來混遲早要還的,技術債Dagger2:Android篇(上)
並且結尾留下了一個問題:生命週期問題。
我相信瞭解過Dagger的小夥伴,一定知道Scope的概念。甚至也知道@Singleton
這個註解。
今天就把這個坑填上。讓我們一起聊一聊@Scope
。
正文
一、理解@Scope
首先,我們們必須要明確@Scope
作用物件:
- 首先,它被用在提供依賴的地方,比如:
@Provides
;@Inject
構造方法。 - 其次,只要提供依賴的地方使用了
@Scope
,那麼對應的Component一定要被同樣的@Scope
修飾。
對於Dagger來說,@Scope
表達的意思是:被@Scope
所標識的Component的生命週期內,只要是@Scope
所標識提供依賴的方法,那麼所提供的依賴都是單例!
不好理解?上段簡單的程式碼:
@Scope
@Retention(RetentionPolicy.RUNTIME)
public @interface MDove {
}
@Module
public class MDoveModule {
// 這裡用@MDove標識,並提供一個A類
@MDove
@Provides
AppleBean provideA() {
return new A();
}
// 這裡沒有用@MDove標識,並提供一個B類
@Provides
OrgranBean provideB() {
return new B();
}
}
@MDove
@Component(modules = {MDoveModule.class})
public interface MDoveComponent {
void inject(MDoveActivity mMDoveActivity);
}
public class FuriteScopeActivity extends AppCompatActivity {
@Inject A a1; // 為縮減行數
@Inject A a2;
@Inject B b1;
@Inject B b2;
MDoveComponent mMDoveComponent;
@Override
protected void onCreate(Bundle savedInstanceState) {
// 省略程式碼
Log.e("MDove", "a1:" + a1.toString());
Log.e("MDove", "a2:" + a2.toString());
Log.e("MDove", "b1:" + b1.toString());
Log.e("MDove", "b2:" + b2.toString());
}
}
複製程式碼
列印結果是什麼樣子呢?
a1:dfecc87
a2:dfecc87
b1:f3867b4
b2:3d52fdd
這下應該能夠理解上面文字的含義了吧?。
總結一下就是:Dagger2中的@Scope
,保證了在@Scope
標記下的Component作用域內 ,只要被@Scope
註解的方法,所提供的依賴,會保持單例 。
一定要好好理解這段話!
@Singleton
也是一種@Scope
同樣滿足上述總結。
二、@Singleton
同樣如此
這裡必須加粗宣告!不要看到Singleton,就想當然以為單例!
@Singleton
和單例沒有半毛錢關係!
@Singleton
只是自定義的@Scope
而已,只要是標識了@Scope
註解,那麼此Component所注入的依賴就是單例,和@Singleton
沒有任何關係。
這裡我們想叫什麼名字都可以!@Skr
、@Kunkun
、、@Fanfan
...啥都行!都可以保證單例。
總之就是一句話:在@Scope
註解標記的Component的作用域內所注入的例項是單例的 。
三、上點程式碼
其實,寫完一、二關於@Scope
的內容就算已經結束了。不過總覺的如果不加點程式碼似乎渾身不得勁,還是整點程式碼吧。
這裡的程式碼,還是“拿來主義”,用國外一些哥們的。不得不承認人家在部落格方面還是挺用心噠。
3.1、自定義@Scope
@Scope
public @interface MainActivityScope {}
複製程式碼
3.2、建立使用此@Scope
的Component
@Component(dependencies = RandomUserComponent.class)
@MainActivityScope
public interface MainActivityComponent {
RandomUserAdapter getRandomUserAdapter();
RandomUsersApi getRandomUserService();
}
複製程式碼
這裡提到的類,我們都可以在上一篇文章出來混遲早要還的,技術債Dagger2:Android篇(上),找到對應的程式碼實現。這裡就不對展開了。
依賴關係圖如下:
3.3、建立對應的@Module
@Module
public class MainActivityModule {
private final MainActivity mainActivity;
public MainActivityModule(MainActivity mainActivity) {
this.mainActivity = mainActivity;
}
// 注意理解這裡的@MainActivityScope
@Provides
@MainActivityScope
public RandomUserAdapter randomUserAdapter(Picasso picasso){
return new RandomUserAdapter(mainActivity, picasso);
}
}
複製程式碼
有了之一、二的鋪墊,這裡就不難理解了吧。加了@MainActivityScope
,我們的randomUserAdapter(Picasso picasso)
在MainActivityComponent
生命週期內,就會永葆單例。否則每次都會new。
3.4、提供MainActivityComponent
所需的依賴
public class RandomUserApplication extends Application {
private RandomUserComponent randomUserApplicationComponent;
public static RandomUserApplication get(Activity activity){
return (RandomUserApplication) activity.getApplication();
}
@Override
public void onCreate() {
super.onCreate();
randomUserApplicationComponent = DaggerRandomUserComponent.builder()
.contextModule(new ContextModule(this))
.build();
}
public RandomUserComponent getRandomUserApplicationComponent(){
return randomUserApplicationComponent;
}
}
複製程式碼
3.5、MainActivity
public class MainActivity extends AppCompatActivity {
// 省略
@Override
protected void onCreate(Bundle savedInstanceState) {
// 省略
MainActivityComponent mainActivityComponent = DaggerMainActivityComponent.builder()
.mainActivityModule(new MainActivityModule(this))
.randomUserComponent(RandomUserApplication.get(this).getRandomUserApplicationComponent())
.build();
randomUsersApi = mainActivityComponent.getRandomUserService();
mAdapter = mainActivityComponent.getRandomUserAdapter();
// 省略
}
}
複製程式碼
此情況下,無論我們呼叫多少次mainActivityComponent.getRandomUserAdapter();
我們拿到的RandomUserAdapter
都是單例的。
有興趣的下夥伴可以跑一跑Demo哦~~
尾聲
關於@Scope
到此就結束了。下一篇內容會針對@Component.Builder
、@SubComponent
的展開梳理。
爭取儘快結束Dagger2,的內容。