误用 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 添加到 parent 中,但是这里最好也传上 parent,而不是粗暴的传入 null;因为子
View 的 LayoutParams 需要由 parent 来确定;否则会在手动 addView 时调用
generateDefaultLayoutParams() 为子 View 生成一个宽高都为包裹内容的
LayoutParams,而这并不一定是我们想要的。
单说起来可能有些抽象,下面使用代码来进行具体的测试与检验。
如之前所说,这实际上调用的是 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());
}
如图所示,正如我们想的,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);
}
如图示,返回的 View 正是我们传入的 mParent,对应的 id 是 ll_root,参数也不再为空。
也许会有人问了,现在要么是 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());
}
与我们分析的一致,有参数,但是没有父布局,且返回的就是我们加载的布局 id。我们在之后可以通过 addView 方法手动将这个布局加入父布局中。
这里还有个要注意的点,那就是 params = root.generateLayoutParams(attrs); 这句代码,我们会发现,为 layoutId 设置的 params 参数,实际上是通过 root 来生成的。这也就告诉我们,虽然不马上添加到 parent 中,但是这里最好也传上 parent,而不是粗暴的传入 null,因为子 View 的 LayoutParams 需要由 parent 来确定;当然,传入 null 也不会有问题,因为在执行 addView() 方法的时候,如果当前 childView 没有参数,会调用 generateDefaultLayoutParams() 生成一个宽高都包裹的 LayoutParams 赋值给 childView,而这并不一定是我们想要的。
代码写多了,大家有时候会发现这个 attachToRoot 也不是想怎样就怎样的,有时候它还就必须是 false,不能为 true。下面我们就来看看这些情况。
在为 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 需要依赖于 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 的错误。