RoboGuice是什麼? 一個Android上的依賴註入框架。 依賴註入是什麼? 從字面理解,這個框架做了兩件事情,第一是去除依賴,第二是註入依賴。簡單理解就是,將對象的初始化委托給一個容器控制器,即去除依賴,再從容器控制器中構建依賴,註入回原本的對象中,即註入依賴。 依賴註入的好處是對象不需要在
RoboGuice是什麼?
一個Android上的依賴註入框架。
依賴註入是什麼?
從字面理解,這個框架做了兩件事情,第一是去除依賴,第二是註入依賴。簡單理解就是,將對象的初始化委托給一個容器控制器,即去除依賴,再從容器控制器中構建依賴,註入回原本的對象中,即註入依賴。
依賴註入的好處是對象不需要在乎其依賴的初始化,使代碼變得無比簡潔。
一.接入
在build.grade中添加依賴
dependencies {
provided 'org.roboguice:roboblender:3.0.1'
compile 'org.roboguice:roboguice:3.0.1'
}
二.視圖註入
接觸依賴註入後,最方便的可能就是視圖的註入了,將之前成片的findViewById的代碼省去,Activity中的代碼量完成了史上第一次大掃除。
視圖註入分三個步驟:
- 繼承自RoboGuice的RoboActivity 當然RoboFragmentActivity也可以
- 為Activity加入content view(setContentView也可以使用註解來實現)
- 使用@InjectView來註入視圖
@ContentView(R.layout.activity_main)
public class MainActivity extends RoboFragmentActivity {
@InjectView(R.id.text_test)
TextView textView;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
textView.setText("hello there!");
}
}
由此可見,視圖註入大大簡化了Activity中的代碼量。
同理 ,Fragment也是一樣的。需要註意的是,視圖註入需要在onViewCreated後使用。
public class AFragment extends RoboFragment {
@InjectView(R.id.fragment_text)
TextView textView;
public static AFragment newInstance() {
return new AFragment();
}
@Nullable
@Override
public View onCreateView(LayoutInflater inflater, @Nullable ViewGroup container, @Nullable Bundle savedInstanceState) {
return inflater.inflate(R.layout.a_fragment, container, false);
}
@Override
public void onViewCreated(View view, Bundle savedInstanceState) {
super.onViewCreated(view, savedInstanceState);
textView.setText("Hi there!");
}
}
三.資源註入
RoboGuice除了提供了視圖註入,還提供了資源的註入。
比如String資源、color資源、Animation資源等。
@ContentView(R.layout.activity_main)
public class MainActivity extends RoboFragmentActivity {
@InjectView(R.id.text_test)
TextView textView;
@InjectResource(R.string.app_name)
String appName;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
textView.setText(appName);
}
}
四.系統服務註入
在Activity中可以註入各種系統服務,比如震動、通知管理。
完整的列表在這:https://github.com/roboguice/roboguice/wiki/Provided-Injections
這樣我們不用再去寫煩人的getSystemService這種代碼。
@ContentView(R.layout.activity_main)
public class MainActivity extends RoboFragmentActivity {
@Inject
Vibrator vibrator;
@Inject
NotificationManager notificationManager;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
vibrator.vibrate(500L);
notificationManager.cancelAll();
}
}
五.對象註入
對象的註入最大程度的完成了代碼的解耦工作。也是類似框架中上手最慢的。
想象一個場景,比如在Activity中用戶判斷登錄狀態,我們不需要在乎UserInfo是如何初始化的,只在乎得到用戶是否登陸的狀態。
結合實際情況,舉個例子。這是一個用來儲存用戶信息的model。
public class UserInfo {
private String userId;
private String token;
public String getUserId() {
return userId;
}
public void setUserId(String userId) {
this.userId = userId;
}
public String getToken() {
return token;
}
public void setToken(String token) {
this.token = token;
}
public boolean isLogin(){
return !TextUtils.isEmpty(token);
}
}
使用註解註入UserInfo,RoboGuice會幫我們完成初始化工作,初始化時調用UserInfo的預設構造方法。
這樣在沒有寫userInfo = new UserInfo()
我們便操作了對象。
@ContentView(R.layout.activity_main)
public class MainActivity extends RoboFragmentActivity {
@Inject
UserInfo userInfo;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
userId = sharedPreferences.getString("userId", "");
token = sharedPreferences.getString("token", "");
String userId = sharedPreferences.getString("userId", "");
String token = sharedPreferences.getString("token", "");
userInfo.setUserId(userId);
userInfo.setToken(token);
}
}
再然而onCreate內部的取用戶信息的代碼確實很醜陋,我們需要在Activity中完成與頁面不相關的初始化工作,核心原因是我們依賴了Activity中的Context。這就相當於,如果對象中的成員初始化時需要對象的一些屬性,我們很難巧妙的將屬性交給容器管理著負責初始化成員。
那麼又該如何處理這麼醜陋的代碼呢。
RoboGuice提供了更讓人欣喜的功能,將對象中的成員初始化需要的屬性封裝起來,提交給容器管理者,這樣當依賴對象屬性的成員初始化過程就可以完全脫離對象,在成功後註入回對象即可。
Talk is cheap! Show me the code.
在RoboGuice的Activity中,容器管理者已經預設提供了的屬性比如頁面中的Context,這樣當成員初始化時,可以使用@Inject來標記構造方法以用來告訴RoboGuice不使用預設構造方法進行初始化,當構造方法中的參數屬性已經由Activity對象提交給容器管理者時,即容器管理者會使用該構造方法進行初始化。
我們經過改裝,UserInfo和Activity是這樣的。其中@ContextSingleton註解標示UserInfo隨Context的生命周期銷毀而銷毀,如果這裡改為@Singleton,那麼UserInfo的生命周期將是整個應用的生命周期,如果兩個Activity都使用了該註解,那麼產生的對象將是同一個。
這裡需要註意的是,如果@ContextSingleton使用不當,將造成記憶體泄露,這個以後會有例子說明。
@ContextSingleton
public class UserInfo {
private static final String TAG = "UserInfo";
private Context context;
private String userId;
private String token;
@Inject
public UserInfo(Context context) {
this.context = context;
init();
}
private void init() {
SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
userId = sharedPreferences.getString("userId", "");
token = sharedPreferences.getString("token", "");
}
public String getUserId() {
return userId;
}
public void setUserId(String userId) {
this.userId = userId;
}
public String getToken() {
return token;
}
public void setToken(String token) {
this.token = token;
}
public boolean isLogin(){
return !TextUtils.isEmpty(token);
}
public void saveUserInfo(String userId) {
SharedPreferences.Editor editor = PreferenceManager.getDefaultSharedPreferences(context).edit();
editor.putString("userId", userId);
editor.apply();
}
}
@ContentView(R.layout.activity_main)
public class MainActivity extends RoboFragmentActivity {
@InjectView(R.id.text_test)
TextView textView;
@Inject
UserInfo userInfo;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
if(userInfo.isLogin()){
textView.setText(userInfo.getUserId());
} else {
textView.setText("未登錄");
}
}
}
至此,入坑篇告一段落,這篇主要說明瞭RoboGuice的視圖、資源、系統服務、對象等註入,為開髮帶來便捷,同時也減少了模塊的耦合性。