代码精读

app/src/main/java/net/micode/notes/widget/NoteWidgetProvider.java

@@ -32,23 +32,38 @@ import net.micode.notes.tool.ResourceParser;
 import net.micode.notes.ui.NoteEditActivity;
 import net.micode.notes.ui.NotesListActivity;
 
+/**
+ * 笔记小部件的基类，负责处理小部件的生命周期和数据展示
+ * 提供了小部件与笔记数据的交互逻辑
+ */
 public abstract class NoteWidgetProvider extends AppWidgetProvider {
+
+    // 数据库查询投影，指定需要查询的列
     public static final String[] PROJECTION = new String[]{
-        NoteColumns.ID,
+            NoteColumns.ID,          // 笔记ID
-        NoteColumns.BG_COLOR_ID,
+            NoteColumns.BG_COLOR_ID, // 笔记背景颜色ID
-        NoteColumns.SNIPPET
+            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;
 
     private static final String TAG = "NoteWidgetProvider";
 
+    /**
+     * 当小部件被删除时调用
+     * 功能：将数据库中对应的笔记Widget ID标记为无效
+     * @param context 应用上下文
+     * @param appWidgetIds 被删除的小部件ID数组
+     */
     @Override
     public void onDeleted(Context context, int[] appWidgetIds) {
         ContentValues values = new ContentValues();
+        // 将Widget ID设置为无效值
         values.put(NoteColumns.WIDGET_ID, AppWidgetManager.INVALID_APPWIDGET_ID);
+        // 批量更新数据库中对应的笔记记录
         for (int i = 0; i < appWidgetIds.length; i++) {
             context.getContentResolver().update(Notes.CONTENT_NOTE_URI,
                     values,
@@ -57,76 +72,124 @@ public abstract class NoteWidgetProvider extends AppWidgetProvider {
         }
     }
 
+    /**
+     * 获取与指定Widget ID关联的笔记信息
+     * @param context 应用上下文
+     * @param widgetId 小部件ID
+     * @return 包含笔记信息的Cursor，若无结果则返回null
+     */
     private Cursor getNoteWidgetInfo(Context context, int widgetId) {
         return context.getContentResolver().query(Notes.CONTENT_NOTE_URI,
                 PROJECTION,
+                // 查询条件：Widget ID匹配且不是垃圾桶中的笔记
                 NoteColumns.WIDGET_ID + "=? AND " + NoteColumns.PARENT_ID + "<>?",
                 new String[]{String.valueOf(widgetId), String.valueOf(Notes.ID_TRASH_FOLER)},
                 null);
     }
 
+    /**
+     * 更新小部件（隐私模式为false）
+     * @param context 应用上下文
+     * @param appWidgetManager 小部件管理器
+     * @param appWidgetIds 要更新的小部件ID数组
+     */
     protected void update(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) {
         update(context, appWidgetManager, appWidgetIds, false);
     }
 
+    /**
+     * 核心更新方法，支持隐私模式
+     * @param context 应用上下文
+     * @param appWidgetManager 小部件管理器
+     * @param appWidgetIds 要更新的小部件ID数组
+     * @param privacyMode 是否为隐私模式（true时显示保护信息）
+     */
     private void update(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds,
                         boolean privacyMode) {
         for (int i = 0; i < appWidgetIds.length; i++) {
             if (appWidgetIds[i] != AppWidgetManager.INVALID_APPWIDGET_ID) {
-                int bgId = ResourceParser.getDefaultBgId(context);
+                int bgId = ResourceParser.getDefaultBgId(context); // 默认背景ID
-                String snippet = "";
+                String snippet = ""; // 笔记摘要
+
+                // 构建点击小部件时启动的Intent
                 Intent intent = new Intent(context, NoteEditActivity.class);
-                intent.setFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
+                intent.setFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP); // 确保Activity在顶部
-                intent.putExtra(Notes.INTENT_EXTRA_WIDGET_ID, appWidgetIds[i]);
+                intent.putExtra(Notes.INTENT_EXTRA_WIDGET_ID, appWidgetIds[i]); // 传递Widget ID
-                intent.putExtra(Notes.INTENT_EXTRA_WIDGET_TYPE, getWidgetType());
+                intent.putExtra(Notes.INTENT_EXTRA_WIDGET_TYPE, getWidgetType()); // 传递Widget类型
 
+                // 查询与Widget关联的笔记信息
                 Cursor c = getNoteWidgetInfo(context, appWidgetIds[i]);
                 if (c != null && c.moveToFirst()) {
+                    // 检查是否有多个笔记关联到同一个Widget（异常情况）
                     if (c.getCount() > 1) {
                         Log.e(TAG, "Multiple message with same widget id:" + appWidgetIds[i]);
                         c.close();
                         return;
                     }
+                    // 提取笔记摘要和背景ID
                     snippet = c.getString(COLUMN_SNIPPET);
                     bgId = c.getInt(COLUMN_BG_COLOR_ID);
+                    // 设置Intent动作为查看已有笔记
                     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动作为插入新笔记
                     intent.setAction(Intent.ACTION_INSERT_OR_EDIT);
                 }
 
                 if (c != null) {
-                    c.close();
+                    c.close(); // 关闭Cursor释放资源
                 }
 
+                // 创建RemoteViews对象用于更新Widget界面
                 RemoteViews rv = new RemoteViews(context.getPackageName(), getLayoutId());
+                // 设置Widget背景图片
                 rv.setImageViewResource(R.id.widget_bg_image, getBgResourceId(bgId));
+                // 向Intent中添加背景ID参数
                 intent.putExtra(Notes.INTENT_EXTRA_BACKGROUND_ID, bgId);
-                /**
+
-                 * Generate the pending intent to start host for the widget
-                 */
                 PendingIntent pendingIntent = null;
                 if (privacyMode) {
+                    // 隐私模式下显示保护提示
                     rv.setTextViewText(R.id.widget_text,
                             context.getString(R.string.widget_under_visit_mode));
+                    // 隐私模式下点击跳转到笔记列表
                     pendingIntent = PendingIntent.getActivity(context, appWidgetIds[i], new Intent(
                             context, NotesListActivity.class), PendingIntent.FLAG_UPDATE_CURRENT);
                 } else {
+                    // 正常模式下显示笔记摘要
                     rv.setTextViewText(R.id.widget_text, snippet);
+                    // 正常模式下点击跳转到笔记编辑页
                     pendingIntent = PendingIntent.getActivity(context, appWidgetIds[i], intent,
                             PendingIntent.FLAG_UPDATE_CURRENT);
                 }
 
+                // 设置Widget点击事件
                 rv.setOnClickPendingIntent(R.id.widget_text, pendingIntent);
+                // 更新Widget界面
                 appWidgetManager.updateAppWidget(appWidgetIds[i], rv);
             }
         }
     }
 
+    /**
+     * 获取背景资源ID的抽象方法，由子类实现
+     * @param bgId 背景颜色ID
+     * @return 对应的背景资源ID
+     */
     protected abstract int getBgResourceId(int bgId);
 
+    /**
+     * 获取Widget布局ID的抽象方法，由子类实现
+     * @return Widget布局的资源ID
+     */
     protected abstract int getLayoutId();
 
+    /**
+     * 获取Widget类型的抽象方法，由子类实现
+     * @return Widget类型标识
+     */
     protected abstract int getWidgetType();
 }