src/Notes-master/src/net/micode/notes/widget/NoteWidgetProvider.java

@@ -14,119 +14,222 @@
  * limitations under the License.
  */
 
+// 包声明：归属小米便签桌面小部件模块，定义所有尺寸便签小部件的通用基类
 package net.micode.notes.widget;
+
+// 导入安卓延迟意图类：用于小部件点击事件的异步意图触发
 import android.app.PendingIntent;
+// 导入安卓小部件管理器类：管理小部件的生命周期（更新、删除、创建）
 import android.appwidget.AppWidgetManager;
+// 导入安卓小部件提供者基类：所有桌面小部件的系统基类
 import android.appwidget.AppWidgetProvider;
+// 导入安卓内容值类：用于封装ContentProvider的更新数据
 import android.content.ContentValues;
+// 导入安卓上下文类：提供应用运行环境（资源访问、ContentResolver获取等）
 import android.content.Context;
+// 导入安卓意图类：用于组件间通信（小部件点击跳转页面）
 import android.content.Intent;
+// 导入安卓数据库游标类：存储数据库查询结果
 import android.database.Cursor;
+// 导入安卓日志类：输出小部件相关日志（异常/调试）
 import android.util.Log;
+// 导入安卓远程视图类：用于渲染桌面小部件的UI（小部件运行在桌面进程，需远程视图）
 import android.widget.RemoteViews;
 
+// 导入小米便签资源类：引用布局、字符串、图片等资源
 import net.micode.notes.R;
+// 导入便签数据常量类：定义便签URI、字段、意图参数等核心常量
 import net.micode.notes.data.Notes;
+// 导入便签列常量子类：简化便签表字段的引用
 import net.micode.notes.data.Notes.NoteColumns;
+// 导入资源解析工具类：解析小部件背景资源
 import net.micode.notes.tool.ResourceParser;
+// 导入便签编辑页面：小部件点击跳转的目标页面
 import net.micode.notes.ui.NoteEditActivity;
+// 导入便签列表页面：隐私模式下小部件点击跳转的目标页面
 import net.micode.notes.ui.NotesListActivity;
 
+/**
+ * 便签桌面小部件抽象基类
+ * 继承自安卓系统AppWidgetProvider，封装所有尺寸便签小部件的通用核心逻辑：
+ * 1. 小部件删除时清理关联的便签数据；
+ * 2. 小部件更新时的通用UI渲染、数据查询、点击事件绑定；
+ * 3. 定义抽象方法，由子类（2x/4x）实现尺寸相关的布局、背景、类型适配。
+ */
 public abstract class NoteWidgetProvider extends AppWidgetProvider {
+    /**
+     * 数据库查询投影数组：指定查询便签的核心字段，减少查询冗余
+     * 包含：便签ID、背景色ID、便签摘要（用于小部件展示）
+     */
     public static final String [] PROJECTION = new String [] {
-        NoteColumns.ID,
-        NoteColumns.BG_COLOR_ID,
-        NoteColumns.SNIPPET
+        NoteColumns.ID,          // 便签唯一标识
+        NoteColumns.BG_COLOR_ID, // 便签背景色ID
+        NoteColumns.SNIPPET      // 便签内容摘要
     };
 
-    public static final int COLUMN_ID           = 0;
-    public static final int COLUMN_BG_COLOR_ID  = 1;
-    public static final int COLUMN_SNIPPET      = 2;
+    // 投影数组对应的列索引常量，简化Cursor取值
+    public static final int COLUMN_ID           = 0;      // 便签ID列索引
+    public static final int COLUMN_BG_COLOR_ID  = 1;      // 背景色ID列索引
+    public static final int COLUMN_SNIPPET      = 2;      // 摘要列索引
 
+    // 日志标签：用于小部件相关日志输出，便于问题定位
     private static final String TAG = "NoteWidgetProvider";
 
+    /**
+     * 重写小部件删除回调方法
+     * 当用户删除便签小部件时触发，核心逻辑：将关联便签的WIDGET_ID置为无效，清理关联关系
+     * @param context 应用上下文
+     * @param appWidgetIds 被删除的小部件ID数组
+     */
     @Override
     public void onDeleted(Context context, int[] appWidgetIds) {
+        // 构建ContentValues：将WIDGET_ID设为无效值（INVALID_APPWIDGET_ID）
         ContentValues values = new ContentValues();
         values.put(NoteColumns.WIDGET_ID, AppWidgetManager.INVALID_APPWIDGET_ID);
+        
+        // 遍历所有被删除的小部件ID，更新关联便签的WIDGET_ID
         for (int i = 0; i < appWidgetIds.length; i++) {
-            context.getContentResolver().update(Notes.CONTENT_NOTE_URI,
-                    values,
-                    NoteColumns.WIDGET_ID + "=?",
-                    new String[] { String.valueOf(appWidgetIds[i])});
+            context.getContentResolver().update(Notes.CONTENT_NOTE_URI, // 便签ContentProvider的URI
+                    values,                                            // 要更新的字段和值
+                    NoteColumns.WIDGET_ID + "=?",                      // 更新条件：WIDGET_ID匹配当前删除的ID
+                    new String[] { String.valueOf(appWidgetIds[i])});   // 条件参数（防止SQL注入）
         }
     }
 
+    /**
+     * 私有方法：根据小部件ID查询关联的便签信息
+     * 过滤条件：关联当前widgetId + 非回收站便签（PARENT_ID≠回收站ID）
+     * @param context 应用上下文，用于获取ContentResolver
+     * @param widgetId 目标小部件ID
+     * @return Cursor：包含匹配的便签信息（ID、背景色、摘要），无匹配则返回null
+     */
     private Cursor getNoteWidgetInfo(Context context, int widgetId) {
-        return context.getContentResolver().query(Notes.CONTENT_NOTE_URI,
-                PROJECTION,
-                NoteColumns.WIDGET_ID + "=? AND " + NoteColumns.PARENT_ID + "<>?",
-                new String[] { String.valueOf(widgetId), String.valueOf(Notes.ID_TRASH_FOLER) },
-                null);
+        return context.getContentResolver().query(Notes.CONTENT_NOTE_URI,  // 便签查询URI
+                PROJECTION,                                              // 查询的字段投影
+                NoteColumns.WIDGET_ID + "=? AND " + NoteColumns.PARENT_ID + "<>?", // 查询条件
+                new String[] { String.valueOf(widgetId), String.valueOf(Notes.ID_TRASH_FOLER) }, // 条件参数
+                null);                                                    // 排序规则（无）
     }
 
+    /**
+     * 对外暴露的小部件更新方法（重载）
+     * 默认以非隐私模式更新小部件，调用带privacyMode的核心更新方法
+     * @param context 应用上下文
+     * @param appWidgetManager 小部件管理器
+     * @param appWidgetIds 需要更新的小部件ID数组
+     */
     protected void update(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) {
         update(context, appWidgetManager, appWidgetIds, false);
     }
 
+    /**
+     * 核心私有更新方法：实现小部件UI渲染、数据绑定、点击事件配置的通用逻辑
+     * @param context 应用上下文
+     * @param appWidgetManager 小部件管理器，用于更新小部件UI
+     * @param appWidgetIds 需要更新的小部件ID数组
+     * @param privacyMode 是否为隐私模式（隐私模式下隐藏内容，跳转列表页）
+     */
     private void update(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds,
             boolean privacyMode) {
+        // 遍历所有需要更新的小部件ID，逐个处理
         for (int i = 0; i < appWidgetIds.length; i++) {
+            // 过滤无效的小部件ID（INVALID_APPWIDGET_ID）
             if (appWidgetIds[i] != AppWidgetManager.INVALID_APPWIDGET_ID) {
+                // 初始化默认背景ID（从资源解析工具获取全局默认背景）
                 int bgId = ResourceParser.getDefaultBgId(context);
+                // 初始化便签摘要（默认空字符串）
                 String snippet = "";
+                
+                // 构建小部件点击意图：默认跳转便签编辑页
                 Intent intent = new Intent(context, NoteEditActivity.class);
-                intent.setFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
-                intent.putExtra(Notes.INTENT_EXTRA_WIDGET_ID, appWidgetIds[i]);
-                intent.putExtra(Notes.INTENT_EXTRA_WIDGET_TYPE, getWidgetType());
+                intent.setFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP); // 防止重复创建Activity
+                intent.putExtra(Notes.INTENT_EXTRA_WIDGET_ID, appWidgetIds[i]); // 携带小部件ID参数
+                intent.putExtra(Notes.INTENT_EXTRA_WIDGET_TYPE, getWidgetType()); // 携带小部件类型（子类实现）
 
+                // 查询当前小部件关联的便签信息
                 Cursor c = getNoteWidgetInfo(context, appWidgetIds[i]);
                 if (c != null && c.moveToFirst()) {
+                    // 异常日志：同一个widgetId关联多个便签（数据异常）
                     if (c.getCount() > 1) {
                         Log.e(TAG, "Multiple message with same widget id:" + appWidgetIds[i]);
                         c.close();
                         return;
                     }
+                    // 从Cursor中获取便签摘要和背景色ID
                     snippet = c.getString(COLUMN_SNIPPET);
                     bgId = c.getInt(COLUMN_BG_COLOR_ID);
+                    // 携带便签ID参数，跳转编辑页时定位到该便签
                     intent.putExtra(Intent.EXTRA_UID, c.getLong(COLUMN_ID));
+                    // 设置意图动作：查看已有便签
                     intent.setAction(Intent.ACTION_VIEW);
                 } else {
+                    // 无关联便签时：显示默认提示文本
                     snippet = context.getResources().getString(R.string.widget_havenot_content);
+                    // 设置意图动作：新建便签
                     intent.setAction(Intent.ACTION_INSERT_OR_EDIT);
                 }
 
+                // 关闭Cursor，释放数据库资源
                 if (c != null) {
                     c.close();
                 }
 
+                // 创建远程视图：加载子类定义的布局（2x/4x）
                 RemoteViews rv = new RemoteViews(context.getPackageName(), getLayoutId());
+                // 设置小部件背景图：使用子类定义的背景资源（2x/4x）
                 rv.setImageViewResource(R.id.widget_bg_image, getBgResourceId(bgId));
+                // 携带背景ID参数，跳转编辑页时同步背景
                 intent.putExtra(Notes.INTENT_EXTRA_BACKGROUND_ID, bgId);
+                
                 /**
-                 * Generate the pending intent to start host for the widget
+                 * 生成小部件点击的PendingIntent（延迟意图）
+                 * 区分隐私模式和普通模式：
+                 * 1. 隐私模式：显示提示文本，跳转便签列表页；
+                 * 2. 普通模式：显示便签摘要，跳转便签编辑页。
                  */
                 PendingIntent pendingIntent = null;
                 if (privacyMode) {
+                    // 隐私模式：设置提示文本（“访问模式下隐藏内容”）
                     rv.setTextViewText(R.id.widget_text,
                             context.getString(R.string.widget_under_visit_mode));
+                    // 构建跳转列表页的PendingIntent
                     pendingIntent = PendingIntent.getActivity(context, appWidgetIds[i], new Intent(
                             context, NotesListActivity.class), PendingIntent.FLAG_UPDATE_CURRENT);
                 } else {
+                    // 普通模式：设置便签摘要文本
                     rv.setTextViewText(R.id.widget_text, snippet);
+                    // 构建跳转编辑页的PendingIntent（FLAG_UPDATE_CURRENT：更新已有Intent的参数）
                     pendingIntent = PendingIntent.getActivity(context, appWidgetIds[i], intent,
                             PendingIntent.FLAG_UPDATE_CURRENT);
                 }
 
+                // 绑定小部件文本区域的点击事件：触发上述PendingIntent
                 rv.setOnClickPendingIntent(R.id.widget_text, pendingIntent);
+                // 通过小部件管理器更新当前小部件的UI
                 appWidgetManager.updateAppWidget(appWidgetIds[i], rv);
             }
         }
     }
 
+    /**
+     * 抽象方法：获取小部件背景资源ID
+     * 由子类（2x/4x）实现，返回对应尺寸的背景资源ID
+     * @param bgId 背景色标识ID
+     * @return 对应尺寸的背景资源ID
+     */
     protected abstract int getBgResourceId(int bgId);
 
+    /**
+     * 抽象方法：获取小部件布局ID
+     * 由子类（2x/4x）实现，返回对应尺寸的布局资源ID
+     * @return 对应尺寸的布局资源ID
+     */
     protected abstract int getLayoutId();
 
+    /**
+     * 抽象方法：获取小部件类型标识
+     * 由子类（2x/4x）实现，返回对应尺寸的类型常量（Notes.TYPE_WIDGET_2X/4X）
+     * @return 小部件类型标识
+     */
     protected abstract int getWidgetType();
-}
+}