android widget 开发实例 : 桌面便签程序的实现详解和源码 （上）

原文地址为：android widget 开发实例 : 桌面便签程序的实现详解和源码 （上）

如有错漏请不吝拍砖指正，转载请注明出处，非常感谢

桌面便签软件是android上常用软件的一种，比如比较早的Sticky Note，就曾非常流行，

Sticky Note的介绍可以参见 http://www.tompda.com/c/article/11778/ 

而实际上使用android平台对widget开发的支持，桌面便签类软件是非常易于开发的。

本文通过逐步实现一个简单的桌面便签软件，和大家分享进行widget开发的过程和方法。

1.MyNote的最终实现效果

为了提起大家阅读本文的兴趣，先介绍一下最终实现的效果。

首先可以通过桌面增加我们的MyNote小部件，如下图所示：

图中的“我的便签”就是我们之后将要开发的便签程序。

点击后启动添加日志界面，如下图所示：

输入便签内容后，可以点击下面所列的四种图标之一作为便签图标。

比如点击第一个后，桌面上就会添加一个便签：

点击桌面上的便签，可以再次对便签内容进行修改，并更换图标。

桌面上可以同时存在多个便签，并可以分别进行修改。

如下图所示，我们将刚才创建的便签的图标修改一下，并新增了一个便签：

每个便签的内容都是分别独立保存的，可以随时点击桌面图标修改。

2.开发方式

开发的目的和追求的效果已经十分清楚了，首先我们确定一下开发方式。

在本文中，将采取一种渐进式的开发，也就是说不会一口气从头做到尾。

而是分为好几个阶段。每个阶段都完成一定的目标，然后下个阶段增加更多的功能，

每个阶段都离最终目标更进一步，OK，你可以说这是一次敏捷开发 :)

第一个阶段，首先我们会搭建一个widget原型程序，

它是完全可以运行的，可以创建桌面widget。

第二个阶段，我们改进 widget 配置Activity 部分的实现

使其具备创建便签的功能

第三个阶段，我们改进 widget 点击响应部分的实现，

使其具备修改便签的功能

3.搭建widget原型程序

本节我们会做一个最简单的widget程序原型，但是它是可以运行的。

一般来说 widget 程序由以下部分组成：

a. AppWidgetProvider 的实现 

b. widget外观布局定义文件

c. 新增widget时的配置Activity的实现（可选）

d. widget 参数配置文件 

以下分别讲解

a. AppWidgetProvider 的实现 

首先我们新建一个android工程起名为MyNote，然后修改 MyNote.java 的代码，

使MyNote继承自 AppWidgetProvider ，并重写 onUpdate 和 onDeleted 方法。

其中onUpdate 会在widget创建及被更新时调用， onDeleted 会在widget被删除时调用。

目前我们不需要在这里实现任何功能，只是简单的记录日志以便我们观察其运行，编写好的代码如下：

package com.silenceburn; import android.appwidget.AppWidgetManager; import android.appwidget.AppWidgetProvider; import android.content.Context; import android.util.Log; public class MyNote extends AppWidgetProvider { /** Called when the activity is first created. */ final String mPerfName = "com.silenceburn.MyColorNoteConf"; @Override public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) { // TODO Auto-generated method stub final int N = appWidgetIds.length; for (int i = 0; i < N; i++) { int appWidgetId = appWidgetIds[i]; Log.i("myLog", "this is [" + appWidgetId + "] onUpdate!"); } } @Override public void onDeleted(Context context, int[] appWidgetIds) { // TODO Auto-generated method stub final int N = appWidgetIds.length; for (int i = 0; i < N; i++) { int appWidgetId = appWidgetIds[i]; Log.i("myLog", "this is [" + appWidgetId + "] onDelete!"); } } }

b. widget外观布局定义文件

我们需要为widget编写一个外观布局文件，在本示例中，布局非常简单，只需要一个imageView即可

编写好的 my_note_widget.xml 文件如下：

<?xml version="1.0" encoding="utf-8"?> <ImageView xmlns:android="http://schemas.android.com/apk/res/android" android:id="@+id/my_widget_img"    android:layout_width="wrap_content"    android:layout_height="wrap_content"    android:class="lazyload" src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsQAAA7EAZUrDhsAAAANSURBVBhXYzh8+PB/AAffA0nNPuCLAAAAAElFTkSuQmCC" data-original="@drawable/sketchy_paper_008"    android:clickable="true"/> 

这里用到了一个外部图片 sketchy_paper_008.png，来源于网络，感谢图片原作者。

可以到 http://dryicons.com/free-icons/preview/sketchy-paper-icons/ 打包下载。

(  注意下载下来的包中的文件名可能和我写的程序中的命名有差异，请注意自行调整。)

c. 新增widget时的配置Activity的实现（可选）

android平台为widget提供一个配置界面的功能，我们可以自定义一个Activity，

在widget参数配置文件中配置好相关参数后，此Activity会在用户新增widget时自动调用。

一般来说，这个配置界面的作用是用户新建widget时，让用户配置widget的一些属性，比如颜色、大小等等。

但是在我们的这个示例程序中，我们用它来当做创建便签的地方！

不过本节只是先实现一个原型程序，所以暂时不做处理，我们只是新建一个Activity即可。

新建名为MyNoteConf的Activity，重写onCreate方法，在OnCreate方法中，

由于这个Activity是由系统在新增widget时自动调用的，

所以我们可以用getIntent获取到传入的widgetId。可以判断其是否是一个有效的widgetId，

最后我们必须返回一个RESULT_OK的Intent，并结束当前Activity，系统才会认为配置成功，在桌面上放置这个widget。

如果返回RESULT_CANCELED，系统会认为配置失败，终止widget的创建过程。

编写好的MyNoteConf的代码如下：

package com.silenceburn; import android.app.Activity; import android.appwidget.AppWidgetManager; import android.content.Intent; import android.os.Bundle; import android.util.Log; public class MyNoteConf extends Activity { int mAppWidgetId; @Override protected void onCreate(Bundle savedInstanceState) { // TODO Auto-generated method stub super.onCreate(savedInstanceState); Log.i("myLog"," on WidgetConf ... "); setResult(RESULT_CANCELED); // Find the widget id from the intent. Intent intent = getIntent(); Bundle extras = intent.getExtras(); if (extras != null) { mAppWidgetId = extras.getInt(AppWidgetManager.EXTRA_APPWIDGET_ID, AppWidgetManager.INVALID_APPWIDGET_ID); } // If they gave us an intent without the widget id, just bail. if (mAppWidgetId == AppWidgetManager.INVALID_APPWIDGET_ID) { finish(); } // return OK Intent resultValue = new Intent(); resultValue.putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, mAppWidgetId); setResult(RESULT_OK, resultValue); finish(); } }

d. widget 参数配置文件

最后我们需要编写一个widget参数配置文件，将布局文件、配置Activity关联起来。

我们在res下新建目录xml，在xml目录下新增文件 my_note_widget.xml ，编写如下：

<appwidget-provider xmlns:android="http://schemas.android.com/apk/res/android" android:minWidth="72dp" android:minHeight="72dp" android:updatePeriodMillis="86400000" android:initialLayout="@layout/my_note_widget" android:configure="com.silenceburn.MyNoteConf"> </appwidget-provider>

其中 minWidth minHeight 用来指定widget的大小，如果我们只占用一个格子，也就是俗称的1X1，

那么72dp的长宽是android平台推荐的一个最佳实践值。

然后用 initialLayout 参数关联了我们编写好的 layout 文件，

用 configure 参数关联了我们编写好的配置用Activity：MyNoteConf，

此外还有一个参数 updatePeriodMills 指定widget的刷新周期，

从省电角度考虑，一般都把此值设置的比较大，如果一定要对widget做周期性的事情，可以使用AlarmManager。

至此所有widget的要素都已经准备好，我们运行一下来看看吧。

4.运行widget原型程序

为了运行widget，我们还需要修改一下 AndroidManifest.xml 来声明我们的widget。

声明一个receiver，过滤 android.appwidget.action.APPWIDGET_UPDATE ，

并且用metadata关联到我们自己编写的 appWidgetProvider 实现。

声明一个activity关联到我们的配置类 MyNoteConf，过滤 android.appwidget.action.APPWIDGET_CONFIGURE。

最后修改一下应用图标，此图标会出现在系统的新增widget列表中。

编写好的AndroidManifest.xml 如下：

<?xml version="1.0" encoding="utf-8"?> <manifest xmlns:android="http://schemas.android.com/apk/res/android" package="com.silenceburn" android:versionCode="1" android:versionName="1.0"> <application android:icon="@drawable/sketchy_paper_008" android:label="@string/app_name"> <receiver android:name=".MyNote"> <intent-filter> <action android:name="android.appwidget.action.APPWIDGET_UPDATE" /> </intent-filter> <meta-data android:name="android.appwidget.provider" android:resource="@xml/my_note_widget" /> </receiver> <activity android:name=".MyNoteConf"> <intent-filter> <action android:name="android.appwidget.action.APPWIDGET_CONFIGURE" /> </intent-filter> </activity> </application> </manifest>

至此原型程序全部开发完成，运行一下看看效果吧！

在桌面上长点，可以选择我们刚刚写的原型widget“MyNote”了，

选择后出现我们定义的配置界面MyNoteConf，

但是由于我们在onCreate中finish了，所以是一闪而过的。

之后MyNote就出现在桌面上了。

我们可以随便拖动它，或者把它丢进垃圾箱，观察一下日志输出。

上半部分总结

上半部分主要完成了一个widget的原型，它没有任何业务功能，

但是已经是一个可以运行的骨架了。

在下半部分中我们为它添加血和肉，让它真正具备业务功能。

希望大家喜欢这种先写骨架，再逐步丰富的开发方式 :)

下半部分已出炉 android widget 开发实例 : 桌面便签程序的实现详解和源码 （下）

地址是：http://blog.csdn.net/silenceburn/archive/2010/12/23/6094705.aspx

转载请注明本文地址：android widget 开发实例 : 桌面便签程序的实现详解和源码 （上）