devbox
繁依Fanyi0
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

Android 之App Widget_android appwidgetprovider

作者：繁依Fanyi0 | 2024-03-25 23:23:11

赞

踩

android appwidgetprovider

1 App Widget简介

应用微件是可以嵌入其他应用（如主屏幕）并接收定期更新的微型应用视图。这些视图称为界面中的微件，您可以使用应用微件提供程序发布微件。能够容纳其他应用微件的应用组件称为应用微件托管应用。下面的屏幕截图显示了闹钟微件。

 2 App Widg

要创建应用微件，您需要：

AppWidgetProviderInfo 对象

描述应用微件的元数据，如应用微件的布局、更新频率和 AppWidgetProvider 类。此对象应在 XML 中定义。

AppWidgetProvider 类实现

定义允许您基于广播事件以编程方式与应用微件连接的基本方法。通过它，您会在更新、启用、停用和删除应用微件时收到广播。

3 桌面小部件的开发步骤

1.在应用的 AndroidManifest.xml 文件中声明AppWidgetProvider类。

例如：

  1.   <receiver android:name=".ExampleAppWidgetProvider" >
  2.          <intent-filter>
  3.    <action android:name="android.appwidget.action.APPWIDGET_UPDATE" />
  4.    <action android:name="com.skywang.widget.UPDATE_ALL"/>
  5. </intent-filter>
  6. <meta-data android:name="android.appwidget.provider"
  7.    android:resource="@xml/example_appwidget_info" />
  8.      </receiver>

<receiver>元素需要android:name属性，该属性指定应用微件使用的AppWidgetProvider 。
<intent-filter>元素必须包含一个具有 android:name属性的<action>元素。此属性指定AppWidgetProvider接受 ACTION_APPWIDGET_UPDATE广播。这是您必须明确声明的唯一一项广播。AppWidgetManager 会根据需要自动将其他所有应用微件广播发送到AppWidgetProvider。
<meta-data>元素指定AppWidgetProviderInfo资源，并且需要以下属性:
android: name-指定元数据名称。使用android.appwidget.provider将数据标识为AppWidgetProviderInfo 描述符。
android :resource-指定AppWidgetProviderInfo资源位置。

2. 编辑AppWidgetProviderInfo对应的资源文件

  1.   <appwidget-provider xmlns:android="http://schemas.android.com/apk/res/android"
  2.         android:minWidth="40dp"
  3.         android:minHeight="40dp"
  4.         android:updatePeriodMillis="86400000"
  5.         android:previewImage="@drawable/preview"
  6.         android:initialLayout="@layout/example_appwidget"
  7.         android:configure="com.example.android.ExampleAppWidgetConfigure"
  8.         android:resizeMode="horizontal|vertical"
  9.         android:widgetCategory="home_screen">
  10.     </appwidget-provider>
    
    <!--
    android:minWidth : 最小宽度
    android:minHeight ： 最小高度
    android:updatePeriodMillis ： 更新widget的时间间隔(ms)，"86400000"为1个小时
    android:previewImage ： 预览图片
    android:initialLayout ： 加载到桌面时对应的布局文件
    android:resizeMode ： widget可以被拉伸的方向。horizontal表示可以水平拉伸，vertical表示可以竖直拉伸
    android:widgetCategory ： widget可以被显示的位置。home_screen表示可以将widget添加到桌面，keyguard表示widget可以被添加到锁屏界面。
    android:configure : 定义要在用户添加应用微件时启动以便用户配置应用微件属性的 Activity
     -->

3. 编辑example_appwidget.xml等资源文件

新建layout/example_appwidget.xml，代码如下：

  1. <?xml version="1.0" encoding="utf-8"?>
  2. <LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
  3.     android:layout_width="match_parent"
  4.     android:layout_height="match_parent"
  5.     android:orientation="vertical" >
  6.   
  7.     <LinearLayout 
  8.         android:layout_width="wrap_content"  
  9.         android:layout_height="wrap_content"
  10.         android:layout_gravity="center" 
  11.         android:orientation="horizontal" >
  12.         
  13.         <TextView  
  14.             android:layout_width="wrap_content"  
  15.             android:layout_height="wrap_content"  
  16.             android:text="HomeScreen Widget" />    
  17.         
  18.         <Button
  19.             android:id="@+id/btn_show"
  20.             android:layout_width="wrap_content"  
  21.             android:layout_height="wrap_content"  
  22.             android:text="Show" />
  23.     </LinearLayout> 
  24.         
  25.     <ImageView
  26.         android:id="@+id/iv_show"
  27.         android:layout_width="wrap_content"  
  28.         android:layout_height="wrap_content" 
  29.         android:layout_gravity="center"/> 
  30.         
  31. </LinearLayout>
  32. 4. 编辑ExampleAppWidgetProvider.java
  33.  
  34.  
  35. public class ExampleAppWidgetProvider extends AppWidgetProvider {
  36.    private static final String TAG = "ExampleAppWidgetProvider";
  37.  
  38.    private boolean DEBUG = false; 
  39.     // 启动ExampleAppWidgetService服务对应的action
  40.     private final Intent EXAMPLE_SERVICE_INTENT = 
  41.           new Intent("android.appwidget.action.EXAMPLE_APP_WIDGET_SERVICE");
  42.     // 更新 widget 的广播对应的action
  43.    private final String ACTION_UPDATE_ALL = "com.skywang.widget.UPDATE_ALL";
  44.     // 保存 widget 的id的HashSet，每新建一个 widget 都会为该 widget 分配一个 id。
  45.    private static Set idsSet = new HashSet();
  46.    // 按钮信息
  47.     private static final int BUTTON_SHOW = 1;
  48.    // 图片数组
  49.     private static final int[] ARR_IMAGES = {
  50.          R.drawable.ic_launcher,
  51.          R.drawable.sample_0,
  52.          R.drawable.sample_1,
  53.          R.drawable.sample_2,
  54.           
  55.     };
  56.     
  57.    // onUpdate() 在更新 widget 时，被执行，
  58.    @Override
  59.    public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) {
  60.       Log.d(TAG, "onUpdate(): appWidgetIds.length="+appWidgetIds.length);
  61.  
  62.       // 每次 widget 被创建时，对应的将widget的id添加到set中
  63.       for (int appWidgetId : appWidgetIds) {
  64.          idsSet.add(Integer.valueOf(appWidgetId));
  65.       }
  66.       prtSet();
  67.    }
  68.    
  69.     // 当 widget 被初次添加 或者 当 widget 的大小被改变时，被调用 
  70.     @Override  
  71.     public void onAppWidgetOptionsChanged(Context context,  
  72.             AppWidgetManager appWidgetManager, int appWidgetId,  
  73.             Bundle newOptions) {
  74.        Log.d(TAG, "onAppWidgetOptionsChanged");
  75.         super.onAppWidgetOptionsChanged(context, appWidgetManager, appWidgetId,  
  76.                 newOptions);  
  77.     }  
  78.     
  79.     // widget被删除时调用  
  80.     @Override  
  81.     public void onDeleted(Context context, int[] appWidgetIds) {  
  82.       Log.d(TAG, "onDeleted(): appWidgetIds.length="+appWidgetIds.length);
  83.  
  84.       // 当 widget 被删除时，对应的删除set中保存的widget的id
  85.       for (int appWidgetId : appWidgetIds) {
  86.          idsSet.remove(Integer.valueOf(appWidgetId));
  87.       }
  88.       prtSet();
  89.       
  90.         super.onDeleted(context, appWidgetIds);  
  91.     }
  92.  
  93.     // 第一个widget被创建时调用  
  94.     @Override  
  95.     public void onEnabled(Context context) {  
  96.        Log.d(TAG, "onEnabled");
  97.        // 在第一个 widget 被创建时，开启服务
  98.        context.startService(EXAMPLE_SERVICE_INTENT);
  99.        
  100.         super.onEnabled(context);  
  101.     }  
  102.     
  103.     // 最后一个widget被删除时调用  
  104.     @Override  
  105.     public void onDisabled(Context context) {  
  106.        Log.d(TAG, "onDisabled");
  107.  
  108.        // 在最后一个 widget 被删除时，终止服务
  109.        context.stopService(EXAMPLE_SERVICE_INTENT);
  110.  
  111.         super.onDisabled(context);  
  112.     }
  113.     
  114.     
  115.     // 接收广播的回调函数
  116.     @Override  
  117.     public void onReceive(Context context, Intent intent) {  
  118.  
  119.         final String action = intent.getAction();
  120.         Log.d(TAG, "OnReceive:Action: " + action);
  121.         if (ACTION_UPDATE_ALL.equals(action)) {
  122.            // “更新”广播
  123.            updateAllAppWidgets(context, AppWidgetManager.getInstance(context), idsSet);
  124.        } else if (intent.hasCategory(Intent.CATEGORY_ALTERNATIVE)) {
  125.           // “按钮点击”广播
  126.            Uri data = intent.getData();
  127.            int buttonId = Integer.parseInt(data.getSchemeSpecificPart());
  128.            if (buttonId == BUTTON_SHOW) {
  129.               Log.d(TAG, "Button wifi clicked");
  130.               Toast.makeText(context, "Button Clicked", Toast.LENGTH_SHORT).show();
  131.            }
  132.        }
  133.         
  134.         super.onReceive(context, intent);  
  135.     }  
  136.  
  137.     // 更新所有的 widget 
  138.     private void updateAllAppWidgets(Context context, AppWidgetManager appWidgetManager, Set set) {
  139.  
  140.       Log.d(TAG, "updateAllAppWidgets(): size="+set.size());
  141.       
  142.       // widget 的id
  143.        int appID;
  144.        // 迭代器，用于遍历所有保存的widget的id
  145.        Iterator it = set.iterator();
  146.  
  147.        while (it.hasNext()) {
  148.           appID = ((Integer)it.next()).intValue();    
  149.           // 随机获取一张图片
  150.           int index = (new java.util.Random().nextInt(ARR_IMAGES.length));
  151.           
  152.           if (DEBUG) Log.d(TAG, "onUpdate(): index="+index);        
  153.           // 获取 example_appwidget.xml 对应的RemoteViews        
  154.           RemoteViews remoteView = new RemoteViews(context.getPackageName(), R.layout.example_appwidget);
  155.           
  156.           // 设置显示图片
  157.           remoteView.setImageViewResource(R.id.iv_show, ARR_IMAGES[index]);
  158.           
  159.           // 设置点击按钮对应的PendingIntent：即点击按钮时，发送广播。
  160.           remoteView.setOnClickPendingIntent(R.id.btn_show, getPendingIntent(context,
  161.                     BUTTON_SHOW));
  162.  
  163.           // 更新 widget
  164.           appWidgetManager.updateAppWidget(appID, remoteView);      
  165.        }      
  166.    }
  167.  
  168.     private PendingIntent getPendingIntent(Context context, int buttonId) {
  169.         Intent intent = new Intent();
  170.         intent.setClass(context, ExampleAppWidgetProvider.class);
  171.         intent.addCategory(Intent.CATEGORY_ALTERNATIVE);
  172.         intent.setData(Uri.parse("custom:" + buttonId));
  173.         PendingIntent pi = PendingIntent.getBroadcast(context, 0, intent, 0 );
  174.         return pi;
  175.     }
  176.  
  177.     // 调试用：遍历set
  178.     private void prtSet() {
  179.        if (DEBUG) {
  180.           int index = 0;
  181.           int size = idsSet.size();
  182.           Iterator it = idsSet.iterator();
  183.           Log.d(TAG, "total:"+size);
  184.           while (it.hasNext()) {
  185.              Log.d(TAG, index + " -- " + ((Integer)it.next()).intValue());
  186.           }
  187.        }
  188.     }
  189. }
AppWidgetProvider重要的几个重写方法，比如onDeleted、onEnabled、onDisabled、onReceive、onUpdate方法的作用已经在代码里面做了注释

5. 编辑ExampleAppWidgetService.java

  1. public class ExampleAppWidgetService extends Service {
  2.    
  3.    private static final String TAG="ExampleAppWidgetService"; 
  4.  
  5.    // 更新 widget 的广播对应的action
  6.    private final String ACTION_UPDATE_ALL = "com.skywang.widget.UPDATE_ALL";
  7.    // 周期性更新 widget 的周期
  8.    private static final int UPDATE_TIME = 5000;
  9.    // 周期性更新 widget 的线程
  10.    private UpdateThread mUpdateThread;
  11.    private Context mContext;
  12.    // 更新周期的计数
  13.    private int count=0;   
  14.  
  15.    @Override
  16.    public void onCreate() {
  17.       
  18.       // 创建并开启线程UpdateThread
  19.       mUpdateThread = new UpdateThread();
  20.       mUpdateThread.start();
  21.       
  22.       mContext = this.getApplicationContext();
  23.  
  24.       super.onCreate();
  25.    }
  26.    
  27.    @Override
  28.    public void onDestroy(){
  29.       // 中断线程，即结束线程。
  30.         if (mUpdateThread != null) {
  31.            mUpdateThread.interrupt();
  32.         }
  33.         
  34.       super.onDestroy();
  35.    }
  36.    
  37.    @Override
  38.    public IBinder onBind(Intent intent) {
  39.       return null;
  40.    }
  41.  
  42.    /*
  43.     * 服务开始时，即调用startService()时，onStartCommand()被执行。
  44.     * onStartCommand() 这里的主要作用：
  45.     * (01) 将 appWidgetIds 添加到队列sAppWidgetIds中
  46.     * (02) 启动线程
  47.     */
  48.    @Override
  49.    public int onStartCommand(Intent intent, int flags, int startId) {
  50.       Log.d(TAG, "onStartCommand");     
  51.       super.onStartCommand(intent, flags, startId);
  52.       
  53.        return START_STICKY;
  54.    }
  55.    
  56.     private class UpdateThread extends Thread {
  57.  
  58.         @Override
  59.         public void run() {
  60.             super.run();
  61.  
  62.             try {
  63.                count = 0;
  64.                while (true) {
  65.                   Log.d(TAG, "run ... count:"+count);
  66.                   count++;
  67.  
  68.                  Intent updateIntent=new Intent(ACTION_UPDATE_ALL);
  69.                  mContext.sendBroadcast(updateIntent);
  70.                  
  71.                    Thread.sleep(UPDATE_TIME);
  72.                } 
  73.             } catch (InterruptedException e) {
  74.                // 将 InterruptedException 定义在while循环之外，意味着抛出 InterruptedException 异常时，终止线程。
  75.                 e.printStackTrace();
  76.             }
  77.         }
  78.     }
  79. }

(01) onCreate() 在创建服务时被执行。它的作用是创建并启动线程UpdateThread()。
(02) onDestroy() 在销毁服务时被执行。它的作用是注销线程UpdateThread()。
(03) 服务UpdateThread 每隔5秒，发送1个广播ACTION_UPDATE_ALL。广播ACTION_UPDATE_ALL在ExampleAppWidgetProvider被处理：用来更新widget中的图片。

6.编译代码生成apk文件，将其安装到手机

7.长按手机的桌面(不同品牌手机可能操作方式不一样)会弹出桌面设置界面，选择添加工具

widget在添加到桌面前的效果图：

widget在添加到桌面后的效果图：

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/繁依Fanyi0/article/detail/313073
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号