ViewStub你真的了解嗎

目錄介紹

01.什麼是ViewStub
02.ViewStub構造方法
03.inflate()方法解析
04.WeakReference使用
05.ViewStub為何無大小
06.ViewStub為何不繪制
07.可以多次inflate()嗎
08.ViewStub不支援merge
09.ViewStub使用場景
10.ViewStub總結分析

好消息

部落格筆記大彙總【16年3月到至今】，包括Java基礎及深入知識點，Android技術部落格，Python學習筆記等等，還包括平時開發中遇到的bug彙總，當然也在工作之餘收集了大量的面試題，長期更新維護并且修正，持續完善……開源的檔案是markdown格式的！同時也開源了生活部落格，從12年起，積累共計N篇[近100萬字，陸續搬到網上]，轉載請注明出處，謝謝！
連結位址： https://github.com/yangchong211/YCBlogs
如果覺得好，可以star一下，謝謝！當然也歡迎提出建議，萬事起于忽微，量變引起質變！

ViewStub 是一個看不見的，沒有大小，不占布局位置的 View，可以用來懶加載布局。
當 ViewStub 變得可見或 inflate() 的時候，布局就會被加載（替換 ViewStub）。是以，ViewStub 一直存在于視圖層次結構中直到調用了 setVisibility(int) 或 inflate() 。
在 ViewStub 加載完成後就會被移除，它所占用的空間就會被新的布局替換。

先來看看構造方法：

public ViewStub(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes) {
    super(context);

    final TypedArray a = context.obtainStyledAttributes(attrs,
            R.styleable.ViewStub, defStyleAttr, defStyleRes);
    // 要被加載的布局 Id
    mInflatedId = a.getResourceId(R.styleable.ViewStub_inflatedId, NO_ID);
    // 要被加載的布局
    mLayoutResource = a.getResourceId(R.styleable.ViewStub_layout, 0);
    // ViewStub 的 Id
    mID = a.getResourceId(R.styleable.ViewStub_id, NO_ID);
    a.recycle();

    // 初始狀态為 GONE
    setVisibility(GONE);
    // 設定為不會繪制
    setWillNotDraw(true);
}

接下來就看看關鍵的方法，然後看看初始化狀态setVisibility方法。

// 複寫了 setVisibility(int) 方法
@Override
@android.view.RemotableViewMethod
public void setVisibility(int visibility) {
    // private WeakReference<View> mInflatedViewRef;
    // mInflatedViewRef 是對布局的弱引用
    if (mInflatedViewRef != null) {
        // 如果不為 null,就拿到懶加載的 View
        View view = mInflatedViewRef.get();
        if (view != null) {
            // 然後就直接對 View 進行 setVisibility 操作
            view.setVisibility(visibility);
        } else {
            // 如果為 null，就抛出異常
            throw new IllegalStateException("setVisibility called on un-referenced view");
        }
    } else {
        super.setVisibility(visibility);
        // 之前說過，setVisibility(int) 也可以進行加載布局
        if (visibility == VISIBLE || visibility == INVISIBLE) {
            // 因為在這裡調用了 inflate()
            inflate();
        }
    }
}

核心來了，平時用的時候，會經常調用到該方法。inflate() 是關鍵的加載實作，代碼如下所示：

public View inflate() {
    // 擷取父視圖
    final ViewParent viewParent = getParent();
    
    if (viewParent != null && viewParent instanceof ViewGroup) {
        // 如果沒有指定布局，就會抛出異常
        if (mLayoutResource != 0) {
            // viewParent 需為 ViewGroup
            final ViewGroup parent = (ViewGroup) viewParent;
            final LayoutInflater factory;
            if (mInflater != null) {
                factory = mInflater;
            } else {
                // 如果沒有指定 LayoutInflater
                factory = LayoutInflater.from(mContext);
            }
            // 擷取布局
            final View view = factory.inflate(mLayoutResource, parent,
                    false);
            // 為 view 設定 Id
            if (mInflatedId != NO_ID) {
                view.setId(mInflatedId);
            }
            // 計算出 ViewStub 在 parent 中的位置
            final int index = parent.indexOfChild(this);
            // 把 ViewStub 從 parent 中移除
            parent.removeViewInLayout(this);
            
            // 接下來就是把 view 加到 parent 的 index 位置中
            final ViewGroup.LayoutParams layoutParams = getLayoutParams();
            if (layoutParams != null) {
                // 如果 ViewStub 的 layoutParams 不為空
                // 就設定給 view
                parent.addView(view, index, layoutParams);
            } else {
                parent.addView(view, index);
            }
            
            // mInflatedViewRef 就是在這裡對 view 進行了弱引用
            mInflatedViewRef = new WeakReference<View>(view);

            if (mInflateListener != null) {
                // 回調
                mInflateListener.onInflate(this, view);
            }

            return view;
        } else {
            throw new IllegalArgumentException("ViewStub must have a valid layoutResource");
        }
    } else {
        throw new IllegalStateException("ViewStub must have a non-null ViewGroup viewParent");
    }
}

Inflate使用特點
- ViewStub隻能被Inflate一次，inflate之後ViewStub對象就會被置為空。即某個被ViewStub指定的布局被Inflate後，就不能夠再通過ViewStub來控制它了。
- ViewStub隻能用來Inflate一個布局檔案，而不是某個具體的View，當然也可以把View寫在某個布局檔案中。

使用了弱引用管理對象的建立，代碼如下所示

在這裡使用了get方法

@Override
@android.view.RemotableViewMethod(asyncImpl = "setVisibilityAsync")
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 {
        
    }
}

在這裡建立了弱引用對象

public View inflate() {
    final ViewParent viewParent = getParent();
    if (viewParent != null && viewParent instanceof ViewGroup) {
        if (mLayoutResource != 0) {
            mInflatedViewRef = new WeakReference<>(view);
            return view;
        } else {
            throw new IllegalArgumentException("ViewStub must have a valid layoutResource");
        }
    } 
}

首先先看一段源碼，如下所示：

@Override
protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {
    setMeasuredDimension(0, 0);
}

@Override
public void draw(Canvas canvas) {
}

@Override
protected void dispatchDraw(Canvas canvas) {
}

有沒有覺得很與衆不同
- draw和dispatchDraw雖然重寫了，但是看代碼卻都是什麼也不做!并且onMeasure還什麼也不做,直接setMeasuredDimension(0,0)；來把view區域設定位0,原來一個ViewStub雖然是一個view,卻是一個沒有任何顯示内容,也不顯示任何内容的特殊view，并且對layout在加載時候不可見的。

具體看一下setWillNotDraw(true)方法，代碼如下：

public void setWillNotDraw(boolean willNotDraw) {
    setFlags(willNotDraw ? WILL_NOT_DRAW : 0, DRAW_MASK);
}

View中，對于WILL_NOT_DRAW是這樣定義的：

/**
 * This view won't draw. {@link #onDraw(android.graphics.Canvas)} won't be
 * called and further optimizations will be performed. It is okay to have
 * this flag set and a background. Use with DRAW_MASK when calling setFlags.
 * {@hide}
 */
static final int WILL_NOT_DRAW = 0x00000080;

設定WILL_NOT_DRAW之後，onDraw()不會被調用，通過略過繪制的過程，優化了性能。在ViewGroup中，初始化時設定了WILL_NOT_DRAW，代碼如下：

public ViewGroup(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes) {
    super(context, attrs, defStyleAttr, defStyleRes);
 
    initViewGroup();
    initFromAttributes(context, attrs, defStyleAttr, defStyleRes);
}
 
private void initViewGroup() {
    // ViewGroup doesn't draw by default
    if (!debugDraw()) {
        setFlags(WILL_NOT_DRAW, DRAW_MASK);
    }
    mGroupFlags |= FLAG_CLIP_CHILDREN;
    mGroupFlags |= FLAG_CLIP_TO_PADDING;
    mGroupFlags |= FLAG_ANIMATION_DONE;
    mGroupFlags |= FLAG_ANIMATION_CACHE;
    mGroupFlags |= FLAG_ALWAYS_DRAWN_WITH_CACHE;
 
    if (mContext.getApplicationInfo().targetSdkVersion >= Build.VERSION_CODES.HONEYCOMB) {
        mGroupFlags |= FLAG_SPLIT_MOTION_EVENTS;
    }
 
    setDescendantFocusability(FOCUS_BEFORE_DESCENDANTS);
 
    mChildren = new View[ARRAY_INITIAL_CAPACITY];
    mChildrenCount = 0;
 
    mPersistentDrawingCache = PERSISTENT_SCROLLING_CACHE;
}

是以，在寫自定義布局時，如果需要調用onDraw()進行繪制，則需要在初始化時候，調用setWillNotDraw(false)。若是想要更進一步閱讀View中WILL_NOT_DRAW的相關源碼，可以去看下PFLAG_SKIP_DRAW相關的代碼。

ViewStub對象隻可以Inflate一次，之後ViewStub對象會被置為空。同時需要注意的問題是，inflate一個ViewStub對象之後，就不能再inflate它了，否則會報錯：ViewStub must have a non-null ViewGroup viewParent。。

其實看一下源碼就很好了解：

public View inflate() {
    //擷取viewStub的父容器對象
    final ViewParent viewParent = getParent();

    if (viewParent != null && viewParent instanceof ViewGroup) {
        if (mLayoutResource != 0) {
            final ViewGroup parent = (ViewGroup) viewParent;
            //這裡是加載布局，并且給它設定id
            //布局的加載是通過LayoutInflater解析出來的
            final View view = inflateViewNoAdd(parent);
            //這行代碼很重要，下面會将到
            replaceSelfWithView(view, parent);

            //使用弱引用
            mInflatedViewRef = new WeakReference<>(view);
            if (mInflateListener != null) {
                mInflateListener.onInflate(this, view);
            }
            return view;
        } else {
            //如果已經加載出來，再次inflate就會抛出異常呢
            throw new IllegalArgumentException("ViewStub must have a valid layoutResource");
        }
    } else {
        throw new IllegalStateException("ViewStub must have a non-null ViewGroup viewParent");
    }
}

其實也可以用一張圖來了解它，如下所示，摘自網絡
也就是說，一旦調用inflate上面的方法後ViewStub就會變成null了，是以使用該對象特别需要注意空指針問題。

不能引入包含merge标簽的布局到ViewStub中。否則會報錯：android.view.InflateException: Binary XML file line #1: can be used only with a valid ViewGroup root and attachToRoot=true

一般的app中大多有這麼一個功能，當加載的資料為空時顯示一個資料為空的視圖、在資料加載失敗時顯示加載失敗對應的UI，當沒有網絡的時候加載沒有網絡的UI，并支援點選重試會比白屏的使用者體驗更好一些。俗稱，頁面狀态切換管理……一般來說，加載中、加載失敗、空資料等狀态的UI風格，在App内的所有頁面中需要保持一緻，也就是需要做到全局統一，也支援局部定制。
ViewStub的優勢在于在上面的場景中，并不一定需要把所有的内容都展示出來，可以隐藏一些View視圖，待使用者需要展示的時候再加載到目前的Layout中，這個時候就可以用到ViewStub這個控件了，這樣可以減少資源的消耗，使最初的加載速度變快。
那麼就有了之前開發使用的狀态管理器開源庫，就是采用了ViewStub這個控件，讓View狀态的切換和Activity徹底分離開。用builder模式來自由的添加需要的狀态View，可以設定有資料，資料為空，加載資料錯誤，網絡錯誤，加載中等多種狀态，并且支援自定義狀态的布局。可以說完全不影響性能……

分析源碼的原理，不管認識到哪一步，最終的目标還是在運用上，即把看源碼獲得的知識用到實際開發中，那麼關于ViewStub的使用技巧，具體可以看我的狀态管理器案例，連結位址： https://github.com/yangchong211/YCStateLayout
歡迎你的star，這也是開源和寫部落格的源源動力，哈哈

ViewStub你真的了解嗎

目錄介紹

好消息

ViewStub狀态管理庫：

開源部落格大彙總：

繼續閱讀

一位經驗豐富的前端開發人員因未能通過算法面試題而受人嘲笑

前端學習之路---移動web開發（二）

css雪碧圖（css sprite）

移動端touch事件和滑鼠事件

Angular——子產品懶加載

在2016年如何學習JavaScript？

實用css技巧——清除浮動方法總結

css3中的結構僞類選擇器

圖檔下載下傳圖檔放大

mockjs 的正确使用姿勢mockjs fetch的使用思路

css display={block,inline,inline-block}的認識

前端開發日記之window.onload

webstorm中配置git

Vue圖檔切換過渡設計

測試工程師面試解析～

2018年不想被web前端開發淘汰，你需要掌握哪些技術？