Android中给fragment写入参数的轻量开发包FragmentArgs简介

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项目。