LayoutInflater.inflate() 方法剖析

程序员很容易满足于写模板代码，因为这样最省事，但不愿走出舒适区，沉溺于这样的生活的话，往往会忽略许多细节，而我就是其中一员。LayoutInflater 相信没有 Android 开发者会陌生，它能将 xml 布局转化为相应的视图（如：ViewGroup 和 Widget），它还可以在 Fragment 的 onCreateView() 方法里面初始化 Fragment 的布局。在阅读了 Google 给出的有关 LayoutInflater 的文档说明以及网上对它的讨论，我发现有许多开发者都不了解 LayoutInflater 的 inflate() 的细节，而且一直以错误的方式使用它。

使用 inflate() 方法的困惑大多来自 Google 文档对该方法的第三个参数 - attachToRoot 模糊的解释。

被初始化的视图布局是否应该添加到方法的第二个参数 ViewGroup root 上？如果不应该，root 只能被用于创建根布局所使用的 LayoutParams。

如果 attachToRoot 为 true，那么作为参数传入的 xml 布局就会被初始化，并添加到方法的第二个参数 - ViewGroup 上。

而 inflate() 方法将返回该组合后的 View，该 View 的根布局就是该 ViewGroup。而当 attachToRoot 为 false，xml 布局将被初始化且作为 inflate() 方法的返回值返回。但此时该 View 的根布局是 xml 文件中的根布局，而不是 inflate() 方法的第二个参数 ViewGroup 所对应的布局。不管怎样，ViewGroup 的 LayoutParams 都需要准确地按照该 xml 布局显示视图。

将 attachToRoot 设为 true 使得 xml 布局被添加到参数的 ViewGroup 中；将它设为 false，会使该布局以其他方式被添加到 ViewGroup 中。

将 attachToRoot 设为 true

假设我们在 xml 布局中显示一个 Button，其 width 和 height 都是 match_parent

<Button xmlns:android="http://schemas.android.com/apk/res/android"
                android:layout_width="match_parent"
                android:layout_height="match_parent"
                android:id="@+id/custom_button">
</Button>

现在我们要把该 Button 添加到 Activity/Fragment 中的 LinearLayout，假设此时 LinearLayout 已经是 Activity/Fragment 的成员，那么我们可以这样实现：

inflater.inflate(R.layout.custom_button, mLinearLayout, true);

我们让 inflate() 方法通过 xml 文件得到 Button 布局，且通过设置 attachToRoot 让 LayoutInflater 将 Button 添加到 mLinearLayout 中，Button 的 LayoutParams 应该是 LinearLayout.LayoutParams。

同样的，下面的方法和上面的效果一样，因为该方法默认将 attachToRoot 设为 true。

inflater.inflate(R.layout.custom_button, mLinearLayout);

其他将 attachToRoot 设为 true 的正确用法是传入自定义 View，在下面的例子里，xml 布局中使用了 标签允许布局将它里面嵌套的 View 直接 include 到它的父布局中，而没有多加一层 ViewGroup，减小了 ViewTree 的深度。

public class MyCustomView extends LinearLayout {
    ...
    private void init() {
        LayoutInflater inflater = LayoutInflater.from(getContext());
        inflater.inflate(R.layout.view_with_merge_tag, this);
    }
}

这样就是将 attachToRoot 设为 true 的完美用法了，布局文件没有设置 ViewGroup 去容纳控件，使得我们能将自定义的 LinearLayout 设为该布局的容器。如果我们没有使用 标签，而是将 FrameLayout 设置为它的根布局，那么初始化完成的工作和政策情况是一样的。该 FrameLayout 和 子元素都会被添加到 LinearLayout 中，LinearLayout 将作为根 ViewGroup 容纳 FrameLayout。

将 attachToRoot 设为 false

现在不妨学习应该在何时将 attachToRoot 设为 false 吧。此时，View 将不会被添加到第二个参数传递的 ViewGroup 中。

回忆前面的例子吧，我们可以通过下面的办法将该 Button 布局添加到 LinearLayout 中。

Button button = (Button) inflater.inflate(R.layout.custom_button, mLinearLayout, false);
mLinearLayout.addView(button);

这两行代码和我们之前将 attachToRoot 设为 true 时一行代码完成的工作相同，将 attachToRoot 设为 false，意味着我们表示：不想将 View 添加到根 ViewGroup 中。但如果想添加到根 ViewGroup 中的话，通过 addView() 方法就可以实现。

虽说将 attachToRoot 设为 false 时，想要将 Button 添加到 ViewGroup 写的代码要比将 attachToRoot 设为 true 要多一些，但有些情况是必须将 attachToRoot 设为 false 的。

例如 RecyclerView 在 onCreateViewHolder() 方法中初始化子布局时就必须将 attachToRoot 设为 false

public ViewHolder onCreateViewHolder(ViewGroup parent, int viewType) {
    LayoutInflater inflater = LayoutInflater.from(getActivity());
    View view = inflater.inflate(android.R.layout.list_item_recyclerView, parent, false);
    return new ViewHolder(view);
}

何时初始化子布局，何时显示子布局，由 RecyclerView 决定，因此，将 View 添加到 ViewGroup 中的职责就不该由我们完成，所以 attachToRoot 就应该设为 false。

当在 Fragment 的 onCreateView() 中初始化并返回布局时，必须将 attachToRoot 设为 false，不然会抛出 IllegalStateException，因为该 View 已经属于某个父布局了。

FragmentManager fragmentManager = getSupportFragmentManager();
Fragment fragment = fragmentManager.findFragmentById(R.id.root_viewGroup);

if (fragment == null) {
    fragment = new MainFragment();
    fragmentManager.beginTransaction()
        .add(R.id.root_viewGroup, fragment)
        .commit();
}

root_viewGroup 将在 Activity 中显示 Fragment，同时是 onCreateView() 中的 ViewGroup 参数，同时也是 inflate() 方法中的 ViewGroup 参数。将 Fragment 的 View 添加到 ViewGroup 的任务由 FragmentManager 完成，如果你不想两次进行该添加操作，就把 attachToRoot 设为 false 吧。

public View onCreateView(LayoutInflater inflater, ViewGroup parentViewGroup, Bundle savedInstanceState) {
    View view = inflater.inflate(R.layout.fragment_layout, parentViewGroup, false);
    …
    return view;
}

如果我们不想在 onCreateView() 中将它添加到 ViewGroup 中，为什么要在参数中提供 ViewGroup 参数呢？为什么 inflate() 方法需要根 ViewGroup？即使我们没有在初始化 View 后立刻将它添加到它的父 ViewGroup 中，我们也需要使用父 ViewGroup 的 LayoutParams 来初始化 View 的布局，即使它不会被添加到该 ViewGroup 中。

网上有很多有关 LayoutInflater 的用法，如果你想将 attachToRoot 设为 false，就将 ViewGroup 参数那填入 null。但如果父 ViewGroup 是可用的，还是应该将它填入该方法。

Lint 会警告你别填入 null，虽说 App 不会因此崩溃，但可能会出现些问题。当 View 不知道 ViewGroup 的 LayoutParams 到底该是什么时，它会尝试通过自身的 generateDefaultLayoutParams 判断。而这些默认的 LayoutParams 可能不是你想要的。你在 xml 文件中设置的 LayoutParams 都会被无视，导致布局不是你想要的。

下面是你没有 ViewGroup 可传递的具体的场景。

AlertDialog.Builder dialogBuilder = new AlertDialog.Builder(mContext);
View customView = inflater.inflate(R.layout.custom_alert_dialog, null);
...
dialogBuilder.setView(customView);
dialogBuilder.show();

这种情况下，传递 null 是没有问题的，因为 AlertDialog 将 LayoutParams 重载，使得无论如何都是 match_parent。但通常情况下，你都是要传入父 ViewGroup 的。

避免崩溃，错误布局以及对 LayoutInflater 的误解

希望这篇博文能帮你避免崩溃、错误布局以及对 LayoutInflater 的误解，下面是一些建议：

• 如果你有可传递的根 ViewGroup，那就传递
• 避免在 ViewGroup 参数那填入 null
• 当添加 View 到 ViewGroup 的职责不由我们负责时，attachToRoot 就设为 false
• 若 View 已经被添加到 ViewGroup 中，别将 attachToRoot 设为 true
• 自定义 View 很适合将 attachToRoot 设为 true