View.inflate() 的前世今生

误用 LayoutInflater 的 inflate() 方法已经不是什么稀罕事儿了……

做 Android 开发做久了，一定会或多或少地对布局的渲染有一些懵逼：

  1. View.inflate() 和 LayoutInflator.from().inflate() 有啥区别？
  2. 调用 inflate() 方法的时候有时候传 null，有时候传 parent 是为啥？
  3. 用 LayoutInflater 有时候还可能传个 attachToRoot ，这又是个啥？

接下来我们就从源码的角度来寻找一下这几个问题的答案，后面再用几个示例来验证我们的猜想。

话不多说，Let's go !

基本介绍

先来看一下这个方法具体做了什么：

/**
 * Inflate a view from an XML resource.  This convenience method wraps the {@link
 * LayoutInflater} class, which provides a full range of options for view inflation.
 */
public static View inflate(Context context, int resource, ViewGroup root) {
    LayoutInflater factory = LayoutInflater.from(context);
    return factory.inflate(resource, root);
}

当我们查看源码，就会发现，这个方法的内部实际上就是调用了 LayoutInflater 的 inflate 方法。正如此方法的注释所言，这是一个方便开发者调用的 LayoutInflater 的包装方法，而 LayoutInflater 本身则为 View 的渲染提供了更多的选择。

那么我们现在的问题就变成了， LayoutInflater 又做了什么？

继续追踪代码，我们会发现， LayoutInflator.from().inflate() 是这个样子的：

// LayoutInflator#inflate(int, ViewGroup)
public View inflate(@LayoutRes int resource, @Nullable ViewGroup root) {
        return inflate(resource, root, root != null);
}

啥？重载？

// LayoutInflator#inflate(int, ViewGroup, boolean)
public View inflate(int resource, ViewGroup root, boolean attachToRoot) {
    final Resources res = getContext().getResources();
    final XmlResourceParser parser = res.getLayout(resource);
    try {
        return inflate(parser, root, attachToRoot);
    } finally {
        parser.close();
    }
}

这里我们看到，通过层层调用，最终会调用到 LayoutInflator#inflate(int, ViewGroup, boolean) 方法，很明显，这个方法会将我们传入的布局 id 转换为 XmlResourceParser，然后进行另一次，也是最后一次重载。

这个方法就厉害了，这里基本上包括了我们所有问题的答案，我们继续往下看。

源码分析

话不多说，上代码。接下来我们来逐段分析下这个 inflate 方法：

public View inflate(XmlPullParser parser, ViewGroup root, boolean attachToRoot) {
    final Context inflaterContext = mContext;
    final AttributeSet attrs = Xml.asAttributeSet(parser);
    
    // 默认返回结果为传入的根布局
    View result = root;
  
    // 通过 createViewFromTag() 方法找到传入的 layoutId 的根布局，并赋值给 temp
    final View temp = createViewFromTag(root, name, inflaterContext, attrs);
    ViewGroup.LayoutParams params = null;
  
    // 如果传入的父布局不为空
    if (root != null) {
        // 为这个 root 生成一套合适的 LayoutParams
        params = root.generateLayoutParams(attrs);
        if (!attachToRoot) {
            // 如果没有 attachToRoot，那为根布局设置 layoutparams
            temp.setLayoutParams(params);
        }
    }

    // 如果传入的父布局不为空，且想要 attachToRoot
    if (root != null && attachToRoot) {
        // 那就将传入的布局以及 layoutparams 通过 addView 方法添加到父布局中 
        root.addView(temp, params);
    }

    // 如果传入的根布局为空，或者不想 attachToRoot，则返回要加载的 layoutId
    if (root == null || !attachToRoot) {
        result = temp;
    }
    return result;
}

代码也分析完了，我再来总结一下：

  • View#inflate 只是个简易的包装方法，实际上还是调用的 LayoutInflater#inflate ;

  • LayoutInflater#inflate 由于可以自己选择 root 和 attachToRoot 的搭配（后面有解释），使用起来更加灵活；

  • 实际上的区别只是在于 root 是否传空，以及 attachToRoot 真假与否；

  • 当 root 传空时，会直接返回要加载的 layoutId，返回的 View 没有父布局且没有 LayoutParams；

  • 当 root 不传空时，又分为 attachToRoot 为真或者为假：

    • attachToRoot = true

    会为传入的 layoutId 直接设置参数，并将其添加到 root 中，然后将传入的 root 返回；

    • attachToRoot = false

    会为传入的 layoutId 设置参数，但是不会添加到 root ，然后返回 layoutId 对应的 View；

    这里需要注意的是，虽然不马上将 View 添加到 parent 中，但是这里最好也传上 parent，而不是粗暴的传入 null；因为子 View 的 LayoutParams 需要由 parent 来确定；否则会在手动 addView 时调用 generateDefaultLayoutParams() 为子 View 生成一个宽高都为包裹内容的 LayoutParams，而这并不一定是我们想要的。

测试 & 检验

单说起来可能有些抽象，下面使用代码来进行具体的测试与检验。

View.inflate(context, layoutId, null)

如之前所说，这实际上调用的是 getLayoutInflater().inflate(layoutId, null) ，结合之前的源码来看：

public View inflate(XmlPullParser parser, ViewGroup root, boolean attachToRoot) {
    View result = root;
    final View temp = createViewFromTag(root, name, inflaterContext, attrs);
    if (root == null || !attachToRoot) {
        result = temp;
    }
    return result;
}

很明显，传入的 root 为空，则会直接将加载好的 xml 布局返回，而这种情况下返回的这个 View 没有参数，也没有父布局。

protected void onCreate(@Nullable Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.layout_test);
    View inflateView = View.inflate(this, R.layout.layout_basic_use_item, null);
    Log.e("Test", "LayoutParams -> " + inflateView.getLayoutParams());
    Log.e("Test", "Parent -> " + inflateView.getParent());
}
image

如图所示，正如我们想的，root 传 null 时，参数以及父布局返回结果均为 null。

View.inflate(context, layoutId, mParent)

按之前分析过的，此方法实际调用的是 getLayoutInflater().inflate(layoutId, root, true) ，再来看源码：

public View inflate(XmlPullParser parser, ViewGroup root, boolean attachToRoot) {
    final Context inflaterContext = mContext;
    final AttributeSet attrs = Xml.asAttributeSet(parser);
    View result = root; 
    final View temp = createViewFromTag(root, name, inflaterContext, attrs);
    ViewGroup.LayoutParams params = null;
    if (root != null) {
        params = root.generateLayoutParams(attrs);
    }
    if (root != null && attachToRoot) {
        root.addView(temp, params);
    }
    return result;
}

如源码所示，返回的 result 会在最开始就被赋值为入参的 root，root 不为空，同时 attachToRoot 为 true，就会将加载好的布局直接通过 addView 方法添加到 root 布局中，然后将 root 返回。

protected void onCreate(@Nullable Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    setContentView(R.layout.layout_test);

    LinearLayout mParent = findViewById(R.id.ll_root);
    View inflateView = View.inflate(this, R.layout.layout_basic_use_item, mParent);

    Log.e("Test", "LayoutParams -> " + inflateView.getLayoutParams());
    Log.e("Test", "Parent -> " + inflateView.getParent());
    Log.e("Test", "inflateView -> " + inflateView);
}
image

如图示，返回的 View 正是我们传入的 mParent，对应的 id 是 ll_root，参数也不再为空。

getLayoutInflater().inflate(layoutId, root, false)

也许会有人问了，现在要么是 root 传空，返回 layoutId 对应的布局；要么是 root 不传空，返回传入的 root 布局。那我要是想 root 不传空，但是还是返回 layoutId 对应的布局呢？

这就是 View#inflate 的局限了，由于它是包装方法，因此 attachToRoot 并不能因需定制。这时候我们完全可以自己调用 getLayoutInflater().inflate(layoutId, root, false) 方法，手动的将第三个参数传为 false，同时为这个方法传入目标根布局。这样，我们就可以得到一个有 LayoutParams，但是没有 parentView 的 layoutId 布局了。

protected void onCreate(@Nullable Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.layout_test);
    LinearLayout mParent = findViewById(R.id.ll_root);
    View inflateView = getLayoutInflater().inflate(R.layout.main, mParent, false);
    Log.e("Test", "LayoutParams -> " + inflateView.getLayoutParams());
    Log.e("Test", "Parent -> " + inflateView.getParent());
}
image

与我们分析的一致，有参数，但是没有父布局，且返回的就是我们加载的布局 id。我们在之后可以通过 addView 方法手动将这个布局加入父布局中。

这里还有个要注意的点，那就是 params = root.generateLayoutParams(attrs); 这句代码，我们会发现，为 layoutId 设置的 params 参数，实际上是通过 root 来生成的。这也就告诉我们，虽然不马上添加到 parent 中，但是这里最好也传上 parent，而不是粗暴的传入 null，因为子 View 的 LayoutParams 需要由 parent 来确定；当然，传入 null 也不会有问题，因为在执行 addView() 方法的时候，如果当前 childView 没有参数，会调用 generateDefaultLayoutParams() 生成一个宽高都包裹的 LayoutParams 赋值给 childView，而这并不一定是我们想要的。

attachToRoot 必须为 false！

代码写多了，大家有时候会发现这个 attachToRoot 也不是想怎样就怎样的，有时候它还就必须是 false，不能为 true。下面我们就来看看这些情况。

  • RecylerView#onCreateViewHolder()

    在为 RecyclerView 创建 ViewHolder 时，由于 View 复用的问题，是 RecyclerView 来决定什么时候展示它的子View，这个完全不由我们决定，这种情况下，attachToRoot 必须为 false：

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

  • Fragment#onCreateView()

    由于 Fragment 需要依赖于 Activity 展示，一般在 Activity 中也会有容器布局来盛放 Fragment：

    Fragment fragment = new Fragment();
getSupportFragmentManager()
        .beginTransaction()
        .add(R.id.root_container, fragment)
        .commit();

    上述代码中的 R.id.root_container 便为容器，这个 View 会作为参数传递给 Fragment#onCreateView() :

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

    它也是你在 inflate() 方法中传入的 ViewGroup，FragmentManager 会将 Fragment 的 View 添加到 ViewGroup 中，言外之意就是，Fragment 对应的布局展示或者说添加进 ViewGroup 时也不是我们来控制的，而是 FragmentManager 来控制的。

总结一下就是，当我们不为子 View 的展示负责时，attachToRoot 必须为 false；否则就会出现对应的负责人，比如上面说的 Rv 或者 FragmentManager，已经把布局 id 添加到 ViewGroup 了，我们还继续设置 attachToRoot 为 true，想要手动 addView，那必然会发生 child already has parent 的错误。

以上。

参考文章

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 158,117评论 4赞 360
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 66,963评论 1赞 290
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 107,897评论 0赞 240
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 43,805评论 0赞 203
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 52,208评论 3赞 286
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 40,535评论 1赞 216
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 31,797评论 2赞 311
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 30,493评论 0赞 197
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 34,215评论 1赞 241
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,477评论 2赞 244
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,988评论 1赞 258
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 28,325评论 2赞 252
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 32,971评论 3赞 235
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,055评论 0赞 8
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,807评论 0赞 194
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 35,544评论 2赞 271
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 35,455评论 2赞 266