Android中App Widget的开发（一）——基本介绍篇

分类：Android, Java 阅读 (3,723) Add comments

5月 132015

转载请注明原文地址：http://bcoder.com/java/android-app-widget-development-1

　　App Widget是Android中可以用于显示在桌面或者锁屏中的便捷显示组件，对于一些应用来说，比如天气预报、音乐播放器、股票行情等应用，开发相应的组件放到桌面上可以让用户更快捷高效的查看内容，提高用户的效率，增强用户的体验，让应用更加受用户欢迎。

一、插件原理介绍

　　因为小插件要长期在桌面上，所以小插件不能通过应用的形式来长期运行，那样会消耗很多的系统资源，所在在安卓系统中，插件是作为插件宿主的一部分而存在，而不是一个应用程序，而插件宿主由安卓系统来控制，这时插件和应用之间的数据传输就不能像Activity之间一样单纯的用Intent来控制了。那么插件的数据是通过什么形式传输的呢？答案是使用的广播的方式来传输数据，插件本身是一个BroadcastReceiver，接收到消息或数据后再进行显示。由此可见，插件并没有Activity，只是一个BroadcastReceiver，而用于处理界面的对象则是RemoteViews而不是View对象。

　　Android中的桌面插件虽然拥有和Activity基本一样的布局，但插件中的组件却不能直接通过组件对象直接操作，比如在Activity中我们要改变一个TextView显示的文字，我们只需要用findViewById找到这个对象并赋给一个定义好的TextView对象，然后用这个对象的setText方法修改显示文字即可。但是在插件中却不可以这样操作，因为他本身并不存在Activity，不提供findViewById这样的方法来寻找对象。具体如何操作以后会讲到，下面我们先来看看要创建一个组件所必须的几个对象。

二、三个必要组件

　　通过上面的描述我们可以知道，一个小插件至少要有两个对象才可以存在，第一就是一个可用于接收消息的BroadcastReceiver对象，在安卓中又针对插件做了一次封装，那我们需要使用的就是继承自AppWidgetProvider类；另外一个，很显而易见的就是要有一个基本的布局，一个layout对象。那么还没完，我们还需要一个对象来描述这个Provider，这就是第三个基本组件AppWidgetProviderInfo对象，一个xml描述文件。下面我们就对这三个对象进行详细描述。

1、AppWidgetProvider类

　　AppWidgetProvider继承自BroadcastReceiver对象，其实就是一个广播接收对象类，它自身又实现了几个用于处理插件被更新、变可用、变不可用、被删除时的方法。下面是一个示例文件：

import android.annotation.SuppressLint;
import android.appwidget.AppWidgetManager;
import android.appwidget.AppWidgetProvider;
import android.content.Context;
import android.content.Intent;
import android.os.Bundle;
import android.os.IBinder;


public class SimpleWidgetProvider extends AppWidgetProvider {

	public SimpleWidgetProvider() {
		// TODO Auto-generated constructor stub
	}

	@Override
	public void onReceive(Context context, Intent intent) {
		// TODO Auto-generated method stub
		super.onReceive(context, intent);
	}

	@Override
	public void onUpdate(Context context, AppWidgetManager appWidgetManager,
			int[] appWidgetIds) {
		// TODO Auto-generated method stub
		super.onUpdate(context, appWidgetManager, appWidgetIds);
	}

	@SuppressLint("NewApi")
	@Override
	public void onAppWidgetOptionsChanged(Context context,
			AppWidgetManager appWidgetManager, int appWidgetId,
			Bundle newOptions) {
		// TODO Auto-generated method stub
		super.onAppWidgetOptionsChanged(context, appWidgetManager, appWidgetId,
				newOptions);
	}

	@Override
	public void onDeleted(Context context, int[] appWidgetIds) {
		// TODO Auto-generated method stub
		super.onDeleted(context, appWidgetIds);
	}

	@Override
	public void onEnabled(Context context) {
		// TODO Auto-generated method stub
		super.onEnabled(context);
	}

	@Override
	public void onDisabled(Context context) {
		// TODO Auto-generated method stub
		super.onDisabled(context);
	}

	@SuppressLint("NewApi")
	@Override
	public void onRestored(Context context, int[] oldWidgetIds,
			int[] newWidgetIds) {
		// TODO Auto-generated method stub
		super.onRestored(context, oldWidgetIds, newWidgetIds);
	}

}

import android.annotation.SuppressLint;

import android.appwidget.AppWidgetManager;

import android.appwidget.AppWidgetProvider;

import android.content.Context;

import android.content.Intent;

import android.os.Bundle;

import android.os.IBinder;

public class SimpleWidgetProvider extends AppWidgetProvider {

public SimpleWidgetProvider() {

// TODO Auto-generated constructor stub

}

@Override

public void onReceive(Context context, Intent intent) {

// TODO Auto-generated method stub

super.onReceive(context, intent);

}

@Override

public void onUpdate(Context context, AppWidgetManager appWidgetManager,

int[] appWidgetIds) {

// TODO Auto-generated method stub

super.onUpdate(context, appWidgetManager, appWidgetIds);

}

@SuppressLint("NewApi")

@Override

public void onAppWidgetOptionsChanged(Context context,

AppWidgetManager appWidgetManager, int appWidgetId,

Bundle newOptions) {

// TODO Auto-generated method stub

super.onAppWidgetOptionsChanged(context, appWidgetManager, appWidgetId,

newOptions);

}

@Override

public void onDeleted(Context context, int[] appWidgetIds) {

// TODO Auto-generated method stub

super.onDeleted(context, appWidgetIds);

}

@Override

public void onEnabled(Context context) {

// TODO Auto-generated method stub

super.onEnabled(context);

}

@Override

public void onDisabled(Context context) {

// TODO Auto-generated method stub

super.onDisabled(context);

}

@SuppressLint("NewApi")

@Override

public void onRestored(Context context, int[] oldWidgetIds,

int[] newWidgetIds) {

// TODO Auto-generated method stub

super.onRestored(context, oldWidgetIds, newWidgetIds);

}

1) onReceive: 此方法实际上是覆盖了父类BroadcastReceiver中的onReceive方法，用于接收广播消息并根据不同的消息内容执行不同的操作。在AppWidgetProvider中已经对更新、删除等消息内容做了处理，并新建了onUpdate、onDeleted等方法用于给开发者响应消息。需要注意的是：开发者可以自定义广播消息，并在onReceive中接收并做相应的操作。
2) onAppWidgetOptionsChanged: 应该是当插件对应的配置页面更改时触发此方法
3) onUpdate: 此方法就是响应设定的定时更新触发时的消息了，用于更新界面内容。

创建方法：在项目中新建一个类，父类设置为AppWidgetProvider即可

2. AppWidgetProviderInfo对象

AppWidgetProviderInfo对象其实就是一个xml文件，存储在resxml目录下，用于定义组件的宽度、高度、组件内容更新频率、初始化布局等信息，系统会根据这些信息创建并调整组件的显示。下面是一个示例文件：

<?xml version="1.0" encoding="utf-8"?>
<appwidget-provider xmlns:android="http://schemas.android.com/apk/res/android"
    android:initialLayout="@layout/widget_layout"
    android:updatePeriodMillis="0"
    android:widgetCategory="home_screen"
    android:minHeight="110dp"
    android:resizeMode="horizontal|vertical"
    android:minWidth="110dp"
    android:minResizeWidth="110dp"
    android:minResizeHeight="110dp">
</appwidget-provider>

<?xml version="1.0" encoding="utf-8"?>

<appwidget-provider xmlns:android="http://schemas.android.com/apk/res/android"

android:initialLayout="@layout/widget_layout"

android:updatePeriodMillis="0"

android:widgetCategory="home_screen"

android:minHeight="110dp"

android:resizeMode="horizontal|vertical"

android:minWidth="110dp"

android:minResizeWidth="110dp"

android:minResizeHeight="110dp">

</appwidget-provider>

1) minWidth: 用于设置组件的最小宽度，系统会根据此值计算出插件横向所要占据的网格数量
2) minHeight: 用于设置组件的最小高度，系统会根据此值计算出插件纵向所要占据的网格数量
3) minResizeWidth: 插件缩放时允许的最小宽度
4) minResizeHeight: 插件缩放时允许的最小高度
5) updatePeriodMillis: 插件的更新频率，单位ms，此值小于半个小时的时候将按半小时计算，因为android不允许小插件过于频率的更新以节省资源和电池用量，对于更新频率要小于半个小时的情况，我们会在后面讲述如何处理
6) initialLayout: 用于指定插件所使用的布局文件
7) initialKeyguardLayout: 用于指定在锁屏界面上插件所使用的布局文件
8) configure: 用于指定插件设置窗口所使用的布局文件
9) previewImage: 用于指定添加插件页面中，插件所使用的预览图像
10) resizeMode: 用于指定插件允许的缩放模式，可选择横向、纵向或者不能缩放
11) widgetCategory: 用于指定插件都在哪个地方显示，可选择在桌面、锁屏界面或者搜索界面。

创建方法：在项目中新建一个xml文件，xml文件的类型为appwidget-provider，生成的文件将自动存储到resxml目录下

3、Widget布局文件

　　首先来说，它是一个布局文件，和Activity的布局文件一样，存储在reslayout目录下，所不同的是，插件布局中并不支持所有的组件。

　　可支持的部局组件如下：

FrameLayout
LinearLayout
RelativeLayout
GridLayout

　　支持的内容组件如下：

AnalogClock
Button
Chronometer
ImageButton
ImageView
ProgressBar
TextView
ViewFlipper
ListView
GridView
StackView
AdapterViewFlipper

　　注意：不可以支持以上组件的子类。

　　创建方法：新建一个layout文件

三、使自己的第一个小组件生效

　　在创建了上文所述的三个对象后，我们还需要在Android Manifest文件中对WidgetProvider对象进行一下声明，这样才可以在插件管理器中看到我们要创建的插件，所用代码如下：

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.example.simplewidget"
    android:versionCode="1"
    android:versionName="1.0" >

    <uses-sdk
        android:minSdkVersion="8"
        android:targetSdkVersion="21" />

    <application
        android:allowBackup="true"
        android:icon="@drawable/ic_launcher"
        android:label="@string/app_name"
        android:theme="@style/AppTheme" >
        <receiver android:name="SimpleWidgetProvider" android:label="@string/app_name">
    		<intent-filter>
        		<action android:name="android.appwidget.action.APPWIDGET_UPDATE" />
        		<category android:name="android.intent.category.DEFAULT" />
    		</intent-filter>
    		<meta-data android:name="android.appwidget.provider"
               android:resource="@xml/widget_provider_info" />
        </receiver>
    </application>

</manifest>

<manifest xmlns:android="http://schemas.android.com/apk/res/android"

package="com.example.simplewidget"

android:versionCode="1"

android:versionName="1.0" >

<uses-sdk

android:minSdkVersion="8"

android:targetSdkVersion="21" />

<application

android:allowBackup="true"

android:icon="@drawable/ic_launcher"

android:label="@string/app_name"

android:theme="@style/AppTheme" >

<intent-filter>

</intent-filter>

android:resource="@xml/widget_provider_info" />

</receiver>

</application>

</manifest>

　　receiver 节点中的内容即为对SimpleWidgetProvider的定义，intent-filter和meta-data节点都必须添加上才可以使插件生效。

打赏

一、插件原理介绍

二、三个必要组件

1、AppWidgetProvider类

2. AppWidgetProviderInfo对象

3、Widget布局文件

三、使自己的第一个小组件生效

Leave a Reply Cancel reply