Android小记:ViewStub的使用

ViewStub

    在介绍ViewStub之前，可以先了解一下<include/>标签，这是一个把其它布局资源包含进某个特定的布局中，在很多平台的开发中，都有类似的概念，这样好处就不用细说了，主要是可以在不同的文件中编辑界面的布局控件。 
    ViewStub，惰性装载控件。ViewStub是一个无形的、零大小的视图，可以在程序运行的过程中，通过懒加载的模式inflate进布局资源中。当一个ViewStub的inflate()方法被调用或者被设为显示时，这个ViewStub使用设定的View才会被加载，并替换当前ViewStub的位置。因此，ViewStub存在于视图层次，直到setVisibility(int)或inflate()方法被调用，否则是不加载控件的，所以消耗的资源小。通常也叫它为“懒惰的include”。 
    ViewStub的好处是，在某些场景中，并不一定需要把所有的内容都展示出来，可以隐藏一些View视图，待用户需要展示的时候再加载到当前的Layout中，这个时候就可以用到ViewStub这个控件了，这样可以减少资源的消耗，使最初的加载速度变快。 
    在ViewStub中，需要用到的属性也就两个，Android也为其提供了相应的getter/setter方法： 
android:inflateId：重写ViewStub的父布局控件的Id。
android:layout：设置ViewStub被inflate的布局控件Id。 

对于ViewStub而言，它需要监听的事件就只有一个，被加载的时候触发的事件

VIewStub.OnInflateListener，在这个事件中，需要实现一个onInflate()方法，以下是这个方法的签名： 

onInflate(ViewStub stub, View inflated); 

在VIewStub.OnInflateListener事件的onInflate()方法中，stub为当前待膨胀的ViewStub控件，inflated参数为当前被膨胀的View视图，可以在其中对其进行一些额外的操作。 

在使用ViewStub的过程中，有一点需要特别注意。对于一个ViewStun而言，当setVisibility(int)或inflate()方法被调用之后，这个ViewStub在布局中将被使用指定的View替换，所以inflate过一遍的ViewStub，如果被隐藏之后再次想要显示，将不能使用inflate()方法，但是可以再次使用setVisibility(int)方法设置为可见，这就是这两个方法的区别。而inflate()被调用之后，返回的是父布局控件对象。

示例Demo 

下面通过一个Demo讲解一下上面提到的内容。在这个Demo中，会简单的使用到<include/>标签，还定义一个ViewStub控件，用于加载一个RatingBar，提供按钮加载与隐藏这个RatingBar，最后提供一个按钮用于操作动态加载的Ratingbar。 

<strong><span style="font-size:14px;">定义的被inflate的控件代码：
<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:orientation="vertical" >

<RatingBar
android:id="@+id/ratingBar1"
android:layout_width="wrap_content"
android:layout_height="wrap_content" />

</LinearLayout>

布局代码：
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:tools="http://schemas.android.com/tools"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:orientation="vertical"
android:paddingBottom="@dimen/activity_vertical_margin"
android:paddingLeft="@dimen/activity_horizontal_margin"
android:paddingRight="@dimen/activity_horizontal_margin"
android:paddingTop="@dimen/activity_vertical_margin"
tools:context=".MainActivity" >

<!-- 使用include标签加载一个id为start的控件 -->

<include
android:layout_width="wrap_content"
android:layout_height="wrap_content"
layout="@layout/start" />

<LinearLayout
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:background="#FFCCDD"
android:orientation="vertical" >

<! />

<ViewStub
android:id="@+id/stub"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:inflatedId="@+id/inflatedStart"
android:layout="@layout/start" />
</LinearLayout>

<Button
android:id="@+id/btn1"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:text="动态添加布局" />

<Button
android:id="@+id/btn2"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:text="动态隐藏布局" />

<Button
android:id="@+id/btn3"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:text="操作StubInflate的控件" />

</LinearLayout>
</span></strong>

<strong><span style="font-size:14px;">实现代码：
package com.bgxt.viewstubdemo;

import android.os.Bundle;
import android.annotation.SuppressLint;
import android.app.Activity;
import android.view.Menu;
import android.view.View;
import android.view.View.OnClickListener;
import android.view.ViewStub;
import android.view.ViewStub.OnInflateListener;
import android.widget.Button;
import android.widget.LinearLayout;
import android.widget.RatingBar;
import android.widget.Toast;

public class MainActivity extends Activity {
private Button btn1, btn2, btn3;
private ViewStub viewStub;

@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
// 获取控件，绑定事件
btn1 = (Button) findViewById(R.id.btn1);
btn2 = (Button) findViewById(R.id.btn2);
btn3 = (Button) findViewById(R.id.btn3);
viewStub = (ViewStub) findViewById(R.id.stub);
viewStub.setOnInflateListener(inflateListener);
btn1.setOnClickListener(click);
btn2.setOnClickListener(click);
btn3.setOnClickListener(click);
}

private OnInflateListener inflateListener = new OnInflateListener() {
@Overrid
public void onInflate(ViewStub stub, View inflated) {
// inflaye ViewStub的时候显示
Toast.makeText(MainActivity.this, "ViewStub is loaded!",
Toast.LENGTH_SHORT).show();
}
};
private View.OnClickListener click = new OnClickListener() {
@Override
public void onClick(View v) {
switch (v.getId()) {
case R.id.btn1:
try {
// 如果没有被inflate过，使用inflate膨胀
LinearLayout layout = (LinearLayout) viewStub.inflate();
RatingBar bar = (RatingBar) layout
.findViewById(R.id.ratingBar1);
bar.setNumStars(4);
} catch (Exception e) {
// 如果使用inflate膨胀报错，就说明已经被膨胀过了，使用setVisibility方法显示
viewStub.setVisibility(View.VISIBLE);
}
break;
case R.id.btn2:
// 隐藏ViewStub
viewStub.setVisibility(View.GONE);
break;
case R.id.btn3:

// 操作被inflate的控件，需要得到当前布局的对象
// 然后通过这个对象去找到被inflate的控件。
// 因为否则在这个示例中，会找到include标签引入的控件
LinearLayout linearLayout = (LinearLayout) findViewById(R.id.inflatedStart);
RatingBar rBar = (RatingBar) linearLayout
.findViewById(R.id.ratingBar1);
float numStart = rBar.getRating();
numStart++;
if (numStart > 4) {
numStart = 0;
}
rBar.setRating(numStart);
break;
}
}
};

@Override
public boolean onCreateOptionsMenu(Menu menu) {
// Inflate the menu; this adds items to the action bar if it is present.
getMenuInflater().inflate(R.menu.main, menu);
return true;
}
}</span></strong>

ViewStub的使用示例

MainACtivity.java:

/** 
 * Demo描述: 利用ViewStub显示和隐藏布局 
 * ViewStub的引入: 
 * 在开发的时候,有些布局是要根据条件而动态显示,达到一个布局两用的效果, 
 * 运用View.VISIBLE和View.GONE去改变布局的可见性. 
 * 这样的做法显然是没什么多大的问题,优点逻辑清晰,控制灵活,但缺点就是耗费资源 
 * 在setContentView()或者用inflate加载布局文件时无论View是否 
 * 被设置为View.GONE和View.VISIBLE,都会创建对象,占用一定程度上的内存,所以在考虑优化程序的时候， 
 * 尽量避免资源浪费，降低程序的资源占有量，提高响应速度，提升软件的用户体验 
 *  
 * 推荐的做法是使用android.view.ViewStub. 
 * ViewStub是一个轻量级的View,它一个看不见的,不占布局位置,占用资源非常小的控件. 
 * ViewStub是一个隐藏的,不占用内存空间的视图对象,它可以在运行时延迟加载布局资源文件当 ViewStub可见,或者调用 
 * inflate()函数时,才会加载这个布局资源文件 注意的问题: ViewStub只能用来Inflate一个布局文件,而不是某个具体的View 
 *  
 * 遇到的问题:  
 * 报错 ViewStub must have a non-null ViewGroup viewParent  
 * 原因: 
 * 官方文档:viewstub不能反复inflate,只能inflate一次 
 */  

<strong><span style="font-size:18px;">public class MainActivity extends Activity {
private Button mButton_show;
private Button mButton_hidden;
private ViewStub mViewStub;
private View mView=null;
private boolean isInflate=true;
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.main);
init();
}
private void init(){
mButton_show=(Button) findViewById(R.id.button_show);
mButton_show.setOnClickListener(new ButttonClickListenerImpl());
mButton_hidden=(Button) findViewById(R.id.button_hidden);
mButton_hidden.setOnClickListener(new ButttonClickListenerImpl());
mViewStub=(ViewStub) findViewById(R.id.viewStub);
}

private class ButttonClickListenerImpl implements OnClickListener {
public void onClick(View v) {
switch (v.getId()) {
case R.id.button_show:
if (isInflate) {
mView=mViewStub.inflate();
isInflate=false;
}else {
mView.setVisibility(View.VISIBLE);
}
TextView textView=
(TextView) mView.findViewById(R.id.viewStub_TextView);
textView.setText("time="+System.currentTimeMillis());
break;
case R.id.button_hidden:
mViewStub.setVisibility(View.GONE);
break;
default:
break;
}
}
}
}

main.xml如下:
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:tools="http://schemas.android.com/tools"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:orientation="vertical"   >
<LinearLayout
android:layout_width="wrap_content"
android:layout_height="wrap_content"   >
<ViewStub
android:id="@+id/viewStub"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout="@layout/testviewstublayout"   />
</LinearLayout>
<Button
android:id="@+id/button_show"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:text="加载ViewStub"  />
<Button
android:id="@+id/button_hidden"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:text="隐藏ViewStub"  />
</LinearLayout>
testviewstublayout.xml.xml如下:
<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:orientation="vertical" >
<TextView
android:id="@+id/viewStub_TextView"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:text="test test test" />
</LinearLayout>  </span><span style="font-size: 14px;">
</span></strong>