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

時間 2019-11-17

標籤 android widget 開發實例桌面便籤程序實現詳解源碼欄目 Android 简体版

原文原文鏈接

桌面便籤軟件是Android上經常使用軟件的一種，好比比較早的Sticky Note，就曾很是流行，而實際上使用android平臺對widget開發的支持，桌面便籤類軟件是很是易於開發的。java

本文經過逐步實現一個簡單的桌面便籤軟件，和你們分享進行widget開發的過程和方法。 linux

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

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

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

具體下載目錄在 /pub/Android源碼集錦/2011年/10月/Android Widget 開發實例：桌面便籤程序的實現詳解和源碼/app

1.MyNote的最終實現效果

爲了提起你們閱讀本文的興趣，先介紹一下最終實現的效果。 ide

首先能夠經過桌面增長咱們的MyNote小部件，以下圖所示：佈局

圖中的「個人便籤」就是咱們以後將要開發的便籤程序。優化

點擊後啓動添加日誌界面，以下圖所示：this

輸入便籤內容後，能夠點擊下面所列的四種圖標之一做爲便籤圖標。

好比點擊第一個後，桌面上就會添加一個便籤：

點擊桌面上的便籤，能夠再次對便籤內容進行修改，並更換圖標。

桌面上能夠同時存在多個便籤，並能夠分別進行修改。

以下圖所示，咱們將剛纔建立的便籤的圖標修改一下，並新增了一個便籤：

每一個便籤的內容都是分別獨立保存的，能夠隨時點擊桌面圖標修改。

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:src="@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的原型，它沒有任何業務功能，

可是已是一個能夠運行的骨架了。

在下半部分中咱們爲它添加血和肉，讓它真正具有業務功能。

但願你們喜歡這種先寫骨架，再逐步豐富的開發方式 :)

在上半部分中，已經實現了一個能夠運行的widget，可是沒有任何業務功能，所以下半部分中的任務就是逐步實現業務功能，最終完成此桌面便籤程序。

5. 利用widget的配置Activtiy，實現新增便籤功能

因爲配置Activity由系統確保在新增widget時必定會調用，所以咱們正好用此界面完成新增便籤的功能。

咱們一樣採用漸進式的開發方式，分爲以下幾個階段

a. 實現layout

b. 實現按鍵點擊

c. 實現數據存儲

如下分步講解

a.實現layout

首先咱們要爲配置Activity定製一個layout，用於實現新增便籤功能。觀察第一節中的最終效果圖，在咱們的Layout上，主要由提示文本TextView 、編輯文本框EditText 、四個圖片按鈕ImageButton 三部分組成。

編寫一個layout文件起名爲 my_note_conf.xml 放在layout文件夾下，在文件中，首先用一個垂直的LinearLayout 把這三部分組織起來，經過使用weight權重設置，使EditText自動擴大到佔滿屏幕。

而後把四個圖片按鈕ImageButton 用一個水平的內嵌LinerLayout組織起來，並調整 gravity、margin 等屬性使其更加美觀。

編寫好的layout文件以下：

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout Android:orientation="vertical"
android:layout_width="fill_parent" android:layout_height="fill_parent"
xmlns:android="http://schemas.android.com/apk/res/android">
<TextView android:layout_height="wrap_content" android:text="@string/note_title"
android:layout_width="wrap_content" android:padding="10dp"></TextView>
<LinearLayout android:layout_height="fill_parent"
android:layout_width="fill_parent" android:layout_weight="1">
<EditText android:id="@+id/EditText02" android:layout_width="fill_parent"
android:layout_height="fill_parent" android:gravity="left"
android:hint="@string/edithint"></EditText>
</LinearLayout>
<LinearLayout android:layout_height="fill_parent"
android:layout_width="fill_parent" android:layout_weight="2"
android:gravity="center">
<ImageButton android:id="@+id/ImageButton01"
android:layout_width="72dp" android:layout_height="72dp"
android:src="@drawable/sketchy_paper_003" android:layout_margin="3dp"></ImageButton>
<ImageButton android:id="@+id/ImageButton02"
android:layout_width="72dp" android:layout_height="72dp"
android:src="@drawable/sketchy_paper_004" android:layout_margin="3dp"></ImageButton>
<ImageButton android:id="@+id/ImageButton03"
android:layout_width="72dp" android:layout_height="72dp"
android:src="@drawable/sketchy_paper_007" android:layout_margin="3dp"></ImageButton>
<ImageButton android:id="@+id/ImageButton04"
android:layout_width="72dp" android:layout_height="72dp"
android:src="@drawable/sketchy_paper_011" android:layout_margin="3dp"></ImageButton>
</LinearLayout>
</LinearLayout>

注意其中調用了外部圖片，下載參考第3節的b小節。

還調用了strings.xml中的字符串定義。關於字符串定義常量，你能夠用values-zh實現國際化，此處再也不敷述。

至此layout編寫完成，記得在配置Activity中增長 setContentView(R.layout.my_note_conf); 語句指定使用該layout文件。

b.實現按鍵點擊

接下來咱們實現四個ImageButton上的按鍵點擊事件，因爲按鍵事件基本相同，所以咱們只編寫一個OnClickListener，而後把它綁定到四個按鈕上去。

在OnClickListener中，首先咱們獲取被點擊的按鈕的id，由此得知用戶但願使用那一個圖片做爲widget圖標，而後獲取 RemoteViews 關聯到咱們的widget，設置widget的imageSrc爲新的圖片，設置完成後須要獲取AppWidgetManager，對指定的widget進行更新，才能使設置生效。

最後不要忘記把onCreate中返回RESULT_OK和finish的代碼移到OnClickListener中來。

b小節部分編寫完成後的代碼以下：

package com.silenceburn;
import android.app.Activity;
import android.appwidget.AppWidgetManager;
import android.content.Intent;
import android.os.Bundle;
import android.util.Log;
import android.view.View;
import android.view.View.OnClickListener;
import android.widget.ImageButton;
import android.widget.RemoteViews;
public class MyNoteConf extends Activity {
int mAppWidgetId;
ImageButton mImBtn1, mImBtn2, mImBtn3, mImBtn4;
@Override
protected void onCreate(Bundle savedInstanceState) {
// TODO Auto-generated method stub
super.onCreate(savedInstanceState);
setContentView(R.layout.my_note_conf);
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();
}
mImBtn1 = (ImageButton) findViewById(R.id.ImageButton01);
mImBtn2 = (ImageButton) findViewById(R.id.ImageButton02);
mImBtn3 = (ImageButton) findViewById(R.id.ImageButton03);
mImBtn4 = (ImageButton) findViewById(R.id.ImageButton04);
mImBtn1.setOnClickListener(mBtnClick);
mImBtn2.setOnClickListener(mBtnClick);
mImBtn3.setOnClickListener(mBtnClick);
mImBtn4.setOnClickListener(mBtnClick);
}
OnClickListener mBtnClick = new OnClickListener() {
@Override
public void onClick(View v) {
int srcId = R.drawable.sketchy_paper_008;
switch (v.getId()) {
case R.id.ImageButton01:
srcId = R.drawable.sketchy_paper_003;
break;
case R.id.ImageButton02:
srcId = R.drawable.sketchy_paper_004;
break;
case R.id.ImageButton03:
srcId = R.drawable.sketchy_paper_007;
break;
case R.id.ImageButton04:
srcId = R.drawable.sketchy_paper_011;
break;
}
Log.i("myLog", "mAppWidgetId is: " + mAppWidgetId);
RemoteViews views = new RemoteViews(MyNoteConf.this
.getPackageName(), R.layout.my_note_widget);
views.setImageViewResource(R.id.my_widget_img, srcId);
AppWidgetManager appWidgetManager = AppWidgetManager
.getInstance(MyNoteConf.this);
appWidgetManager.updateAppWidget(mAppWidgetId, views);
// return OK
Intent resultValue = new Intent();
resultValue.putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID,
mAppWidgetId);
setResult(RESULT_OK, resultValue);
finish();
}
};
}

這時咱們能夠運行一下看看效果了，添加咱們開發的MyNote的widget後，會中止在配置界面等待用戶輸入便籤內容，並選擇桌面圖標。用戶選擇後會在桌面上添加相應圖標了！

c.實現數據存儲

雖然用戶能夠指定桌面圖標了，可是用戶的便籤內容尚未存儲起來，需用把用戶的便籤內容持久化。

要把數據持久化，在android中最簡單的辦法是使用 SharedPreferences，更好的作法是使用SQLite，更更好的作法是使用ContentProvider包裝。

本實例側重於講解widget開發，所以偷個懶，使用最簡單的方法 SharedPreferences 實現。

SharedPreferences 使用很是簡單，首先用一個特定的 Prefix 獲取咱們自用的 Preferences 空間。

這個特定的 Prefix 通常使用當前類的全限定名，以避免和其餘程序衝突。

獲取到的Preferences 空間能夠想象爲一個哈希表，可使用putXXXX(key,content)系列方法向其中放入名值對。

所以咱們要作的事情就很是簡單了，首先指定一個特定前綴： final String mPerfName = "com.silenceburn.MyNoteConf";

而後獲取EditText的內容，得到一個Preferences引用，使用putString將EditText的內容放入Preferences，代碼加下：

TextView mTextView = (TextView) MyNoteConf.this
.findViewById(R.id.EditText02);
SharedPreferences.Editor prefs = MyNoteConf.this
.getSharedPreferences(mPerfName, 0).edit();
prefs.putString("DAT" + mAppWidgetId, mTextView.getText()
.toString());
prefs.commit();

注意這裏putString時使用的Key是 "DAT" + mAppWidgetId ，

因爲mAppWidgetId 是每一個widget的惟一標示，這樣就能夠有效的區分不一樣的widget的內容進行分別存儲了。

將上述代碼加入onClick 即完成了配置Activity部分的編寫。

6.增長 widget 點擊響應，實現修改便籤功能

OK，終於來到了最後一步，就要大功告成了。這一步中的分階段目標有：

a. 增長widget點擊響應

b. 實現修改便籤的Activity界面

如下分階段說明

a. 增長widget點擊響應

首先咱們新建一個Activity類，起名爲 MyNoteEdit，widget被點擊時，將調用該Activity。

因爲是對便籤內容進行修改，因此咱們這裏能夠取巧偷個懶，佈局直接複用 my_note_conf.xml。

在本階段，重點問題是能夠點擊widget調用MyNoteEdit，所以不須要進行更多處理，因此代碼很簡單：

package com.silenceburn;
import android.app.Activity;
import android.os.Bundle;
public class MyNoteEdit extends Activity {
@Override
protected void onCreate(Bundle savedInstanceState) {
// TODO Auto-generated method stub
super.onCreate(savedInstanceState);
setContentView(R.layout.my_note_conf);
}
}

以後，爲了給widget增長點擊響應，咱們要再次修改一下第5小節中配置Activity的代碼，爲widget附着上一個pendingIntent，這樣當widget被點擊時，就能夠觸發咱們指定的Intent了。

代碼片斷以下：

Intent intent = new Intent(MyNoteConf.this, MyNoteEdit.class);
intent.setAction(mPerfName + mAppWidgetId);
intent.putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID,mAppWidgetId);
PendingIntent pendingIntent = PendingIntent.getActivity(MyNoteConf.this, 0,
intent, 0);
views.setOnClickPendingIntent(R.id.my_widget_img, pendingIntent);

注意這裏咱們使用intent.setAction(mPerfName + mAppWidgetId);爲每一個widget賦予了獨一無二的Action。

不然得到的pendingIntent實際是同一個實例，僅extraData不一樣，根據建立pendingIntent方法的不一樣，extraData可能會被覆蓋或者只初始化一次再也不改變（getActivity的最後一個參數flags決定）。

這樣咱們在pendingIntent中就只能獲得第一個新增的widget的Id，或者最後一次新增的widget的Id，

這顯然不是咱們但願看到的。

最後千萬不要忘記在AndroidManifest.xml中添加咱們新增的MyNoteEdit的聲明， <activity android:name=".MyNoteEdit"/>

至此點擊響應增長完成，能夠運行一下看看效果，生成widget到桌面後，能夠點擊widget激活修改窗口。

修改窗口複用了my_note_conf.xml 做爲layout，因此和配置Activity看起來是一摸同樣的。

b. 實現修改便籤的Activity界面

到目前爲止，絕大多數功能已經實現完畢，就差最後一小步了，就是修改便籤內容。

由於在第五節的c小節中，咱們putString時使用的Key是 "DAT" + mAppWidgetId ，因此咱們在MyNoteEdit的onCreate裏面，獲取激發了此Activity的Intent，從Intent中取出放在extraData裏的widgetId，就能夠用此ID從perference中取出便籤內容，並setText到EditText控件中。

這部分代碼片斷以下：