Android Widget 開發實例：桌面便簽程序的實現詳解和源碼

桌面便簽軟件是Android上常用軟件的一種，比如比較早的Sticky Note，就曾非常流行，而實際上使用android平台對widget開發的支持，桌面便簽類軟件是非常易於開發的。

本文通過逐步實現一個簡單的桌面便簽軟件，和大家分享進行widget開發的過程和方法。 

同時本程序提供完整的工程源碼下載

免費下載地址在 http://linux.linuxidc.com/

用戶名與密碼都是www.linuxidc.com

具體下載目錄在 /pub/Android源碼集錦/2011年/10月/Android 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被刪除時調用。

目前我們不需要在這裡實現任何功能，只是簡單的記錄日志以便我們觀察其運行，編寫好的代碼如下：

1. package com.silenceburn;  
2.   
3. import android.appwidget.AppWidgetManager;  
4. import android.appwidget.AppWidgetProvider;  
5. import android.content.Context;  
6. import android.util.Log;  
7.   
8. public class MyNote extends AppWidgetProvider {  
9.     /** Called when the activity is first created. */  
10.       
11.     final String mPerfName = "com.silenceburn.MyColorNoteConf";  
12.   
13.     @Override  
14.     public void onUpdate(Context context, AppWidgetManager appWidgetManager,  
15.             int[] appWidgetIds) {  
16.         // TODO Auto-generated method stub   
17.         final int N = appWidgetIds.length;  
18.         for (int i = 0; i < N; i++) {  
19.             int appWidgetId = appWidgetIds[i];  
20.             Log.i("myLog", "this is [" + appWidgetId + "] onUpdate!");  
21.   
22.         }  
23.     }  
24.   
25.     @Override  
26.     public void onDeleted(Context context, int[] appWidgetIds) {  
27.         // TODO Auto-generated method stub   
28.         final int N = appWidgetIds.length;  
29.         for (int i = 0; i < N; i++) {  
30.             int appWidgetId = appWidgetIds[i];  
31.             Log.i("myLog", "this is [" + appWidgetId + "] onDelete!");  
32.         }  
33.     }  
34.   
35. }  

b. widget外觀布局定義文件

我們需要為widget編寫一個外觀布局文件，在本示例中，布局非常簡單，只需要一個imageView即可

編寫好的 my_note_widget.xml 文件如下：

1. <?xml version="1.0" encoding="utf-8"?>  
2. <ImageView xmlns:android="http://schemas.android.com/apk/res/android"  
3.     android:id="@+id/my_widget_img"  
4.     android:layout_width="wrap_content"  
5.     android:layout_height="wrap_content"  
6.     android:src="@drawable/sketchy_paper_008"  
7.     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的代碼如下：

1. package com.silenceburn;  
2.   
3. import android.app.Activity;  
4. import android.appwidget.AppWidgetManager;  
5. import android.content.Intent;  
6. import android.os.Bundle;  
7. import android.util.Log;  
8.   
9. public class MyNoteConf extends Activity {  
10.       
11.     int mAppWidgetId;  
12.       
13.     @Override  
14.     protected void onCreate(Bundle savedInstanceState) {  
15.         // TODO Auto-generated method stub   
16.         super.onCreate(savedInstanceState);  
17.           
18.         Log.i("myLog"," on WidgetConf ... ");  
19.           
20.         setResult(RESULT_CANCELED);  
21.           
22.         // Find the widget id from the intent.   
23.         Intent intent = getIntent();  
24.         Bundle extras = intent.getExtras();  
25.         if (extras != null) {  
26.             mAppWidgetId = extras.getInt(AppWidgetManager.EXTRA_APPWIDGET_ID,  
27.                     AppWidgetManager.INVALID_APPWIDGET_ID);  
28.         }  
29.   
30.         // If they gave us an intent without the widget id, just bail.   
31.         if (mAppWidgetId == AppWidgetManager.INVALID_APPWIDGET_ID) {  
32.             finish();  
33.         }  
34.           
35.         // return OK   
36.         Intent resultValue = new Intent();  
37.         resultValue.putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID,  
38.                 mAppWidgetId);  
39.           
40.         setResult(RESULT_OK, resultValue);  
41.         finish();  
42.     }  
43. }  

d. widget 參數配置文件

最後我們需要編寫一個widget參數配置文件，將布局文件、配置Activity關聯起來。

我們在res下新建目錄xml，在xml目錄下新增文件 my_note_widget.xml ，編寫如下：

1. <appwidget-provider xmlns:android="http://schemas.android.com/apk/res/android"  
2.     android:minWidth="72dp" android:minHeight="72dp"  
3.     android:updatePeriodMillis="86400000" android:initialLayout="@layout/my_note_widget"  
4.     android:configure="com.silenceburn.MyNoteConf">  
5. </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 如下：

1. <?xml version="1.0" encoding="utf-8"?>  
2. <manifest xmlns:android="http://schemas.android.com/apk/res/android"  
3.     package="com.silenceburn" android:versionCode="1" android:versionName="1.0">  
4.     <application android:icon="@drawable/sketchy_paper_008"  
5.         android:label="@string/app_name">  
6.         <receiver android:name=".MyNote">  
7.             <intent-filter>  
8.                 <action android:name="android.appwidget.action.APPWIDGET_UPDATE" />  
9.             </intent-filter>  
10.             <meta-data android:name="android.appwidget.provider"  
11.                 android:resource="@xml/my_note_widget" />  
12.         </receiver>  
13.   
14.         <activity android:name=".MyNoteConf">  
15.             <intent-filter>  
16.                 <action android:name="android.appwidget.action.APPWIDGET_CONFIGURE" />  
17.             </intent-filter>  
18.         </activity>  
19.     </application>  
20. </manifest>   

至此原型程序全部開發完成，運行一下看看效果吧！

在桌面上長點，可以選擇我們剛剛寫的原型widget“MyNote”了，

選擇後出現我們定義的配置界面MyNoteConf，

但是由於我們在onCreate中finish了，所以是一閃而過的。

之後MyNote就出現在桌面上了。 

我們可以隨便拖動它，或者把它丟進垃圾箱，觀察一下日志輸出。

---

上半部分總結

上半部分主要完成了一個widget的原型，它沒有任何業務功能，

但是已經是一個可以運行的骨架了。 

在下半部分中我們為它添加血和肉，讓它真正具備業務功能。 

希望大家喜歡這種先寫骨架，再逐步豐富的開發方式 :)