android中方便為fragment寫入引數的FragmentArgs簡介
原文連結 作者:Hannes Dorfmann 譯者:趙峰
Android開發有時候會令人頭痛。你不得不為諸如建立fragment這樣簡單的事情寫很多程式碼。幸運的是java支援一個強大的工具:註釋處理器(Annotation Processors)。
Fragment的問題是你不得不設定很多引數,從而讓它正常執行。很多android開發新手通常這樣寫:
public class MyFragment extends Fragment { private int id; private String title; public static MyFragment newInstance(int id, String title) { MyFragment f = new MyFragment(); f.id = id; f.title = title; return f; } @Override public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) { Toast.makeText(getActivity(), "Hello " + title.substring(0, 3), Toast.LENGTH_SHORT).show(); } }
這樣做怎麼了?我已經在自己的裝置上嘗試過了,它很好用?
它的卻能工作,但是你有沒有試過把你的裝置從豎向改為橫向?你的app將會因為NullPointerException而崩潰,當你試圖訪問id或title時。
我的app是正常的,因為我把app設定為豎向。所以我從來沒遇到過這個問題。
隨便你!Android是一個真正的多工作業系統。多個app在同一時間執行,同時如果需要記憶體android系統將會銷燬activity(和其中包含的fragment)。可能你在日常的app開發中不會注意這些問題。然而,當你在play store中釋出後,你將會注意到你的app崩潰了,但你不知道什麼原因。使用你app的使用者可能同時間使用多個app,很有可能你的app在後臺被銷燬了。例如:A 使用者開啟你的app,MyFragment在螢幕上顯示。下一步你的使用者按了home鍵(這是你的app在後臺執行),並且打開了其它應用。你的app可能會因為釋放記憶體而被銷燬。之後,使用者返回你的app,例如通過多工按鈕。所以,Android現在會怎麼做?Android會恢復之前的app狀態,同時恢復MyFragment,這就是問題所在。Fragment試圖訪問title,但title是null,因為它不是被永久儲存的。
我知道了,所以我需要把它們儲存在onSaveInstanceState(Bundle)中?
不是。官方的文件有一些不清楚,但是onSaveInstanceState(Bundle)的使用方法應該跟你用Activity.onSaveInstanceState(Bundle)一樣:你使用這個方法儲存例項的“臨時”狀態,例如去處理螢幕的方向(從豎向到橫向,反之亦然)。所以說當app在後臺被殺掉時fragment的例項狀態並不能被儲存成持久資料,它的作用是再一次返回前臺時恢復資料。它的作用跟Activity.onSaveInstanceState(Bundle)在Activity中的作用相同,它們用於“臨時”儲存例項狀態。然而,持久的引數是通過intent外部資料傳輸的。
所以我應該在Activity中得Intent儲存Fragment的引數?
不需要,Fragment有它自己的機制。有兩個方法:Fragment.setArguments(Bundle)和Fragment.getArguments(),你必須通過這兩個方法來確保引數被持久儲存。這就是我上面提到的痛苦之處。需要有大量的程式碼這樣寫。第一,你要建立一個Bundle,然後你需要放入鍵值對,最後呼叫Fragment.setArguments()。不幸的是,你的工作還沒有結束,你必須通過Fragment.getArguments()來讀出Bundle。一些這樣的工作:
public class MyFragment extends Fragment { private static String KEY_ID = "key.id"; private static String KEY_TITLE = "key.title"; private int id; private String title; public static MyFragment newInstance(int id, String title) { MyFragment f = new MyFragment(); Bundle b = new Bundle(); b.putInt(KEY_ID, id); b.putString(KEY_TITLE, title); f.setArguments(b); return f; } @Override public void onCreate(Bundle savedInstanceState) { // onCreate it's a good point to read the arguments Bundle b = getArguments(); this.id = b.getInt(KEY_ID); this.title = b.getString(KEY_TITLE); } @Override public View onCreate(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) { // No NullPointer here, because onCreate() is called before this Toast.makeText(getActivity(), "Hello " + title.substring(0, 3), Toast.LENGTH_SHORT).show(); } }我希望你現在能明白我所說的“痛苦”。在你的應用中你將會為每一個fragment寫很多程式碼。如果有人為你寫這樣的程式碼,這將不讓人滿意。註釋處理允許你在編譯的時候生成java程式碼。注意我們並不是在討論評價在執行時間使用反射的註釋。
FragmentArgs是一個輕量的包,用於為你的fragment生成精確的java程式碼。
import com.hannesdorfmann.fragmentargs.FragmentArgs; import com.hannesdorfmann.fragmentargs.annotation.Arg; public class MyFragment extends Fragment { @Arg int id; @Arg String title; @Override public void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); FragmentArgs.inject(this); // read @Arg fields } @Override public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) { Toast.makeText(getActivity(), "Hello " + title, Toast.LENGTH_SHORT) .show(); } }
只需要在你的Fragment類中加入註釋欄位,FragmentArgs就會生成引用程式碼。在你的Activity中你將使用生成的Builder類(你的fragment的字尾是”Builder”),而不是使用new MyFragment()或靜態的MyFragment.newInstance(int id,String title)方法。
例如:
public class MyActivity extends Activity { public void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); int id = 123; String title = "test"; // Using the generated Builder Fragment fragment = new MyFragmentBuilder(id, title).build(); // Fragment Transaction getFragmentManager().beginTransaction().replace(R.id.container,fragment).commit(); } }
你可能已經注意到在Fragment.onCreate(Bundle)中宣告的FragmentArgs.inject(this)。這個呼叫使你的fragment獲得了生成程式碼的連線。你可能會問你自己:“我需不需要在每一個Fragment中的onCreate(Bundle)中加入inject()方法”。答案是no。你只需要在你的fragment基類中插入這一句就可以,並且在所有的fragment中繼承它。
public class BaseFragment extends Fragment { @Override public void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); FragmentArgs.inject(this); // read @Arg fields } } public class MyFragment extends BaseFragment { @Arg String title; @Override public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) { Toast.makeText(getActivity(), "Hello " + title, Toast.LENGTH_SHORT) .show(); } }
信用:一部分的註釋生成程式碼是基於Hugo Visser的Bundles專案。