Hacks布局篇-Hack4 使用ViewStub实现延迟加载

ViewStub

作者：李旺成

时间：2016年5月7日

---

该 Hack 将介绍如何使用 ViewStub 实现视图的延迟加载（懒加载）。

ViewStub 简介

在 Android 开发中，经常会遇到这样的情况，在程序运行过程中动态的根据当前条件来决定是否显示某个控件或布局，一般大家都会使用 View 的 setVisibility() 方法来控制。这里介绍另外一种方式，那就是使用 ViewStub 来方便的完成这一功能。

先看看官方文档对 ViewStub 的介绍：

ViewStub文档

简单翻译下：
VeiwStub 是一种不可视并且大小为 0 的视图，可以延迟到运行时填充（inflate）布局资源。当 ViewStub 设置为可视或者 inflate() 方法被调用后，就会填充布局资源，然后 ViewStub 便会被填充的视图替代。

一句话介绍：

• ViewStub 是一个轻量级的 View，可以实现动态布局加载
• ViewStub 是一个看不见的，大小为 0 的视图
• ViewStub 主要是作为一个“占位符”放置于 View Tree 中，ViewStub 本身是不可见的

ViewStub 最大的优点
是当你需要时才会加载，使用它并不会影响 UI 初始化时的性能（可以说提高了初始化时的性能）。各种不常用的布局，比如：进度条、显示错误消息等都可以使用 ViewStub 来动态加载，以减少内存使用，加快渲染速度（懒加载 —— 用到的时候才加载）。

说明：在动态加载布局时，使用 ViewStub 的性能要比使用设置 View 的可见性高。因为虽然把 View 的初始可见 View.GONE，使其不可见，但是在 Inflate 布局的时候 View 仍然会被 Inflate，也就是说仍然会创建对象，会被实例化，会被设置属性。也就是说，会耗费内存等资源。

ViewStub 简单使用

先看效果：

ViewStub实现懒加载

来看看怎么用吧：
1、在 Layout 中使用

    ...
    
    ...
    

inflatedId 属性：该属性的作用是重新定义引用的 layout id，其属性值是调用 ViewStub 的 inflate() 方法时返回的 View 的 ID
layout 属性：该属性用于指定 inflate 时要填充的布局（与 include 的 layout 用法完全一样）
layout_marginXxx 属性：这些属性设置在 layout 指定的子布局中是没有作用的，需要放在它的 ViewStub 上面才会起作用。ViewStub 的属性在 inflate 后会都传给相应的布局

**2、ViewStub.inflate() 方法 **
看一下方法签名：

public View inflate();

inflate 方法

该方法返回一个 View，就是 layout 属性设置的布局。所以，一般都是这样用：

TextView fooder = (TextView) mTestVS.inflate();
fooder.setText("我是ViewStub Inflate的页脚");

**3、ViewStub.setVisibility() 方法 **
ViewStub 重写了 View 的 setVisibility() 方法，先看看源码：

/**
 * When visibility is set to {@link #VISIBLE} or {@link #INVISIBLE},
 * {@link #inflate()} is invoked and this StubbedView is replaced in its parent
 * by the inflated layout resource. After that calls to this function are passed
 * through to the inflated view.
 *
 * @param visibility One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}.
 *
 * @see #inflate() 
 */
@Override
@android.view.RemotableViewMethod
public void setVisibility(int visibility) {
    if (mInflatedViewRef != null) {
        View view = mInflatedViewRef.get();
        if (view != null) {
            view.setVisibility(visibility);
        } else {
            throw new IllegalStateException("setVisibility called on un-referenced view");
        }
    } else {
        super.setVisibility(visibility);
        if (visibility == VISIBLE || visibility == INVISIBLE) {
            inflate();
        }
    }
}

从源码中可以看出：ViewStub 的 setVisibility 成 View.VISIBLE 或 INVISIBLE 如果是首次使用，都会自动 inflate （调用 inflate() 方法）其指向的布局文件，并替换 ViewStub 本身，再次使用则是相当于对其指向的布局文件设置可见性。

4、小结
Layout 中：
把 ViewStub 当作占位符，设置 layout 属性，指向目的布局

Java 代码中：
findViewById() --> inflate() / setVisibility()

注意事项

使用 ViewStub 的时候有下面几点需要注意：

• 关于 ViewStub 指向的布局的一些属性
  当 ViewStub 调用 Inflate() 方法时，它所指向的布局文件替换掉当前 ViewStub 本身，注意并不是完全意义上的替换（与 include 标签还不太一样），替换时，布局文件的 layout params 是以 ViewStub 为准，其他布局属性是以布局文件自身为准

• ViewStub 目前不支持 标签

ViewStub Inflate 标签布局

• ViewStub 是“一次性的”
  这里的”一次性“是指调用过 ViewStub 的 inflate() 方法显示了目标布局之后，不可以再次调用该方法（注意，调用了 setVisibility(View.VISIBLE) 或者 setVisibility(View.INVISIBLE) 之后也绝对不可以再调 inflate() 方法），否则提示如下异常：

ViewStub多次Inflate

也就是说：ViewStub 对象只可以 Inflate 一次，之后 ViewStub 对象会被置为空。按句话说，某个被 ViewStub 对象指定的布局被 Inflate 一次之后，就不可以再次通过 ViewStub 对象来控制它了。（参考自：使用惰性控件ViewStub实现布局动态加载）

• ViewStub 只能用来 Inflate 一个布局文件，而不是某个具体的 View
  关于这个我做实验的时候并没有碰到，所以，猜测有可能是老版本的问题，关于这个没有深究了，知道原因的同学麻烦告诉我一下。

项目地址

AndroidHacks合集
布局篇

示例用到代码见：
Hack4Activity.java
activity_hack4.xml

参考

使用惰性控件ViewStub实现布局动态加载
Android性能优化之一：ViewStub
Android实战技巧：ViewStub的应用