From ca7c76df15866b54ba0aad42472b046a07e5e411 Mon Sep 17 00:00:00 2001 From: jacky-qiao <1102127448@qq.com> Date: Tue, 31 Dec 2024 09:59:25 +0800 Subject: [PATCH 1/5] =?UTF-8?q?data=E4=B8=AD=E7=9A=846=E4=B8=AA=E4=BB=A3?= =?UTF-8?q?=E7=A0=81=E4=BF=AE=E6=94=B9=E8=BF=81=E7=A7=BB=E5=AE=8C=E6=AF=95?= =?UTF-8?q?--=E6=96=87=E6=B8=A4=E4=B9=94?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../src/net/micode/notes/data/Contact.java | 23 +- .../src/net/micode/notes/data/Notes.java | 226 +++++++------- .../notes/data/NotesDatabaseHelper.java | 289 +++++++++--------- .../net/micode/notes/data/NotesProvider.java | 214 ++++++++----- 4 files changed, 409 insertions(+), 343 deletions(-) diff --git a/Notes-master/src/net/micode/notes/data/Contact.java b/Notes-master/src/net/micode/notes/data/Contact.java index d97ac5d..639e7ec 100644 --- a/Notes-master/src/net/micode/notes/data/Contact.java +++ b/Notes-master/src/net/micode/notes/data/Contact.java @@ -26,9 +26,12 @@ import android.util.Log; import java.util.HashMap; public class Contact { + // 保存联系人名与电话号码映射的缓存 private static HashMap sContactCache; + // 日志标记 private static final String TAG = "Contact"; + // 查询联系人所用的选择条件 private static final String CALLER_ID_SELECTION = "PHONE_NUMBERS_EQUAL(" + Phone.NUMBER + ",?) AND " + Data.MIMETYPE + "='" + Phone.CONTENT_ITEM_TYPE + "'" + " AND " + Data.RAW_CONTACT_ID + " IN " @@ -36,36 +39,54 @@ public class Contact { + " FROM phone_lookup" + " WHERE min_match = '+')"; + /** + * 根据电话号码获取联系人的姓名 + * + * @param context 应用的上下文 + * @param phoneNumber 要查询的电话号码 + * @return 联系人的姓名，如果没有找到则返回null + */ public static String getContact(Context context, String phoneNumber) { + // 初始化联系人缓存 if(sContactCache == null) { sContactCache = new HashMap(); } + // 如果缓存中已经存在该电话号码的联系人名，直接返回 if(sContactCache.containsKey(phoneNumber)) { return sContactCache.get(phoneNumber); } + // 替换选择条件中的占位符 String selection = CALLER_ID_SELECTION.replace("+", PhoneNumberUtils.toCallerIDMinMatch(phoneNumber)); + + // 执行查询 Cursor cursor = context.getContentResolver().query( Data.CONTENT_URI, - new String [] { Phone.DISPLAY_NAME }, + new String [] { Phone.DISPLAY_NAME }, // 查询显示名称 selection, new String[] { phoneNumber }, null); + // 如果查询结果不为空且移动到结果集的第一行 if (cursor != null && cursor.moveToFirst()) { try { + // 获取联系人姓名 String name = cursor.getString(0); + // 将联系人姓名缓存起来 sContactCache.put(phoneNumber, name); return name; } catch (IndexOutOfBoundsException e) { + // 捕获索引越界异常，记录错误日志 Log.e(TAG, " Cursor get string error " + e.toString()); return null; } finally { + // 关闭cursor，释放资源 cursor.close(); } } else { + // 如果没有找到匹配的联系人，记录日志 Log.d(TAG, "No contact matched with number:" + phoneNumber); return null; } diff --git a/Notes-master/src/net/micode/notes/data/Notes.java b/Notes-master/src/net/micode/notes/data/Notes.java index f240604..56518a5 100644 --- a/Notes-master/src/net/micode/notes/data/Notes.java +++ b/Notes-master/src/net/micode/notes/data/Notes.java @@ -1,279 +1,283 @@ /* * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net) * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at + * 依据 Apache 许可证第2.0版（“许可证”）授权； + * 您不得在未遵守许可证的情况下使用本文件。 + * 您可以在以下网址获取许可证副本： * * http://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * 除非适用法律要求或书面同意，依据许可证分发的软件 + * 是按照 "按原样" 基础提供的， + * 不提供任何形式的保证或条件，无论明确或隐含。 + * 请参阅许可证以获取特定语言涉及的权限和限制。 */ package net.micode.notes.data; import android.net.Uri; + public class Notes { + // Notes类的授权标识符 public static final String AUTHORITY = "micode_notes"; + + // 日志标签 public static final String TAG = "Notes"; - public static final int TYPE_NOTE = 0; - public static final int TYPE_FOLDER = 1; - public static final int TYPE_SYSTEM = 2; + + // 笔记类型 + public static final int TYPE_NOTE = 0; // 笔记类型 + public static final int TYPE_FOLDER = 1; // 文件夹类型 + public static final int TYPE_SYSTEM = 2; // 系统类型 /** - * Following IDs are system folders' identifiers - * {@link Notes#ID_ROOT_FOLDER } is default folder - * {@link Notes#ID_TEMPARAY_FOLDER } is for notes belonging no folder - * {@link Notes#ID_CALL_RECORD_FOLDER} is to store call records + * 以下 IDs 是系统文件夹的标识符 + * {@link Notes#ID_ROOT_FOLDER } 是默认文件夹 + * {@link Notes#ID_TEMPARAY_FOLDER } 是放置无文件夹笔记的临时文件夹 + * {@link Notes#ID_CALL_RECORD_FOLDER} 是存储通话记录的文件夹 */ - public static final int ID_ROOT_FOLDER = 0; - public static final int ID_TEMPARAY_FOLDER = -1; - public static final int ID_CALL_RECORD_FOLDER = -2; - public static final int ID_TRASH_FOLER = -3; - - public static final String INTENT_EXTRA_ALERT_DATE = "net.micode.notes.alert_date"; - public static final String INTENT_EXTRA_BACKGROUND_ID = "net.micode.notes.background_color_id"; - public static final String INTENT_EXTRA_WIDGET_ID = "net.micode.notes.widget_id"; - public static final String INTENT_EXTRA_WIDGET_TYPE = "net.micode.notes.widget_type"; - public static final String INTENT_EXTRA_FOLDER_ID = "net.micode.notes.folder_id"; - public static final String INTENT_EXTRA_CALL_DATE = "net.micode.notes.call_date"; - - public static final int TYPE_WIDGET_INVALIDE = -1; - public static final int TYPE_WIDGET_2X = 0; - public static final int TYPE_WIDGET_4X = 1; + public static final int ID_ROOT_FOLDER = 0; // 根文件夹 + public static final int ID_TEMPARAY_FOLDER = -1; // 临时文件夹 + public static final int ID_CALL_RECORD_FOLDER = -2; // 通话记录文件夹 + public static final int ID_TRASH_FOLER = -3; // 垃圾箱文件夹 + + // Intent Extra Strings + public static final String INTENT_EXTRA_ALERT_DATE = "net.micode.notes.alert_date"; // 提醒日期 + public static final String INTENT_EXTRA_BACKGROUND_ID = "net.micode.notes.background_color_id"; // 背景颜色ID + public static final String INTENT_EXTRA_WIDGET_ID = "net.micode.notes.widget_id"; // 小部件ID + public static final String INTENT_EXTRA_WIDGET_TYPE = "net.micode.notes.widget_type"; // 小部件类型 + public static final String INTENT_EXTRA_FOLDER_ID = "net.micode.notes.folder_id"; // 文件夹ID + public static final String INTENT_EXTRA_CALL_DATE = "net.micode.notes.call_date"; // 通话日期 + + // 小部件类型 + public static final int TYPE_WIDGET_INVALIDE = -1; // 无效的小部件类型 + public static final int TYPE_WIDGET_2X = 0; // 2x小部件类型 + public static final int TYPE_WIDGET_4X = 1; // 4x小部件类型 public static class DataConstants { - public static final String NOTE = TextNote.CONTENT_ITEM_TYPE; - public static final String CALL_NOTE = CallNote.CONTENT_ITEM_TYPE; + public static final String NOTE = TextNote.CONTENT_ITEM_TYPE; // 笔记内容类型 + public static final String CALL_NOTE = CallNote.CONTENT_ITEM_TYPE; // 通话记录内容类型 } /** - * Uri to query all notes and folders + * 查询所有笔记和文件夹的 URI */ public static final Uri CONTENT_NOTE_URI = Uri.parse("content://" + AUTHORITY + "/note"); /** - * Uri to query data + * 查询数据的 URI */ public static final Uri CONTENT_DATA_URI = Uri.parse("content://" + AUTHORITY + "/data"); public interface NoteColumns { /** - * The unique ID for a row - *

Type: INTEGER (long)

+ * 行的独特 ID + *

类型: INTEGER (long)

*/ public static final String ID = "_id"; /** - * The parent's id for note or folder - *

Type: INTEGER (long)

+ * 笔记或文件夹的父 ID + *

类型: INTEGER (long)

*/ public static final String PARENT_ID = "parent_id"; /** - * Created data for note or folder - *

Type: INTEGER (long)

+ * 创建日期用于笔记或文件夹 + *

类型: INTEGER (long)

*/ public static final String CREATED_DATE = "created_date"; /** - * Latest modified date - *

Type: INTEGER (long)

+ * 最新修改日期 + *

类型: INTEGER (long)

*/ public static final String MODIFIED_DATE = "modified_date"; - /** - * Alert date - *

Type: INTEGER (long)

+ * 提醒日期 + *

类型: INTEGER (long)

*/ public static final String ALERTED_DATE = "alert_date"; /** - * Folder's name or text content of note - *

Type: TEXT

+ * 文件夹的名称或笔记的文本内容 + *

类型: TEXT

*/ public static final String SNIPPET = "snippet"; /** - * Note's widget id - *

Type: INTEGER (long)

+ * 笔记的小部件 ID + *

类型: INTEGER (long)

*/ public static final String WIDGET_ID = "widget_id"; /** - * Note's widget type - *

Type: INTEGER (long)

+ * 笔记的小部件类型 + *

类型: INTEGER (long)

*/ public static final String WIDGET_TYPE = "widget_type"; /** - * Note's background color's id - *

Type: INTEGER (long)

+ * 笔记的背景颜色的 ID + *

类型: INTEGER (long)

*/ public static final String BG_COLOR_ID = "bg_color_id"; /** - * For text note, it doesn't has attachment, for multi-media - * note, it has at least one attachment - *

Type: INTEGER

+ * 对于文本笔记，没有附件；对于多媒体笔记，至少有一个附件 + *

类型: INTEGER

*/ public static final String HAS_ATTACHMENT = "has_attachment"; /** - * Folder's count of notes - *

Type: INTEGER (long)

+ * 文件夹中笔记的数量 + *

类型: INTEGER (long)

*/ public static final String NOTES_COUNT = "notes_count"; /** - * The file type: folder or note - *

Type: INTEGER

+ * 文件类型：文件夹或笔记 + *

类型: INTEGER

*/ public static final String TYPE = "type"; /** - * The last sync id - *

Type: INTEGER (long)

+ * 最后同步 ID + *

类型: INTEGER (long)

*/ public static final String SYNC_ID = "sync_id"; /** - * Sign to indicate local modified or not - *

Type: INTEGER

+ * 标记以指示本地是否已修改 + *

类型: INTEGER

*/ public static final String LOCAL_MODIFIED = "local_modified"; /** - * Original parent id before moving into temporary folder - *

Type : INTEGER

+ * 移动到临时文件夹之前的原始父 ID + *

类型 : INTEGER

*/ public static final String ORIGIN_PARENT_ID = "origin_parent_id"; /** - * The gtask id - *

Type : TEXT

+ * gtask ID + *

类型 : TEXT

*/ public static final String GTASK_ID = "gtask_id"; /** - * The version code - *

Type : INTEGER (long)

+ * 版本代码 + *

类型 : INTEGER (long)

*/ public static final String VERSION = "version"; } public interface DataColumns { /** - * The unique ID for a row - *

Type: INTEGER (long)

+ * 行的独特 ID + *

类型: INTEGER (long)

*/ public static final String ID = "_id"; /** - * The MIME type of the item represented by this row. - *

Type: Text

+ * 此行所表示项目的 MIME 类型。 + *

类型: Text

*/ public static final String MIME_TYPE = "mime_type"; /** - * The reference id to note that this data belongs to - *

Type: INTEGER (long)

+ * 该数据所属笔记的参考 ID + *

类型: INTEGER (long)

*/ public static final String NOTE_ID = "note_id"; /** - * Created data for note or folder - *

Type: INTEGER (long)

+ * 创建日期用于笔记或文件夹 + *

类型: INTEGER (long)

*/ public static final String CREATED_DATE = "created_date"; /** - * Latest modified date - *

Type: INTEGER (long)

+ * 最新修改日期 + *

类型: INTEGER (long)

*/ public static final String MODIFIED_DATE = "modified_date"; /** - * Data's content - *

Type: TEXT

+ * 数据内容 + *

类型: TEXT

*/ public static final String CONTENT = "content"; - /** - * Generic data column, the meaning is {@link #MIMETYPE} specific, used for - * integer data type - *

Type: INTEGER

+ * 通用数据列，具体含义取决于 {@link #MIMETYPE}，用于 + * 整数数据类型 + *

类型: INTEGER

*/ public static final String DATA1 = "data1"; /** - * Generic data column, the meaning is {@link #MIMETYPE} specific, used for - * integer data type - *

Type: INTEGER

+ * 通用数据列，具体含义取决于 {@link #MIMETYPE}，用于 + * 整数数据类型 + *

类型: INTEGER

*/ public static final String DATA2 = "data2"; /** - * Generic data column, the meaning is {@link #MIMETYPE} specific, used for - * TEXT data type - *

Type: TEXT

+ * 通用数据列，具体含义取决于 {@link #MIMETYPE}，用于 + * TEXT 数据类型 + *

类型: TEXT

*/ public static final String DATA3 = "data3"; /** - * Generic data column, the meaning is {@link #MIMETYPE} specific, used for - * TEXT data type - *

Type: TEXT

+ * 通用数据列，具体含义取决于 {@link #MIMETYPE}，用于 + * TEXT 数据类型 + *

类型: TEXT

*/ public static final String DATA4 = "data4"; /** - * Generic data column, the meaning is {@link #MIMETYPE} specific, used for - * TEXT data type - *

Type: TEXT

+ * 通用数据列，具体含义取决于 {@link #MIMETYPE}，用于 + * TEXT 数据类型 + *

类型: TEXT

*/ public static final String DATA5 = "data5"; } public static final class TextNote implements DataColumns { /** - * Mode to indicate the text in check list mode or not - *

Type: Integer 1:check list mode 0: normal mode

+ * 指示文本处于检查列表模式还是普通模式 + *

类型: Integer 1:检查列表模式 0:普通模式

*/ public static final String MODE = DATA1; - public static final int MODE_CHECK_LIST = 1; + public static final int MODE_CHECK_LIST = 1; // 检查列表模式的常量 - public static final String CONTENT_TYPE = "vnd.android.cursor.dir/text_note"; + public static final String CONTENT_TYPE = "vnd.android.cursor.dir/text_note"; // 笔记内容类型 - public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/text_note"; + public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/text_note"; // 单个笔记项内容类型 - public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/text_note"); + public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/text_note"); // 笔记的内容URI } public static final class CallNote implements DataColumns { /** - * Call date for this record - *

Type: INTEGER (long)

+ * 此记录的通话日期 + *

类型: INTEGER (long)

*/ public static final String CALL_DATE = DATA1; /** - * Phone number for this record - *

Type: TEXT

+ * 此记录的电话号码 + *

类型: TEXT

*/ public static final String PHONE_NUMBER = DATA3; - public static final String CONTENT_TYPE = "vnd.android.cursor.dir/call_note"; + public static final String CONTENT_TYPE = "vnd.android.cursor.dir/call_note"; // 通话记录内容类型 - public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/call_note"; + public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/call_note"; // 单个通话记录项内容类型 - public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/call_note"); + public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/call_note"); // 通话记录的内容URI } } diff --git a/Notes-master/src/net/micode/notes/data/NotesDatabaseHelper.java b/Notes-master/src/net/micode/notes/data/NotesDatabaseHelper.java index ffe5d57..6057f34 100644 --- a/Notes-master/src/net/micode/notes/data/NotesDatabaseHelper.java +++ b/Notes-master/src/net/micode/notes/data/NotesDatabaseHelper.java @@ -1,92 +1,99 @@ /* * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net) * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at + * 本文件采用Apache 2.0许可协议进行许可。 + * 未经许可，您不得使用本文件。您可以在以下地址获取许可证： * * http://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * 除非适用法律另有规定或书面协议另有约定，否则根据许可证分发的软件是按"原样"提供的， + * 不附带任何明示或暗示的担保或条件。有关许可证下的特定语言条款和限制，请参阅许可证。 */ +// 指定包名 package net.micode.notes.data; -import android.content.ContentValues; -import android.content.Context; -import android.database.sqlite.SQLiteDatabase; -import android.database.sqlite.SQLiteOpenHelper; -import android.util.Log; - -import net.micode.notes.data.Notes.DataColumns; -import net.micode.notes.data.Notes.DataConstants; -import net.micode.notes.data.Notes.NoteColumns; +// 导入必要的类 +import android.content.ContentValues; // 用于数据库内容的存储 +import android.content.Context; // 上下文类 +import android.database.sqlite.SQLiteDatabase; // SQLite数据库类 +import android.database.sqlite.SQLiteOpenHelper; // SQLite数据库帮助类 +import android.util.Log; // 日志类 +// 导入自定义数据列和常量 +import net.micode.notes.data.Notes.DataColumns; // 数据列模型 +import net.micode.notes.data.Notes.DataConstants; // 数据常量 +import net.micode.notes.data.Notes.NoteColumns; // 笔记列模型 +// 创建NotesDatabaseHelper类，继承自SQLiteOpenHelper public class NotesDatabaseHelper extends SQLiteOpenHelper { + // 数据库名称 private static final String DB_NAME = "note.db"; + // 数据库版本号 private static final int DB_VERSION = 4; + // 定义表名的接口 public interface TABLE { + // 笔记表的名称 public static final String NOTE = "note"; + // 数据表的名称 public static final String DATA = "data"; } + // 日志标签 private static final String TAG = "NotesDatabaseHelper"; + // 单例实例 private static NotesDatabaseHelper mInstance; + // 创建笔记表的SQL语句 private static final String CREATE_NOTE_TABLE_SQL = "CREATE TABLE " + TABLE.NOTE + "(" + - NoteColumns.ID + " INTEGER PRIMARY KEY," + - NoteColumns.PARENT_ID + " INTEGER NOT NULL DEFAULT 0," + - NoteColumns.ALERTED_DATE + " INTEGER NOT NULL DEFAULT 0," + - NoteColumns.BG_COLOR_ID + " INTEGER NOT NULL DEFAULT 0," + - NoteColumns.CREATED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + - NoteColumns.HAS_ATTACHMENT + " INTEGER NOT NULL DEFAULT 0," + - NoteColumns.MODIFIED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + - NoteColumns.NOTES_COUNT + " INTEGER NOT NULL DEFAULT 0," + - NoteColumns.SNIPPET + " TEXT NOT NULL DEFAULT ''," + - NoteColumns.TYPE + " INTEGER NOT NULL DEFAULT 0," + - NoteColumns.WIDGET_ID + " INTEGER NOT NULL DEFAULT 0," + - NoteColumns.WIDGET_TYPE + " INTEGER NOT NULL DEFAULT -1," + - NoteColumns.SYNC_ID + " INTEGER NOT NULL DEFAULT 0," + - NoteColumns.LOCAL_MODIFIED + " INTEGER NOT NULL DEFAULT 0," + - NoteColumns.ORIGIN_PARENT_ID + " INTEGER NOT NULL DEFAULT 0," + - NoteColumns.GTASK_ID + " TEXT NOT NULL DEFAULT ''," + - NoteColumns.VERSION + " INTEGER NOT NULL DEFAULT 0" + + NoteColumns.ID + " INTEGER PRIMARY KEY," + // 笔记ID，主键 + NoteColumns.PARENT_ID + " INTEGER NOT NULL DEFAULT 0," + // 父级ID + NoteColumns.ALERTED_DATE + " INTEGER NOT NULL DEFAULT 0," + // 提醒日期 + NoteColumns.BG_COLOR_ID + " INTEGER NOT NULL DEFAULT 0," + // 背景颜色ID + NoteColumns.CREATED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + // 创建日期 + NoteColumns.HAS_ATTACHMENT + " INTEGER NOT NULL DEFAULT 0," + // 是否有附件 + NoteColumns.MODIFIED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + // 修改日期 + NoteColumns.NOTES_COUNT + " INTEGER NOT NULL DEFAULT 0," + // 笔记数量 + NoteColumns.SNIPPET + " TEXT NOT NULL DEFAULT ''," + // 笔记摘要 + NoteColumns.TYPE + " INTEGER NOT NULL DEFAULT 0," + // 笔记类型 + NoteColumns.WIDGET_ID + " INTEGER NOT NULL DEFAULT 0," + // 小部件ID + NoteColumns.WIDGET_TYPE + " INTEGER NOT NULL DEFAULT -1," + // 小部件类型 + NoteColumns.SYNC_ID + " INTEGER NOT NULL DEFAULT 0," + // 同步ID + NoteColumns.LOCAL_MODIFIED + " INTEGER NOT NULL DEFAULT 0," + // 本地修改标志 + NoteColumns.ORIGIN_PARENT_ID + " INTEGER NOT NULL DEFAULT 0," + // 原始父级ID + NoteColumns.GTASK_ID + " TEXT NOT NULL DEFAULT ''," + // GTASK ID + NoteColumns.VERSION + " INTEGER NOT NULL DEFAULT 0" + // 版本号 ")"; + // 创建数据表的SQL语句 private static final String CREATE_DATA_TABLE_SQL = "CREATE TABLE " + TABLE.DATA + "(" + - DataColumns.ID + " INTEGER PRIMARY KEY," + - DataColumns.MIME_TYPE + " TEXT NOT NULL," + - DataColumns.NOTE_ID + " INTEGER NOT NULL DEFAULT 0," + - NoteColumns.CREATED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + - NoteColumns.MODIFIED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + - DataColumns.CONTENT + " TEXT NOT NULL DEFAULT ''," + - DataColumns.DATA1 + " INTEGER," + - DataColumns.DATA2 + " INTEGER," + - DataColumns.DATA3 + " TEXT NOT NULL DEFAULT ''," + - DataColumns.DATA4 + " TEXT NOT NULL DEFAULT ''," + - DataColumns.DATA5 + " TEXT NOT NULL DEFAULT ''" + + DataColumns.ID + " INTEGER PRIMARY KEY," + // 数据ID，主键 + DataColumns.MIME_TYPE + " TEXT NOT NULL," + // MIME类型 + DataColumns.NOTE_ID + " INTEGER NOT NULL DEFAULT 0," + // 关联的笔记ID + NoteColumns.CREATED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + // 创建日期 + NoteColumns.MODIFIED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + // 修改日期 + DataColumns.CONTENT + " TEXT NOT NULL DEFAULT ''," + // 内容 + DataColumns.DATA1 + " INTEGER," + // 数据字段1 + DataColumns.DATA2 + " INTEGER," + // 数据字段2 + DataColumns.DATA3 + " TEXT NOT NULL DEFAULT ''," + // 数据字段3 + DataColumns.DATA4 + " TEXT NOT NULL DEFAULT ''," + // 数据字段4 + DataColumns.DATA5 + " TEXT NOT NULL DEFAULT ''" + // 数据字段5 ")"; + // 创建数据表中NOTE_ID字段的索引 private static final String CREATE_DATA_NOTE_ID_INDEX_SQL = "CREATE INDEX IF NOT EXISTS note_id_index ON " + TABLE.DATA + "(" + DataColumns.NOTE_ID + ");"; - /** - * Increase folder's note count when move note to the folder - */ + // 当更新笔记时增加文件夹的笔记计数的触发器 private static final String NOTE_INCREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER = - "CREATE TRIGGER increase_folder_count_on_update "+ + "CREATE TRIGGER increase_folder_count_on_update "+ " AFTER UPDATE OF " + NoteColumns.PARENT_ID + " ON " + TABLE.NOTE + " BEGIN " + " UPDATE " + TABLE.NOTE + @@ -94,9 +101,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { " WHERE " + NoteColumns.ID + "=new." + NoteColumns.PARENT_ID + ";" + " END"; - /** - * Decrease folder's note count when move note from folder - */ + // 当从文件夹中移动笔记时减少文件夹的笔记计数的触发器 private static final String NOTE_DECREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER = "CREATE TRIGGER decrease_folder_count_on_update " + " AFTER UPDATE OF " + NoteColumns.PARENT_ID + " ON " + TABLE.NOTE + @@ -107,9 +112,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { " AND " + NoteColumns.NOTES_COUNT + ">0" + ";" + " END"; - /** - * Increase folder's note count when insert new note to the folder - */ + // 当在文件夹中插入新笔记时增加文件夹的笔记计数的触发器 private static final String NOTE_INCREASE_FOLDER_COUNT_ON_INSERT_TRIGGER = "CREATE TRIGGER increase_folder_count_on_insert " + " AFTER INSERT ON " + TABLE.NOTE + @@ -119,9 +122,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { " WHERE " + NoteColumns.ID + "=new." + NoteColumns.PARENT_ID + ";" + " END"; - /** - * Decrease folder's note count when delete note from the folder - */ + // 当从文件夹中删除笔记时减少文件夹的笔记计数的触发器 private static final String NOTE_DECREASE_FOLDER_COUNT_ON_DELETE_TRIGGER = "CREATE TRIGGER decrease_folder_count_on_delete " + " AFTER DELETE ON " + TABLE.NOTE + @@ -132,9 +133,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { " AND " + NoteColumns.NOTES_COUNT + ">0;" + " END"; - /** - * Update note's content when insert data with type {@link DataConstants#NOTE} - */ + // 在插入类型为NOTE的数据时更新笔记内容的触发器 private static final String DATA_UPDATE_NOTE_CONTENT_ON_INSERT_TRIGGER = "CREATE TRIGGER update_note_content_on_insert " + " AFTER INSERT ON " + TABLE.DATA + @@ -145,9 +144,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { " WHERE " + NoteColumns.ID + "=new." + DataColumns.NOTE_ID + ";" + " END"; - /** - * Update note's content when data with {@link DataConstants#NOTE} type has changed - */ + // 当类型为NOTE的数据发生变化时更新笔记内容的触发器 private static final String DATA_UPDATE_NOTE_CONTENT_ON_UPDATE_TRIGGER = "CREATE TRIGGER update_note_content_on_update " + " AFTER UPDATE ON " + TABLE.DATA + @@ -158,9 +155,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { " WHERE " + NoteColumns.ID + "=new." + DataColumns.NOTE_ID + ";" + " END"; - /** - * Update note's content when data with {@link DataConstants#NOTE} type has deleted - */ + // 当类型为NOTE的数据被删除时更新笔记内容的触发器 private static final String DATA_UPDATE_NOTE_CONTENT_ON_DELETE_TRIGGER = "CREATE TRIGGER update_note_content_on_delete " + " AFTER delete ON " + TABLE.DATA + @@ -171,9 +166,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { " WHERE " + NoteColumns.ID + "=old." + DataColumns.NOTE_ID + ";" + " END"; - /** - * Delete datas belong to note which has been deleted - */ + // 删除已删除笔记的所有数据的触发器 private static final String NOTE_DELETE_DATA_ON_DELETE_TRIGGER = "CREATE TRIGGER delete_data_on_delete " + " AFTER DELETE ON " + TABLE.NOTE + @@ -182,9 +175,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { " WHERE " + DataColumns.NOTE_ID + "=old." + NoteColumns.ID + ";" + " END"; - /** - * Delete notes belong to folder which has been deleted - */ + // 删除已删除文件夹中的笔记的触发器 private static final String FOLDER_DELETE_NOTES_ON_DELETE_TRIGGER = "CREATE TRIGGER folder_delete_notes_on_delete " + " AFTER DELETE ON " + TABLE.NOTE + @@ -193,9 +184,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { " WHERE " + NoteColumns.PARENT_ID + "=old." + NoteColumns.ID + ";" + " END"; - /** - * Move notes belong to folder which has been moved to trash folder - */ + // 当文件夹被移动到垃圾桶时移动文件夹中的笔记的触发器 private static final String FOLDER_MOVE_NOTES_ON_TRASH_TRIGGER = "CREATE TRIGGER folder_move_notes_on_trash " + " AFTER UPDATE ON " + TABLE.NOTE + @@ -206,26 +195,30 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { " WHERE " + NoteColumns.PARENT_ID + "=old." + NoteColumns.ID + ";" + " END"; + // 构造函数，接受上下文参数 public NotesDatabaseHelper(Context context) { - super(context, DB_NAME, null, DB_VERSION); + super(context, DB_NAME, null, DB_VERSION); // 调用父类构造函数 } + // 创建笔记表 public void createNoteTable(SQLiteDatabase db) { - db.execSQL(CREATE_NOTE_TABLE_SQL); - reCreateNoteTableTriggers(db); - createSystemFolder(db); - Log.d(TAG, "note table has been created"); + db.execSQL(CREATE_NOTE_TABLE_SQL); // 执行创建表的SQL语句 + reCreateNoteTableTriggers(db); // 重新创建触发器 + createSystemFolder(db); // 创建系统文件夹 + Log.d(TAG, "note table has been created"); // 日志输出 } + // 重新创建笔记表的所有触发器 private void reCreateNoteTableTriggers(SQLiteDatabase db) { - db.execSQL("DROP TRIGGER IF EXISTS increase_folder_count_on_update"); - db.execSQL("DROP TRIGGER IF EXISTS decrease_folder_count_on_update"); - db.execSQL("DROP TRIGGER IF EXISTS decrease_folder_count_on_delete"); - db.execSQL("DROP TRIGGER IF EXISTS delete_data_on_delete"); - db.execSQL("DROP TRIGGER IF EXISTS increase_folder_count_on_insert"); - db.execSQL("DROP TRIGGER IF EXISTS folder_delete_notes_on_delete"); - db.execSQL("DROP TRIGGER IF EXISTS folder_move_notes_on_trash"); - + db.execSQL("DROP TRIGGER IF EXISTS increase_folder_count_on_update"); // 删除触发器 + db.execSQL("DROP TRIGGER IF EXISTS decrease_folder_count_on_update"); // 删除触发器 + db.execSQL("DROP TRIGGER IF EXISTS decrease_folder_count_on_delete"); // 删除触发器 + db.execSQL("DROP TRIGGER IF EXISTS delete_data_on_delete"); // 删除触发器 + db.execSQL("DROP TRIGGER IF EXISTS increase_folder_count_on_insert"); // 删除触发器 + db.execSQL("DROP TRIGGER IF EXISTS folder_delete_notes_on_delete"); // 删除触发器 + db.execSQL("DROP TRIGGER IF EXISTS folder_move_notes_on_trash"); // 删除触发器 + + // 创建新的触发器 db.execSQL(NOTE_INCREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER); db.execSQL(NOTE_DECREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER); db.execSQL(NOTE_DECREASE_FOLDER_COUNT_ON_DELETE_TRIGGER); @@ -235,128 +228,130 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { db.execSQL(FOLDER_MOVE_NOTES_ON_TRASH_TRIGGER); } + // 创建系统文件夹 private void createSystemFolder(SQLiteDatabase db) { - ContentValues values = new ContentValues(); + ContentValues values = new ContentValues(); // 创建内容值对象 - /** - * call record foler for call notes - */ + // 为通话记录文件夹插入记录 values.put(NoteColumns.ID, Notes.ID_CALL_RECORD_FOLDER); values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); - db.insert(TABLE.NOTE, null, values); + db.insert(TABLE.NOTE, null, values); // 插入记录 - /** - * root folder which is default folder - */ - values.clear(); + // 创建根文件夹 + values.clear(); // 清空内容值 values.put(NoteColumns.ID, Notes.ID_ROOT_FOLDER); values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); - db.insert(TABLE.NOTE, null, values); + db.insert(TABLE.NOTE, null, values); // 插入记录 - /** - * temporary folder which is used for moving note - */ - values.clear(); + // 创建临时文件夹 + values.clear(); // 清空内容值 values.put(NoteColumns.ID, Notes.ID_TEMPARAY_FOLDER); values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); - db.insert(TABLE.NOTE, null, values); + db.insert(TABLE.NOTE, null, values); // 插入记录 - /** - * create trash folder - */ - values.clear(); + // 创建垃圾桶文件夹 + values.clear(); // 清空内容值 values.put(NoteColumns.ID, Notes.ID_TRASH_FOLER); values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); - db.insert(TABLE.NOTE, null, values); + db.insert(TABLE.NOTE, null, values); // 插入记录 } + // 创建数据表 public void createDataTable(SQLiteDatabase db) { - db.execSQL(CREATE_DATA_TABLE_SQL); - reCreateDataTableTriggers(db); - db.execSQL(CREATE_DATA_NOTE_ID_INDEX_SQL); - Log.d(TAG, "data table has been created"); + db.execSQL(CREATE_DATA_TABLE_SQL); // 执行创建表的SQL语句 + reCreateDataTableTriggers(db); // 重新创建触发器 + db.execSQL(CREATE_DATA_NOTE_ID_INDEX_SQL); // 创建索引 + Log.d(TAG, "data table has been created"); // 日志输出 } + // 重新创建数据表的所有触发器 private void reCreateDataTableTriggers(SQLiteDatabase db) { - db.execSQL("DROP TRIGGER IF EXISTS update_note_content_on_insert"); - db.execSQL("DROP TRIGGER IF EXISTS update_note_content_on_update"); - db.execSQL("DROP TRIGGER IF EXISTS update_note_content_on_delete"); + db.execSQL("DROP TRIGGER IF EXISTS update_note_content_on_insert"); // 删除触发器 + db.execSQL("DROP TRIGGER IF EXISTS update_note_content_on_update"); // 删除触发器 + db.execSQL("DROP TRIGGER IF EXISTS update_note_content_on_delete"); // 删除触发器 + // 创建新的触发器 db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_INSERT_TRIGGER); db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_UPDATE_TRIGGER); db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_DELETE_TRIGGER); } + // 获取NotesDatabaseHelper的单例实例 static synchronized NotesDatabaseHelper getInstance(Context context) { - if (mInstance == null) { + if (mInstance == null) { // 如果实例为空，则创建新的实例 mInstance = new NotesDatabaseHelper(context); } - return mInstance; + return mInstance; // 返回实例 } + // 当创建数据库时被调用 @Override public void onCreate(SQLiteDatabase db) { - createNoteTable(db); - createDataTable(db); + createNoteTable(db); // 创建笔记表 + createDataTable(db); // 创建数据表 } + // 当升级数据库时被调用 @Override public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) { - boolean reCreateTriggers = false; - boolean skipV2 = false; + boolean reCreateTriggers = false; // 重创建触发器的标志 + boolean skipV2 = false; // 跳过V2的标志 - if (oldVersion == 1) { - upgradeToV2(db); - skipV2 = true; // this upgrade including the upgrade from v2 to v3 - oldVersion++; + if (oldVersion == 1) { // 如果旧版本是1 + upgradeToV2(db); // 升级到V2 + skipV2 = true; // 跳过V2的标志设为true + oldVersion++; // 增加版本号 } - if (oldVersion == 2 && !skipV2) { - upgradeToV3(db); - reCreateTriggers = true; - oldVersion++; + if (oldVersion == 2 && !skipV2) { // 如果旧版本是2且没有跳过 + upgradeToV3(db); // 升级到V3 + reCreateTriggers = true; // 设置重创建触发器的标志为true + oldVersion++; // 增加版本号 } - if (oldVersion == 3) { - upgradeToV4(db); - oldVersion++; + if (oldVersion == 3) { // 如果旧版本是3 + upgradeToV4(db); // 升级到V4 + oldVersion++; // 增加版本号 } - if (reCreateTriggers) { - reCreateNoteTableTriggers(db); - reCreateDataTableTriggers(db); + if (reCreateTriggers) { // 如果需要重创建触发器 + reCreateNoteTableTriggers(db); // 重新创建笔记表的触发器 + reCreateDataTableTriggers(db); // 重新创建数据表的触发器 } - if (oldVersion != newVersion) { + if (oldVersion != newVersion) { // 如果版本不一致，则抛出异常 throw new IllegalStateException("Upgrade notes database to version " + newVersion - + "fails"); + + " fails"); } } + // 升级到V2 private void upgradeToV2(SQLiteDatabase db) { - db.execSQL("DROP TABLE IF EXISTS " + TABLE.NOTE); - db.execSQL("DROP TABLE IF EXISTS " + TABLE.DATA); - createNoteTable(db); - createDataTable(db); + db.execSQL("DROP TABLE IF EXISTS " + TABLE.NOTE); // 删除笔记表 + db.execSQL("DROP TABLE IF EXISTS " + TABLE.DATA); // 删除数据表 + createNoteTable(db); // 创建笔记表 + createDataTable(db); // 创建数据表 } + // 升级到V3 private void upgradeToV3(SQLiteDatabase db) { - // drop unused triggers + // 删除未使用的触发器 db.execSQL("DROP TRIGGER IF EXISTS update_note_modified_date_on_insert"); db.execSQL("DROP TRIGGER IF EXISTS update_note_modified_date_on_delete"); db.execSQL("DROP TRIGGER IF EXISTS update_note_modified_date_on_update"); - // add a column for gtask id + // 为笔记添加一个新的字符ID列 db.execSQL("ALTER TABLE " + TABLE.NOTE + " ADD COLUMN " + NoteColumns.GTASK_ID + " TEXT NOT NULL DEFAULT ''"); - // add a trash system folder + // 添加一个垃圾桶系统文件夹 ContentValues values = new ContentValues(); values.put(NoteColumns.ID, Notes.ID_TRASH_FOLER); values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); - db.insert(TABLE.NOTE, null, values); + db.insert(TABLE.NOTE, null, values); // 插入记录 } + // 升级到V4 private void upgradeToV4(SQLiteDatabase db) { db.execSQL("ALTER TABLE " + TABLE.NOTE + " ADD COLUMN " + NoteColumns.VERSION - + " INTEGER NOT NULL DEFAULT 0"); + + " INTEGER NOT NULL DEFAULT 0"); // 为笔记表添加版本列 } } diff --git a/Notes-master/src/net/micode/notes/data/NotesProvider.java b/Notes-master/src/net/micode/notes/data/NotesProvider.java index edb0a60..23a981f 100644 --- a/Notes-master/src/net/micode/notes/data/NotesProvider.java +++ b/Notes-master/src/net/micode/notes/data/NotesProvider.java @@ -16,7 +16,7 @@ package net.micode.notes.data; - +// 导入需要的Android和本地类 import android.app.SearchManager; import android.content.ContentProvider; import android.content.ContentUris; @@ -34,271 +34,317 @@ import net.micode.notes.data.Notes.DataColumns; import net.micode.notes.data.Notes.NoteColumns; import net.micode.notes.data.NotesDatabaseHelper.TABLE; - +/** + * NotesProvider 类继承自 ContentProvider， + * 负责与外部交互以进行笔记数据的增删改查操作。 + */ public class NotesProvider extends ContentProvider { + // UriMatcher，用于匹配不同的URI请求 private static final UriMatcher mMatcher; + // 数据库助手实例 private NotesDatabaseHelper mHelper; + // 日志标签 private static final String TAG = "NotesProvider"; - private static final int URI_NOTE = 1; - private static final int URI_NOTE_ITEM = 2; - private static final int URI_DATA = 3; - private static final int URI_DATA_ITEM = 4; + // 定义URI常量 + private static final int URI_NOTE = 1; // 笔记 URI + private static final int URI_NOTE_ITEM = 2; // 单个笔记 URI + private static final int URI_DATA = 3; // 数据 URI + private static final int URI_DATA_ITEM = 4; // 单个数据 URI - private static final int URI_SEARCH = 5; - private static final int URI_SEARCH_SUGGEST = 6; + private static final int URI_SEARCH = 5; // 搜索 URI + private static final int URI_SEARCH_SUGGEST = 6; // 搜索建议 URI + // 静态代码块，初始化 URI 匹配器并添加各种 URI 匹配规则 static { mMatcher = new UriMatcher(UriMatcher.NO_MATCH); - mMatcher.addURI(Notes.AUTHORITY, "note", URI_NOTE); - mMatcher.addURI(Notes.AUTHORITY, "note/#", URI_NOTE_ITEM); - mMatcher.addURI(Notes.AUTHORITY, "data", URI_DATA); - mMatcher.addURI(Notes.AUTHORITY, "data/#", URI_DATA_ITEM); - mMatcher.addURI(Notes.AUTHORITY, "search", URI_SEARCH); - mMatcher.addURI(Notes.AUTHORITY, SearchManager.SUGGEST_URI_PATH_QUERY, URI_SEARCH_SUGGEST); - mMatcher.addURI(Notes.AUTHORITY, SearchManager.SUGGEST_URI_PATH_QUERY + "/*", URI_SEARCH_SUGGEST); + mMatcher.addURI(Notes.AUTHORITY, "note", URI_NOTE); // 笔记的 URI + mMatcher.addURI(Notes.AUTHORITY, "note/#", URI_NOTE_ITEM); // 单个笔记的 URI + mMatcher.addURI(Notes.AUTHORITY, "data", URI_DATA); // 数据的 URI + mMatcher.addURI(Notes.AUTHORITY, "data/#", URI_DATA_ITEM); // 单个数据的 URI + mMatcher.addURI(Notes.AUTHORITY, "search", URI_SEARCH); // 搜索 URI + mMatcher.addURI(Notes.AUTHORITY, SearchManager.SUGGEST_URI_PATH_QUERY, URI_SEARCH_SUGGEST); // 搜索建议 URI + mMatcher.addURI(Notes.AUTHORITY, SearchManager.SUGGEST_URI_PATH_QUERY + "/*", URI_SEARCH_SUGGEST); // 带参数的搜索建议 URI } /** - * x'0A' represents the '\n' character in sqlite. For title and content in the search result, - * we will trim '\n' and white space in order to show more information. + * 在搜索结果中，x'0A' 代表换行符。为了更好地展示信息， + * 我们将搜索结果中的标题和内容进行修剪以去除换行符和空格。 */ - private static final String NOTES_SEARCH_PROJECTION = NoteColumns.ID + "," - + NoteColumns.ID + " AS " + SearchManager.SUGGEST_COLUMN_INTENT_EXTRA_DATA + "," - + "TRIM(REPLACE(" + NoteColumns.SNIPPET + ", x'0A','')) AS " + SearchManager.SUGGEST_COLUMN_TEXT_1 + "," - + "TRIM(REPLACE(" + NoteColumns.SNIPPET + ", x'0A','')) AS " + SearchManager.SUGGEST_COLUMN_TEXT_2 + "," - + R.drawable.search_result + " AS " + SearchManager.SUGGEST_COLUMN_ICON_1 + "," - + "'" + Intent.ACTION_VIEW + "' AS " + SearchManager.SUGGEST_COLUMN_INTENT_ACTION + "," - + "'" + Notes.TextNote.CONTENT_TYPE + "' AS " + SearchManager.SUGGEST_COLUMN_INTENT_DATA; + private static final String NOTES_SEARCH_PROJECTION = NoteColumns.ID + "," // 笔记 ID + + NoteColumns.ID + " AS " + SearchManager.SUGGEST_COLUMN_INTENT_EXTRA_DATA + "," // 笔记 ID 作为意图额外数据 + + "TRIM(REPLACE(" + NoteColumns.SNIPPET + ", x'0A','')) AS " + SearchManager.SUGGEST_COLUMN_TEXT_1 + "," // 修剪后的内容作为建议文本1 + + "TRIM(REPLACE(" + NoteColumns.SNIPPET + ", x'0A','')) AS " + SearchManager.SUGGEST_COLUMN_TEXT_2 + "," // 修剪后的内容作为建议文本2 + + R.drawable.search_result + " AS " + SearchManager.SUGGEST_COLUMN_ICON_1 + "," // 搜索结果图标 + + "'" + Intent.ACTION_VIEW + "' AS " + SearchManager.SUGGEST_COLUMN_INTENT_ACTION + "," // 意图行为 + + "'" + Notes.TextNote.CONTENT_TYPE + "' AS " + SearchManager.SUGGEST_COLUMN_INTENT_DATA; // 笔记内容类型 + // 搜索笔记的 SQL 查询语句 private static String NOTES_SNIPPET_SEARCH_QUERY = "SELECT " + NOTES_SEARCH_PROJECTION - + " FROM " + TABLE.NOTE - + " WHERE " + NoteColumns.SNIPPET + " LIKE ?" - + " AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER - + " AND " + NoteColumns.TYPE + "=" + Notes.TYPE_NOTE; + + " FROM " + TABLE.NOTE // 查询的表为笔记表 + + " WHERE " + NoteColumns.SNIPPET + " LIKE ?" // 根据内容片段进行模糊匹配 + + " AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER // 排除回收站的内容 + + " AND " + NoteColumns.TYPE + "=" + Notes.TYPE_NOTE; // 仅匹配笔记类型 @Override public boolean onCreate() { + // 初始化数据库助手 mHelper = NotesDatabaseHelper.getInstance(getContext()); - return true; + return true; // 创建成功 } @Override public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder) { + // 查询方法，处理不同的URI请求并返回结果的Cursor Cursor c = null; - SQLiteDatabase db = mHelper.getReadableDatabase(); - String id = null; - switch (mMatcher.match(uri)) { + SQLiteDatabase db = mHelper.getReadableDatabase(); // 获取可读数据库 + String id = null; // 用于存储ID + + switch (mMatcher.match(uri)) { // 根据URI匹配不同的查询类型 case URI_NOTE: - c = db.query(TABLE.NOTE, projection, selection, selectionArgs, null, null, - sortOrder); + // 查询所有笔记 + c = db.query(TABLE.NOTE, projection, selection, selectionArgs, null, null, sortOrder); break; case URI_NOTE_ITEM: - id = uri.getPathSegments().get(1); + // 查询单个笔记 + id = uri.getPathSegments().get(1); // 从URI中获取笔记ID c = db.query(TABLE.NOTE, projection, NoteColumns.ID + "=" + id + parseSelection(selection), selectionArgs, null, null, sortOrder); break; case URI_DATA: - c = db.query(TABLE.DATA, projection, selection, selectionArgs, null, null, - sortOrder); + // 查询所有数据 + c = db.query(TABLE.DATA, projection, selection, selectionArgs, null, null, sortOrder); break; case URI_DATA_ITEM: - id = uri.getPathSegments().get(1); + // 查询单个数据 + id = uri.getPathSegments().get(1); // 从URI中获取数据ID c = db.query(TABLE.DATA, projection, DataColumns.ID + "=" + id + parseSelection(selection), selectionArgs, null, null, sortOrder); break; case URI_SEARCH: case URI_SEARCH_SUGGEST: if (sortOrder != null || projection != null) { + // 搜索请求不支持排序或选择 throw new IllegalArgumentException( "do not specify sortOrder, selection, selectionArgs, or projection" + "with this query"); } String searchString = null; if (mMatcher.match(uri) == URI_SEARCH_SUGGEST) { + // 获取搜索建议的参数 if (uri.getPathSegments().size() > 1) { searchString = uri.getPathSegments().get(1); } } else { + // 从查询参数获取搜索字符串 searchString = uri.getQueryParameter("pattern"); } if (TextUtils.isEmpty(searchString)) { - return null; + return null; // 如果搜索字符串为空，则返回null } try { + // 使用通配符模糊匹配 searchString = String.format("%%%s%%", searchString); c = db.rawQuery(NOTES_SNIPPET_SEARCH_QUERY, - new String[] { searchString }); + new String[] { searchString }); // 执行搜索查询 } catch (IllegalStateException ex) { - Log.e(TAG, "got exception: " + ex.toString()); + Log.e(TAG, "got exception: " + ex.toString()); // 记录异常 } break; default: + // 未知的URI，抛出异常 throw new IllegalArgumentException("Unknown URI " + uri); } + if (c != null) { + // 设置通知URI，数据变化时通知的URI c.setNotificationUri(getContext().getContentResolver(), uri); } - return c; + return c; // 返回查询结果 } @Override public Uri insert(Uri uri, ContentValues values) { - SQLiteDatabase db = mHelper.getWritableDatabase(); - long dataId = 0, noteId = 0, insertedId = 0; - switch (mMatcher.match(uri)) { + // 插入数据方法 + SQLiteDatabase db = mHelper.getWritableDatabase(); // 获取可写数据库 + long dataId = 0, noteId = 0, insertedId = 0; // 初始化ID + + switch (mMatcher.match(uri)) { // 根据URI匹配不同的插入类型 case URI_NOTE: + // 插入新的笔记 insertedId = noteId = db.insert(TABLE.NOTE, null, values); break; case URI_DATA: + // 插入新的数据 if (values.containsKey(DataColumns.NOTE_ID)) { + // 获取关联的笔记ID noteId = values.getAsLong(DataColumns.NOTE_ID); } else { - Log.d(TAG, "Wrong data format without note id:" + values.toString()); + Log.d(TAG, "Wrong data format without note id:" + values.toString()); // 记录错误日志 } insertedId = dataId = db.insert(TABLE.DATA, null, values); break; default: + // 未知的URI，抛出异常 throw new IllegalArgumentException("Unknown URI " + uri); } - // Notify the note uri + + // 当笔记插入成功时，通知笔记URI if (noteId > 0) { getContext().getContentResolver().notifyChange( ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), null); } - // Notify the data uri + // 当数据插入成功时，通知数据URI if (dataId > 0) { getContext().getContentResolver().notifyChange( ContentUris.withAppendedId(Notes.CONTENT_DATA_URI, dataId), null); } - return ContentUris.withAppendedId(uri, insertedId); + return ContentUris.withAppendedId(uri, insertedId); // 返回新插入项的URI } @Override public int delete(Uri uri, String selection, String[] selectionArgs) { - int count = 0; - String id = null; - SQLiteDatabase db = mHelper.getWritableDatabase(); - boolean deleteData = false; - switch (mMatcher.match(uri)) { + // 删除数据方法 + int count = 0; // 计数删除的行数 + String id = null; // 用于存储ID + SQLiteDatabase db = mHelper.getWritableDatabase(); // 获取可写数据库 + boolean deleteData = false; // 标记是否删除数据 + + switch (mMatcher.match(uri)) { // 根据URI匹配不同的删除类型 case URI_NOTE: - selection = "(" + selection + ") AND " + NoteColumns.ID + ">0 "; + // 删除所有笔记 + selection = "(" + selection + ") AND " + NoteColumns.ID + ">0 "; // 除去系统文件夹 count = db.delete(TABLE.NOTE, selection, selectionArgs); break; case URI_NOTE_ITEM: - id = uri.getPathSegments().get(1); - /** - * ID that smaller than 0 is system folder which is not allowed to - * trash - */ + // 删除单个笔记 + id = uri.getPathSegments().get(1); // 从URI中获取笔记ID long noteId = Long.valueOf(id); if (noteId <= 0) { - break; + break; // 系统文件夹不允许删除 } count = db.delete(TABLE.NOTE, NoteColumns.ID + "=" + id + parseSelection(selection), selectionArgs); break; case URI_DATA: + // 删除所有数据 count = db.delete(TABLE.DATA, selection, selectionArgs); - deleteData = true; + deleteData = true; // 标记为删除数据 break; case URI_DATA_ITEM: - id = uri.getPathSegments().get(1); + // 删除单个数据 + id = uri.getPathSegments().get(1); // 从URI中获取数据ID count = db.delete(TABLE.DATA, DataColumns.ID + "=" + id + parseSelection(selection), selectionArgs); - deleteData = true; + deleteData = true; // 标记为删除数据 break; default: + // 未知的URI，抛出异常 throw new IllegalArgumentException("Unknown URI " + uri); } + if (count > 0) { if (deleteData) { + // 如果删除了数据，通知笔记URI getContext().getContentResolver().notifyChange(Notes.CONTENT_NOTE_URI, null); } + // 通知数据URI getContext().getContentResolver().notifyChange(uri, null); } - return count; + return count; // 返回删除的行数 } @Override public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs) { - int count = 0; - String id = null; - SQLiteDatabase db = mHelper.getWritableDatabase(); - boolean updateData = false; - switch (mMatcher.match(uri)) { + // 更新数据方法 + int count = 0; // 计数更新的行数 + String id = null; // 用于存储ID + SQLiteDatabase db = mHelper.getWritableDatabase(); // 获取可写数据库 + boolean updateData = false; // 标记是否更新数据 + + switch (mMatcher.match(uri)) { // 根据URI匹配不同的更新类型 case URI_NOTE: - increaseNoteVersion(-1, selection, selectionArgs); + // 更新所有笔记 + increaseNoteVersion(-1, selection, selectionArgs); // 更新版本 count = db.update(TABLE.NOTE, values, selection, selectionArgs); break; case URI_NOTE_ITEM: - id = uri.getPathSegments().get(1); - increaseNoteVersion(Long.valueOf(id), selection, selectionArgs); + // 更新单个笔记 + id = uri.getPathSegments().get(1); // 从URI中获取笔记ID + increaseNoteVersion(Long.valueOf(id), selection, selectionArgs); // 更新版本 count = db.update(TABLE.NOTE, values, NoteColumns.ID + "=" + id + parseSelection(selection), selectionArgs); break; case URI_DATA: + // 更新所有数据 count = db.update(TABLE.DATA, values, selection, selectionArgs); - updateData = true; + updateData = true; // 标记为更新数据 break; case URI_DATA_ITEM: - id = uri.getPathSegments().get(1); + // 更新单个数据 + id = uri.getPathSegments().get(1); // 从URI中获取数据ID count = db.update(TABLE.DATA, values, DataColumns.ID + "=" + id + parseSelection(selection), selectionArgs); - updateData = true; + updateData = true; // 标记为更新数据 break; default: + // 未知的URI，抛出异常 throw new IllegalArgumentException("Unknown URI " + uri); } if (count > 0) { if (updateData) { + // 如果更新了数据，通知笔记URI getContext().getContentResolver().notifyChange(Notes.CONTENT_NOTE_URI, null); } + // 通知数据URI getContext().getContentResolver().notifyChange(uri, null); } - return count; + return count; // 返回更新的行数 } + // 辅助方法，用于解析选择条件 private String parseSelection(String selection) { - return (!TextUtils.isEmpty(selection) ? " AND (" + selection + ')' : ""); + return (!TextUtils.isEmpty(selection) ? " AND (" + selection + ')' : ""); // 如果选择条件不为空则添加 AND } + // 辅助方法，用于增加笔记版本 private void increaseNoteVersion(long id, String selection, String[] selectionArgs) { StringBuilder sql = new StringBuilder(120); sql.append("UPDATE "); sql.append(TABLE.NOTE); sql.append(" SET "); sql.append(NoteColumns.VERSION); - sql.append("=" + NoteColumns.VERSION + "+1 "); + sql.append("=" + NoteColumns.VERSION + "+1 "); // 增加版本号 if (id > 0 || !TextUtils.isEmpty(selection)) { - sql.append(" WHERE "); + sql.append(" WHERE "); // 如果有ID或选择条件，添加WHERE } if (id > 0) { - sql.append(NoteColumns.ID + "=" + String.valueOf(id)); + sql.append(NoteColumns.ID + "=" + String.valueOf(id)); // 添加ID条件 } if (!TextUtils.isEmpty(selection)) { + // 处理选择参数 String selectString = id > 0 ? parseSelection(selection) : selection; for (String args : selectionArgs) { - selectString = selectString.replaceFirst("\\?", args); + selectString = selectString.replaceFirst("\\?", args); // 替换占位符 } sql.append(selectString); } - mHelper.getWritableDatabase().execSQL(sql.toString()); + mHelper.getWritableDatabase().execSQL(sql.toString()); // 执行SQL更新版本号 } @Override public String getType(Uri uri) { - // TODO Auto-generated method stub + // 返回特定URI的MIME类型，这里暂时不实现 return null; } From 0244641af056482e33a75a7f616f23dcb0ffd2bf Mon Sep 17 00:00:00 2001 From: jacky-qiao <1102127448@qq.com> Date: Tue, 31 Dec 2024 10:00:20 +0800 Subject: [PATCH 2/5] =?UTF-8?q?gtask/data=E4=B8=AD6=E4=B8=AA=E4=BB=A3?= =?UTF-8?q?=E7=A0=81=E4=BF=AE=E6=94=B9=E5=AE=8C=E6=AF=95?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../net/micode/notes/gtask/data/MetaData.java | 66 ++- .../src/net/micode/notes/gtask/data/Node.java | 71 ++- .../net/micode/notes/gtask/data/SqlData.java | 217 ++++--- .../net/micode/notes/gtask/data/SqlNote.java | 551 +++++++++--------- .../src/net/micode/notes/gtask/data/Task.java | 315 +++++----- .../net/micode/notes/gtask/data/TaskList.java | 219 ++++--- 6 files changed, 744 insertions(+), 695 deletions(-) diff --git a/Notes-master/src/net/micode/notes/gtask/data/MetaData.java b/Notes-master/src/net/micode/notes/gtask/data/MetaData.java index 3a2050b..6225cb0 100644 --- a/Notes-master/src/net/micode/notes/gtask/data/MetaData.java +++ b/Notes-master/src/net/micode/notes/gtask/data/MetaData.java @@ -1,82 +1,94 @@ /* * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net) * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at + * 该文件属于Apache License, Version 2.0（“许可证”）下的版权作品； + * 你不能以不符合许可证的方式使用此文件。 + * 你可以在以下网址获取许可证副本： * * http://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * 除非适用法律要求或书面同意，软件 + * 根据许可证分发是在“原样”基础上进行的， + * 不提供任何形式的保证或条件，无论是明示或暗示的。 + * 查看许可证以获取有关权限和 + * 限制的具体信息。 */ -package net.micode.notes.gtask.data; +package net.micode.notes.gtask.data; // 定义该类的位置 -import android.database.Cursor; -import android.util.Log; +import android.database.Cursor; // 导入Android的Cursor类，用于数据库操作 +import android.util.Log; // 导入Android的Log类，用于日志输出 -import net.micode.notes.tool.GTaskStringUtils; - -import org.json.JSONException; -import org.json.JSONObject; +import net.micode.notes.tool.GTaskStringUtils; // 导入自定义工具类，用于字符串处理 +import org.json.JSONException; // 导入JSON异常处理类 +import org.json.JSONObject; // 导入JSON对象类 +// MetaData类继承自Task类，表示元数据的管理类 public class MetaData extends Task { - private final static String TAG = MetaData.class.getSimpleName(); + private final static String TAG = MetaData.class.getSimpleName(); // 获取当前类名作为日志标签 - private String mRelatedGid = null; + private String mRelatedGid = null; // 声明一个私有属性，用于存储相关的GID + // 设置元数据的方法，接收GID和JSON对象作为参数 public void setMeta(String gid, JSONObject metaInfo) { try { + // 将GID放入metadata信息中 metaInfo.put(GTaskStringUtils.META_HEAD_GTASK_ID, gid); } catch (JSONException e) { + // 捕获JSON异常并记录错误 Log.e(TAG, "failed to put related gid"); } + // 设置笔记内容为JSON对象的字符串表示 setNotes(metaInfo.toString()); + // 设置名称为常量名称 setName(GTaskStringUtils.META_NOTE_NAME); } + // 获取相关GID的方法 public String getRelatedGid() { - return mRelatedGid; + return mRelatedGid; // 返回相关GID } + // 重写isWorthSaving方法，判断是否值得保存 @Override public boolean isWorthSaving() { - return getNotes() != null; + return getNotes() != null; // 如果笔记内容不为空，则值得保存 } + // 重写通过远程JSON设置内容的方法 @Override public void setContentByRemoteJSON(JSONObject js) { - super.setContentByRemoteJSON(js); - if (getNotes() != null) { + super.setContentByRemoteJSON(js); // 调用父类的方法 + if (getNotes() != null) { // 如果笔记内容不为空 try { + // 将笔记内容转换为JSON对象 JSONObject metaInfo = new JSONObject(getNotes().trim()); + // 获取相关GID并保存 mRelatedGid = metaInfo.getString(GTaskStringUtils.META_HEAD_GTASK_ID); } catch (JSONException e) { + // 捕获JSON异常并记录警告 Log.w(TAG, "failed to get related gid"); - mRelatedGid = null; + mRelatedGid = null; // 将相关GID设置为null } } } + // 重写通过本地JSON设置内容的方法，该方法不应被调用 @Override public void setContentByLocalJSON(JSONObject js) { - // this function should not be called - throw new IllegalAccessError("MetaData:setContentByLocalJSON should not be called"); + throw new IllegalAccessError("MetaData:setContentByLocalJSON should not be called"); // 抛出异常，指明不应调用 } + // 重写从内容获取本地JSON的方法，该方法不应被调用 @Override public JSONObject getLocalJSONFromContent() { - throw new IllegalAccessError("MetaData:getLocalJSONFromContent should not be called"); + throw new IllegalAccessError("MetaData:getLocalJSONFromContent should not be called"); // 抛出异常，指明不应调用 } + // 重写获取同步操作的方法，该方法不应被调用 @Override public int getSyncAction(Cursor c) { - throw new IllegalAccessError("MetaData:getSyncAction should not be called"); + throw new IllegalAccessError("MetaData:getSyncAction should not be called"); // 抛出异常，指明不应调用 } - } diff --git a/Notes-master/src/net/micode/notes/gtask/data/Node.java b/Notes-master/src/net/micode/notes/gtask/data/Node.java index 63950e0..a520edc 100644 --- a/Notes-master/src/net/micode/notes/gtask/data/Node.java +++ b/Notes-master/src/net/micode/notes/gtask/data/Node.java @@ -14,88 +14,95 @@ * limitations under the License. */ +// 定义包名 package net.micode.notes.gtask.data; +// 导入必要的类 import android.database.Cursor; - import org.json.JSONObject; +// 抽象类 Node，表示一个数据节点的基本结构 public abstract class Node { - public static final int SYNC_ACTION_NONE = 0; - - public static final int SYNC_ACTION_ADD_REMOTE = 1; - - public static final int SYNC_ACTION_ADD_LOCAL = 2; - - public static final int SYNC_ACTION_DEL_REMOTE = 3; - - public static final int SYNC_ACTION_DEL_LOCAL = 4; - - public static final int SYNC_ACTION_UPDATE_REMOTE = 5; - - public static final int SYNC_ACTION_UPDATE_LOCAL = 6; - - public static final int SYNC_ACTION_UPDATE_CONFLICT = 7; - - public static final int SYNC_ACTION_ERROR = 8; - - private String mGid; - - private String mName; - - private long mLastModified; - - private boolean mDeleted; - + // 定义同步操作的常量 + public static final int SYNC_ACTION_NONE = 0; // 无操作 + public static final int SYNC_ACTION_ADD_REMOTE = 1; // 从远程添加 + public static final int SYNC_ACTION_ADD_LOCAL = 2; // 从本地添加 + public static final int SYNC_ACTION_DEL_REMOTE = 3; // 从远程删除 + public static final int SYNC_ACTION_DEL_LOCAL = 4; // 从本地删除 + public static final int SYNC_ACTION_UPDATE_REMOTE = 5; // 从远程更新 + public static final int SYNC_ACTION_UPDATE_LOCAL = 6; // 从本地更新 + public static final int SYNC_ACTION_UPDATE_CONFLICT = 7; // 更新冲突 + public static final int SYNC_ACTION_ERROR = 8; // 错误操作 + + // 定义节点的属性 + private String mGid; // 唯一标识符 + private String mName; // 节点名称 + private long mLastModified; // 最后修改时间 + private boolean mDeleted; // 是否删除标记 + + // 构造函数，初始化节点属性 public Node() { - mGid = null; - mName = ""; - mLastModified = 0; - mDeleted = false; + mGid = null; // 初始化 Gid 为 null + mName = ""; // 初始化名称为空字符串 + mLastModified = 0; // 初始化最后修改时间为 0 + mDeleted = false; // 初始化删除状态为 false } + // 抽象方法，获取创建操作的 JSON 对象 public abstract JSONObject getCreateAction(int actionId); + // 抽象方法，获取更新操作的 JSON 对象 public abstract JSONObject getUpdateAction(int actionId); + // 抽象方法，通过远程 JSON 设置内容 public abstract void setContentByRemoteJSON(JSONObject js); + // 抽象方法，通过本地 JSON 设置内容 public abstract void setContentByLocalJSON(JSONObject js); + // 抽象方法，从内容获取本地 JSON public abstract JSONObject getLocalJSONFromContent(); + // 抽象方法，从 Cursor 获取同步操作类型 public abstract int getSyncAction(Cursor c); + // 设置 Gid public void setGid(String gid) { this.mGid = gid; } + // 设置名称 public void setName(String name) { this.mName = name; } + // 设置最后修改时间 public void setLastModified(long lastModified) { this.mLastModified = lastModified; } + // 设置删除状态 public void setDeleted(boolean deleted) { this.mDeleted = deleted; } + // 获取 Gid public String getGid() { return this.mGid; } + // 获取名称 public String getName() { return this.mName; } + // 获取最后修改时间 public long getLastModified() { return this.mLastModified; } + // 获取删除状态 public boolean getDeleted() { return this.mDeleted; } - } diff --git a/Notes-master/src/net/micode/notes/gtask/data/SqlData.java b/Notes-master/src/net/micode/notes/gtask/data/SqlData.java index d3ec3be..88e1fe8 100644 --- a/Notes-master/src/net/micode/notes/gtask/data/SqlData.java +++ b/Notes-master/src/net/micode/notes/gtask/data/SqlData.java @@ -1,189 +1,186 @@ /* - * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net) + * 版权所有 (c) 2010-2011 MiCode 开源社区 (www.micode.net) * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at + * 根据 Apache 许可证第 2.0 版（“许可证”）授权； + * 您不得在未遵守许可证的情况下使用此文件。 + * 您可以在以下网址获得许可证的副本： * * http://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * 除非适用法律要求或书面同意，否则根据许可证分发的软件 + * 是在“按原样”基础上分发的，不附带任何明示或暗示的担保或条件。 + * 有关许可证下权限和限制的具体语言，请参阅许可证。 */ -package net.micode.notes.gtask.data; +package net.micode.notes.gtask.data; // 定义包名 -import android.content.ContentResolver; -import android.content.ContentUris; -import android.content.ContentValues; -import android.content.Context; -import android.database.Cursor; -import android.net.Uri; -import android.util.Log; +import android.content.ContentResolver; // 导入ContentResolver类，用于管理内容提供者的操作 +import android.content.ContentUris; // 导入ContentUris类，用于构造内容URI +import android.content.ContentValues; // 导入ContentValues类，用于存储行的列值 +import android.content.Context; // 导入Context类，表示应用环境 +import android.database.Cursor; // 导入Cursor类，用于访问数据库查询结果 +import android.net.Uri; // 导入Uri类，用于表示内容的URI +import android.util.Log; // 导入Log类，用于记录调试信息 -import net.micode.notes.data.Notes; -import net.micode.notes.data.Notes.DataColumns; -import net.micode.notes.data.Notes.DataConstants; -import net.micode.notes.data.Notes.NoteColumns; -import net.micode.notes.data.NotesDatabaseHelper.TABLE; -import net.micode.notes.gtask.exception.ActionFailureException; +import net.micode.notes.data.Notes; // 导入Notes类，表示笔记相关的数据结构 +import net.micode.notes.data.Notes.DataColumns; // 导入数据列常量 +import net.micode.notes.data.Notes.DataConstants; // 导入数据常量 +import net.micode.notes.data.Notes.NoteColumns; // 导入笔记列常量 +import net.micode.notes.data.NotesDatabaseHelper.TABLE; // 导入数据库表名常量 +import net.micode.notes.gtask.exception.ActionFailureException; // 导入自定义异常类 -import org.json.JSONException; -import org.json.JSONObject; +import org.json.JSONException; // 导入JSONException类，用于处理JSON异常 +import org.json.JSONObject; // 导入JSONObject类，表示一个JSON对象 -public class SqlData { - private static final String TAG = SqlData.class.getSimpleName(); +public class SqlData { // 定义SqlData类 + private static final String TAG = SqlData.class.getSimpleName(); // 定义日志标签 - private static final int INVALID_ID = -99999; + private static final int INVALID_ID = -99999; // 定义无效ID常量 + // 定义数据投影数组，包含要查询的列 public static final String[] PROJECTION_DATA = new String[] { DataColumns.ID, DataColumns.MIME_TYPE, DataColumns.CONTENT, DataColumns.DATA1, DataColumns.DATA3 }; + // 列索引常量 public static final int DATA_ID_COLUMN = 0; - public static final int DATA_MIME_TYPE_COLUMN = 1; - public static final int DATA_CONTENT_COLUMN = 2; - public static final int DATA_CONTENT_DATA_1_COLUMN = 3; - public static final int DATA_CONTENT_DATA_3_COLUMN = 4; - private ContentResolver mContentResolver; - - private boolean mIsCreate; - - private long mDataId; - - private String mDataMimeType; - - private String mDataContent; - - private long mDataContentData1; - - private String mDataContentData3; - - private ContentValues mDiffDataValues; + private ContentResolver mContentResolver; // 内容解析器实例 + private boolean mIsCreate; // 标记是否为创建状态 + private long mDataId; // 数据ID + private String mDataMimeType; // 数据MIME类型 + private String mDataContent; // 数据内容 + private long mDataContentData1; // 数据内容的第一个额外字段 + private String mDataContentData3; // 数据内容的第三个额外字段 + private ContentValues mDiffDataValues; // 存储变化的数据值 + // 构造函数，用于创建新的SqlData实例 public SqlData(Context context) { - mContentResolver = context.getContentResolver(); - mIsCreate = true; - mDataId = INVALID_ID; - mDataMimeType = DataConstants.NOTE; - mDataContent = ""; - mDataContentData1 = 0; - mDataContentData3 = ""; - mDiffDataValues = new ContentValues(); + mContentResolver = context.getContentResolver(); // 获取内容解析器 + mIsCreate = true; // 设置为创建状态 + mDataId = INVALID_ID; // 初始化ID为无效值 + mDataMimeType = DataConstants.NOTE; // 默认MIME类型为笔记 + mDataContent = ""; // 初始化内容为空 + mDataContentData1 = 0; // 第一个数据字段初始化为0 + mDataContentData3 = ""; // 第三个数据字段初始化为空 + mDiffDataValues = new ContentValues(); // 创建内容值实例 } + // 构造函数，用于从游标中加载SqlData实例 public SqlData(Context context, Cursor c) { - mContentResolver = context.getContentResolver(); - mIsCreate = false; - loadFromCursor(c); - mDiffDataValues = new ContentValues(); + mContentResolver = context.getContentResolver(); // 获取内容解析器 + mIsCreate = false; // 设置为非创建状态 + loadFromCursor(c); // 从游标加载数据 + mDiffDataValues = new ContentValues(); // 创建内容值实例 } + // 从游标中加载数据到SqlData实例 private void loadFromCursor(Cursor c) { - mDataId = c.getLong(DATA_ID_COLUMN); - mDataMimeType = c.getString(DATA_MIME_TYPE_COLUMN); - mDataContent = c.getString(DATA_CONTENT_COLUMN); - mDataContentData1 = c.getLong(DATA_CONTENT_DATA_1_COLUMN); - mDataContentData3 = c.getString(DATA_CONTENT_DATA_3_COLUMN); + mDataId = c.getLong(DATA_ID_COLUMN); // 获取数据ID + mDataMimeType = c.getString(DATA_MIME_TYPE_COLUMN); // 获取MIME类型 + mDataContent = c.getString(DATA_CONTENT_COLUMN); // 获取内容 + mDataContentData1 = c.getLong(DATA_CONTENT_DATA_1_COLUMN); // 获取第一个数据字段 + mDataContentData3 = c.getString(DATA_CONTENT_DATA_3_COLUMN); // 获取第三个数据字段 } + // 设置内容，从JSONObject填充数据 public void setContent(JSONObject js) throws JSONException { - long dataId = js.has(DataColumns.ID) ? js.getLong(DataColumns.ID) : INVALID_ID; - if (mIsCreate || mDataId != dataId) { - mDiffDataValues.put(DataColumns.ID, dataId); + long dataId = js.has(DataColumns.ID) ? js.getLong(DataColumns.ID) : INVALID_ID; // 获取ID + if (mIsCreate || mDataId != dataId) { // 如果是创建状态或ID不相等 + mDiffDataValues.put(DataColumns.ID, dataId); // 更新变化的ID值 } - mDataId = dataId; + mDataId = dataId; // 更新数据ID String dataMimeType = js.has(DataColumns.MIME_TYPE) ? js.getString(DataColumns.MIME_TYPE) - : DataConstants.NOTE; - if (mIsCreate || !mDataMimeType.equals(dataMimeType)) { - mDiffDataValues.put(DataColumns.MIME_TYPE, dataMimeType); + : DataConstants.NOTE; // 获取MIME类型 + if (mIsCreate || !mDataMimeType.equals(dataMimeType)) { // 如果是创建状态或MIME类型不同 + mDiffDataValues.put(DataColumns.MIME_TYPE, dataMimeType); // 更新变化的MIME类型 } - mDataMimeType = dataMimeType; + mDataMimeType = dataMimeType; // 更新MIME类型 - String dataContent = js.has(DataColumns.CONTENT) ? js.getString(DataColumns.CONTENT) : ""; - if (mIsCreate || !mDataContent.equals(dataContent)) { - mDiffDataValues.put(DataColumns.CONTENT, dataContent); + String dataContent = js.has(DataColumns.CONTENT) ? js.getString(DataColumns.CONTENT) : ""; // 获取内容 + if (mIsCreate || !mDataContent.equals(dataContent)) { // 如果是创建状态或内容不同 + mDiffDataValues.put(DataColumns.CONTENT, dataContent); // 更新变化的内容 } - mDataContent = dataContent; + mDataContent = dataContent; // 更新内容 - long dataContentData1 = js.has(DataColumns.DATA1) ? js.getLong(DataColumns.DATA1) : 0; - if (mIsCreate || mDataContentData1 != dataContentData1) { - mDiffDataValues.put(DataColumns.DATA1, dataContentData1); + long dataContentData1 = js.has(DataColumns.DATA1) ? js.getLong(DataColumns.DATA1) : 0; // 获取第一个数据字段 + if (mIsCreate || mDataContentData1 != dataContentData1) { // 如果是创建状态或字段不同 + mDiffDataValues.put(DataColumns.DATA1, dataContentData1); // 更新变化的第一个数据字段 } - mDataContentData1 = dataContentData1; + mDataContentData1 = dataContentData1; // 更新第一个数据字段 - String dataContentData3 = js.has(DataColumns.DATA3) ? js.getString(DataColumns.DATA3) : ""; - if (mIsCreate || !mDataContentData3.equals(dataContentData3)) { - mDiffDataValues.put(DataColumns.DATA3, dataContentData3); + String dataContentData3 = js.has(DataColumns.DATA3) ? js.getString(DataColumns.DATA3) : ""; // 获取第三个数据字段 + if (mIsCreate || !mDataContentData3.equals(dataContentData3)) { // 如果是创建状态或字段不同 + mDiffDataValues.put(DataColumns.DATA3, dataContentData3); // 更新变化的第三个数据字段 } - mDataContentData3 = dataContentData3; + mDataContentData3 = dataContentData3; // 更新第三个数据字段 } + // 获取内容，返回为JSONObject public JSONObject getContent() throws JSONException { - if (mIsCreate) { - Log.e(TAG, "it seems that we haven't created this in database yet"); - return null; + if (mIsCreate) { // 如果是创建状态 + Log.e(TAG, "it seems that we haven't created this in database yet"); // 记录错误日志 + return null; // 返回null } - JSONObject js = new JSONObject(); + JSONObject js = new JSONObject(); // 创建新的JSON对象 + // 将数据添加到JSON对象中 js.put(DataColumns.ID, mDataId); js.put(DataColumns.MIME_TYPE, mDataMimeType); js.put(DataColumns.CONTENT, mDataContent); js.put(DataColumns.DATA1, mDataContentData1); js.put(DataColumns.DATA3, mDataContentData3); - return js; + return js; // 返回填充的JSON对象 } + // 提交更改到数据库 public void commit(long noteId, boolean validateVersion, long version) { - if (mIsCreate) { - if (mDataId == INVALID_ID && mDiffDataValues.containsKey(DataColumns.ID)) { - mDiffDataValues.remove(DataColumns.ID); + if (mIsCreate) { // 如果是创建状态 + if (mDataId == INVALID_ID && mDiffDataValues.containsKey(DataColumns.ID)) { // 如果ID无效且变化值中包含ID + mDiffDataValues.remove(DataColumns.ID); // 移除变化值中的ID } - mDiffDataValues.put(DataColumns.NOTE_ID, noteId); - Uri uri = mContentResolver.insert(Notes.CONTENT_DATA_URI, mDiffDataValues); + mDiffDataValues.put(DataColumns.NOTE_ID, noteId); // 添加笔记ID到变化值 + Uri uri = mContentResolver.insert(Notes.CONTENT_DATA_URI, mDiffDataValues); // 插入数据 try { - mDataId = Long.valueOf(uri.getPathSegments().get(1)); - } catch (NumberFormatException e) { - Log.e(TAG, "Get note id error :" + e.toString()); - throw new ActionFailureException("create note failed"); + mDataId = Long.valueOf(uri.getPathSegments().get(1)); // 获取新创建的ID + } catch (NumberFormatException e) { // 捕获数字格式异常 + Log.e(TAG, "Get note id error :" + e.toString()); // 记录错误日志 + throw new ActionFailureException("create note failed"); // 抛出创建失败异常 } - } else { - if (mDiffDataValues.size() > 0) { - int result = 0; - if (!validateVersion) { + } else { // 如果不是创建状态 + if (mDiffDataValues.size() > 0) { // 如果有变化值 + int result = 0; // 定义返回结果 + if (!validateVersion) { // 如果不验证版本 result = mContentResolver.update(ContentUris.withAppendedId( - Notes.CONTENT_DATA_URI, mDataId), mDiffDataValues, null, null); - } else { + Notes.CONTENT_DATA_URI, mDataId), mDiffDataValues, null, null); // 更新数据 + } else { // 如果验证版本 result = mContentResolver.update(ContentUris.withAppendedId( Notes.CONTENT_DATA_URI, mDataId), mDiffDataValues, " ? in (SELECT " + NoteColumns.ID + " FROM " + TABLE.NOTE + " WHERE " + NoteColumns.VERSION + "=?)", new String[] { String.valueOf(noteId), String.valueOf(version) - }); + }); // 根据版本更新数据 } - if (result == 0) { - Log.w(TAG, "there is no update. maybe user updates note when syncing"); + if (result == 0) { // 如果没有更新行 + Log.w(TAG, "there is no update. maybe user updates note when syncing"); // 记录警告日志 } } } - mDiffDataValues.clear(); - mIsCreate = false; + mDiffDataValues.clear(); // 清空变化的数据值 + mIsCreate = false; // 设置为非创建状态 } + // 获取数据ID public long getId() { - return mDataId; + return mDataId; // 返回数据ID } } diff --git a/Notes-master/src/net/micode/notes/gtask/data/SqlNote.java b/Notes-master/src/net/micode/notes/gtask/data/SqlNote.java index 79a4095..cb58657 100644 --- a/Notes-master/src/net/micode/notes/gtask/data/SqlNote.java +++ b/Notes-master/src/net/micode/notes/gtask/data/SqlNote.java @@ -16,33 +16,35 @@ package net.micode.notes.gtask.data; -import android.appwidget.AppWidgetManager; -import android.content.ContentResolver; -import android.content.ContentValues; -import android.content.Context; -import android.database.Cursor; -import android.net.Uri; -import android.util.Log; - -import net.micode.notes.data.Notes; -import net.micode.notes.data.Notes.DataColumns; -import net.micode.notes.data.Notes.NoteColumns; -import net.micode.notes.gtask.exception.ActionFailureException; -import net.micode.notes.tool.GTaskStringUtils; -import net.micode.notes.tool.ResourceParser; - -import org.json.JSONArray; -import org.json.JSONException; -import org.json.JSONObject; - -import java.util.ArrayList; - - +// 导入相关的类 +import android.appwidget.AppWidgetManager; // 用于访问小部件管理器 +import android.content.ContentResolver; // 用于访问内容提供者 +import android.content.ContentValues; // 表示一组键值对 +import android.content.Context; // Android的上下文类 +import android.database.Cursor; // 用于访问查询结果 +import android.net.Uri; // 表示统一资源标识符 +import android.util.Log; // 日志记录工具 + +import net.micode.notes.data.Notes; // 引入笔记数据类 +import net.micode.notes.data.Notes.DataColumns; // 数据列常量 +import net.micode.notes.data.Notes.NoteColumns; // 笔记列常量 +import net.micode.notes.gtask.exception.ActionFailureException; // 异常类 +import net.micode.notes.tool.GTaskStringUtils; // 工具类，用于处理GTask字符串 +import net.micode.notes.tool.ResourceParser; // 资源解析工具类 + +import org.json.JSONArray; // 用于处理JSON数组 +import org.json.JSONException; // JSON异常处理 +import org.json.JSONObject; // 用于处理JSON对象 + +import java.util.ArrayList; // 动态数组 + +// SqlNote 类表示笔记的数据库操作 public class SqlNote { - private static final String TAG = SqlNote.class.getSimpleName(); + private static final String TAG = SqlNote.class.getSimpleName(); // 日志标签 - private static final int INVALID_ID = -99999; + private static final int INVALID_ID = -99999; // 无效ID常量 + // 定义查询笔记所需的列 public static final String[] PROJECTION_NOTE = new String[] { NoteColumns.ID, NoteColumns.ALERTED_DATE, NoteColumns.BG_COLOR_ID, NoteColumns.CREATED_DATE, NoteColumns.HAS_ATTACHMENT, NoteColumns.MODIFIED_DATE, @@ -52,454 +54,443 @@ public class SqlNote { NoteColumns.VERSION }; + // 定义各个列的索引常量 public static final int ID_COLUMN = 0; - public static final int ALERTED_DATE_COLUMN = 1; - public static final int BG_COLOR_ID_COLUMN = 2; - public static final int CREATED_DATE_COLUMN = 3; - public static final int HAS_ATTACHMENT_COLUMN = 4; - public static final int MODIFIED_DATE_COLUMN = 5; - public static final int NOTES_COUNT_COLUMN = 6; - public static final int PARENT_ID_COLUMN = 7; - public static final int SNIPPET_COLUMN = 8; - public static final int TYPE_COLUMN = 9; - public static final int WIDGET_ID_COLUMN = 10; - public static final int WIDGET_TYPE_COLUMN = 11; - public static final int SYNC_ID_COLUMN = 12; - public static final int LOCAL_MODIFIED_COLUMN = 13; - public static final int ORIGIN_PARENT_ID_COLUMN = 14; - public static final int GTASK_ID_COLUMN = 15; - public static final int VERSION_COLUMN = 16; - private Context mContext; - - private ContentResolver mContentResolver; - - private boolean mIsCreate; - - private long mId; - - private long mAlertDate; - - private int mBgColorId; - - private long mCreatedDate; - - private int mHasAttachment; - - private long mModifiedDate; - - private long mParentId; - - private String mSnippet; - - private int mType; - - private int mWidgetId; - - private int mWidgetType; - - private long mOriginParent; - - private long mVersion; - - private ContentValues mDiffNoteValues; - - private ArrayList mDataList; - + // 成员变量定义 + private Context mContext; // 上下文对象 + private ContentResolver mContentResolver; // 内容解析器 + private boolean mIsCreate; // 指示是否为新建笔记的标志 + private long mId; // 笔记ID + private long mAlertDate; // 提醒日期 + private int mBgColorId; // 背景颜色ID + private long mCreatedDate; // 创建日期 + private int mHasAttachment; // 是否有附件 + private long mModifiedDate; // 修改日期 + private long mParentId; // 父级ID + private String mSnippet; // 笔记摘录 + private int mType; // 笔记类型 + private int mWidgetId; // 小部件ID + private int mWidgetType; // 小部件类型 + private long mOriginParent; // 原始父级ID + private long mVersion; // 版本号 + private ContentValues mDiffNoteValues; // 存储变化的笔记值 + private ArrayList mDataList; // 存储笔记数据的列表 + + // 构造函数：创建新的SqlNote实例 public SqlNote(Context context) { - mContext = context; - mContentResolver = context.getContentResolver(); - mIsCreate = true; - mId = INVALID_ID; - mAlertDate = 0; - mBgColorId = ResourceParser.getDefaultBgId(context); - mCreatedDate = System.currentTimeMillis(); - mHasAttachment = 0; - mModifiedDate = System.currentTimeMillis(); - mParentId = 0; - mSnippet = ""; - mType = Notes.TYPE_NOTE; - mWidgetId = AppWidgetManager.INVALID_APPWIDGET_ID; - mWidgetType = Notes.TYPE_WIDGET_INVALIDE; - mOriginParent = 0; - mVersion = 0; - mDiffNoteValues = new ContentValues(); - mDataList = new ArrayList(); + mContext = context; // 设置上下文 + mContentResolver = context.getContentResolver(); // 获取内容解析器 + mIsCreate = true; // 设置为新建状态 + mId = INVALID_ID; // 设置ID为无效值 + mAlertDate = 0; // 初始化提醒日期 + mBgColorId = ResourceParser.getDefaultBgId(context); // 获取默认背景ID + mCreatedDate = System.currentTimeMillis(); // 获取当前时间作为创建日期 + mHasAttachment = 0; // 初始化无附件 + mModifiedDate = System.currentTimeMillis(); // 获取当前时间作为修改日期 + mParentId = 0; // 初始化父级ID + mSnippet = ""; // 初始化笔记摘录 + mType = Notes.TYPE_NOTE; // 默认类型为笔记 + mWidgetId = AppWidgetManager.INVALID_APPWIDGET_ID; // 设置小部件ID为无效值 + mWidgetType = Notes.TYPE_WIDGET_INVALIDE; // 设置小部件类型为无效值 + mOriginParent = 0; // 初始化原始父级ID + mVersion = 0; // 初始化版本号 + mDiffNoteValues = new ContentValues(); // 初始化变化的笔记值 + mDataList = new ArrayList(); // 初始化笔记数据列表 } + // 构造函数：根据Cursor创建SqlNote实例 public SqlNote(Context context, Cursor c) { - mContext = context; - mContentResolver = context.getContentResolver(); - mIsCreate = false; - loadFromCursor(c); - mDataList = new ArrayList(); - if (mType == Notes.TYPE_NOTE) - loadDataContent(); - mDiffNoteValues = new ContentValues(); + mContext = context; // 设置上下文 + mContentResolver = context.getContentResolver(); // 获取内容解析器 + mIsCreate = false; // 设置为非新建状态 + loadFromCursor(c); // 从Cursor加载数据 + mDataList = new ArrayList(); // 初始化笔记数据列表 + if (mType == Notes.TYPE_NOTE) // 如果类型为笔记 + loadDataContent(); // 加载数据内容 + mDiffNoteValues = new ContentValues(); // 初始化变化的笔记值 } + // 构造函数：根据ID创建SqlNote实例 public SqlNote(Context context, long id) { - mContext = context; - mContentResolver = context.getContentResolver(); - mIsCreate = false; - loadFromCursor(id); - mDataList = new ArrayList(); - if (mType == Notes.TYPE_NOTE) - loadDataContent(); - mDiffNoteValues = new ContentValues(); - + mContext = context; // 设置上下文 + mContentResolver = context.getContentResolver(); // 获取内容解析器 + mIsCreate = false; // 设置为非新建状态 + loadFromCursor(id); // 根据ID加载数据 + mDataList = new ArrayList(); // 初始化笔记数据列表 + if (mType == Notes.TYPE_NOTE) // 如果类型为笔记 + loadDataContent(); // 加载数据内容 + mDiffNoteValues = new ContentValues(); // 初始化变化的笔记值 } + // 从Cursor中加载笔记数据 private void loadFromCursor(long id) { - Cursor c = null; + Cursor c = null; // 初始化Cursor try { + // 查询笔记数据 c = mContentResolver.query(Notes.CONTENT_NOTE_URI, PROJECTION_NOTE, "(_id=?)", new String[] { - String.valueOf(id) + String.valueOf(id) // 根据ID查询 }, null); - if (c != null) { - c.moveToNext(); - loadFromCursor(c); + if (c != null) { // 如果Cursor不为空 + c.moveToNext(); // 移动到下一行 + loadFromCursor(c); // 从Cursor加载数据 } else { - Log.w(TAG, "loadFromCursor: cursor = null"); + Log.w(TAG, "loadFromCursor: cursor = null"); // 如果Cursor为空，记录警告日志 } } finally { - if (c != null) + if (c != null) // 关闭Cursor c.close(); } } + // 从Cursor中加载笔记数据 private void loadFromCursor(Cursor c) { - mId = c.getLong(ID_COLUMN); - mAlertDate = c.getLong(ALERTED_DATE_COLUMN); - mBgColorId = c.getInt(BG_COLOR_ID_COLUMN); - mCreatedDate = c.getLong(CREATED_DATE_COLUMN); - mHasAttachment = c.getInt(HAS_ATTACHMENT_COLUMN); - mModifiedDate = c.getLong(MODIFIED_DATE_COLUMN); - mParentId = c.getLong(PARENT_ID_COLUMN); - mSnippet = c.getString(SNIPPET_COLUMN); - mType = c.getInt(TYPE_COLUMN); - mWidgetId = c.getInt(WIDGET_ID_COLUMN); - mWidgetType = c.getInt(WIDGET_TYPE_COLUMN); - mVersion = c.getLong(VERSION_COLUMN); + mId = c.getLong(ID_COLUMN); // 获取ID + mAlertDate = c.getLong(ALERTED_DATE_COLUMN); // 获取提醒日期 + mBgColorId = c.getInt(BG_COLOR_ID_COLUMN); // 获取背景颜色ID + mCreatedDate = c.getLong(CREATED_DATE_COLUMN); // 获取创建日期 + mHasAttachment = c.getInt(HAS_ATTACHMENT_COLUMN); // 获取附件标志 + mModifiedDate = c.getLong(MODIFIED_DATE_COLUMN); // 获取修改日期 + mParentId = c.getLong(PARENT_ID_COLUMN); // 获取父级ID + mSnippet = c.getString(SNIPPET_COLUMN); // 获取笔记摘录 + mType = c.getInt(TYPE_COLUMN); // 获取笔记类型 + mWidgetId = c.getInt(WIDGET_ID_COLUMN); // 获取小部件ID + mWidgetType = c.getInt(WIDGET_TYPE_COLUMN); // 获取小部件类型 + mVersion = c.getLong(VERSION_COLUMN); // 获取版本号 } + // 加载笔记数据内容 private void loadDataContent() { - Cursor c = null; - mDataList.clear(); + Cursor c = null; // 初始化Cursor + mDataList.clear(); // 清空数据列表 try { + // 查询笔记数据内容 c = mContentResolver.query(Notes.CONTENT_DATA_URI, SqlData.PROJECTION_DATA, "(note_id=?)", new String[] { - String.valueOf(mId) + String.valueOf(mId) // 根据笔记ID查询 }, null); - if (c != null) { - if (c.getCount() == 0) { - Log.w(TAG, "it seems that the note has not data"); - return; + if (c != null) { // 如果Cursor不为空 + if (c.getCount() == 0) { // 如果没有数据 + Log.w(TAG, "it seems that the note has not data"); // 记录警告日志 + return; // 返回 } + // 遍历Cursor中的数据 while (c.moveToNext()) { - SqlData data = new SqlData(mContext, c); - mDataList.add(data); + SqlData data = new SqlData(mContext, c); // 创建SqlData实例 + mDataList.add(data); // 添加到数据列表 } } else { - Log.w(TAG, "loadDataContent: cursor = null"); + Log.w(TAG, "loadDataContent: cursor = null"); // 如果Cursor为空，记录警告日志 } } finally { - if (c != null) + if (c != null) // 关闭Cursor c.close(); } } + // 设置笔记内容 public boolean setContent(JSONObject js) { try { - JSONObject note = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); - if (note.getInt(NoteColumns.TYPE) == Notes.TYPE_SYSTEM) { - Log.w(TAG, "cannot set system folder"); - } else if (note.getInt(NoteColumns.TYPE) == Notes.TYPE_FOLDER) { - // for folder we can only update the snnipet and type + JSONObject note = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); // 获取笔记对象 + if (note.getInt(NoteColumns.TYPE) == Notes.TYPE_SYSTEM) { // 如果是系统文件夹 + Log.w(TAG, "cannot set system folder"); // 记录警告日志 + } else if (note.getInt(NoteColumns.TYPE) == Notes.TYPE_FOLDER) { // 如果是文件夹 + // 只更新摘录和类型 String snippet = note.has(NoteColumns.SNIPPET) ? note - .getString(NoteColumns.SNIPPET) : ""; + .getString(NoteColumns.SNIPPET) : ""; // 获取摘录 if (mIsCreate || !mSnippet.equals(snippet)) { - mDiffNoteValues.put(NoteColumns.SNIPPET, snippet); + mDiffNoteValues.put(NoteColumns.SNIPPET, snippet); // 更新摘录 } - mSnippet = snippet; + mSnippet = snippet; // 设置摘录 int type = note.has(NoteColumns.TYPE) ? note.getInt(NoteColumns.TYPE) - : Notes.TYPE_NOTE; + : Notes.TYPE_NOTE; // 获取类型 if (mIsCreate || mType != type) { - mDiffNoteValues.put(NoteColumns.TYPE, type); + mDiffNoteValues.put(NoteColumns.TYPE, type); // 更新类型 } - mType = type; - } else if (note.getInt(NoteColumns.TYPE) == Notes.TYPE_NOTE) { - JSONArray dataArray = js.getJSONArray(GTaskStringUtils.META_HEAD_DATA); - long id = note.has(NoteColumns.ID) ? note.getLong(NoteColumns.ID) : INVALID_ID; + mType = type; // 设置类型 + } else if (note.getInt(NoteColumns.TYPE) == Notes.TYPE_NOTE) { // 如果是笔记 + JSONArray dataArray = js.getJSONArray(GTaskStringUtils.META_HEAD_DATA); // 获取数据数组 + long id = note.has(NoteColumns.ID) ? note.getLong(NoteColumns.ID) : INVALID_ID; // 获取ID if (mIsCreate || mId != id) { - mDiffNoteValues.put(NoteColumns.ID, id); + mDiffNoteValues.put(NoteColumns.ID, id); // 更新ID } - mId = id; + mId = id; // 设置ID long alertDate = note.has(NoteColumns.ALERTED_DATE) ? note - .getLong(NoteColumns.ALERTED_DATE) : 0; + .getLong(NoteColumns.ALERTED_DATE) : 0; // 获取提醒日期 if (mIsCreate || mAlertDate != alertDate) { - mDiffNoteValues.put(NoteColumns.ALERTED_DATE, alertDate); + mDiffNoteValues.put(NoteColumns.ALERTED_DATE, alertDate); // 更新提醒日期 } - mAlertDate = alertDate; + mAlertDate = alertDate; // 设置提醒日期 int bgColorId = note.has(NoteColumns.BG_COLOR_ID) ? note - .getInt(NoteColumns.BG_COLOR_ID) : ResourceParser.getDefaultBgId(mContext); + .getInt(NoteColumns.BG_COLOR_ID) : ResourceParser.getDefaultBgId(mContext); // 获取背景颜色ID if (mIsCreate || mBgColorId != bgColorId) { - mDiffNoteValues.put(NoteColumns.BG_COLOR_ID, bgColorId); + mDiffNoteValues.put(NoteColumns.BG_COLOR_ID, bgColorId); // 更新背景颜色ID } - mBgColorId = bgColorId; + mBgColorId = bgColorId; // 设置背景颜色ID long createDate = note.has(NoteColumns.CREATED_DATE) ? note - .getLong(NoteColumns.CREATED_DATE) : System.currentTimeMillis(); + .getLong(NoteColumns.CREATED_DATE) : System.currentTimeMillis(); // 获取创建日期 if (mIsCreate || mCreatedDate != createDate) { - mDiffNoteValues.put(NoteColumns.CREATED_DATE, createDate); + mDiffNoteValues.put(NoteColumns.CREATED_DATE, createDate); // 更新创建日期 } - mCreatedDate = createDate; + mCreatedDate = createDate; // 设置创建日期 int hasAttachment = note.has(NoteColumns.HAS_ATTACHMENT) ? note - .getInt(NoteColumns.HAS_ATTACHMENT) : 0; + .getInt(NoteColumns.HAS_ATTACHMENT) : 0; // 获取附件标志 if (mIsCreate || mHasAttachment != hasAttachment) { - mDiffNoteValues.put(NoteColumns.HAS_ATTACHMENT, hasAttachment); + mDiffNoteValues.put(NoteColumns.HAS_ATTACHMENT, hasAttachment); // 更新附件标志 } - mHasAttachment = hasAttachment; + mHasAttachment = hasAttachment; // 设置附件标志 long modifiedDate = note.has(NoteColumns.MODIFIED_DATE) ? note - .getLong(NoteColumns.MODIFIED_DATE) : System.currentTimeMillis(); + .getLong(NoteColumns.MODIFIED_DATE) : System.currentTimeMillis(); // 获取修改日期 if (mIsCreate || mModifiedDate != modifiedDate) { - mDiffNoteValues.put(NoteColumns.MODIFIED_DATE, modifiedDate); + mDiffNoteValues.put(NoteColumns.MODIFIED_DATE, modifiedDate); // 更新修改日期 } - mModifiedDate = modifiedDate; + mModifiedDate = modifiedDate; // 设置修改日期 long parentId = note.has(NoteColumns.PARENT_ID) ? note - .getLong(NoteColumns.PARENT_ID) : 0; + .getLong(NoteColumns.PARENT_ID) : 0; // 获取父级ID if (mIsCreate || mParentId != parentId) { - mDiffNoteValues.put(NoteColumns.PARENT_ID, parentId); + mDiffNoteValues.put(NoteColumns.PARENT_ID, parentId); // 更新父级ID } - mParentId = parentId; + mParentId = parentId; // 设置父级ID String snippet = note.has(NoteColumns.SNIPPET) ? note - .getString(NoteColumns.SNIPPET) : ""; + .getString(NoteColumns.SNIPPET) : ""; // 获取摘录 if (mIsCreate || !mSnippet.equals(snippet)) { - mDiffNoteValues.put(NoteColumns.SNIPPET, snippet); + mDiffNoteValues.put(NoteColumns.SNIPPET, snippet); // 更新摘录 } - mSnippet = snippet; + mSnippet = snippet; // 设置摘录 int type = note.has(NoteColumns.TYPE) ? note.getInt(NoteColumns.TYPE) - : Notes.TYPE_NOTE; + : Notes.TYPE_NOTE; // 获取类型 if (mIsCreate || mType != type) { - mDiffNoteValues.put(NoteColumns.TYPE, type); + mDiffNoteValues.put(NoteColumns.TYPE, type); // 更新类型 } - mType = type; + mType = type; // 设置类型 int widgetId = note.has(NoteColumns.WIDGET_ID) ? note.getInt(NoteColumns.WIDGET_ID) - : AppWidgetManager.INVALID_APPWIDGET_ID; + : AppWidgetManager.INVALID_APPWIDGET_ID; // 获取小部件ID if (mIsCreate || mWidgetId != widgetId) { - mDiffNoteValues.put(NoteColumns.WIDGET_ID, widgetId); + mDiffNoteValues.put(NoteColumns.WIDGET_ID, widgetId); // 更新小部件ID } - mWidgetId = widgetId; + mWidgetId = widgetId; // 设置小部件ID int widgetType = note.has(NoteColumns.WIDGET_TYPE) ? note - .getInt(NoteColumns.WIDGET_TYPE) : Notes.TYPE_WIDGET_INVALIDE; + .getInt(NoteColumns.WIDGET_TYPE) : Notes.TYPE_WIDGET_INVALIDE; // 获取小部件类型 if (mIsCreate || mWidgetType != widgetType) { - mDiffNoteValues.put(NoteColumns.WIDGET_TYPE, widgetType); + mDiffNoteValues.put(NoteColumns.WIDGET_TYPE, widgetType); // 更新小部件类型 } - mWidgetType = widgetType; + mWidgetType = widgetType; // 设置小部件类型 long originParent = note.has(NoteColumns.ORIGIN_PARENT_ID) ? note - .getLong(NoteColumns.ORIGIN_PARENT_ID) : 0; + .getLong(NoteColumns.ORIGIN_PARENT_ID) : 0; // 获取原始父级ID if (mIsCreate || mOriginParent != originParent) { - mDiffNoteValues.put(NoteColumns.ORIGIN_PARENT_ID, originParent); + mDiffNoteValues.put(NoteColumns.ORIGIN_PARENT_ID, originParent); // 更新原始父级ID } - mOriginParent = originParent; + mOriginParent = originParent; // 设置原始父级ID + // 加载数据数组中的每一项 for (int i = 0; i < dataArray.length(); i++) { - JSONObject data = dataArray.getJSONObject(i); - SqlData sqlData = null; - if (data.has(DataColumns.ID)) { - long dataId = data.getLong(DataColumns.ID); - for (SqlData temp : mDataList) { + JSONObject data = dataArray.getJSONObject(i); // 获取JSON数据对象 + SqlData sqlData = null; // 初始化SqlData对象 + if (data.has(DataColumns.ID)) { // 如果数据中有ID + long dataId = data.getLong(DataColumns.ID); // 获取数据ID + for (SqlData temp : mDataList) { // 查找对应的SqlData实例 if (dataId == temp.getId()) { - sqlData = temp; + sqlData = temp; // 找到对应的SqlData } } } - if (sqlData == null) { - sqlData = new SqlData(mContext); - mDataList.add(sqlData); + if (sqlData == null) { // 如果没有找到对应的SqlData + sqlData = new SqlData(mContext); // 创建新的SqlData实例 + mDataList.add(sqlData); // 添加到数据列表 } - sqlData.setContent(data); + sqlData.setContent(data); // 设置SqlData内容 } } - } catch (JSONException e) { - Log.e(TAG, e.toString()); - e.printStackTrace(); - return false; + } catch (JSONException e) { // 捕获JSON异常 + Log.e(TAG, e.toString()); // 记录错误日志 + e.printStackTrace(); // 打印堆栈信息 + return false; // 返回false表示失败 } - return true; + return true; // 返回true表示成功 } + // 获取笔记内容 public JSONObject getContent() { try { - JSONObject js = new JSONObject(); + JSONObject js = new JSONObject(); // 创建新的JSON对象 - if (mIsCreate) { - Log.e(TAG, "it seems that we haven't created this in database yet"); - return null; + if (mIsCreate) { // 如果是新建状态 + Log.e(TAG, "it seems that we haven't created this in database yet"); // 记录错误日志 + return null; // 返回null } - JSONObject note = new JSONObject(); - if (mType == Notes.TYPE_NOTE) { - note.put(NoteColumns.ID, mId); - note.put(NoteColumns.ALERTED_DATE, mAlertDate); - note.put(NoteColumns.BG_COLOR_ID, mBgColorId); - note.put(NoteColumns.CREATED_DATE, mCreatedDate); - note.put(NoteColumns.HAS_ATTACHMENT, mHasAttachment); - note.put(NoteColumns.MODIFIED_DATE, mModifiedDate); - note.put(NoteColumns.PARENT_ID, mParentId); - note.put(NoteColumns.SNIPPET, mSnippet); - note.put(NoteColumns.TYPE, mType); - note.put(NoteColumns.WIDGET_ID, mWidgetId); - note.put(NoteColumns.WIDGET_TYPE, mWidgetType); - note.put(NoteColumns.ORIGIN_PARENT_ID, mOriginParent); - js.put(GTaskStringUtils.META_HEAD_NOTE, note); - - JSONArray dataArray = new JSONArray(); - for (SqlData sqlData : mDataList) { - JSONObject data = sqlData.getContent(); - if (data != null) { - dataArray.put(data); + JSONObject note = new JSONObject(); // 创建笔记对象 + if (mType == Notes.TYPE_NOTE) { // 如果类型为笔记 + note.put(NoteColumns.ID, mId); // 添加ID + note.put(NoteColumns.ALERTED_DATE, mAlertDate); // 添加提醒日期 + note.put(NoteColumns.BG_COLOR_ID, mBgColorId); // 添加背景颜色ID + note.put(NoteColumns.CREATED_DATE, mCreatedDate); // 添加创建日期 + note.put(NoteColumns.HAS_ATTACHMENT, mHasAttachment); // 添加附件标志 + note.put(NoteColumns.MODIFIED_DATE, mModifiedDate); // 添加修改日期 + note.put(NoteColumns.PARENT_ID, mParentId); // 添加父级ID + note.put(NoteColumns.SNIPPET, mSnippet); // 添加摘录 + note.put(NoteColumns.TYPE, mType); // 添加笔记类型 + note.put(NoteColumns.WIDGET_ID, mWidgetId); // 添加小部件ID + note.put(NoteColumns.WIDGET_TYPE, mWidgetType); // 添加小部件类型 + note.put(NoteColumns.ORIGIN_PARENT_ID, mOriginParent); // 添加原始父级ID + js.put(GTaskStringUtils.META_HEAD_NOTE, note); // 将笔记对象放入结果JSON + + JSONArray dataArray = new JSONArray(); // 创建数据数组 + for (SqlData sqlData : mDataList) { // 遍历数据列表 + JSONObject data = sqlData.getContent(); // 获取数据的JSON对象 + if (data != null) { // 如果数据不为空 + dataArray.put(data); // 添加到数组 } } - js.put(GTaskStringUtils.META_HEAD_DATA, dataArray); - } else if (mType == Notes.TYPE_FOLDER || mType == Notes.TYPE_SYSTEM) { - note.put(NoteColumns.ID, mId); - note.put(NoteColumns.TYPE, mType); - note.put(NoteColumns.SNIPPET, mSnippet); - js.put(GTaskStringUtils.META_HEAD_NOTE, note); + js.put(GTaskStringUtils.META_HEAD_DATA, dataArray); // 将数据数组放入结果JSON + } else if (mType == Notes.TYPE_FOLDER || mType == Notes.TYPE_SYSTEM) { // 如果是文件夹或系统类型 + note.put(NoteColumns.ID, mId); // 添加ID + note.put(NoteColumns.TYPE, mType); // 添加类型 + note.put(NoteColumns.SNIPPET, mSnippet); // 添加摘录 + js.put(GTaskStringUtils.META_HEAD_NOTE, note); // 将笔记对象放入结果JSON } - return js; - } catch (JSONException e) { - Log.e(TAG, e.toString()); - e.printStackTrace(); + return js; // 返回结果JSON对象 + } catch (JSONException e) { // 捕获JSON异常 + Log.e(TAG, e.toString()); // 记录错误日志 + e.printStackTrace(); // 打印堆栈信息 } - return null; + return null; // 返回null } + // 设置父级ID public void setParentId(long id) { - mParentId = id; - mDiffNoteValues.put(NoteColumns.PARENT_ID, id); + mParentId = id; // 设置父级ID + mDiffNoteValues.put(NoteColumns.PARENT_ID, id); // 更新变化的值 } + // 设置GTask Id public void setGtaskId(String gid) { - mDiffNoteValues.put(NoteColumns.GTASK_ID, gid); + mDiffNoteValues.put(NoteColumns.GTASK_ID, gid); // 更新变化的值 } + // 设置同步ID public void setSyncId(long syncId) { - mDiffNoteValues.put(NoteColumns.SYNC_ID, syncId); + mDiffNoteValues.put(NoteColumns.SYNC_ID, syncId); // 更新变化的值 } + // 重置本地修改标志 public void resetLocalModified() { - mDiffNoteValues.put(NoteColumns.LOCAL_MODIFIED, 0); + mDiffNoteValues.put(NoteColumns.LOCAL_MODIFIED, 0); // 更新变化的值 } + // 获取笔记ID public long getId() { - return mId; + return mId; // 返回ID } + // 获取父级ID public long getParentId() { - return mParentId; + return mParentId; // 返回父级ID } + // 获取笔记摘录 public String getSnippet() { - return mSnippet; + return mSnippet; // 返回摘录 } + // 判断是否为笔记类型 public boolean isNoteType() { - return mType == Notes.TYPE_NOTE; + return mType == Notes.TYPE_NOTE; // 返回类型是否为笔记 } + // 提交笔记到数据库 public void commit(boolean validateVersion) { - if (mIsCreate) { + if (mIsCreate) { // 如果是新建状态 if (mId == INVALID_ID && mDiffNoteValues.containsKey(NoteColumns.ID)) { - mDiffNoteValues.remove(NoteColumns.ID); + mDiffNoteValues.remove(NoteColumns.ID); // 移除ID } - Uri uri = mContentResolver.insert(Notes.CONTENT_NOTE_URI, mDiffNoteValues); + Uri uri = mContentResolver.insert(Notes.CONTENT_NOTE_URI, mDiffNoteValues); // 插入笔记 try { - mId = Long.valueOf(uri.getPathSegments().get(1)); - } catch (NumberFormatException e) { - Log.e(TAG, "Get note id error :" + e.toString()); - throw new ActionFailureException("create note failed"); + mId = Long.valueOf(uri.getPathSegments().get(1)); // 获取笔记ID + } catch (NumberFormatException e) { // 捕获数字格式异常 + Log.e(TAG, "Get note id error :" + e.toString()); // 记录错误日志 + throw new ActionFailureException("create note failed"); // 抛出创建失败异常 } - if (mId == 0) { - throw new IllegalStateException("Create thread id failed"); + if (mId == 0) { // 如果ID为0，表示创建失败 + throw new IllegalStateException("Create thread id failed"); // 抛出异常 } - if (mType == Notes.TYPE_NOTE) { + if (mType == Notes.TYPE_NOTE) { // 如果类型为笔记 for (SqlData sqlData : mDataList) { - sqlData.commit(mId, false, -1); + sqlData.commit(mId, false, -1); // 提交每个SqlData } } - } else { + } else { // 如果不是新建状态 if (mId <= 0 && mId != Notes.ID_ROOT_FOLDER && mId != Notes.ID_CALL_RECORD_FOLDER) { - Log.e(TAG, "No such note"); - throw new IllegalStateException("Try to update note with invalid id"); + Log.e(TAG, "No such note"); // 记录错误日志 + throw new IllegalStateException("Try to update note with invalid id"); // 抛出异常 } - if (mDiffNoteValues.size() > 0) { - mVersion ++; - int result = 0; - if (!validateVersion) { + if (mDiffNoteValues.size() > 0) { // 如果有变化的值 + mVersion++; // 增加版本号 + int result = 0; // 结果初始化 + if (!validateVersion) { // 如果不需要验证版本 result = mContentResolver.update(Notes.CONTENT_NOTE_URI, mDiffNoteValues, "(" + NoteColumns.ID + "=?)", new String[] { - String.valueOf(mId) + String.valueOf(mId) // 根据ID更新 }); - } else { + } else { // 需要验证版本 result = mContentResolver.update(Notes.CONTENT_NOTE_URI, mDiffNoteValues, "(" + NoteColumns.ID + "=?) AND (" + NoteColumns.VERSION + "<=?)", new String[] { - String.valueOf(mId), String.valueOf(mVersion) + String.valueOf(mId), String.valueOf(mVersion) // 根据ID和版本更新 }); } - if (result == 0) { - Log.w(TAG, "there is no update. maybe user updates note when syncing"); + if (result == 0) { // 如果没有更新，可能是同步中 + Log.w(TAG, "there is no update. maybe user updates note when syncing"); // 记录警告日志 } } - if (mType == Notes.TYPE_NOTE) { - for (SqlData sqlData : mDataList) { + if (mType == Notes.TYPE_NOTE) { // 如果类型为笔记 + for (SqlData sqlData : mDataList) { // 提交每个SqlData sqlData.commit(mId, validateVersion, mVersion); } } } - // refresh local info - loadFromCursor(mId); + // 刷新本地信息 + loadFromCursor(mId); // 重新加载笔记数据 if (mType == Notes.TYPE_NOTE) - loadDataContent(); + loadDataContent(); // 重新加载数据内容 - mDiffNoteValues.clear(); - mIsCreate = false; + mDiffNoteValues.clear(); // 清空变化的值 + mIsCreate = false; // 设置为非新建状态 } } diff --git a/Notes-master/src/net/micode/notes/gtask/data/Task.java b/Notes-master/src/net/micode/notes/gtask/data/Task.java index 6a19454..b36e2bd 100644 --- a/Notes-master/src/net/micode/notes/gtask/data/Task.java +++ b/Notes-master/src/net/micode/notes/gtask/data/Task.java @@ -14,338 +14,355 @@ * limitations under the License. */ -package net.micode.notes.gtask.data; +package net.micode.notes.gtask.data; // 声明该类属于 net.micode.notes.gtask.data 包 -import android.database.Cursor; -import android.text.TextUtils; -import android.util.Log; +import android.database.Cursor; // 导入 Cursor 类，用于操作数据库结果集 +import android.text.TextUtils; // 导入 TextUtils 类，用于处理文本操作 +import android.util.Log; // 导入 Log 类，用于日志记录 -import net.micode.notes.data.Notes; -import net.micode.notes.data.Notes.DataColumns; -import net.micode.notes.data.Notes.DataConstants; -import net.micode.notes.data.Notes.NoteColumns; -import net.micode.notes.gtask.exception.ActionFailureException; -import net.micode.notes.tool.GTaskStringUtils; +import net.micode.notes.data.Notes; // 导入 Notes 类，用于引用笔记相关的常量和方法 +import net.micode.notes.data.Notes.DataColumns; // 导入数据列常量 +import net.micode.notes.data.Notes.DataConstants; // 导入数据常量 +import net.micode.notes.data.Notes.NoteColumns; // 导入笔记列常量 +import net.micode.notes.gtask.exception.ActionFailureException; // 导入自定义异常类 +import net.micode.notes.tool.GTaskStringUtils; // 导入工具类，用于处理任务字符串 -import org.json.JSONArray; -import org.json.JSONException; -import org.json.JSONObject; +import org.json.JSONArray; // 导入 JSONArray 类，用于处理 JSON 数组 +import org.json.JSONException; // 导入 JSONException 类，用于处理 JSON 异常 +import org.json.JSONObject; // 导入 JSONObject 类，用于处理 JSON 对象 +// 定义 Task 类，继承自 Node 类 public class Task extends Node { - private static final String TAG = Task.class.getSimpleName(); + private static final String TAG = Task.class.getSimpleName(); // 定义日志标签 - private boolean mCompleted; + private boolean mCompleted; // 任务完成状态 - private String mNotes; + private String mNotes; // 任务备注 - private JSONObject mMetaInfo; + private JSONObject mMetaInfo; // 任务的元信息（JSON 格式） - private Task mPriorSibling; + private Task mPriorSibling; // 任务的前一个兄弟任务 - private TaskList mParent; + private TaskList mParent; // 任务的父任务列表 + // 构造函数，初始化任务的状态 public Task() { - super(); - mCompleted = false; - mNotes = null; - mPriorSibling = null; - mParent = null; - mMetaInfo = null; + super(); // 调用父类构造函数 + mCompleted = false; // 默认未完成 + mNotes = null; // 默认无备注 + mPriorSibling = null; // 默认无前一个兄弟任务 + mParent = null; // 默认无父任务列表 + mMetaInfo = null; // 默认无元信息 } + // 获取创建任务的操作 JSON 对象 public JSONObject getCreateAction(int actionId) { - JSONObject js = new JSONObject(); + JSONObject js = new JSONObject(); // 创建 JSON 对象 try { - // action_type + // action_type - 设置操作类型为创建 js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, GTaskStringUtils.GTASK_JSON_ACTION_TYPE_CREATE); - // action_id + // action_id - 设置操作 ID js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId); - // index + // index - 任务在父任务中的索引位置 js.put(GTaskStringUtils.GTASK_JSON_INDEX, mParent.getChildTaskIndex(this)); - // entity_delta + // entity_delta - 创建任务的实体数据 JSONObject entity = new JSONObject(); - entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName()); - entity.put(GTaskStringUtils.GTASK_JSON_CREATOR_ID, "null"); + entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName()); // 任务名称 + entity.put(GTaskStringUtils.GTASK_JSON_CREATOR_ID, "null"); // 创建者 ID，初始化为 null entity.put(GTaskStringUtils.GTASK_JSON_ENTITY_TYPE, - GTaskStringUtils.GTASK_JSON_TYPE_TASK); + GTaskStringUtils.GTASK_JSON_TYPE_TASK); // 实体类型为任务 if (getNotes() != null) { - entity.put(GTaskStringUtils.GTASK_JSON_NOTES, getNotes()); + entity.put(GTaskStringUtils.GTASK_JSON_NOTES, getNotes()); // 任务备注 } - js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); + js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); // 将实体数据加入 JSON 对象 - // parent_id + // parent_id - 设置父任务 ID js.put(GTaskStringUtils.GTASK_JSON_PARENT_ID, mParent.getGid()); - // dest_parent_type + // dest_parent_type - 设置目标父类型 js.put(GTaskStringUtils.GTASK_JSON_DEST_PARENT_TYPE, GTaskStringUtils.GTASK_JSON_TYPE_GROUP); - // list_id + // list_id - 设置任务列表 ID js.put(GTaskStringUtils.GTASK_JSON_LIST_ID, mParent.getGid()); - // prior_sibling_id + // prior_sibling_id - 设置前一个兄弟任务 ID if (mPriorSibling != null) { js.put(GTaskStringUtils.GTASK_JSON_PRIOR_SIBLING_ID, mPriorSibling.getGid()); } - } catch (JSONException e) { - Log.e(TAG, e.toString()); - e.printStackTrace(); - throw new ActionFailureException("fail to generate task-create jsonobject"); + } catch (JSONException e) { // 捕获 JSON 异常 + Log.e(TAG, e.toString()); // 记录错误日志 + e.printStackTrace(); // 打印堆栈跟踪 + throw new ActionFailureException("fail to generate task-create jsonobject"); // 抛出自定义异常 } - return js; + return js; // 返回创建操作的 JSON 对象 } + // 获取更新任务的操作 JSON 对象 public JSONObject getUpdateAction(int actionId) { - JSONObject js = new JSONObject(); + JSONObject js = new JSONObject(); // 创建 JSON 对象 try { - // action_type + // action_type - 设置操作类型为更新 js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, GTaskStringUtils.GTASK_JSON_ACTION_TYPE_UPDATE); - // action_id + // action_id - 设置操作 ID js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId); - // id + // id - 设置任务 ID js.put(GTaskStringUtils.GTASK_JSON_ID, getGid()); - // entity_delta + // entity_delta - 更新的实体数据 JSONObject entity = new JSONObject(); - entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName()); + entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName()); // 任务名称 if (getNotes() != null) { - entity.put(GTaskStringUtils.GTASK_JSON_NOTES, getNotes()); + entity.put(GTaskStringUtils.GTASK_JSON_NOTES, getNotes()); // 任务备注 } - entity.put(GTaskStringUtils.GTASK_JSON_DELETED, getDeleted()); - js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); + entity.put(GTaskStringUtils.GTASK_JSON_DELETED, getDeleted()); // 任务删除状态 + js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); // 将实体数据加入 JSON 对象 - } catch (JSONException e) { - Log.e(TAG, e.toString()); - e.printStackTrace(); - throw new ActionFailureException("fail to generate task-update jsonobject"); + } catch (JSONException e) { // 捕获 JSON 异常 + Log.e(TAG, e.toString()); // 记录错误日志 + e.printStackTrace(); // 打印堆栈跟踪 + throw new ActionFailureException("fail to generate task-update jsonobject"); // 抛出自定义异常 } - return js; + return js; // 返回更新操作的 JSON 对象 } + // 根据远程 JSON 设置任务内容 public void setContentByRemoteJSON(JSONObject js) { - if (js != null) { + if (js != null) { // 如果 JSON 对象不为空 try { - // id + // id - 获取任务 ID if (js.has(GTaskStringUtils.GTASK_JSON_ID)) { setGid(js.getString(GTaskStringUtils.GTASK_JSON_ID)); } - // last_modified + // last_modified - 获取最后修改时间 if (js.has(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)) { setLastModified(js.getLong(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)); } - // name + // name - 获取任务名称 if (js.has(GTaskStringUtils.GTASK_JSON_NAME)) { setName(js.getString(GTaskStringUtils.GTASK_JSON_NAME)); } - // notes + // notes - 获取任务备注 if (js.has(GTaskStringUtils.GTASK_JSON_NOTES)) { setNotes(js.getString(GTaskStringUtils.GTASK_JSON_NOTES)); } - // deleted + // deleted - 获取任务删除状态 if (js.has(GTaskStringUtils.GTASK_JSON_DELETED)) { setDeleted(js.getBoolean(GTaskStringUtils.GTASK_JSON_DELETED)); } - // completed + // completed - 获取任务完成状态 if (js.has(GTaskStringUtils.GTASK_JSON_COMPLETED)) { setCompleted(js.getBoolean(GTaskStringUtils.GTASK_JSON_COMPLETED)); } - } catch (JSONException e) { - Log.e(TAG, e.toString()); - e.printStackTrace(); - throw new ActionFailureException("fail to get task content from jsonobject"); + } catch (JSONException e) { // 捕获 JSON 异常 + Log.e(TAG, e.toString()); // 记录错误日志 + e.printStackTrace(); // 打印堆栈跟踪 + throw new ActionFailureException("fail to get task content from jsonobject"); // 抛出自定义异常 } } } + // 根据本地 JSON 设置任务内容 public void setContentByLocalJSON(JSONObject js) { if (js == null || !js.has(GTaskStringUtils.META_HEAD_NOTE) - || !js.has(GTaskStringUtils.META_HEAD_DATA)) { - Log.w(TAG, "setContentByLocalJSON: nothing is avaiable"); + || !js.has(GTaskStringUtils.META_HEAD_DATA)) { // 检查 JSON 对象是否包含必要字段 + Log.w(TAG, "setContentByLocalJSON: nothing is avaiable"); // 记录警告日志 } try { - JSONObject note = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); - JSONArray dataArray = js.getJSONArray(GTaskStringUtils.META_HEAD_DATA); + JSONObject note = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); // 获取笔记信息 + JSONArray dataArray = js.getJSONArray(GTaskStringUtils.META_HEAD_DATA); // 获取数据数组 - if (note.getInt(NoteColumns.TYPE) != Notes.TYPE_NOTE) { - Log.e(TAG, "invalid type"); - return; + if (note.getInt(NoteColumns.TYPE) != Notes.TYPE_NOTE) { // 检查笔记类型 + Log.e(TAG, "invalid type"); // 记录错误日志 + return; // 退出 } + // 遍历数据数组，寻找内容 for (int i = 0; i < dataArray.length(); i++) { JSONObject data = dataArray.getJSONObject(i); if (TextUtils.equals(data.getString(DataColumns.MIME_TYPE), DataConstants.NOTE)) { - setName(data.getString(DataColumns.CONTENT)); - break; + setName(data.getString(DataColumns.CONTENT)); // 设置任务名称 + break; // 找到后退出循环 } } - } catch (JSONException e) { - Log.e(TAG, e.toString()); - e.printStackTrace(); + } catch (JSONException e) { // 捕获 JSON 异常 + Log.e(TAG, e.toString()); // 记录错误日志 + e.printStackTrace(); // 打印堆栈跟踪 } } + // 从任务内容生成本地 JSON public JSONObject getLocalJSONFromContent() { - String name = getName(); + String name = getName(); // 获取任务名称 try { - if (mMetaInfo == null) { - // new task created from web - if (name == null) { - Log.w(TAG, "the note seems to be an empty one"); - return null; + if (mMetaInfo == null) { // 如果元信息为空（表示从网页创建的任务） + if (name == null) { // 检查任务名称是否为空 + Log.w(TAG, "the note seems to be an empty one"); // 记录警告日志 + return null; // 返回空 } - JSONObject js = new JSONObject(); - JSONObject note = new JSONObject(); - JSONArray dataArray = new JSONArray(); - JSONObject data = new JSONObject(); - data.put(DataColumns.CONTENT, name); - dataArray.put(data); - js.put(GTaskStringUtils.META_HEAD_DATA, dataArray); - note.put(NoteColumns.TYPE, Notes.TYPE_NOTE); - js.put(GTaskStringUtils.META_HEAD_NOTE, note); - return js; - } else { - // synced task - JSONObject note = mMetaInfo.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); - JSONArray dataArray = mMetaInfo.getJSONArray(GTaskStringUtils.META_HEAD_DATA); + JSONObject js = new JSONObject(); // 创建 JSON 对象 + JSONObject note = new JSONObject(); // 创建笔记对象 + JSONArray dataArray = new JSONArray(); // 创建数据数组 + JSONObject data = new JSONObject(); // 创建数据对象 + data.put(DataColumns.CONTENT, name); // 设置内容为任务名称 + dataArray.put(data); // 将数据对象加入数据数组 + js.put(GTaskStringUtils.META_HEAD_DATA, dataArray); // 将数据数组加入 JSON 对象 + note.put(NoteColumns.TYPE, Notes.TYPE_NOTE); // 设置笔记类型 + js.put(GTaskStringUtils.META_HEAD_NOTE, note); // 将笔记对象加入 JSON 对象 + return js; // 返回 JSON 对象 + } else { // 处理已同步的任务 + JSONObject note = mMetaInfo.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); // 获取笔记对象 + JSONArray dataArray = mMetaInfo.getJSONArray(GTaskStringUtils.META_HEAD_DATA); // 获取数据数组 for (int i = 0; i < dataArray.length(); i++) { JSONObject data = dataArray.getJSONObject(i); if (TextUtils.equals(data.getString(DataColumns.MIME_TYPE), DataConstants.NOTE)) { - data.put(DataColumns.CONTENT, getName()); - break; + data.put(DataColumns.CONTENT, getName()); // 更新内容为任务名称 + break; // 找到后退出循环 } } - note.put(NoteColumns.TYPE, Notes.TYPE_NOTE); - return mMetaInfo; + note.put(NoteColumns.TYPE, Notes.TYPE_NOTE); // 设置笔记类型 + return mMetaInfo; // 返回元信息 JSON 对象 } - } catch (JSONException e) { - Log.e(TAG, e.toString()); - e.printStackTrace(); - return null; + } catch (JSONException e) { // 捕获 JSON 异常 + Log.e(TAG, e.toString()); // 记录错误日志 + e.printStackTrace(); // 打印堆栈跟踪 + return null; // 返回空 } } + // 设置任务的元信息 public void setMetaInfo(MetaData metaData) { - if (metaData != null && metaData.getNotes() != null) { + if (metaData != null && metaData.getNotes() != null) { // 检查元数据和笔记是否为空 try { - mMetaInfo = new JSONObject(metaData.getNotes()); - } catch (JSONException e) { - Log.w(TAG, e.toString()); - mMetaInfo = null; + mMetaInfo = new JSONObject(metaData.getNotes()); // 将笔记设置为元信息的 JSON 对象 + } catch (JSONException e) { // 捕获 JSON 异常 + Log.w(TAG, e.toString()); // 记录警告日志 + mMetaInfo = null; // 将元信息设置为 null } } } + // 获取同步操作类型 public int getSyncAction(Cursor c) { try { JSONObject noteInfo = null; if (mMetaInfo != null && mMetaInfo.has(GTaskStringUtils.META_HEAD_NOTE)) { - noteInfo = mMetaInfo.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); + noteInfo = mMetaInfo.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); // 获取笔记信息 } - if (noteInfo == null) { - Log.w(TAG, "it seems that note meta has been deleted"); - return SYNC_ACTION_UPDATE_REMOTE; + if (noteInfo == null) { // 检查笔记信息是否为 null + Log.w(TAG, "it seems that note meta has been deleted"); // 记录警告日志 + return SYNC_ACTION_UPDATE_REMOTE; // 返回远程更新操作 } - if (!noteInfo.has(NoteColumns.ID)) { - Log.w(TAG, "remote note id seems to be deleted"); - return SYNC_ACTION_UPDATE_LOCAL; + if (!noteInfo.has(NoteColumns.ID)) { // 检查笔记 ID 是否存在 + Log.w(TAG, "remote note id seems to be deleted"); // 记录警告日志 + return SYNC_ACTION_UPDATE_LOCAL; // 返回本地更新操作 } - // validate the note id now + // 验证笔记 ID if (c.getLong(SqlNote.ID_COLUMN) != noteInfo.getLong(NoteColumns.ID)) { - Log.w(TAG, "note id doesn't match"); - return SYNC_ACTION_UPDATE_LOCAL; + Log.w(TAG, "note id doesn't match"); // 记录警告日志 + return SYNC_ACTION_UPDATE_LOCAL; // 返回本地更新操作 } - if (c.getInt(SqlNote.LOCAL_MODIFIED_COLUMN) == 0) { - // there is no local update + if (c.getInt(SqlNote.LOCAL_MODIFIED_COLUMN) == 0) { // 检查本地是否未修改 + // 无本地更新 if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) { - // no update both side - return SYNC_ACTION_NONE; + // 双方均无更新 + return SYNC_ACTION_NONE; // 返回无更新 } else { - // apply remote to local - return SYNC_ACTION_UPDATE_LOCAL; + // 应用远程到本地 + return SYNC_ACTION_UPDATE_LOCAL; // 返回本地更新操作 } } else { - // validate gtask id + // 验证 gtask ID if (!c.getString(SqlNote.GTASK_ID_COLUMN).equals(getGid())) { - Log.e(TAG, "gtask id doesn't match"); - return SYNC_ACTION_ERROR; + Log.e(TAG, "gtask id doesn't match"); // 记录错误日志 + return SYNC_ACTION_ERROR; // 返回错误操作 } if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) { - // local modification only - return SYNC_ACTION_UPDATE_REMOTE; + // 仅本地修改 + return SYNC_ACTION_UPDATE_REMOTE; // 返回远程更新操作 } else { - return SYNC_ACTION_UPDATE_CONFLICT; + return SYNC_ACTION_UPDATE_CONFLICT; // 返回冲突操作 } } - } catch (Exception e) { - Log.e(TAG, e.toString()); - e.printStackTrace(); + } catch (Exception e) { // 捕获异常 + Log.e(TAG, e.toString()); // 记录错误日志 + e.printStackTrace(); // 打印堆栈跟踪 } - return SYNC_ACTION_ERROR; + return SYNC_ACTION_ERROR; // 默认返回错误操作 } + // 判断任务是否值得保存 public boolean isWorthSaving() { return mMetaInfo != null || (getName() != null && getName().trim().length() > 0) - || (getNotes() != null && getNotes().trim().length() > 0); + || (getNotes() != null && getNotes().trim().length() > 0); // 检查是否有元信息、名称或备注 } + // 设置任务完成状态 public void setCompleted(boolean completed) { - this.mCompleted = completed; + this.mCompleted = completed; // 赋值完成状态 } + // 设置任务备注 public void setNotes(String notes) { - this.mNotes = notes; + this.mNotes = notes; // 赋值备注 } + // 设置前一个兄弟任务 public void setPriorSibling(Task priorSibling) { - this.mPriorSibling = priorSibling; + this.mPriorSibling = priorSibling; // 赋值前一个兄弟任务 } + // 设置父任务列表 public void setParent(TaskList parent) { - this.mParent = parent; + this.mParent = parent; // 赋值父任务列表 } + // 获取任务完成状态 public boolean getCompleted() { - return this.mCompleted; + return this.mCompleted; // 返回完成状态 } + // 获取任务备注 public String getNotes() { - return this.mNotes; + return this.mNotes; // 返回备注 } + // 获取前一个兄弟任务 public Task getPriorSibling() { - return this.mPriorSibling; + return this.mPriorSibling; // 返回前一个兄弟任务 } + // 获取父任务列表 public TaskList getParent() { - return this.mParent; + return this.mParent; // 返回父任务列表 } } diff --git a/Notes-master/src/net/micode/notes/gtask/data/TaskList.java b/Notes-master/src/net/micode/notes/gtask/data/TaskList.java index 4ea21c5..d76b4b7 100644 --- a/Notes-master/src/net/micode/notes/gtask/data/TaskList.java +++ b/Notes-master/src/net/micode/notes/gtask/data/TaskList.java @@ -16,156 +16,169 @@ package net.micode.notes.gtask.data; +// 导入所需的类 import android.database.Cursor; import android.util.Log; - import net.micode.notes.data.Notes; import net.micode.notes.data.Notes.NoteColumns; import net.micode.notes.gtask.exception.ActionFailureException; import net.micode.notes.tool.GTaskStringUtils; - import org.json.JSONException; import org.json.JSONObject; - import java.util.ArrayList; - +// TaskList类继承自Node类，表示一个任务列表 public class TaskList extends Node { + // 定义日志标签 private static final String TAG = TaskList.class.getSimpleName(); + // 任务列表的索引 private int mIndex; + // 存储子任务的列表 private ArrayList mChildren; + // TaskList的构造函数，初始化子任务列表和索引 public TaskList() { super(); mChildren = new ArrayList(); - mIndex = 1; + mIndex = 1; // 默认索引为1 } + // 获取创建任务列表的JSON对象 public JSONObject getCreateAction(int actionId) { - JSONObject js = new JSONObject(); + JSONObject js = new JSONObject(); // 创建一个新的JSON对象 try { - // action_type + // 设置动作类型为创建 js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, GTaskStringUtils.GTASK_JSON_ACTION_TYPE_CREATE); - // action_id + // 设置动作ID js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId); - // index + // 设置索引 js.put(GTaskStringUtils.GTASK_JSON_INDEX, mIndex); - // entity_delta + // 创建实体的变化对象 JSONObject entity = new JSONObject(); - entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName()); - entity.put(GTaskStringUtils.GTASK_JSON_CREATOR_ID, "null"); + entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName()); // 设置名称 + entity.put(GTaskStringUtils.GTASK_JSON_CREATOR_ID, "null"); // 创建者ID entity.put(GTaskStringUtils.GTASK_JSON_ENTITY_TYPE, - GTaskStringUtils.GTASK_JSON_TYPE_GROUP); - js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); + GTaskStringUtils.GTASK_JSON_TYPE_GROUP); // 实体类型 + js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); // 将实体变化对象放入主对象中 } catch (JSONException e) { - Log.e(TAG, e.toString()); + Log.e(TAG, e.toString()); // 打印错误日志 e.printStackTrace(); - throw new ActionFailureException("fail to generate tasklist-create jsonobject"); + throw new ActionFailureException("fail to generate tasklist-create jsonobject"); // 抛出异常 } - return js; + return js; // 返回生成的JSON对象 } + // 获取更新任务列表的JSON对象 public JSONObject getUpdateAction(int actionId) { - JSONObject js = new JSONObject(); + JSONObject js = new JSONObject(); // 创建一个新的JSON对象 try { - // action_type + // 设置动作类型为更新 js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, GTaskStringUtils.GTASK_JSON_ACTION_TYPE_UPDATE); - // action_id + // 设置动作ID js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId); - // id + // 设置任务列表ID js.put(GTaskStringUtils.GTASK_JSON_ID, getGid()); - // entity_delta + // 创建实体的变化对象 JSONObject entity = new JSONObject(); - entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName()); - entity.put(GTaskStringUtils.GTASK_JSON_DELETED, getDeleted()); - js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); + entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName()); // 设置名称 + entity.put(GTaskStringUtils.GTASK_JSON_DELETED, getDeleted()); // 设置删除状态 + js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); // 将实体变化对象放入主对象中 } catch (JSONException e) { - Log.e(TAG, e.toString()); + Log.e(TAG, e.toString()); // 打印错误日志 e.printStackTrace(); - throw new ActionFailureException("fail to generate tasklist-update jsonobject"); + throw new ActionFailureException("fail to generate tasklist-update jsonobject"); // 抛出异常 } - return js; + return js; // 返回生成的JSON对象 } + // 根据远程JSON设置任务列表的内容 public void setContentByRemoteJSON(JSONObject js) { if (js != null) { try { - // id + // 设置任务列表ID if (js.has(GTaskStringUtils.GTASK_JSON_ID)) { setGid(js.getString(GTaskStringUtils.GTASK_JSON_ID)); } - // last_modified + // 设置最后修改时间 if (js.has(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)) { setLastModified(js.getLong(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)); } - // name + // 设置名称 if (js.has(GTaskStringUtils.GTASK_JSON_NAME)) { setName(js.getString(GTaskStringUtils.GTASK_JSON_NAME)); } } catch (JSONException e) { - Log.e(TAG, e.toString()); + Log.e(TAG, e.toString()); // 打印错误日志 e.printStackTrace(); - throw new ActionFailureException("fail to get tasklist content from jsonobject"); + throw new ActionFailureException("fail to get tasklist content from jsonobject"); // 抛出异常 } } } + // 根据本地JSON设置任务列表的内容 public void setContentByLocalJSON(JSONObject js) { + // 检查JSON对象是否有效 if (js == null || !js.has(GTaskStringUtils.META_HEAD_NOTE)) { - Log.w(TAG, "setContentByLocalJSON: nothing is avaiable"); + Log.w(TAG, "setContentByLocalJSON: nothing is avaiable"); // 发出警告日志 } try { + // 获取任务列表的文件夹对象 JSONObject folder = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); + // 根据文件夹类型设置名称 if (folder.getInt(NoteColumns.TYPE) == Notes.TYPE_FOLDER) { String name = folder.getString(NoteColumns.SNIPPET); - setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX + name); + setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX + name); // 设置文件夹名称 } else if (folder.getInt(NoteColumns.TYPE) == Notes.TYPE_SYSTEM) { + // 检查系统文件夹ID并设置相应名称 if (folder.getLong(NoteColumns.ID) == Notes.ID_ROOT_FOLDER) setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_DEFAULT); else if (folder.getLong(NoteColumns.ID) == Notes.ID_CALL_RECORD_FOLDER) setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_CALL_NOTE); else - Log.e(TAG, "invalid system folder"); + Log.e(TAG, "invalid system folder"); // 打印错误日志 } else { - Log.e(TAG, "error type"); + Log.e(TAG, "error type"); // 打印错误日志 } } catch (JSONException e) { - Log.e(TAG, e.toString()); + Log.e(TAG, e.toString()); // 打印错误日志 e.printStackTrace(); } } + // 从内容生成本地JSON对象 public JSONObject getLocalJSONFromContent() { try { - JSONObject js = new JSONObject(); - JSONObject folder = new JSONObject(); + JSONObject js = new JSONObject(); // 创建一个新的JSON对象 + JSONObject folder = new JSONObject(); // 创建文件夹的JSON对象 - String folderName = getName(); + String folderName = getName(); // 获取任务列表名称 if (getName().startsWith(GTaskStringUtils.MIUI_FOLDER_PREFFIX)) folderName = folderName.substring(GTaskStringUtils.MIUI_FOLDER_PREFFIX.length(), - folderName.length()); + folderName.length()); // 去掉前缀 + + // 设置文件夹名称和类型 folder.put(NoteColumns.SNIPPET, folderName); if (folderName.equals(GTaskStringUtils.FOLDER_DEFAULT) || folderName.equals(GTaskStringUtils.FOLDER_CALL_NOTE)) @@ -173,171 +186,183 @@ public class TaskList extends Node { else folder.put(NoteColumns.TYPE, Notes.TYPE_FOLDER); - js.put(GTaskStringUtils.META_HEAD_NOTE, folder); + js.put(GTaskStringUtils.META_HEAD_NOTE, folder); // 将文件夹对象放入主对象中 - return js; + return js; // 返回生成的JSON对象 } catch (JSONException e) { - Log.e(TAG, e.toString()); + Log.e(TAG, e.toString()); // 打印错误日志 e.printStackTrace(); - return null; + return null; // 出现异常时返回null } } + // 获取同步操作 public int getSyncAction(Cursor c) { try { if (c.getInt(SqlNote.LOCAL_MODIFIED_COLUMN) == 0) { - // there is no local update + // 本地没有更新 if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) { - // no update both side - return SYNC_ACTION_NONE; + // 本地和远程都没有更新 + return SYNC_ACTION_NONE; // 返回无操作 } else { - // apply remote to local + // 将远程应用到本地 return SYNC_ACTION_UPDATE_LOCAL; } } else { - // validate gtask id + // 校验任务ID if (!c.getString(SqlNote.GTASK_ID_COLUMN).equals(getGid())) { - Log.e(TAG, "gtask id doesn't match"); - return SYNC_ACTION_ERROR; + Log.e(TAG, "gtask id doesn't match"); // 打印错误日志 + return SYNC_ACTION_ERROR; // 返回错误状态 } if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) { - // local modification only + // 仅本地修改 return SYNC_ACTION_UPDATE_REMOTE; } else { - // for folder conflicts, just apply local modification + // 对于文件夹冲突，采用本地修改 return SYNC_ACTION_UPDATE_REMOTE; } } } catch (Exception e) { - Log.e(TAG, e.toString()); + Log.e(TAG, e.toString()); // 打印错误日志 e.printStackTrace(); } - return SYNC_ACTION_ERROR; + return SYNC_ACTION_ERROR; // 出现异常时返回错误状态 } + // 获取子任务数量 public int getChildTaskCount() { - return mChildren.size(); + return mChildren.size(); // 返回子任务列表大小 } + // 添加子任务 public boolean addChildTask(Task task) { boolean ret = false; if (task != null && !mChildren.contains(task)) { - ret = mChildren.add(task); + ret = mChildren.add(task); // 尝试添加任务 if (ret) { - // need to set prior sibling and parent + // 需要设置前一个兄弟任务和父任务 task.setPriorSibling(mChildren.isEmpty() ? null : mChildren .get(mChildren.size() - 1)); - task.setParent(this); + task.setParent(this); // 设置父任务 } } - return ret; + return ret; // 返回添加结果 } + // 根据索引添加子任务 public boolean addChildTask(Task task, int index) { if (index < 0 || index > mChildren.size()) { - Log.e(TAG, "add child task: invalid index"); - return false; + Log.e(TAG, "add child task: invalid index"); // 打印错误日志 + return false; // 返回失败 } - int pos = mChildren.indexOf(task); + int pos = mChildren.indexOf(task); // 查找任务在列表中的位置 if (task != null && pos == -1) { - mChildren.add(index, task); + mChildren.add(index, task); // 根据索引添加任务 - // update the task list + // 更新任务列表 Task preTask = null; Task afterTask = null; if (index != 0) - preTask = mChildren.get(index - 1); + preTask = mChildren.get(index - 1); // 获取前一个任务 if (index != mChildren.size() - 1) - afterTask = mChildren.get(index + 1); + afterTask = mChildren.get(index + 1); // 获取后一个任务 - task.setPriorSibling(preTask); + task.setPriorSibling(preTask); // 设置前一个兄弟任务 if (afterTask != null) - afterTask.setPriorSibling(task); + afterTask.setPriorSibling(task); // 设置后一个兄弟任务 } - return true; + return true; // 返回成功 } + // 移除子任务 public boolean removeChildTask(Task task) { boolean ret = false; - int index = mChildren.indexOf(task); + int index = mChildren.indexOf(task); // 查找任务在列表中的位置 if (index != -1) { - ret = mChildren.remove(task); + ret = mChildren.remove(task); // 尝试移除任务 if (ret) { - // reset prior sibling and parent + // 重置前一个兄弟任务和父任务 task.setPriorSibling(null); task.setParent(null); - // update the task list + // 更新任务列表 if (index != mChildren.size()) { mChildren.get(index).setPriorSibling( - index == 0 ? null : mChildren.get(index - 1)); + index == 0 ? null : mChildren.get(index - 1)); // 更新前一个兄弟任务 } } } - return ret; + return ret; // 返回移除结果 } + // 移动子任务 public boolean moveChildTask(Task task, int index) { - if (index < 0 || index >= mChildren.size()) { - Log.e(TAG, "move child task: invalid index"); - return false; + Log.e(TAG, "move child task: invalid index"); // 打印错误日志 + return false; // 返回失败 } - int pos = mChildren.indexOf(task); + int pos = mChildren.indexOf(task); // 查找任务在列表中的位置 if (pos == -1) { - Log.e(TAG, "move child task: the task should in the list"); - return false; + Log.e(TAG, "move child task: the task should in the list"); // 打印错误日志 + return false; // 返回失败 } if (pos == index) - return true; - return (removeChildTask(task) && addChildTask(task, index)); + return true; // 位置不变返回成功 + return (removeChildTask(task) && addChildTask(task, index)); // 移除并重新添加任务 } + // 根据GID查找子任务 public Task findChildTaskByGid(String gid) { for (int i = 0; i < mChildren.size(); i++) { Task t = mChildren.get(i); if (t.getGid().equals(gid)) { - return t; + return t; // 找到任务返回 } } - return null; + return null; // 未找到返回null } + // 获取子任务索引 public int getChildTaskIndex(Task task) { - return mChildren.indexOf(task); + return mChildren.indexOf(task); // 返回任务在列表中的位置 } + // 根据索引获取子任务 public Task getChildTaskByIndex(int index) { if (index < 0 || index >= mChildren.size()) { - Log.e(TAG, "getTaskByIndex: invalid index"); - return null; + Log.e(TAG, "getTaskByIndex: invalid index"); // 打印错误日志 + return null; // 返回null } - return mChildren.get(index); + return mChildren.get(index); // 返回任务 } + // 根据GID获取子任务 public Task getChilTaskByGid(String gid) { for (Task task : mChildren) { if (task.getGid().equals(gid)) - return task; + return task; // 找到任务返回 } - return null; + return null; // 未找到返回null } + // 获取子任务列表 public ArrayList getChildTaskList() { - return this.mChildren; + return this.mChildren; // 返回子任务列表 } + // 设置索引 public void setIndex(int index) { - this.mIndex = index; + this.mIndex = index; // 设置任务列表索引 } + // 获取索引 public int getIndex() { - return this.mIndex; + return this.mIndex; // 返回任务列表索引 } } From 4f9de7a38485f33da0401b38faeffc078cabb57b Mon Sep 17 00:00:00 2001 From: jacky-qiao <1102127448@qq.com> Date: Tue, 31 Dec 2024 10:02:06 +0800 Subject: [PATCH 3/5] =?UTF-8?q?=E4=BB=A3=E7=A0=81=E6=B3=A8=E9=87=8A?= =?UTF-8?q?=E6=83=85=E5=86=B5=E6=B7=BB=E5=8A=A0=E4=BA=86=E8=87=AA=E5=B7=B1?= =?UTF-8?q?=E4=BF=AE=E6=94=B9=E7=9A=84=E9=83=A8=E5=88=86?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- 代码注释统计.txt | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/代码注释统计.txt b/代码注释统计.txt index 1d455f1..63c4222 100644 --- a/代码注释统计.txt +++ b/代码注释统计.txt @@ -1,12 +1,9 @@ 张晋菡： -widget中3段代码 ui中14段代码 -tool中4段代码 -model中3段代码 -gtask/remote中4段代码 -共计约2000行代码 程星桦： 张鹏展： 文渤乔： +data中4段代码 +gtask/中6段代码 From 073337a9e60508ac6b928d8f64859f999529d6fc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BC=A0=E9=B9=8F=E5=B1=95?= <2740594397@qq.com> Date: Tue, 31 Dec 2024 11:12:02 +0800 Subject: [PATCH 4/5] =?UTF-8?q?gtask=E5=90=8E=E9=9D=A2=E4=B8=A4=E4=B8=AA?= =?UTF-8?q?=E6=96=87=E4=BB=B6=E5=A4=B9exception=E5=92=8Cremote=EF=BC=8Ctoo?= =?UTF-8?q?l=E4=B8=AD=E5=9B=9B=E4=B8=AA=E4=BB=A3=E7=A0=81?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../exception/ActionFailureException.java | 39 + .../exception/NetworkFailureException.java | 41 +- .../notes/gtask/remote/GTaskASyncTask.java | 203 ++-- .../notes/gtask/remote/GTaskClient.java | 916 ++++++++++++------ .../notes/gtask/remote/GTaskManager.java | 378 +++++--- .../notes/gtask/remote/GTaskSyncService.java | 218 ++++- 6 files changed, 1280 insertions(+), 515 deletions(-) diff --git a/Notes-master/src/net/micode/notes/gtask/exception/ActionFailureException.java b/Notes-master/src/net/micode/notes/gtask/exception/ActionFailureException.java index 15504be..be517f6 100644 --- a/Notes-master/src/net/micode/notes/gtask/exception/ActionFailureException.java +++ b/Notes-master/src/net/micode/notes/gtask/exception/ActionFailureException.java @@ -1,33 +1,72 @@ /* * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net) + * // 版权声明，指定代码的版权所有者和代码编写的时间范围 * * Licensed under the Apache License, Version 2.0 (the "License"); + * // 声明该代码是根据Apache License 2.0版本授权的 * you may not use this file except in compliance with the License. + * // 提示使用者，除非符合该许可证的要求，否则不能使用此文件 * You may obtain a copy of the License at + * // 指出如何获取许可证副本 * * http://www.apache.org/licenses/LICENSE-2.0 + * // 许可证的URL链接 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. + * // 指出根据许可证分发的软件是“按现状”提供的，没有明示或暗示的任何保证或条件 */ +<<<<<<< HEAD +package net.micode.notes.gtask.exception; // 定义该类所在的包 +======= package net.micode.notes.gtask.exception; +// 指定该Java文件的包路径 +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae +/** + * ActionFailureException 是一个运行时异常，表示执行操作失败的情况。 + * 这个异常可以通过不同的构造函数来创建，允许提供详细的错误信息和导致异常的原因。 + */ public class ActionFailureException extends RuntimeException { +<<<<<<< HEAD + private static final long serialVersionUID = 4425249765923293627L; // 序列化版本UID，用于序列化机制 +======= + // 声明一个名为ActionFailureException的公共类，该类继承自RuntimeException private static final long serialVersionUID = 4425249765923293627L; + // 声明一个常量serialVersionUID，用于序列化时保持版本的兼容性 +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae + // 默认构造函数 public ActionFailureException() { +<<<<<<< HEAD + super(); // 调用父类的构造函数 +======= super(); + // 默认构造函数，调用父类RuntimeException的无参构造函数 +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae } + // 带有错误信息的构造函数 public ActionFailureException(String paramString) { +<<<<<<< HEAD + super(paramString); // 调用父类构造函数，传递错误信息 +======= super(paramString); + // 带有一个字符串参数的构造函数，调用父类RuntimeException的带字符串参数的构造函数 +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae } + // 带有错误信息和根本原因的构造函数 public ActionFailureException(String paramString, Throwable paramThrowable) { +<<<<<<< HEAD + super(paramString, paramThrowable); // 调用父类构造函数，传递错误信息和原因 +======= super(paramString, paramThrowable); + // 带有一个字符串和一个Throwable参数的构造函数，调用父类RuntimeException的相应构造函数 +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae } } diff --git a/Notes-master/src/net/micode/notes/gtask/exception/NetworkFailureException.java b/Notes-master/src/net/micode/notes/gtask/exception/NetworkFailureException.java index b08cfb1..278a3bb 100644 --- a/Notes-master/src/net/micode/notes/gtask/exception/NetworkFailureException.java +++ b/Notes-master/src/net/micode/notes/gtask/exception/NetworkFailureException.java @@ -14,20 +14,55 @@ * limitations under the License. */ +<<<<<<< HEAD +package net.micode.notes.gtask.exception; // 定义包路径 + +/** + * NetworkFailureException 是一个自定义异常类， + * 用于表示网络故障的相关异常情况。 + */ +public class NetworkFailureException extends Exception { + // 序列版本UID，用于序列化 + private static final long serialVersionUID = 2107610287180234136L; + + // 默认构造函数 +======= +// 该类所属的包名，表明这个类是位于net.micode.notes.gtask.exception包下，用于存放相关的异常类 package net.micode.notes.gtask.exception; +// NetworkFailureException类继承自Exception，用于表示网络相关的操作出现故障时抛出的异常情况 public class NetworkFailureException extends Exception { + // 序列化版本号，用于在对象序列化和反序列化过程中确保版本的兼容性，这里是一个固定的长整型数值 private static final long serialVersionUID = 2107610287180234136L; + // 无参构造函数，调用父类（Exception）的无参构造函数，用于创建一个默认的NetworkFailureException实例，不附带任何详细信息 +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae public NetworkFailureException() { - super(); + super(); // 调用父类的构造函数 } +<<<<<<< HEAD + // 带有消息的构造函数 +======= + // 带有一个字符串参数的构造函数，该字符串参数通常用于传递异常相关的详细描述信息， + // 调用父类（Exception）的对应构造函数，将传入的字符串作为异常的详细消息 +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae public NetworkFailureException(String paramString) { - super(paramString); + super(paramString); // 调用父类的构造函数，传入异常消息 } +<<<<<<< HEAD + // 带有消息和原因的构造函数 +======= + // 带有一个字符串参数和一个Throwable参数的构造函数，字符串参数用于传递异常相关的详细描述信息， + // Throwable参数通常用于关联引起当前异常的其他异常（例如底层网络库抛出的原始异常等）， + // 调用父类（Exception）的对应构造函数进行初始化，将两个参数传递给父类构造函数 +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae public NetworkFailureException(String paramString, Throwable paramThrowable) { - super(paramString, paramThrowable); + super(paramString, paramThrowable); // 调用父类的构造函数，传入异常消息和原因 } +<<<<<<< HEAD +} +======= } +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae diff --git a/Notes-master/src/net/micode/notes/gtask/remote/GTaskASyncTask.java b/Notes-master/src/net/micode/notes/gtask/remote/GTaskASyncTask.java index 426b9ee..bd3553e 100644 --- a/Notes-master/src/net/micode/notes/gtask/remote/GTaskASyncTask.java +++ b/Notes-master/src/net/micode/notes/gtask/remote/GTaskASyncTask.java @@ -1,151 +1,188 @@ /* * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net) * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at + * 根据Apache License, Version 2.0（以下简称“许可证”）授权； + * 除非遵守许可证，否则不得使用此文件。 + * 你可以在以下网址获得许可证的副本： * * http://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * 除非适用法律要求或书面同意，否则按“原样”提供软件 + * 在许可证下分发，不附带任何明示或暗示的保证或条件。 + * 请参阅许可证，了解有关权限和限制的具体语言。 */ -package net.micode.notes.gtask.remote; +package net.micode.notes.gtask.remote; // 定义包名 -import android.app.Notification; -import android.app.NotificationManager; -import android.app.PendingIntent; -import android.content.Context; -import android.content.Intent; -import android.os.AsyncTask; +import android.app.Notification; // 导入通知相关类 +import android.app.NotificationManager; // 导入通知管理类 +import android.app.PendingIntent; // 导入待处理意图类 +import android.content.Context; // 导入上下文类 +import android.content.Intent; // 导入意图类 +import android.os.AsyncTask; // 导入异步任务类 -import net.micode.notes.R; -import net.micode.notes.ui.NotesListActivity; -import net.micode.notes.ui.NotesPreferenceActivity; +<<<<<<< HEAD +import net.micode.notes.R; // 导入资源文件 +import net.micode.notes.ui.NotesListActivity; // 导入笔记列表活动 +import net.micode.notes.ui.NotesPreferenceActivity; // 导入笔记偏好设置活动 -/** - * GTaskASyncTask 是一个用于在后台执行 Google Task 同步操作的异步任务类。 - * 它继承自 Android 的 AsyncTask 类，处理同步过程中的通知显示和结果处理。 - */ +// 定义GTaskASyncTask类，继承自AsyncTask +public class GTaskASyncTask extends AsyncTask { + + private static int GTASK_SYNC_NOTIFICATION_ID = 5234235; // 定义用于同步通知的ID + + // 定义完成监听器接口 +======= +// 异步任务类，用于执行GTask同步操作 public class GTaskASyncTask extends AsyncTask { - // 定义 Google Task 同步的通知 ID + // 定义GTASK同步通知的ID private static int GTASK_SYNC_NOTIFICATION_ID = 5234235; - /** - * 定义接口 OnCompleteListener，用于在同步完成后执行特定的操作 - */ + // 定义完成监听接口 +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae public interface OnCompleteListener { - void onComplete(); + void onComplete(); // 监听完成事件 } - // 上下文环境 - private Context mContext; +<<<<<<< HEAD + private Context mContext; // 上下文 + private NotificationManager mNotifiManager; // 通知管理器 + private GTaskManager mTaskManager; // 任务管理器 + private OnCompleteListener mOnCompleteListener; // 完成监听器 + // 构造函数，初始化上下文和监听器 +======= + // 上下文对象 + private Context mContext; // 通知管理器 private NotificationManager mNotifiManager; - - // Google Task 管理器 + // 任务管理器 private GTaskManager mTaskManager; - - // 同步完成后的监听器 + // 完成监听器 private OnCompleteListener mOnCompleteListener; - /** - * 构造函数，初始化上下文环境、监听器、通知管理器和 Google Task 管理器 - * @param context 应用程序的上下文环境 - * @param listener 同步完成后的监听器 - */ + // 构造函数，初始化上下文、通知管理器、任务管理器和完成监听器 +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae public GTaskASyncTask(Context context, OnCompleteListener listener) { - mContext = context; - mOnCompleteListener = listener; - mNotifiManager = (NotificationManager) mContext.getSystemService(Context.NOTIFICATION_SERVICE); - mTaskManager = GTaskManager.getInstance(); + mContext = context; // 设置上下文 + mOnCompleteListener = listener; // 设置完成监听器 + mNotifiManager = (NotificationManager) mContext + .getSystemService(Context.NOTIFICATION_SERVICE); // 获取通知服务 + mTaskManager = GTaskManager.getInstance(); // 获取任务管理器实例 } - /** - * 取消同步操作 - */ +<<<<<<< HEAD + // 取消同步 +======= + // 取消同步的方法 +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae public void cancelSync() { - mTaskManager.cancelSync(); + mTaskManager.cancelSync(); // 调用任务管理器的取消同步方法 } - /** - * 发布进度信息，显示在通知栏中 - * @param message 进度信息 - */ +<<<<<<< HEAD + // 发布进度 + public void publishProgess(String message) { + publishProgress(new String[] { + message // 发布进度消息 +======= + // 发布进度消息的方法 public void publishProgess(String message) { - publishProgress(new String[]{message}); + publishProgress(new String[] { + message +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae + }); } - /** - * 显示通知的方法 - * @param tickerId 通知的标题资源 ID - * @param content 通知的内容 - */ + // 显示通知的方法 private void showNotification(int tickerId, String content) { - Notification notification = new Notification(R.drawable.notification, mContext.getString(tickerId), System.currentTimeMillis()); + // 创建通知对象 + Notification notification = new Notification(R.drawable.notification, mContext + .getString(tickerId), System.currentTimeMillis()); +<<<<<<< HEAD + notification.defaults = Notification.DEFAULT_LIGHTS; // 设置默认灯光效果 + notification.flags = Notification.FLAG_AUTO_CANCEL; // 设置自动取消标志 + PendingIntent pendingIntent; // 定义待处理意图 + // 根据tickerId判断要跳转的活动 + if (tickerId != R.string.ticker_success) { + pendingIntent = PendingIntent.getActivity(mContext, 0, new Intent(mContext, + NotesPreferenceActivity.class), 0); // 启动偏好设置活动 + +======= notification.defaults = Notification.DEFAULT_LIGHTS; notification.flags = Notification.FLAG_AUTO_CANCEL; + // 根据tickerId创建不同的PendingIntent PendingIntent pendingIntent; if (tickerId != R.string.ticker_success) { - pendingIntent = PendingIntent.getActivity(mContext, 0, new Intent(mContext, NotesPreferenceActivity.class), 0); + pendingIntent = PendingIntent.getActivity(mContext, 0, new Intent(mContext, + NotesPreferenceActivity.class), 0); +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae } else { - pendingIntent = PendingIntent.getActivity(mContext, 0, new Intent(mContext, NotesListActivity.class), 0); + pendingIntent = PendingIntent.getActivity(mContext, 0, new Intent(mContext, + NotesListActivity.class), 0); // 启动笔记列表活动 } - notification.setLatestEventInfo(mContext, mContext.getString(R.string.app_name), content, pendingIntent); + // 设置通知的最新事件信息 + notification.setLatestEventInfo(mContext, mContext.getString(R.string.app_name), content, + pendingIntent); +<<<<<<< HEAD + mNotifiManager.notify(GTASK_SYNC_NOTIFICATION_ID, notification); // 发送通知 +======= + // 发送通知 mNotifiManager.notify(GTASK_SYNC_NOTIFICATION_ID, notification); +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae } - /** - * 在后台线程中执行同步任务 - * @param unused 无用参数 - * @return 同步任务的结果状态码 - */ + // 后台执行同步操作的方法 @Override protected Integer doInBackground(Void... unused) { - publishProgess(mContext.getString(R.string.sync_progress_login, NotesPreferenceActivity.getSyncAccountName(mContext))); - return mTaskManager.sync(mContext, this); + // 发布登录进度 + publishProgess(mContext.getString(R.string.sync_progress_login, NotesPreferenceActivity + .getSyncAccountName(mContext))); + return mTaskManager.sync(mContext, this); // 调用同步方法并返回状态 } - /** - * 当同步过程中有进度更新时调用此方法，在通知栏中显示进度信息 - * @param progress 更新的进度信息 - */ + // 更新进度的方法 @Override protected void onProgressUpdate(String... progress) { - showNotification(R.string.ticker_syncing, progress[0]); + showNotification(R.string.ticker_syncing, progress[0]); // 显示同步进度通知 + // 如果上下文是GTaskSyncService，则广播进度消息 if (mContext instanceof GTaskSyncService) { ((GTaskSyncService) mContext).sendBroadcast(progress[0]); } } - /** - * 同步任务完成后调用此方法，根据结果状态码进行不同的处理 - * @param result 同步任务的结果状态码 - */ + // 执行完毕后的方法 @Override protected void onPostExecute(Integer result) { +<<<<<<< HEAD + // 根据同步结果显示相应的通知 +======= + // 根据结果展示不同的通知 +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae if (result == GTaskManager.STATE_SUCCESS) { - showNotification(R.string.ticker_success, mContext.getString(R.string.success_sync_account, mTaskManager.getSyncAccount())); - NotesPreferenceActivity.setLastSyncTime(mContext, System.currentTimeMillis()); + showNotification(R.string.ticker_success, mContext.getString( + R.string.success_sync_account, mTaskManager.getSyncAccount())); + NotesPreferenceActivity.setLastSyncTime(mContext, System.currentTimeMillis()); // 记录最后同步时间 } else if (result == GTaskManager.STATE_NETWORK_ERROR) { - showNotification(R.string.ticker_fail, mContext.getString(R.string.error_sync_network)); + showNotification(R.string.ticker_fail, mContext.getString(R.string.error_sync_network)); // 显示网络错误通知 } else if (result == GTaskManager.STATE_INTERNAL_ERROR) { - showNotification(R.string.ticker_fail, mContext.getString(R.string.error_sync_internal)); + showNotification(R.string.ticker_fail, mContext.getString(R.string.error_sync_internal)); // 显示内部错误通知 } else if (result == GTaskManager.STATE_SYNC_CANCELLED) { - showNotification(R.string.ticker_cancel, mContext.getString(R.string.error_sync_cancelled)); + showNotification(R.string.ticker_cancel, mContext + .getString(R.string.error_sync_cancelled)); // 显示取消同步通知 } +<<<<<<< HEAD + // 如果存在完成监听器，则在新线程中调用其onComplete方法 +======= + // 如果存在完成监听器，则通知监听器任务完成 +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae if (mOnCompleteListener != null) { new Thread(new Runnable() { public void run() { - mOnCompleteListener.onComplete(); + mOnCompleteListener.onComplete(); // 调用完成监听器的onComplete方法 } }).start(); } } -} +} \ No newline at end of file diff --git a/Notes-master/src/net/micode/notes/gtask/remote/GTaskClient.java b/Notes-master/src/net/micode/notes/gtask/remote/GTaskClient.java index 01ffcb8..beb8e62 100644 --- a/Notes-master/src/net/micode/notes/gtask/remote/GTaskClient.java +++ b/Notes-master/src/net/micode/notes/gtask/remote/GTaskClient.java @@ -1,3 +1,4 @@ +<<<<<<< HEAD /* * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net) * @@ -13,85 +14,127 @@ * See the License for the specific language governing permissions and * limitations under the License. */ - + +// 定义包名 +======= +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae package net.micode.notes.gtask.remote; - -import android.accounts.Account; -import android.accounts.AccountManager; -import android.accounts.AccountManagerFuture; -import android.app.Activity; -import android.os.Bundle; -import android.text.TextUtils; -import android.util.Log; - -import net.micode.notes.gtask.data.Node; -import net.micode.notes.gtask.data.Task; -import net.micode.notes.gtask.data.TaskList; -import net.micode.notes.gtask.exception.ActionFailureException; -import net.micode.notes.gtask.exception.NetworkFailureException; -import net.micode.notes.tool.GTaskStringUtils; -import net.micode.notes.ui.NotesPreferenceActivity; - -import org.apache.http.HttpEntity; -import org.apache.http.HttpResponse; -import org.apache.http.client.ClientProtocolException; -import org.apache.http.client.entity.UrlEncodedFormEntity; -import org.apache.http.client.methods.HttpGet; -import org.apache.http.client.methods.HttpPost; -import org.apache.http.cookie.Cookie; -import org.apache.http.impl.client.BasicCookieStore; -import org.apache.http.impl.client.DefaultHttpClient; -import org.apache.http.message.BasicNameValuePair; -import org.apache.http.params.BasicHttpParams; -import org.apache.http.params.HttpConnectionParams; -import org.apache.http.params.HttpParams; -import org.apache.http.params.HttpProtocolParams; -import org.json.JSONArray; -import org.json.JSONException; -import org.json.JSONObject; - -import java.io.BufferedReader; -import java.io.IOException; -import java.io.InputStream; -import java.io.InputStreamReader; -import java.util.LinkedList; -import java.util.List; -import java.util.zip.GZIPInputStream; -import java.util.zip.Inflater; -import java.util.zip.InflaterInputStream; - - -// GTaskClient 类用于与 Google Tasks 远程服务进行交互 + +// 导入相关类和接口 +import android.accounts.Account; // 引入账户类 +import android.accounts.AccountManager; // 引入账户管理类 +import android.accounts.AccountManagerFuture; // 引入账户管理未来对象类 +import android.app.Activity; // 引入活动类 +import android.os.Bundle; // 引入包类 +import android.text.TextUtils; // 引入文本工具类 +import android.util.Log; // 引入日志工具类 + +// 导入自定义数据模型和异常处理类 +import net.micode.notes.gtask.data.Node; // 引入节点数据模型 +import net.micode.notes.gtask.data.Task; // 引入任务数据模型 +import net.micode.notes.gtask.data.TaskList; // 引入任务列表数据模型 +import net.micode.notes.gtask.exception.ActionFailureException; // 引入动作失败异常 +import net.micode.notes.gtask.exception.NetworkFailureException; // 引入网络失败异常 +import net.micode.notes.tool.GTaskStringUtils; // 引入GTask字符串工具类 +import net.micode.notes.ui.NotesPreferenceActivity; // 引入笔记偏好活动类 + +// 导入Apache HttpClient相关的类 +import org.apache.http.HttpEntity; // 引入HTTP实体类 +import org.apache.http.HttpResponse; // 引入HTTP响应类 +import org.apache.http.client.ClientProtocolException; // 引入客户端协议异常 +import org.apache.http.client.entity.UrlEncodedFormEntity; // 引入URL编码表单实体类 +import org.apache.http.client.methods.HttpGet; // 引入HTTP GET请求类 +import org.apache.http.client.methods.HttpPost; // 引入HTTP POST请求类 +import org.apache.http.cookie.Cookie; // 引入Cookie类 +import org.apache.http.impl.client.BasicCookieStore; // 引入基本Cookie存储类 +import org.apache.http.impl.client.DefaultHttpClient; // 引入默认HTTP客户端类 +import org.apache.http.message.BasicNameValuePair; // 引入基本名称值对类 +import org.apache.http.params.BasicHttpParams; // 引入基本HTTP参数类 +import org.apache.http.params.HttpConnectionParams; // 引入HTTP连接参数类 +import org.apache.http.params.HttpParams; // 引入HTTP参数类 + +// 导入JSON相关的类 +import org.json.JSONArray; // 引入JSON数组类 +import org.json.JSONException; // 引入JSON异常类 +import org.json.JSONObject; // 引入JSON对象类 + +<<<<<<< HEAD +// 引入JDK类 +import java.io.BufferedReader; // 引入缓冲读取器类 +import java.io.IOException; // 引入IO异常类 +import java.io.InputStream; // 引入输入流类 +import java.io.InputStreamReader; // 引入输入流读取器类 +import java.util.LinkedList; // 引入链表类 +import java.util.List; // 引入列表类 +import java.util.zip.GZIPInputStream; // 引入GZIP输入流类 +import java.util.zip.Inflater; // 引入解压缩类 +import java.util.zip.InflaterInputStream; // 引入解压缩输入流类 + +// GTaskClient类负责处理与Google任务(GTask)的通信 +======= +// GTaskClient类用于与Google Tasks进行交互，实现诸如登录、任务和任务列表的创建、更新、移动、删除以及获取相关数据等功能 +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae public class GTaskClient { + // 日志标签 private static final String TAG = GTaskClient.class.getSimpleName(); - + +<<<<<<< HEAD + // Google任务相关的URL private static final String GTASK_URL = "https://mail.google.com/tasks/"; - private static final String GTASK_GET_URL = "https://mail.google.com/tasks/ig"; - +======= + // Google Tasks的基础URL + private static final String GTASK_URL = "https://mail.google.com/tasks/"; + // 用于获取Google Tasks数据的URL + private static final String GTASK_GET_URL = "https://mail.google.com/tasks/ig"; + // 用于向Google Tasks发送POST请求的URL +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae private static final String GTASK_POST_URL = "https://mail.google.com/tasks/r/ig"; - + + // 单例实例 private static GTaskClient mInstance = null; - + +<<<<<<< HEAD + // HTTP客户端 private DefaultHttpClient mHttpClient; - + + // GET和POST请求的URL private String mGetUrl; - private String mPostUrl; - + + // 客户端版本和登录状态相关的字段 private long mClientVersion; - private boolean mLoggedin; - private long mLastLoginTime; - private int mActionId; - private Account mAccount; - + + // 更新数组 private JSONArray mUpdateArray; - - // 私有构造函数，确保只能通过 getInstance 方法获取实例 + + // 私有构造函数，初始化类的成员变量 +======= + // 用于发送HTTP请求的HttpClient对象 + private DefaultHttpClient mHttpClient; + // 获取数据的具体URL + private String mGetUrl; + // 发送POST请求的具体URL + private String mPostUrl; + // 客户端版本号 + private long mClientVersion; + // 标记是否已登录 + private boolean mLoggedin; + // 上次登录的时间戳 + private long mLastLoginTime; + // 用于标识操作的ID，每次操作自增 + private int mActionId; + // 当前使用的账户 + private Account mAccount; + // 用于暂存更新操作相关数据的JSON数组 + private JSONArray mUpdateArray; + + // 私有构造函数，初始化相关成员变量 +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae private GTaskClient() { mHttpClient = null; mGetUrl = GTASK_GET_URL; @@ -103,84 +146,133 @@ public class GTaskClient { mAccount = null; mUpdateArray = null; } - - // 获取 GTaskClient 的单例实例 + +<<<<<<< HEAD + // 获取单例实例 +======= + // 获取GTaskClient的单例实例 +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae public static synchronized GTaskClient getInstance() { if (mInstance == null) { mInstance = new GTaskClient(); } return mInstance; } - - // 登录 Google Tasks，如果已登录则检查登录状态是否过期或账户是否切换 + +<<<<<<< HEAD + // 登录方法 + public boolean login(Activity activity) { + // 假设cookie在5分钟后过期 +======= + // 执行登录操作 public boolean login(Activity activity) { - // we suppose that the cookie would expire after 5 minutes - // then we need to re-login + // 假设Cookie在5分钟后过期，若距离上次登录时间超过5分钟，则需要重新登录 +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae final long interval = 1000 * 60 * 5; if (mLastLoginTime + interval < System.currentTimeMillis()) { - mLoggedin = false; + mLoggedin = false; // 如果超时，设置未登录 } - - // need to re-login after account switch + +<<<<<<< HEAD + // 如果账户切换，需要重新登录 + if (mLoggedin && !TextUtils.equals(getSyncAccount().name, NotesPreferenceActivity.getSyncAccountName(activity))) { + mLoggedin = false; // 账户切换，重新登录 +======= + // 如果已登录，但当前账户与设置中的同步账户不一致，也需要重新登录 if (mLoggedin && !TextUtils.equals(getSyncAccount().name, NotesPreferenceActivity .getSyncAccountName(activity))) { mLoggedin = false; +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae } - + + // 若已经登录，无需再次登录 if (mLoggedin) { Log.d(TAG, "already logged in"); return true; } - + +<<<<<<< HEAD + mLastLoginTime = System.currentTimeMillis(); // 更新最后登录时间 + String authToken = loginGoogleAccount(activity, false); // 获取Google账户的认证令牌 +======= mLastLoginTime = System.currentTimeMillis(); + // 登录Google账户获取授权令牌 String authToken = loginGoogleAccount(activity, false); +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae if (authToken == null) { Log.e(TAG, "login google account failed"); - return false; + return false; // 登录失败 } - - // login with custom domain if necessary + +<<<<<<< HEAD + // 如果为自定义域，则尝试进行登录 + if (!(mAccount.name.toLowerCase().endsWith("gmail.com") || mAccount.name.toLowerCase().endsWith("googlemail.com"))) { +======= + // 如果账户不是以gmail.com或googlemail.com结尾（可能是自定义域名），则使用自定义域名相关的URL进行登录 if (!(mAccount.name.toLowerCase().endsWith("gmail.com") || mAccount.name.toLowerCase() .endsWith("googlemail.com"))) { +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae StringBuilder url = new StringBuilder(GTASK_URL).append("a/"); int index = mAccount.name.indexOf('@') + 1; String suffix = mAccount.name.substring(index); url.append(suffix + "/"); - mGetUrl = url.toString() + "ig"; - mPostUrl = url.toString() + "r/ig"; - + mGetUrl = url.toString() + "ig"; // 更新GET请求的URL + mPostUrl = url.toString() + "r/ig"; // 更新POST请求的URL + if (tryToLoginGtask(activity, authToken)) { - mLoggedin = true; + mLoggedin = true; // 登录成功 } } - - // try to login with google official url + +<<<<<<< HEAD + // 尝试以 Google 官方 URL 登录 +======= + // 如果使用自定义域名登录失败，则尝试使用Google官方URL登录 +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae if (!mLoggedin) { - mGetUrl = GTASK_GET_URL; - mPostUrl = GTASK_POST_URL; + mGetUrl = GTASK_GET_URL; // 恢复默认的GET请求URL + mPostUrl = GTASK_POST_URL; // 恢复默认的POST请求URL if (!tryToLoginGtask(activity, authToken)) { - return false; + return false; // 登录失败 } } - - mLoggedin = true; + + mLoggedin = true; // 设置为已登录 return true; } - - // 获取 Google 账户的认证令牌，如果需要则失效当前令牌 + +<<<<<<< HEAD + // 获取Google账户认证令牌的方法 + private String loginGoogleAccount(Activity activity, boolean invalidateToken) { + String authToken; + AccountManager accountManager = AccountManager.get(activity); // 获取账户管理器 + Account[] accounts = accountManager.getAccountsByType("com.google"); // 获取Google账户 +======= + // 登录Google账户获取授权令牌 private String loginGoogleAccount(Activity activity, boolean invalidateToken) { String authToken; + // 获取账户管理器 AccountManager accountManager = AccountManager.get(activity); + // 获取所有Google类型的账户 Account[] accounts = accountManager.getAccountsByType("com.google"); - +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae + + // 如果没有可用的Google账户，日志记录并返回null if (accounts.length == 0) { Log.e(TAG, "there is no available google account"); return null; } - + +<<<<<<< HEAD + String accountName = NotesPreferenceActivity.getSyncAccountName(activity); // 获取同步的账户名 +======= + // 获取设置中的同步账户名称 String accountName = NotesPreferenceActivity.getSyncAccountName(activity); +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae Account account = null; + + // 找到设置中与账户名匹配的账户 for (Account a : accounts) { if (a.name.equals(accountName)) { account = a; @@ -188,53 +280,83 @@ public class GTaskClient { } } if (account != null) { - mAccount = account; + mAccount = account; // 设置账户 } else { Log.e(TAG, "unable to get an account with the same name in the settings"); - return null; + return null; // 找不到匹配账户，返回null } - - // get the token now + +<<<<<<< HEAD + // 获取认证令牌 + AccountManagerFuture accountManagerFuture = accountManager.getAuthToken(account, "goanna_mobile", null, activity, null, null); +======= + // 获取授权令牌 AccountManagerFuture accountManagerFuture = accountManager.getAuthToken(account, "goanna_mobile", null, activity, null, null); +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae try { - Bundle authTokenBundle = accountManagerFuture.getResult(); - authToken = authTokenBundle.getString(AccountManager.KEY_AUTHTOKEN); + Bundle authTokenBundle = accountManagerFuture.getResult(); // 获取结果 + authToken = authTokenBundle.getString(AccountManager.KEY_AUTHTOKEN); // 读取令牌 + + // 如果需要无效化令牌，则重新获取 if (invalidateToken) { + // 如果需要使令牌失效，则先失效再重新获取 accountManager.invalidateAuthToken("com.google", authToken); - loginGoogleAccount(activity, false); + loginGoogleAccount(activity, false); // 递归调用获取新令牌 } } catch (Exception e) { Log.e(TAG, "get auth token failed"); - authToken = null; + authToken = null; // 获取token失败 } - - return authToken; + + return authToken; // 返回令牌 } - - // 尝试登录 Google Tasks，如果第一次失败则尝试失效认证令牌后重新登录 + +<<<<<<< HEAD + // 尝试登录到GTask + private boolean tryToLoginGtask(Activity activity, String authToken) { + if (!loginGtask(authToken)) { + // 如果认证令牌过期，则无效化并尝试重新登录 +======= + // 尝试登录Google Tasks private boolean tryToLoginGtask(Activity activity, String authToken) { if (!loginGtask(authToken)) { - // maybe the auth token is out of date, now let's invalidate the - // token and try again + // 如果登录失败，可能是授权令牌过期，先使令牌失效再重新尝试登录Google账户获取新令牌，然后再次登录Google Tasks +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae authToken = loginGoogleAccount(activity, true); if (authToken == null) { Log.e(TAG, "login google account failed"); - return false; + return false; // 登录失败 } - + if (!loginGtask(authToken)) { Log.e(TAG, "login gtask failed"); - return false; + return false; // 登录失败 } } - return true; + return true; // 登录成功 } - - // 使用认证令牌登录 Google Tasks 并获取客户端版本 + +<<<<<<< HEAD + // 使用认证令牌登录到GTask + private boolean loginGtask(String authToken) { + int timeoutConnection = 10000; // 连接超时设置 + int timeoutSocket = 15000; // Socket超时设置 + HttpParams httpParameters = new BasicHttpParams(); // 创建基本HTTP参数 + HttpConnectionParams.setConnectionTimeout(httpParameters, timeoutConnection); // 设置连接超时 + HttpConnectionParams.setSoTimeout(httpParameters, timeoutSocket); // 设置Socket超时 + mHttpClient = new DefaultHttpClient(httpParameters); // 创建HTTP客户端 + BasicCookieStore localBasicCookieStore = new BasicCookieStore(); // 创建Cookie存储 + mHttpClient.setCookieStore(localBasicCookieStore); // 设置Cookie存储 + HttpProtocolParams.setUseExpectContinue(mHttpClient.getParams(), false); // 设置HTTP协议参数 + + // 登录GTask +======= + // 实际执行登录Google Tasks的操作，获取相关信息（如客户端版本号等） private boolean loginGtask(String authToken) { int timeoutConnection = 10000; int timeoutSocket = 15000; + // 设置HTTP请求的参数，包括连接超时和读取超时时间 HttpParams httpParameters = new BasicHttpParams(); HttpConnectionParams.setConnectionTimeout(httpParameters, timeoutConnection); HttpConnectionParams.setSoTimeout(httpParameters, timeoutSocket); @@ -242,27 +364,35 @@ public class GTaskClient { BasicCookieStore localBasicCookieStore = new BasicCookieStore(); mHttpClient.setCookieStore(localBasicCookieStore); HttpProtocolParams.setUseExpectContinue(mHttpClient.getParams(), false); - - // login gtask + + // 登录Google Tasks，发送带有授权令牌的GET请求 +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae try { - String loginUrl = mGetUrl + "?auth=" + authToken; - HttpGet httpGet = new HttpGet(loginUrl); - HttpResponse response = null; - response = mHttpClient.execute(httpGet); - - // get the cookie now + String loginUrl = mGetUrl + "?auth=" + authToken; // 创建登录URL + HttpGet httpGet = new HttpGet(loginUrl); // 创建GET请求 + HttpResponse response = mHttpClient.execute(httpGet); // 执行请求 + +<<<<<<< HEAD + // 获取Cookie +======= + // 获取登录后的Cookie信息，检查是否包含认证相关的Cookie（名称包含"GTL"） +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae List cookies = mHttpClient.getCookieStore().getCookies(); - boolean hasAuthCookie = false; + boolean hasAuthCookie = false; // 验证是否存在认证Cookie for (Cookie cookie : cookies) { if (cookie.getName().contains("GTL")) { - hasAuthCookie = true; + hasAuthCookie = true; // 存在认证Cookie } } if (!hasAuthCookie) { - Log.w(TAG, "it seems that there is no auth cookie"); + Log.w(TAG, "it seems that there is no auth cookie"); // 没有认证Cookie的警告 } - - // get the client version + +<<<<<<< HEAD + // 从响应中获取客户端版本 +======= + // 从响应中获取客户端版本号等信息，通过解析返回的JavaScript代码中的相关数据 +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae String resString = getResponseContent(response.getEntity()); String jsBegin = "_setup("; String jsEnd = ")}"; @@ -270,337 +400,567 @@ public class GTaskClient { int end = resString.lastIndexOf(jsEnd); String jsString = null; if (begin != -1 && end != -1 && begin < end) { - jsString = resString.substring(begin + jsBegin.length(), end); + jsString = resString.substring(begin + jsBegin.length(), end); // 提取JSON字符串 } - JSONObject js = new JSONObject(jsString); - mClientVersion = js.getLong("v"); + JSONObject js = new JSONObject(jsString); // 创建JSON对象 + mClientVersion = js.getLong("v"); // 获取客户端版本 } catch (JSONException e) { Log.e(TAG, e.toString()); e.printStackTrace(); - return false; + return false; // 处理JSON异常，返回登录失败 } catch (Exception e) { - // simply catch all exceptions +<<<<<<< HEAD +======= + // 捕获其他所有异常，若发生异常则登录失败 +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae Log.e(TAG, "httpget gtask_url failed"); - return false; + return false; // 处理其他异常，返回登录失败 } - - return true; + + return true; // 登录成功 } - - // 获取并递增一个唯一的动作 ID + +<<<<<<< HEAD + // 获取下一个动作ID +======= + // 获取下一个操作的ID +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae private int getActionId() { - return mActionId++; + return mActionId++; // 返回当前ID并递增 } - - // 创建一个用于发送 POST 请求的 HttpPost 对象，并设置必要的头部信息 + +<<<<<<< HEAD + // 创建HTTP POST请求 +======= + // 创建用于发送POST请求的HttpPost对象，并设置相关请求头 +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae private HttpPost createHttpPost() { - HttpPost httpPost = new HttpPost(mPostUrl); - httpPost.setHeader("Content-Type", "application/x-www-form-urlencoded;charset=utf-8"); - httpPost.setHeader("AT", "1"); - return httpPost; + HttpPost httpPost = new HttpPost(mPostUrl); // 创建POST请求 + httpPost.setHeader("Content-Type", "application/x-www-form-urlencoded;charset=utf-8"); // 设置请求头 + httpPost.setHeader("AT", "1"); // 设置自定义请求头 + return httpPost; // 返回POST请求 } - - // 从 HttpEntity 中读取响应内容，并根据内容编码进行解压 + +<<<<<<< HEAD + // 获取HTTP响应内容 +======= + // 从HTTP实体中获取响应内容，根据内容编码（如gzip、deflate等）进行相应的解压处理 +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae private String getResponseContent(HttpEntity entity) throws IOException { - String contentEncoding = null; + String contentEncoding = null; // 声明内容编码 if (entity.getContentEncoding() != null) { - contentEncoding = entity.getContentEncoding().getValue(); + contentEncoding = entity.getContentEncoding().getValue(); // 获取内容编码 Log.d(TAG, "encoding: " + contentEncoding); } - - InputStream input = entity.getContent(); + + InputStream input = entity.getContent(); // 获取输入流 + // 根据内容编码类型进行处理 if (contentEncoding != null && contentEncoding.equalsIgnoreCase("gzip")) { - input = new GZIPInputStream(entity.getContent()); + input = new GZIPInputStream(entity.getContent()); // 处理GZIP编码 } else if (contentEncoding != null && contentEncoding.equalsIgnoreCase("deflate")) { Inflater inflater = new Inflater(true); - input = new InflaterInputStream(entity.getContent(), inflater); + input = new InflaterInputStream(entity.getContent(), inflater); // 处理Deflate编码 } - + try { - InputStreamReader isr = new InputStreamReader(input); - BufferedReader br = new BufferedReader(isr); - StringBuilder sb = new StringBuilder(); - + InputStreamReader isr = new InputStreamReader(input); // 创建输入流读取器 + BufferedReader br = new BufferedReader(isr); // 创建缓冲读取器 + StringBuilder sb = new StringBuilder(); // 创建字符串构建器 + + // 持续读取内容 while (true) { - String buff = br.readLine(); + String buff = br.readLine(); // 读取一行 if (buff == null) { - return sb.toString(); + return sb.toString(); // 如果没有内容，返回结果 } - sb = sb.append(buff); + sb = sb.append(buff); // 添加读取内容 } } finally { - input.close(); + input.close(); // 关闭输入流 } } - - // 发送 POST 请求并获取响应的 JSONObject + +<<<<<<< HEAD + // 发送POST请求 +======= + // 发送POST请求，将JSON数据发送到Google Tasks服务器，并处理响应返回的JSON数据 +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae private JSONObject postRequest(JSONObject js) throws NetworkFailureException { if (!mLoggedin) { - Log.e(TAG, "please login first"); - throw new ActionFailureException("not logged in"); + Log.e(TAG, "please login first"); // 如果未登录，记录错误 + throw new ActionFailureException("not logged in"); // 抛出异常 } - - HttpPost httpPost = createHttpPost(); + + HttpPost httpPost = createHttpPost(); // 创建POST请求 try { - LinkedList list = new LinkedList(); - list.add(new BasicNameValuePair("r", js.toString())); - UrlEncodedFormEntity entity = new UrlEncodedFormEntity(list, "UTF-8"); - httpPost.setEntity(entity); - - // execute the post + LinkedList list = new LinkedList(); // 创建参数列表 + list.add(new BasicNameValuePair("r", js.toString())); // 添加请求参数 + UrlEncodedFormEntity entity = new UrlEncodedFormEntity(list, "UTF-8"); // 创建实体 + httpPost.setEntity(entity); // 设置POST实体 + +<<<<<<< HEAD + // 执行POST请求并获取响应 +======= + // 执行POST请求并获取响应，然后解析响应内容为JSONObject返回 +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae HttpResponse response = mHttpClient.execute(httpPost); - String jsString = getResponseContent(response.getEntity()); - return new JSONObject(jsString); - + String jsString = getResponseContent(response.getEntity()); // 获取响应内容 + return new JSONObject(jsString); // 返回响应的JSON对象 + } catch (ClientProtocolException e) { Log.e(TAG, e.toString()); e.printStackTrace(); - throw new NetworkFailureException("postRequest failed"); + throw new NetworkFailureException("postRequest failed"); // 抛出网络失败异常 } catch (IOException e) { Log.e(TAG, e.toString()); e.printStackTrace(); - throw new NetworkFailureException("postRequest failed"); + throw new NetworkFailureException("postRequest failed"); // 抛出IO异常 } catch (JSONException e) { Log.e(TAG, e.toString()); e.printStackTrace(); - throw new ActionFailureException("unable to convert response content to jsonobject"); + throw new ActionFailureException("unable to convert response content to jsonobject"); // 抛出JSON转换异常 } catch (Exception e) { Log.e(TAG, e.toString()); e.printStackTrace(); - throw new ActionFailureException("error occurs when posting request"); + throw new ActionFailureException("error occurs when posting request"); // 其它异常处理 } } - - // 创建一个新的任务，并发送相应的 POST 请求到 Google Tasks + +<<<<<<< HEAD + // 创建任务 +======= + // 创建一个任务并发送到Google Tasks服务器 +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae public void createTask(Task task) throws NetworkFailureException { - commitUpdate(); + commitUpdate(); // 提交更新 try { - JSONObject jsPost = new JSONObject(); - JSONArray actionList = new JSONArray(); - - // action_list + JSONObject jsPost = new JSONObject(); // 创建JSON对象 + JSONArray actionList = new JSONArray(); // 创建动作列表 + +<<<<<<< HEAD + // 添加创建动作到动作列表 +======= + // 将任务的创建操作添加到操作列表中 +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae actionList.put(task.getCreateAction(getActionId())); - jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList); - - // client version + jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList); // 添加动作列表到JSON对象 + +<<<<<<< HEAD + // 添加客户端版本到JSON对象 + jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion); + + // 执行POST请求 +======= + // 设置客户端版本号 jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion); - - // post + + // 发送POST请求并处理响应，获取新创建任务的ID并设置到任务对象中 +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae JSONObject jsResponse = postRequest(jsPost); - JSONObject jsResult = (JSONObject) jsResponse.getJSONArray( - GTaskStringUtils.GTASK_JSON_RESULTS).get(0); - task.setGid(jsResult.getString(GTaskStringUtils.GTASK_JSON_NEW_ID)); - + JSONObject jsResult = (JSONObject) jsResponse.getJSONArray(GTaskStringUtils.GTASK_JSON_RESULTS).get(0); // 获取返回结果 + task.setGid(jsResult.getString(GTaskStringUtils.GTASK_JSON_NEW_ID)); // 设置任务的ID + } catch (JSONException e) { Log.e(TAG, e.toString()); e.printStackTrace(); - throw new ActionFailureException("create task: handing jsonobject failed"); + throw new ActionFailureException("create task: handing jsonobject failed"); // 抛出JSON处理异常 } } - - // 创建一个新的任务列表，并发送相应的 POST 请求到 Google Tasks + +<<<<<<< HEAD + // 创建任务列表 +======= + // 创建一个任务列表并发送到Google Tasks服务器 +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae public void createTaskList(TaskList tasklist) throws NetworkFailureException { - commitUpdate(); + commitUpdate(); // 提交更新 try { - JSONObject jsPost = new JSONObject(); - JSONArray actionList = new JSONArray(); - - // action_list + JSONObject jsPost = new JSONObject(); // 创建JSON对象 + JSONArray actionList = new JSONArray(); // 创建动作列表 + +<<<<<<< HEAD + // 添加创建动作到动作列表 +======= + // 将任务列表的创建操作添加到操作列表中 +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae actionList.put(tasklist.getCreateAction(getActionId())); - jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList); - - // client version + jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList); // 添加动作列表到JSON对象 + +<<<<<<< HEAD + // 添加客户端版本到JSON对象 + jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion); + + // 执行POST请求 +======= + // 设置客户端版本号 jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion); - - // post + + // 发送POST请求并处理响应，获取新创建任务列表的ID并设置到任务列表对象中 +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae JSONObject jsResponse = postRequest(jsPost); - JSONObject jsResult = (JSONObject) jsResponse.getJSONArray( - GTaskStringUtils.GTASK_JSON_RESULTS).get(0); - tasklist.setGid(jsResult.getString(GTaskStringUtils.GTASK_JSON_NEW_ID)); - + JSONObject jsResult = (JSONObject) jsResponse.getJSONArray(GTaskStringUtils.GTASK_JSON_RESULTS).get(0); // 获取返回结果 + tasklist.setGid(jsResult.getString(GTaskStringUtils.GTASK_JSON_NEW_ID)); // 设置任务列表的ID + } catch (JSONException e) { Log.e(TAG, e.toString()); e.printStackTrace(); - throw new ActionFailureException("create tasklist: handing jsonobject failed"); + throw new ActionFailureException("create tasklist: handing jsonobject failed"); // 抛出JSON处理异常 } } - - // 提交更新列表中的所有动作到 Google Tasks + +<<<<<<< HEAD + // 提交更新 +======= + // 提交更新操作，将暂存的更新操作数组发送到服务器 +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae public void commitUpdate() throws NetworkFailureException { + // 如果存在更新数组 if (mUpdateArray != null) { try { - JSONObject jsPost = new JSONObject(); - - // action_list + JSONObject jsPost = new JSONObject(); // 创建JSON对象 + +<<<<<<< HEAD + // 添加动作列表到JSON对象 jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, mUpdateArray); - - // client_version + // 添加客户端版本到JSON对象 +======= + // 设置操作列表 + jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, mUpdateArray); + + // 设置客户端版本号 +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion); - - postRequest(jsPost); - mUpdateArray = null; + + postRequest(jsPost); // 执行POST请求 + mUpdateArray = null; // 清空更新数组 } catch (JSONException e) { Log.e(TAG, e.toString()); e.printStackTrace(); - throw new ActionFailureException("commit update: handing jsonobject failed"); + throw new ActionFailureException("commit update: handing jsonobject failed"); // 抛出JSON处理异常 } } } - - // 添加一个节点的更新动作到更新列表中 + +<<<<<<< HEAD + // 添加更新节点 public void addUpdateNode(Node node) throws NetworkFailureException { if (node != null) { - // too many update items may result in an error - // set max to 10 items + // 更新项目过多可能会导致错误，最多设为10个项目 +======= + // 添加一个节点的更新操作到暂存的更新操作数组中，限制最多10个更新项 + // 将节点的更新操作添加到更新数组中，如果更新数组中的元素超过10个，则先提交更新 + public void addUpdateNode(Node node) throws NetworkFailureException { + if (node != null) { + // 过多的更新项可能会导致错误，所以设置最大更新项数量为10个 +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae if (mUpdateArray != null && mUpdateArray.length() > 10) { - commitUpdate(); + commitUpdate(); // 提交更新 } - + + // 如果更新数组为空，则创建一个新的JSONArray对象用于存放更新操作 if (mUpdateArray == null) +<<<<<<< HEAD + mUpdateArray = new JSONArray(); // 初始化更新数组 + mUpdateArray.put(node.getUpdateAction(getActionId())); // 将更新的节点添加到数组 + } + } + + // 移动任务 + public void moveTask(Task task, TaskList preParent, TaskList curParent) throws NetworkFailureException { + commitUpdate(); // 提交更新 +======= mUpdateArray = new JSONArray(); + // 将节点的更新操作（通过节点获取，操作ID使用当前的操作ID）添加到更新数组中 mUpdateArray.put(node.getUpdateAction(getActionId())); } } - - // 移动一个任务到另一个任务列表，并发送相应的 POST 请求到 Google Tasks + + // 移动任务，将任务从一个任务列表移动到另一个任务列表（可能是同一个列表内移动位置） public void moveTask(Task task, TaskList preParent, TaskList curParent) throws NetworkFailureException { commitUpdate(); +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae try { - JSONObject jsPost = new JSONObject(); - JSONArray actionList = new JSONArray(); - JSONObject action = new JSONObject(); - - // action_list + JSONObject jsPost = new JSONObject(); // 创建JSON对象 + JSONArray actionList = new JSONArray(); // 创建动作列表 + JSONObject action = new JSONObject(); // 创建动作对象 + +<<<<<<< HEAD + // 构建移动动作 + action.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, GTaskStringUtils.GTASK_JSON_ACTION_TYPE_MOVE); + action.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, getActionId()); + action.put(GTaskStringUtils.GTASK_JSON_ID, task.getGid()); // 设置任务ID + + // 如果前后父任务相同且任务有前兄弟，则附加前兄弟ID + if (preParent == curParent && task.getPriorSibling() != null) { + action.put(GTaskStringUtils.GTASK_JSON_PRIOR_SIBLING_ID, task.getPriorSibling()); + } + action.put(GTaskStringUtils.GTASK_JSON_SOURCE_LIST, preParent.getGid()); // 源任务列表ID + action.put(GTaskStringUtils.GTASK_JSON_DEST_PARENT, curParent.getGid()); // 目标父任务列表ID + + // 如果任务从一个任务列表移动到另一个任务列表，则附加目标列表ID + if (preParent != curParent) { + action.put(GTaskStringUtils.GTASK_JSON_DEST_LIST, curParent.getGid()); + } + actionList.put(action); // 添加动作到动作列表 + jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList); // 添加动作列表到JSON对象 + + // 添加客户端版本到JSON对象 + jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion); + + postRequest(jsPost); // 执行POST请求 +======= + // 操作列表相关设置 + // 设置操作类型为移动任务（对应预定义的移动操作类型常量） action.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, GTaskStringUtils.GTASK_JSON_ACTION_TYPE_MOVE); + // 设置操作的唯一ID，通过获取下一个可用的操作ID来赋值 action.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, getActionId()); + // 设置要移动的任务的全局唯一ID action.put(GTaskStringUtils.GTASK_JSON_ID, task.getGid()); + // 如果移动前后的父任务列表相同（即在同一个任务列表内移动），并且任务不是该列表中的第一个任务， + // 则设置其前一个兄弟任务的ID，用于确定移动后的顺序 if (preParent == curParent && task.getPriorSibling() != null) { - // put prioring_sibing_id only if moving within the tasklist and - // it is not the first one action.put(GTaskStringUtils.GTASK_JSON_PRIOR_SIBLING_ID, task.getPriorSibling()); } + // 设置任务原来所在的任务列表的全局唯一ID（源列表） action.put(GTaskStringUtils.GTASK_JSON_SOURCE_LIST, preParent.getGid()); + // 设置任务要移动到的目标任务列表的父级任务列表的全局唯一ID（目标父列表） action.put(GTaskStringUtils.GTASK_JSON_DEST_PARENT, curParent.getGid()); + // 如果移动是在不同的任务列表之间进行，则设置目标任务列表的全局唯一ID（目标列表） if (preParent != curParent) { - // put the dest_list only if moving between tasklists action.put(GTaskStringUtils.GTASK_JSON_DEST_LIST, curParent.getGid()); } + // 将这个移动操作添加到操作列表中 actionList.put(action); + // 将操作列表添加到要发送的JSON数据对象中，对应预定义的操作列表的JSON键 jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList); - - // client_version + + // 设置客户端版本号，对应预定义的客户端版本号的JSON键 jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion); - + + // 发送POST请求，将包含移动任务操作信息的JSON数据发送到服务器进行处理 postRequest(jsPost); - +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae + } catch (JSONException e) { Log.e(TAG, e.toString()); e.printStackTrace(); +<<<<<<< HEAD + throw new ActionFailureException("move task: handing jsonobject failed"); // 抛出JSON处理异常 + } + } + + // 删除节点 +======= + // 如果JSON处理出现异常，抛出操作失败异常，并说明是移动任务时处理JSON对象失败 throw new ActionFailureException("move task: handing jsonobject failed"); } } - - // 删除一个节点，并发送相应的 POST 请求到 Google Tasks + + // 删除节点（比如任务、任务列表等），通过设置节点的删除标记为true，并将其更新操作发送到服务器来实现删除 +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae public void deleteNode(Node node) throws NetworkFailureException { - commitUpdate(); + commitUpdate(); // 提交更新 try { - JSONObject jsPost = new JSONObject(); - JSONArray actionList = new JSONArray(); - - // action_list + JSONObject jsPost = new JSONObject(); // 创建JSON对象 + JSONArray actionList = new JSONArray(); // 创建动作列表 + +<<<<<<< HEAD + // 标记节点为已删除并添加到动作列表 node.setDeleted(true); + actionList.put(node.getUpdateAction(getActionId())); // 获取节点更新动作并添加到列表 + jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList); // 添加动作列表到JSON对象 + + // 添加客户端版本到JSON对象 + jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion); + + postRequest(jsPost); // 执行POST请求 + mUpdateArray = null; // 清空更新数组 + } catch (JSONException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new ActionFailureException("delete node: handing jsonobject failed"); // 抛出JSON处理异常 + } + } + + // 获取任务列表 +======= + // 操作列表相关设置 + // 将节点标记为已删除 + node.setDeleted(true); + // 将节点的更新操作（此时因为已标记为删除，对应的就是删除操作）添加到操作列表中 actionList.put(node.getUpdateAction(getActionId())); + // 将操作列表添加到要发送的JSON数据对象中，对应预定义的操作列表的JSON键 jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList); - - // client_version + + // 设置客户端版本号，对应预定义的客户端版本号的JSON键 jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion); - + + // 发送POST请求，将包含删除节点操作信息的JSON数据发送到服务器进行处理 postRequest(jsPost); + // 发送成功后，将更新数组置空，因为相关更新操作已提交完成 mUpdateArray = null; } catch (JSONException e) { Log.e(TAG, e.toString()); e.printStackTrace(); + // 如果JSON处理出现异常，抛出操作失败异常，并说明是删除节点时处理JSON对象失败 throw new ActionFailureException("delete node: handing jsonobject failed"); } } - - // 获取所有任务列表，并返回相应的 JSONArray + + // 获取所有的任务列表信息，前提是已经登录成功，否则会抛出异常提示需要先登录 +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae public JSONArray getTaskLists() throws NetworkFailureException { if (!mLoggedin) { - Log.e(TAG, "please login first"); - throw new ActionFailureException("not logged in"); + Log.e(TAG, "please login first"); // 如果未登录，记录错误 + throw new ActionFailureException("not logged in"); // 抛出异常 } - + try { +<<<<<<< HEAD + HttpGet httpGet = new HttpGet(mGetUrl); // 创建GET请求 + HttpResponse response = mHttpClient.execute(httpGet); // 执行请求 + + // 获取任务列表 + String resString = getResponseContent(response.getEntity()); // 获取响应内容 +======= + // 创建一个HTTP GET请求对象，用于获取任务列表数据，请求的URL是之前设置好的获取数据的URL HttpGet httpGet = new HttpGet(mGetUrl); HttpResponse response = null; + // 执行HTTP GET请求，获取服务器的响应 response = mHttpClient.execute(httpGet); - - // get the task list + + // 从响应的实体中获取内容，并进行处理，提取出包含任务列表信息的JSON数据部分 String resString = getResponseContent(response.getEntity()); +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae String jsBegin = "_setup("; String jsEnd = ")}"; int begin = resString.indexOf(jsBegin); int end = resString.lastIndexOf(jsEnd); String jsString = null; + // 提取JSON字符串 if (begin != -1 && end != -1 && begin < end) { jsString = resString.substring(begin + jsBegin.length(), end); } +<<<<<<< HEAD + JSONObject js = new JSONObject(jsString); // 创建JSON对象 + return js.getJSONObject("t").getJSONArray(GTaskStringUtils.GTASK_JSON_LISTS); // 返回任务列表 + } catch (ClientProtocolException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new NetworkFailureException("gettasklists: httpget failed"); // 抛出网络请求失败异常 + } catch (IOException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new NetworkFailureException("gettasklists: httpget failed"); // 抛出IO异常 + } catch (JSONException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new ActionFailureException("get task lists: handing jasonobject failed"); // 抛出JSON处理异常 + } + } + + // 获取指定任务列表 +======= JSONObject js = new JSONObject(jsString); + // 从解析后的JSON对象中获取任务列表数组并返回，对应预定义的任务列表的JSON键 return js.getJSONObject("t").getJSONArray(GTaskStringUtils.GTASK_JSON_LISTS); } catch (ClientProtocolException e) { Log.e(TAG, e.toString()); e.printStackTrace(); + // 如果HTTP协议相关操作出现异常，抛出网络失败异常，并说明是获取任务列表时HTTP GET请求失败 throw new NetworkFailureException("gettasklists: httpget failed"); } catch (IOException e) { Log.e(TAG, e.toString()); e.printStackTrace(); + // 如果输入输出操作出现异常，抛出网络失败异常，并说明是获取任务列表时HTTP GET请求失败 throw new NetworkFailureException("gettasklists: httpget failed"); } catch (JSONException e) { Log.e(TAG, e.toString()); e.printStackTrace(); + // 如果JSON处理出现异常，抛出操作失败异常，并说明是获取任务列表时处理JSON对象失败 throw new ActionFailureException("get task lists: handing jasonobject failed"); } } - - // 获取指定任务列表中的所有任务，并返回相应的 JSONArray + + // 根据给定的任务列表全局唯一ID，获取该任务列表中的任务信息，需要先提交之前暂存的更新操作 +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae public JSONArray getTaskList(String listGid) throws NetworkFailureException { - commitUpdate(); + commitUpdate(); // 提交更新 try { - JSONObject jsPost = new JSONObject(); - JSONArray actionList = new JSONArray(); - JSONObject action = new JSONObject(); - - // action_list + JSONObject jsPost = new JSONObject(); // 创建JSON对象 + JSONArray actionList = new JSONArray(); // 创建动作列表 + JSONObject action = new JSONObject(); // 创建动作对象 + +<<<<<<< HEAD + // 构建获取所有任务的动作 + action.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, GTaskStringUtils.GTASK_JSON_ACTION_TYPE_GETALL); + action.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, getActionId()); + action.put(GTaskStringUtils.GTASK_JSON_LIST_ID, listGid); // 设置列表ID + action.put(GTaskStringUtils.GTASK_JSON_GET_DELETED, false); // 不获取已删除的任务 + actionList.put(action); // 添加动作到动作列表 + jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList); // 添加动作列表到JSON对象 + + // 添加客户端版本到JSON对象 + jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion); + + JSONObject jsResponse = postRequest(jsPost); // 执行POST请求 + return jsResponse.getJSONArray(GTaskStringUtils.GTASK_JSON_TASKS); // 返回任务数组 + } catch (JSONException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new ActionFailureException("get task list: handing jsonobject failed"); // 抛出JSON处理异常 + } + } + + // 获取同步账户 +======= + // 操作列表相关设置 + // 设置操作类型为获取所有任务（对应预定义的获取所有任务操作类型常量） action.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, GTaskStringUtils.GTASK_JSON_ACTION_TYPE_GETALL); + // 设置操作的唯一ID，通过获取下一个可用的操作ID来赋值 action.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, getActionId()); + // 设置要获取任务的任务列表的全局唯一ID action.put(GTaskStringUtils.GTASK_JSON_LIST_ID, listGid); + // 设置是否获取已删除的任务，这里设置为false，表示不获取已删除任务 action.put(GTaskStringUtils.GTASK_JSON_GET_DELETED, false); + // 将这个获取任务操作添加到操作列表中 actionList.put(action); + // 将操作列表添加到要发送的JSON数据对象中，对应预定义的操作列表的JSON键 jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList); - - // client_version + + // 设置客户端版本号，对应预定义的客户端版本号的JSON键 jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion); - + + // 发送POST请求，将包含获取任务列表中任务操作信息的JSON数据发送到服务器进行处理 JSONObject jsResponse = postRequest(jsPost); + // 从服务器响应的JSON数据中获取任务数组并返回，对应预定义的任务的JSON键 return jsResponse.getJSONArray(GTaskStringUtils.GTASK_JSON_TASKS); } catch (JSONException e) { Log.e(TAG, e.toString()); e.printStackTrace(); + // 如果JSON处理出现异常，抛出操作失败异常，并说明是获取任务列表时处理JSON对象失败 throw new ActionFailureException("get task list: handing jsonobject failed"); } } - - // 获取当前同步的 Google 账户 + + // 获取当前用于同步的账户信息 +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae public Account getSyncAccount() { - return mAccount; + return mAccount; // 返回账户信息 } - - // 重置更新列表 + +<<<<<<< HEAD + // 重置更新数组 public void resetUpdateArray() { - mUpdateArray = null; + mUpdateArray = null; // 清空更新数组 } -} \ No newline at end of file +} +======= + // 重置更新数组，即将其置为空，一般用于清除之前暂存的更新操作相关数据 +public void resetUpdateArray() { + mUpdateArray = null; +} +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae diff --git a/Notes-master/src/net/micode/notes/gtask/remote/GTaskManager.java b/Notes-master/src/net/micode/notes/gtask/remote/GTaskManager.java index 774f9a6..83b6a11 100644 --- a/Notes-master/src/net/micode/notes/gtask/remote/GTaskManager.java +++ b/Notes-master/src/net/micode/notes/gtask/remote/GTaskManager.java @@ -1,31 +1,54 @@ /* - * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net) + * 版权所有 (c) 2010-2011, MiCode 开源社区 (www.micode.net) * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at + * 根据 Apache 许可证，第 2.0 版（“许可证”）许可； + * 除非遵循许可证，否则不得使用此文件。 + * 可以在以下网址获取许可证副本： * * http://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * 除非适用于相关法律或书面协议，否则根据许可证分发的软件 + * 是以“原样”基础提供，不提供任何形式的保证或条件，无论是明示的还是暗示的。 + * 请参阅许可证以了解特定语言管理权限和 + * 许可证下的限制。 */ +// 定义包 package net.micode.notes.gtask.remote; -import android.app.Activity; -import android.content.ContentResolver; -import android.content.ContentUris; -import android.content.ContentValues; -import android.content.Context; -import android.database.Cursor; -import android.util.Log; +// 导入需要的类 +import android.app.Activity; // 用于活动管理的类 +import android.content.ContentResolver; // 用于内容提供者的类 +import android.content.ContentUris; // 处理内容 URI 的工具类 +import android.content.ContentValues; // 包含 ContentProvider 插入或更新所需值的类 +import android.content.Context; // 应用上下文类 +import android.database.Cursor; // 数据库查询结果的类 +import android.util.Log; // 记录日志的工具类 +// 导入项目中的相关类 import net.micode.notes.R; import net.micode.notes.data.Notes; +<<<<<<< HEAD +import net.micode.notes.data.Notes.DataColumns; // 数据列常量 +import net.micode.notes.data.Notes.NoteColumns; // 笔记列常量 +import net.micode.notes.gtask.data.MetaData; // 任务元数据类 +import net.micode.notes.gtask.data.Node; // 节点类 +import net.micode.notes.gtask.data.SqlNote; // SQL 笔记类 +import net.micode.notes.gtask.data.Task; // 任务类 +import net.micode.notes.gtask.data.TaskList; // 任务列表类 +import net.micode.notes.gtask.exception.ActionFailureException; // 操作失败异常 +import net.micode.notes.gtask.exception.NetworkFailureException; // 网络失败异常 +import net.micode.notes.tool.DataUtils; // 数据工具类 +import net.micode.notes.tool.GTaskStringUtils; // GTask 字符串工具类 + +import org.json.JSONArray; // JSON 数组类 +import org.json.JSONException; // JSON 异常类 +import org.json.JSONObject; // JSON 对象类 + +import java.util.HashMap; // 哈希表实现 +import java.util.HashSet; // 哈希集合实现 +import java.util.Iterator; // 迭代器类 +======= import net.micode.notes.data.Notes.DataColumns; import net.micode.notes.data.Notes.NoteColumns; import net.micode.notes.gtask.data.MetaData; @@ -47,47 +70,49 @@ import java.util.HashSet; import java.util.Iterator; import java.util.Map; -// 这是一个管理Google任务同步的类 +// GTaskManager类用于管理与Google Tasks的同步操作，包括初始化任务列表、同步内容、处理各种同步类型的操作等功能 public class GTaskManager { private static final String TAG = GTaskManager.class.getSimpleName(); + // 同步成功状态码 public static final int STATE_SUCCESS = 0; - + // 网络错误状态码 public static final int STATE_NETWORK_ERROR = 1; - + // 内部错误状态码 public static final int STATE_INTERNAL_ERROR = 2; - + // 同步正在进行状态码 public static final int STATE_SYNC_IN_PROGRESS = 3; - + // 同步被取消状态码 public static final int STATE_SYNC_CANCELLED = 4; private static GTaskManager mInstance = null; + // 关联的Activity，用于获取授权令牌等操作 private Activity mActivity; - + // 应用上下文 private Context mContext; - + // 用于操作内容提供器，进行数据查询、更新等操作 private ContentResolver mContentResolver; - + // 标记是否正在同步 private boolean mSyncing; - + // 标记同步是否被取消 private boolean mCancelled; - + // 存储Google Tasks任务列表的哈希表，以任务列表的全局唯一ID（GID）为键，任务列表对象为值 private HashMap mGTaskListHashMap; - + // 存储Google Tasks节点（任务、任务列表等）的哈希表，以节点的全局唯一ID（GID）为键，节点对象为值 private HashMap mGTaskHashMap; - + // 存储元数据的哈希表，以相关的全局唯一ID为键，元数据对象为值 private HashMap mMetaHashMap; - + // 元数据对应的任务列表 private TaskList mMetaList; - + // 存储本地已删除记录的ID集合，用于后续清理本地数据 private HashSet mLocalDeleteIdMap; - + // 存储从Google Tasks的全局唯一ID（GID）到本地记录ID（NID）的映射关系 private HashMap mGidToNid; - + // 存储从本地记录ID（NID）到Google Tasks的全局唯一ID（GID）的映射关系 private HashMap mNidToGid; - // 私有构造函数，防止外部实例化 + // 私有构造函数，初始化相关成员变量 private GTaskManager() { mSyncing = false; mCancelled = false; @@ -108,12 +133,13 @@ public class GTaskManager { return mInstance; } - // 设置活动上下文，用于获取认证令牌 + // 设置关联的Activity上下文，主要用于获取授权令牌等相关操作 public synchronized void setActivityContext(Activity activity) { + // used for getting authtoken mActivity = activity; } - // 同步Google任务与本地数据库 + // 执行同步操作，与Google Tasks进行数据同步 public int sync(Context context, GTaskASyncTask asyncTask) { if (mSyncing) { Log.d(TAG, "Sync is in progress"); @@ -123,6 +149,7 @@ public class GTaskManager { mContentResolver = mContext.getContentResolver(); mSyncing = true; mCancelled = false; + // 清除之前同步相关的数据缓存，如任务列表、节点、元数据等的哈希表以及ID映射关系等 mGTaskListHashMap.clear(); mGTaskHashMap.clear(); mMetaHashMap.clear(); @@ -134,18 +161,18 @@ public class GTaskManager { GTaskClient client = GTaskClient.getInstance(); client.resetUpdateArray(); - // 登录Google任务 + // 登录Google Tasks，如果取消同步则不再进行登录操作，如果登录失败则抛出网络异常 if (!mCancelled) { if (!client.login(mActivity)) { throw new NetworkFailureException("login google task failed"); } } - // 从Google获取任务列表 + // 发布同步进度信息，初始化任务列表阶段 asyncTask.publishProgess(mContext.getString(R.string.sync_progress_init_list)); initGTaskList(); - // 同步内容 + // 发布同步进度信息，进行内容同步阶段 asyncTask.publishProgess(mContext.getString(R.string.sync_progress_syncing)); syncContent(); } catch (NetworkFailureException e) { @@ -159,6 +186,7 @@ public class GTaskManager { e.printStackTrace(); return STATE_INTERNAL_ERROR; } finally { + // 无论同步是否成功，最终都清除同步相关的数据缓存 mGTaskListHashMap.clear(); mGTaskHashMap.clear(); mMetaHashMap.clear(); @@ -171,26 +199,28 @@ public class GTaskManager { return mCancelled ? STATE_SYNC_CANCELLED : STATE_SUCCESS; } - // 初始化Google任务列表 + // 初始化Google Tasks任务列表相关信息，包括获取任务列表、元数据列表以及加载任务等操作 private void initGTaskList() throws NetworkFailureException { if (mCancelled) return; GTaskClient client = GTaskClient.getInstance(); try { + // 从Google Tasks获取任务列表信息，返回JSON数组形式的数据 JSONArray jsTaskLists = client.getTaskLists(); - // 初始化元数据列表 + // 先初始化元数据列表，查找名为特定前缀加上"meta"的任务列表作为元数据列表 mMetaList = null; for (int i = 0; i < jsTaskLists.length(); i++) { JSONObject object = jsTaskLists.getJSONObject(i); String gid = object.getString(GTaskStringUtils.GTASK_JSON_ID); String name = object.getString(GTaskStringUtils.GTASK_JSON_NAME); - if (name.equals(GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_META)) { + if (name + .equals(GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_META)) { mMetaList = new TaskList(); mMetaList.setContentByRemoteJSON(object); - // 加载元数据 + // 加载元数据，获取元数据列表对应的任务列表中的具体元数据信息 JSONArray jsMetas = client.getTaskList(gid); for (int j = 0; j < jsMetas.length(); j++) { object = (JSONObject) jsMetas.getJSONObject(j); @@ -206,26 +236,29 @@ public class GTaskManager { } } - // 如果元数据列表不存在则创建 + // 如果元数据列表不存在，则创建一个新的元数据列表，并发送到Google Tasks服务器创建对应的任务列表 if (mMetaList == null) { mMetaList = new TaskList(); - mMetaList.setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_META); + mMetaList.setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX + + GTaskStringUtils.FOLDER_META); GTaskClient.getInstance().createTaskList(mMetaList); } - // 初始化任务列表 + // 初始化普通任务列表，遍历获取到的任务列表信息，创建任务列表对象并加载对应的任务信息 for (int i = 0; i < jsTaskLists.length(); i++) { JSONObject object = jsTaskLists.getJSONObject(i); String gid = object.getString(GTaskStringUtils.GTASK_JSON_ID); String name = object.getString(GTaskStringUtils.GTASK_JSON_NAME); - if (name.startsWith(GTaskStringUtils.MIUI_FOLDER_PREFFIX) && !name.equals(GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_META)) { + if (name.startsWith(GTaskStringUtils.MIUI_FOLDER_PREFFIX) + && !name.equals(GTaskStringUtils.MIUI_FOLDER_PREFFIX + + GTaskStringUtils.FOLDER_META)) { TaskList tasklist = new TaskList(); tasklist.setContentByRemoteJSON(object); mGTaskListHashMap.put(gid, tasklist); mGTaskHashMap.put(gid, tasklist); - // 加载任务 + // 加载任务，获取当前任务列表对应的任务信息 JSONArray jsTasks = client.getTaskList(gid); for (int j = 0; j < jsTasks.length(); j++) { object = (JSONObject) jsTasks.getJSONObject(j); @@ -247,7 +280,7 @@ public class GTaskManager { } } - // 同步内容到Google任务或本地数据库 + // 进行内容同步操作，处理本地与Google Tasks之间的数据同步，包括本地删除、文件夹同步、数据库中已有记录的同步等情况 private void syncContent() throws NetworkFailureException { int syncType; Cursor c = null; @@ -260,9 +293,12 @@ public class GTaskManager { return; } - // 同步本地删除的笔记 + // 处理本地已删除的笔记（记录），查询本地回收站文件夹中的记录，对比Google Tasks中的对应节点进行相应的同步操作 try { - c = mContentResolver.query(Notes.CONTENT_NOTE_URI, SqlNote.PROJECTION_NOTE, "(type<>? AND parent_id=?)", new String[] { String.valueOf(Notes.TYPE_SYSTEM), String.valueOf(Notes.ID_TRASH_FOLER) }, null); + c = mContentResolver.query(Notes.CONTENT_NOTE_URI, SqlNote.PROJECTION_NOTE, + "(type<>? AND parent_id=?)", new String[] { + String.valueOf(Notes.TYPE_SYSTEM), String.valueOf(Notes.ID_TRASH_FOLER) + }, null); if (c != null) { while (c.moveToNext()) { gid = c.getString(SqlNote.GTASK_ID_COLUMN); @@ -284,12 +320,15 @@ public class GTaskManager { } } - // 同步文件夹 + // 同步文件夹相关信息 syncFolder(); - // 同步本地存在的笔记 + // 处理数据库中已存在的笔记（记录），根据其在Google Tasks中的对应情况确定同步类型，然后进行相应的同步操作 try { - c = mContentResolver.query(Notes.CONTENT_NOTE_URI, SqlNote.PROJECTION_NOTE, "(type=? AND parent_id<>?)", new String[] { String.valueOf(Notes.TYPE_NOTE), String.valueOf(Notes.ID_TRASH_FOLER) }, NoteColumns.TYPE + " DESC"); + c = mContentResolver.query(Notes.CONTENT_NOTE_URI, SqlNote.PROJECTION_NOTE, + "(type=? AND parent_id<>?)", new String[] { + String.valueOf(Notes.TYPE_NOTE), String.valueOf(Notes.ID_TRASH_FOLER) + }, NoteColumns.TYPE + " DESC"); if (c != null) { while (c.moveToNext()) { gid = c.getString(SqlNote.GTASK_ID_COLUMN); @@ -301,10 +340,10 @@ public class GTaskManager { syncType = node.getSyncAction(c); } else { if (c.getString(SqlNote.GTASK_ID_COLUMN).trim().length() == 0) { - // 本地新增 + // 本地新增情况 syncType = Node.SYNC_ACTION_ADD_REMOTE; } else { - // 远程删除 + // 远程已删除情况 syncType = Node.SYNC_ACTION_DEL_LOCAL; } } @@ -321,7 +360,7 @@ public class GTaskManager { } } - // 同步剩余的Google任务 + // 处理剩余的在Google Tasks中存在但本地未处理的节点，进行相应的同步操作（一般是添加到本地） Iterator> iter = mGTaskHashMap.entrySet().iterator(); while (iter.hasNext()) { Map.Entry entry = iter.next(); @@ -329,14 +368,14 @@ public class GTaskManager { doContentSync(Node.SYNC_ACTION_ADD_LOCAL, node, null); } - // 清除本地删除的条目 + // mCancelled可能被其他线程设置，所以需要逐个检查，清除本地已删除记录的相关数据（如果同步未取消） if (!mCancelled) { if (!DataUtils.batchDeleteNotes(mContentResolver, mLocalDeleteIdMap)) { throw new ActionFailureException("failed to batch-delete local deleted notes"); } } - // 刷新本地同步ID + // 刷新本地同步ID（如果同步未取消），提交更新并进行相关操作来更新本地记录的同步ID if (!mCancelled) { GTaskClient.getInstance().commitUpdate(); refreshLocalSyncId(); @@ -344,7 +383,7 @@ public class GTaskManager { } - // 同步文件夹到Google任务或本地数据库 + // 同步文件夹相关信息，包括根文件夹、通话记录文件夹、本地已存在的文件夹以及远程新增的文件夹等情况的处理 private void syncFolder() throws NetworkFailureException { Cursor c = null; String gid; @@ -355,9 +394,10 @@ public class GTaskManager { return; } - // 同步根文件夹 + // 处理根文件夹的同步情况，根据其在Google Tasks中的对应情况进行相应的同步操作（添加、更新等） try { - c = mContentResolver.query(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, Notes.ID_ROOT_FOLDER), SqlNote.PROJECTION_NOTE, null, null, null); + c = mContentResolver.query(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, + Notes.ID_ROOT_FOLDER), SqlNote.PROJECTION_NOTE, null, null, null); if (c != null) { c.moveToNext(); gid = c.getString(SqlNote.GTASK_ID_COLUMN); @@ -366,8 +406,9 @@ public class GTaskManager { mGTaskHashMap.remove(gid); mGidToNid.put(gid, (long) Notes.ID_ROOT_FOLDER); mNidToGid.put((long) Notes.ID_ROOT_FOLDER, gid); - // 更新远程名称（如果需要） - if (!node.getName().equals(GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_DEFAULT)) + // 对于系统文件夹，仅在必要时更新远程名称 + if (!node.getName().equals( + GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_DEFAULT)) doContentSync(Node.SYNC_ACTION_UPDATE_REMOTE, node, c); } else { doContentSync(Node.SYNC_ACTION_ADD_REMOTE, node, c); @@ -382,68 +423,101 @@ public class GTaskManager { } } - // 同步通话记录文件夹 + // for call-note文件夹相关的同步操作处理 + // 查询通话记录文件夹在本地数据库中的信息，根据其在Google Tasks中的对应情况进行相应的同步操作（添加、更新等） + // 如果查询到该文件夹信息存在（即游标c不为空且能移动到下一条记录），则进一步处理 try { - c = mContentResolver.query(Notes.CONTENT_NOTE_URI, SqlNote.PROJECTION_NOTE, "(_id=?)", new String[] { String.valueOf(Notes.ID_CALL_RECORD_FOLDER) }, null); + // 通过ContentResolver查询本地数据库中通话记录文件夹的记录信息，指定查询条件为_id等于通话记录文件夹的特定ID + c = mContentResolver.query(Notes.CONTENT_NOTE_URI, SqlNote.PROJECTION_NOTE, "(_id=?)", + new String[] { + String.valueOf(Notes.ID_CALL_RECORD_FOLDER) + }, null); if (c != null) { if (c.moveToNext()) { + // 获取该文件夹在Google Tasks中对应的全局唯一ID（GID） gid = c.getString(SqlNote.GTASK_ID_COLUMN); + // 根据GID从存储Google Tasks节点的哈希表中获取对应的节点对象 node = mGTaskHashMap.get(gid); if (node != null) { + // 如果节点存在，从哈希表中移除该节点（表示已处理） mGTaskHashMap.remove(gid); + // 在本地ID到Google Tasks的GID映射表中记录该文件夹的映射关系，键为GID，值为通话记录文件夹的本地ID mGidToNid.put(gid, (long) Notes.ID_CALL_RECORD_FOLDER); + // 在Google Tasks的GID到本地ID映射表中记录映射关系，键为本地ID，值为GID mNidToGid.put((long) Notes.ID_CALL_RECORD_FOLDER, gid); - // 更新远程名称（如果需要） - if (!node.getName().equals(GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_CALL_NOTE)) + // 对于系统文件夹，仅在其名称与预期的通话记录文件夹名称不一致时（即可能有更新情况），进行远程更新操作 + if (!node.getName().equals( + GTaskStringUtils.MIUI_FOLDER_PREFFIX + + GTaskStringUtils.FOLDER_CALL_NOTE)) doContentSync(Node.SYNC_ACTION_UPDATE_REMOTE, node, c); } else { + // 如果节点不存在，则执行添加远程节点的操作（意味着本地有该文件夹记录，但在Google Tasks中还未创建对应节点） doContentSync(Node.SYNC_ACTION_ADD_REMOTE, node, c); } } } else { + // 如果查询失败，打印警告日志 Log.w(TAG, "failed to query call note folder"); } } finally { + // 无论查询是否成功，最终都要关闭游标，释放资源，并将游标置空 if (c != null) { c.close(); c = null; } } - // 同步本地存在的文件夹 + // 处理本地已存在的文件夹的同步情况 + // 查询本地除回收站外的文件夹记录信息，根据其在Google Tasks中的对应情况进行相应的同步操作 try { - c = mContentResolver.query(Notes.CONTENT_NOTE_URI, SqlNote.PROJECTION_NOTE, "(type=? AND parent_id<>?)", new String[] { String.valueOf(Notes.TYPE_FOLDER), String.valueOf(Notes.ID_TRASH_FOLER) }, NoteColumns.TYPE + " DESC"); + // 通过ContentResolver查询本地数据库中符合条件的文件夹记录信息，条件为类型是文件夹且父ID不等于回收站文件夹的ID + c = mContentResolver.query(Notes.CONTENT_NOTE_URI, SqlNote.PROJECTION_NOTE, + "(type=? AND parent_id<>?)", new String[] { + String.valueOf(Notes.TYPE_FOLDER), String.valueOf(Notes.ID_TRASH_FOLER) + }, NoteColumns.TYPE + " DESC"); if (c != null) { while (c.moveToNext()) { + // 获取文件夹在Google Tasks中对应的全局唯一ID（GID） gid = c.getString(SqlNote.GTASK_ID_COLUMN); + // 根据GID从存储Google Tasks节点的哈希表中获取对应的节点对象 node = mGTaskHashMap.get(gid); if (node != null) { + // 如果节点存在，从哈希表中移除该节点（表示已处理） mGTaskHashMap.remove(gid); + // 在本地ID到Google Tasks的GID映射表中记录该文件夹的映射关系，键为GID，值为文件夹的本地ID mGidToNid.put(gid, c.getLong(SqlNote.ID_COLUMN)); + // 在Google Tasks的GID到本地ID映射表中记录映射关系，键为本地ID，值为GID mNidToGid.put(c.getLong(SqlNote.ID_COLUMN), gid); + // 获取该节点对应的同步操作类型（根据节点和游标信息判断是添加、更新、删除等哪种类型） syncType = node.getSyncAction(c); } else { + // 如果节点不存在，根据其GID是否为空字符串判断是本地新增还是远程删除情况，进而确定同步类型 if (c.getString(SqlNote.GTASK_ID_COLUMN).trim().length() == 0) { - // 本地新增 + // 本地新增情况，同步类型设置为添加远程节点 syncType = Node.SYNC_ACTION_ADD_REMOTE; } else { - // 远程删除 + // 远程删除情况，同步类型设置为删除本地节点 syncType = Node.SYNC_ACTION_DEL_LOCAL; } } + // 根据确定的同步类型执行相应的内容同步操作 doContentSync(syncType, node, c); } } else { + // 如果查询失败，打印警告日志 Log.w(TAG, "failed to query existing folder"); } } finally { + // 无论查询是否成功，最终都要关闭游标，释放资源，并将游标置空 if (c != null) { c.close(); c = null; } } - // 同步远程新增的文件夹 + // 处理远程新增文件夹的同步情况 + // 遍历存储Google Tasks任务列表的哈希表，对于在Google + // Tasks中存在但本地未处理（还在mGTaskHashMap中）的文件夹，进行添加本地节点的同步操作 Iterator> iter = mGTaskListHashMap.entrySet().iterator(); while (iter.hasNext()) { Map.Entry entry = iter.next(); @@ -455,11 +529,12 @@ public class GTaskManager { } } + // 如果同步未被取消，提交Google Tasks客户端的更新操作（将之前暂存的更新操作发送到服务器执行） if (!mCancelled) GTaskClient.getInstance().commitUpdate(); } - // 执行内容同步操作 + // 根据给定的同步类型执行具体的内容同步操作 private void doContentSync(int syncType, Node node, Cursor c) throws NetworkFailureException { if (mCancelled) { return; @@ -467,12 +542,16 @@ public class GTaskManager { MetaData meta; switch (syncType) { + // 同步类型为添加本地节点，调用相应方法进行本地节点添加操作 case Node.SYNC_ACTION_ADD_LOCAL: addLocalNode(node); break; + // 同步类型为添加远程节点，调用相应方法进行远程节点添加操作，并传入节点和游标信息 case Node.SYNC_ACTION_ADD_REMOTE: addRemoteNode(node, c); break; + // 同步类型为删除本地节点，先从元数据哈希表中获取对应的元数据，若存在则调用Google Tasks客户端删除该元数据节点， + // 同时将本地记录的ID添加到本地已删除记录集合中 case Node.SYNC_ACTION_DEL_LOCAL: meta = mMetaHashMap.get(c.getString(SqlNote.GTASK_ID_COLUMN)); if (meta != null) { @@ -480,6 +559,8 @@ public class GTaskManager { } mLocalDeleteIdMap.add(c.getLong(SqlNote.ID_COLUMN)); break; + // 同步类型为删除远程节点，先从元数据哈希表中获取对应节点的元数据，若存在则调用Google Tasks客户端删除该元数据节点， + // 然后再删除该节点本身 case Node.SYNC_ACTION_DEL_REMOTE: meta = mMetaHashMap.get(node.getGid()); if (meta != null) { @@ -487,65 +568,84 @@ public class GTaskManager { } GTaskClient.getInstance().deleteNode(node); break; + // 同步类型为更新本地节点，调用相应方法进行本地节点更新操作，并传入节点和游标信息 case Node.SYNC_ACTION_UPDATE_LOCAL: updateLocalNode(node, c); break; + // 同步类型为更新远程节点，调用相应方法进行远程节点更新操作，并传入节点和游标信息 case Node.SYNC_ACTION_UPDATE_REMOTE: updateRemoteNode(node, c); break; + // 同步类型为更新冲突，目前简单采用本地更新的方式（可能后续可以考虑合并修改等更好的处理方式），调用远程节点更新方法 case Node.SYNC_ACTION_UPDATE_CONFLICT: - // 合并修改可能是更好的做法 - // 目前我们简单地使用本地更新 + // merging both modifications maybe a good idea + // right now just use local update simply updateRemoteNode(node, c); break; + // 同步类型为无操作，直接跳过不做任何处理 case Node.SYNC_ACTION_NONE: break; + // 同步类型为错误或其他未知类型，抛出操作失败异常，表示遇到了未知的同步操作类型 case Node.SYNC_ACTION_ERROR: default: throw new ActionFailureException("unkown sync action type"); } } - // 在本地添加Google任务节点 + // 添加本地节点的操作方法 private void addLocalNode(Node node) throws NetworkFailureException { if (mCancelled) { return; } SqlNote sqlNote; + // 如果节点是任务列表类型（TaskList） if (node instanceof TaskList) { - if (node.getName().equals(GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_DEFAULT)) { + // 如果节点名称是默认根文件夹的名称，创建一个对应根文件夹的SqlNote对象，传入上下文和根文件夹的本地ID + if (node.getName().equals( + GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_DEFAULT)) { sqlNote = new SqlNote(mContext, Notes.ID_ROOT_FOLDER); - } else if (node.getName().equals(GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_CALL_NOTE)) { + } else if (node.getName().equals( + GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_CALL_NOTE)) { + // 如果节点名称是通话记录文件夹的名称，创建一个对应通话记录文件夹的SqlNote对象，传入上下文和通话记录文件夹的本地ID sqlNote = new SqlNote(mContext, Notes.ID_CALL_RECORD_FOLDER); } else { + // 其他普通任务列表情况，创建一个新的SqlNote对象，传入上下文 sqlNote = new SqlNote(mContext); + // 设置SqlNote的内容为节点的本地JSON格式内容（从节点获取） sqlNote.setContent(node.getLocalJSONFromContent()); + // 设置父ID为根文件夹的本地ID sqlNote.setParentId(Notes.ID_ROOT_FOLDER); } } else { + // 如果节点是普通任务（Task）类型，创建一个新的SqlNote对象，传入上下文 sqlNote = new SqlNote(mContext); JSONObject js = node.getLocalJSONFromContent(); try { + // 如果节点的本地JSON数据中包含特定的笔记头部信息（META_HEAD_NOTE） if (js.has(GTaskStringUtils.META_HEAD_NOTE)) { JSONObject note = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); if (note.has(NoteColumns.ID)) { long id = note.getLong(NoteColumns.ID); + // 检查该笔记ID在本地笔记数据库中是否已存在，如果存在则移除该ID（可能需要重新生成新的ID） if (DataUtils.existInNoteDatabase(mContentResolver, id)) { - // ID不可用，必须创建一个新的 + // the id is not available, have to create a new one note.remove(NoteColumns.ID); } } } + // 如果节点的本地JSON数据中包含特定的数据头部信息（META_HEAD_DATA） if (js.has(GTaskStringUtils.META_HEAD_DATA)) { JSONArray dataArray = js.getJSONArray(GTaskStringUtils.META_HEAD_DATA); for (int i = 0; i < dataArray.length(); i++) { JSONObject data = dataArray.getJSONObject(i); if (data.has(DataColumns.ID)) { long dataId = data.getLong(DataColumns.ID); + // 检查该数据ID在本地数据数据库中是否已存在，如果存在则移除该ID（可能需要重新生成新的ID） if (DataUtils.existInDataDatabase(mContentResolver, dataId)) { - // Data ID不可用，必须创建一个新的 + // the data id is not available, have to create + // a new one data.remove(DataColumns.ID); } } @@ -556,52 +656,61 @@ public class GTaskManager { Log.w(TAG, e.toString()); e.printStackTrace(); } + // 设置SqlNote的内容为处理后的JSON数据 sqlNote.setContent(js); + // 获取任务节点的父节点在本地ID到Google Tasks的GID映射表中的对应父ID，如果不存在则抛出异常表示找不到本地父ID Long parentId = mGidToNid.get(((Task) node).getParent().getGid()); if (parentId == null) { Log.e(TAG, "cannot find task's parent id locally"); throw new ActionFailureException("cannot add local node"); } + // 设置SqlNote的父ID为获取到的父节点的本地ID sqlNote.setParentId(parentId.longValue()); } - // 创建本地节点 + // 设置SqlNote的Google Tasks全局唯一ID（GID）为节点的GID sqlNote.setGtaskId(node.getGid()); + // 将SqlNote对象提交保存到本地数据库（传入参数false可能表示不触发某些额外的相关操作） sqlNote.commit(false); - // 更新GID-NID映射 + // 在本地ID到Google Tasks的GID映射表中记录该节点的映射关系，键为节点的GID，值为SqlNote的本地ID mGidToNid.put(node.getGid(), sqlNote.getId()); + // 在Google Tasks的GID到本地ID映射表中记录映射关系，键为SqlNote的本地ID，值为节点的GID mNidToGid.put(sqlNote.getId(), node.getGid()); - // 更新元数据 + // 更新远程元数据，传入节点的GID和对应的SqlNote对象 updateRemoteMeta(node.getGid(), sqlNote); } - // 更新本地Google任务节点 + // 更新本地节点的操作方法 private void updateLocalNode(Node node, Cursor c) throws NetworkFailureException { if (mCancelled) { return; } SqlNote sqlNote; - // 更新本地笔记 + // 根据传入的上下文和游标信息创建一个新的SqlNote对象，用于更新本地节点信息 sqlNote = new SqlNote(mContext, c); + // 设置SqlNote的内容为节点的本地JSON格式内容（从节点获取） sqlNote.setContent(node.getLocalJSONFromContent()); - Long parentId = (node instanceof Task) ? mGidToNid.get(((Task) node).getParent().getGid()) : new Long(Notes.ID_ROOT_FOLDER); + Long parentId = (node instanceof Task) ? mGidToNid.get(((Task) node).getParent().getGid()) + : new Long(Notes.ID_ROOT_FOLDER); if (parentId == null) { Log.e(TAG, "cannot find task's parent id locally"); throw new ActionFailureException("cannot update local node"); } + // 设置SqlNote的父ID为获取到的父节点的本地ID sqlNote.setParentId(parentId.longValue()); + // 将更新后的SqlNote对象提交保存到本地数据库（传入参数true可能表示触发某些额外的相关操作） sqlNote.commit(true); - // 更新元数据信息 + // 更新远程元数据，传入节点的GID和对应的SqlNote对象 updateRemoteMeta(node.getGid(), sqlNote); } - // 在Google任务中添加新的节点 + // 添加远程节点的操作方法 private void addRemoteNode(Node node, Cursor c) throws NetworkFailureException { if (mCancelled) { return; @@ -610,9 +719,10 @@ public class GTaskManager { SqlNote sqlNote = new SqlNote(mContext, c); Node n; - // 远程更新 + // 如果SqlNote对应的是笔记类型（即普通任务） if (sqlNote.isNoteType()) { Task task = new Task(); + // 设置任务的内容为从本地SqlNote获取的JSON格式内容 task.setContentByLocalJSON(sqlNote.getContent()); String parentGid = mNidToGid.get(sqlNote.getParentId()); @@ -620,17 +730,20 @@ public class GTaskManager { Log.e(TAG, "cannot find task's parent tasklist"); throw new ActionFailureException("cannot add remote task"); } + // 将任务添加到对应的父任务列表中（通过本地ID到Google Tasks的GID映射表找到父任务列表） mGTaskListHashMap.get(parentGid).addChildTask(task); + // 通过Google Tasks客户端创建该任务（发送到服务器创建对应的任务节点） GTaskClient.getInstance().createTask(task); n = (Node) task; - // 添加元数据 + // 更新远程元数据，传入任务的GID和对应的SqlNote对象 updateRemoteMeta(task.getGid(), sqlNote); } else { TaskList tasklist = null; - // 如果文件夹已经存在则跳过 + // 构建文件夹名称，先添加特定的前缀，然后根据SqlNote的本地ID判断是否是根文件夹或通话记录文件夹，添加相应的后缀名称， + // 否则添加SqlNote的摘要信息作为后缀 String folderName = GTaskStringUtils.MIUI_FOLDER_PREFFIX; if (sqlNote.getId() == Notes.ID_ROOT_FOLDER) folderName += GTaskStringUtils.FOLDER_DEFAULT; @@ -639,131 +752,179 @@ public class GTaskManager { else folderName += sqlNote.getSnippet(); + // 遍历存储Google Tasks任务列表的哈希表（mGTaskListHashMap）的迭代器 Iterator> iter = mGTaskListHashMap.entrySet().iterator(); while (iter.hasNext()) { + // 获取哈希表中的每一个键值对，键是任务列表的全局唯一ID（GID），值是对应的任务列表对象（TaskList） Map.Entry entry = iter.next(); String gid = entry.getKey(); TaskList list = entry.getValue(); + // 判断当前任务列表的名称是否与之前构建的文件夹名称（folderName）相等 if (list.getName().equals(folderName)) { + // 如果相等，说明找到了对应的任务列表，将其赋值给tasklist变量 tasklist = list; + // 如果在存储Google Tasks节点的哈希表（mGTaskHashMap）中包含该任务列表的GID，说明已经处理过，将其移除 if (mGTaskHashMap.containsKey(gid)) { mGTaskHashMap.remove(gid); } + // 找到匹配的任务列表后就可以结束循环了 break; } } - // 如果没有匹配项则可以添加 + // 如果经过上述查找没有找到匹配的任务列表（tasklist仍为null），则创建一个新的任务列表对象 if (tasklist == null) { tasklist = new TaskList(); + // 设置新任务列表的内容为从本地SqlNote获取的JSON格式内容 tasklist.setContentByLocalJSON(sqlNote.getContent()); + // 通过Google Tasks客户端创建该任务列表（发送到服务器创建对应的任务列表节点） GTaskClient.getInstance().createTaskList(tasklist); + // 将新创建的任务列表添加到存储Google Tasks任务列表的哈希表中，键为任务列表的GID，值为任务列表对象 mGTaskListHashMap.put(tasklist.getGid(), tasklist); } + // 将创建或找到的任务列表对象转换为Node类型并赋值给n（因为Node是更通用的节点类型，TaskList是一种特殊的Node） n = (Node) tasklist; } - // 更新本地笔记 + // 更新本地笔记相关信息 + // 设置本地SqlNote的Google Tasks全局唯一ID（GID）为n的GID，即与远程任务列表或任务对应的GID保持一致 sqlNote.setGtaskId(n.getGid()); + // 将SqlNote对象提交保存到本地数据库（传入参数false可能表示不触发某些额外的相关操作，此处用于保存基本的关联信息等） sqlNote.commit(false); + // 重置本地修改标志（可能表示将本地记录标记为已与远程同步，不再是本地修改状态） sqlNote.resetLocalModified(); + // 再次提交保存SqlNote对象到本地数据库（传入参数true可能表示触发一些更新相关的额外操作，确保修改标志等信息更新成功） sqlNote.commit(true); - // GID-ID映射 + // gid-id映射更新 + // 在本地ID到Google Tasks的GID映射表（mGidToNid）中记录该节点（n）的映射关系，键为节点的GID，值为SqlNote的本地ID mGidToNid.put(n.getGid(), sqlNote.getId()); + // 在Google Tasks的GID到本地ID映射表（mNidToGid）中记录映射关系，键为SqlNote的本地ID，值为节点的GID mNidToGid.put(sqlNote.getId(), n.getGid()); } - // 在Google任务中更新节点 + // 更新远程节点的操作方法 private void updateRemoteNode(Node node, Cursor c) throws NetworkFailureException { if (mCancelled) { return; } + // 根据传入的上下文和游标信息创建一个新的SqlNote对象，用于后续操作 SqlNote sqlNote = new SqlNote(mContext, c); - // 远程更新 + // 远程更新操作 + // 设置远程节点（node）的内容为从本地SqlNote获取的JSON格式内容，即将本地修改同步到远程节点 node.setContentByLocalJSON(sqlNote.getContent()); + // 通过Google Tasks客户端将更新后的节点添加到更新队列中（后续会批量提交更新到服务器） GTaskClient.getInstance().addUpdateNode(node); - // 更新元数据 + // 更新远程元数据，传入节点的GID和对应的SqlNote对象 updateRemoteMeta(node.getGid(), sqlNote); - // 如果需要移动任务 + // 如果SqlNote对应的是笔记类型（即普通任务），则可能需要处理任务移动相关操作 if (sqlNote.isNoteType()) { Task task = (Task) node; + // 获取任务当前的父任务列表 TaskList preParentList = task.getParent(); + // 通过本地ID到Google Tasks的GID映射表，根据本地记录的父ID获取当前任务在远程对应的父任务列表的GID String curParentGid = mNidToGid.get(sqlNote.getParentId()); if (curParentGid == null) { Log.e(TAG, "cannot find task's parent tasklist"); throw new ActionFailureException("cannot update remote task"); } + // 根据获取到的GID从存储Google Tasks任务列表的哈希表中获取当前任务在远程对应的父任务列表对象 TaskList curParentList = mGTaskListHashMap.get(curParentGid); + // 如果当前任务的前后父任务列表不一致，说明任务需要在远程进行移动操作 if (preParentList != curParentList) { + // 先从原父任务列表中移除该任务 preParentList.removeChildTask(task); + // 将任务添加到新的父任务列表中 curParentList.addChildTask(task); + // 通过Google Tasks客户端执行任务移动操作，告知服务器任务在远程的位置变更 GTaskClient.getInstance().moveTask(task, preParentList, curParentList); } } - // 清除本地修改标志 + // 清除本地修改标志，标记本地记录已同步到远程，不再处于本地修改状态 sqlNote.resetLocalModified(); + // 将更新后的SqlNote对象提交保存到本地数据库（传入参数true可能表示触发一些更新相关的额外操作，确保修改标志等信息更新成功） sqlNote.commit(true); } - // 更新Google任务中的元数据 + // 更新远程元数据的操作方法 private void updateRemoteMeta(String gid, SqlNote sqlNote) throws NetworkFailureException { if (sqlNote != null && sqlNote.isNoteType()) { + // 从存储元数据的哈希表（mMetaHashMap）中根据GID获取对应的元数据对象（MetaData） MetaData metaData = mMetaHashMap.get(gid); if (metaData != null) { + // 如果元数据对象存在，设置其元数据内容，传入GID和从本地SqlNote获取的JSON格式内容 metaData.setMeta(gid, sqlNote.getContent()); + // 通过Google Tasks客户端将更新后的元数据添加到更新队列中（后续会批量提交更新到服务器） GTaskClient.getInstance().addUpdateNode(metaData); } else { + // 如果元数据对象不存在，则创建一个新的元数据对象 metaData = new MetaData(); + // 设置新元数据对象的元数据内容，传入GID和从本地SqlNote获取的JSON格式内容 metaData.setMeta(gid, sqlNote.getContent()); + // 将新创建的元数据对象添加到元数据列表（mMetaList）中作为子任务（从逻辑上关联起来） mMetaList.addChildTask(metaData); + // 将新创建的元数据对象添加到存储元数据的哈希表中，键为GID，值为元数据对象 mMetaHashMap.put(gid, metaData); + // 通过Google Tasks客户端创建该元数据任务（发送到服务器创建对应的元数据节点） GTaskClient.getInstance().createTask(metaData); } } } - // 刷新本地同步ID + // 刷新本地同步ID的操作方法 private void refreshLocalSyncId() throws NetworkFailureException { if (mCancelled) { return; } - // 获取最新的Google任务列表 + // 为了获取最新的Google Tasks列表信息，先清空之前存储相关信息的哈希表 mGTaskHashMap.clear(); mGTaskListHashMap.clear(); mMetaHashMap.clear(); + // 重新初始化Google Tasks列表信息（重新获取任务列表、元数据等相关内容） initGTaskList(); Cursor c = null; try { - c = mContentResolver.query(Notes.CONTENT_NOTE_URI, SqlNote.PROJECTION_NOTE, "(type<>? AND parent_id<>?)", new String[] { String.valueOf(Notes.TYPE_SYSTEM), String.valueOf(Notes.ID_TRASH_FOLER) }, NoteColumns.TYPE + " DESC"); + // 通过ContentResolver查询本地数据库中除系统类型且不在回收站的笔记记录信息，按照类型降序排列 + c = mContentResolver.query(Notes.CONTENT_NOTE_URI, SqlNote.PROJECTION_NOTE, + "(type<>? AND parent_id<>?)", new String[] { + String.valueOf(Notes.TYPE_SYSTEM), String.valueOf(Notes.ID_TRASH_FOLER) + }, NoteColumns.TYPE + " DESC"); if (c != null) { while (c.moveToNext()) { + // 获取笔记在Google Tasks中对应的全局唯一ID（GID） String gid = c.getString(SqlNote.GTASK_ID_COLUMN); + // 根据GID从存储Google Tasks节点的哈希表中获取对应的节点对象 Node node = mGTaskHashMap.get(gid); if (node != null) { + // 如果节点存在，从哈希表中移除该节点（表示已处理） mGTaskHashMap.remove(gid); + // 创建一个ContentValues对象用于存放要更新的数据，此处将同步ID设置为节点的最后修改时间 ContentValues values = new ContentValues(); values.put(NoteColumns.SYNC_ID, node.getLastModified()); - mContentResolver.update(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, c.getLong(SqlNote.ID_COLUMN)), values, null, null); + // 通过ContentResolver更新本地数据库中对应笔记的记录，设置同步ID字段的值 + mContentResolver.update(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, + c.getLong(SqlNote.ID_COLUMN)), values, null, null); } else { Log.e(TAG, "something is missed"); - throw new ActionFailureException("some local items don't have gid after sync"); + throw new ActionFailureException( + "some local items don't have gid after sync"); } } } else { Log.w(TAG, "failed to query local note to refresh sync id"); } } finally { + // 无论查询是否成功，最终都要关闭游标，释放资源，并将游标置空 if (c != null) { c.close(); c = null; @@ -771,13 +932,14 @@ public class GTaskManager { } } - // 获取同步账户 + // 获取同步账户名称的方法，通过Google Tasks客户端获取同步账户对象，并返回其名称 public String getSyncAccount() { return GTaskClient.getInstance().getSyncAccount().name; } - // 取消同步 + // 取消同步的方法，将表示同步是否取消的标志（mCancelled）设置为true，其他相关操作可以根据该标志来判断是否停止执行 public void cancelSync() { mCancelled = true; } -} \ No newline at end of file +} +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae diff --git a/Notes-master/src/net/micode/notes/gtask/remote/GTaskSyncService.java b/Notes-master/src/net/micode/notes/gtask/remote/GTaskSyncService.java index e052e82..189946b 100644 --- a/Notes-master/src/net/micode/notes/gtask/remote/GTaskSyncService.java +++ b/Notes-master/src/net/micode/notes/gtask/remote/GTaskSyncService.java @@ -13,136 +13,268 @@ * See the License for the specific language governing permissions and * limitations under the License. */ - + package net.micode.notes.gtask.remote; - + import android.app.Activity; import android.app.Service; import android.content.Context; import android.content.Intent; import android.os.Bundle; import android.os.IBinder; - -// GTaskSyncService 是一个用于同步任务的服务类 + +<<<<<<< HEAD +/** + * GTaskSyncService 是一个用于处理 Google 任务同步的服务类。 + * 该类扩展自 Android 的 Service 类，负责执行同步操作。 + */ public class GTaskSyncService extends Service { - // 定义同步操作的 action 类型名称 + // 主要用于标识同步动作的字符串名称 public final static String ACTION_STRING_NAME = "sync_action_type"; - - // 定义开始同步的 action 类型 + + // 开始同步的操作类型常量 public final static int ACTION_START_SYNC = 0; - - // 定义取消同步的 action 类型 + + // 取消同步的操作类型常量 public final static int ACTION_CANCEL_SYNC = 1; - - // 定义无效的 action 类型 + + // 无效的操作类型常量 public final static int ACTION_INVALID = 2; - - // 定义同步服务广播名称 + + // 广播名称，用于通知同步服务的状态 public final static String GTASK_SERVICE_BROADCAST_NAME = "net.micode.notes.gtask.remote.gtask_sync_service"; - - // 定义同步服务广播中是否正在同步的键名 + + // 广播参数，用于标识当前是否正在同步 public final static String GTASK_SERVICE_BROADCAST_IS_SYNCING = "isSyncing"; - - // 定义同步服务广播中进度信息的键名 + + // 广播参数，用于传递同步进度消息 public final static String GTASK_SERVICE_BROADCAST_PROGRESS_MSG = "progressMsg"; - - // 静态变量，用于存储同步任务实例 + + // 静态变量，表示当前的异步任务 private static GTaskASyncTask mSyncTask = null; - - // 静态变量，用于存储同步进度信息 + + // 存储当前同步的进度信息 private static String mSyncProgress = ""; - - // 启动同步任务的方法 + + /** + * 启动同步任务的方法 + */ private void startSync() { + // 如果没有正在进行的同步任务，则创建并启动新的任务 +======= +// GTaskSyncService类继承自Service，用于管理与Google Tasks的同步相关操作，包括启动同步、取消同步以及广播同步状态等功能 +public class GTaskSyncService extends Service { + + // 用于在Intent中传递同步操作类型的字符串常量，作为键来标识具体的操作类型信息 + public final static String ACTION_STRING_NAME = "sync_action_type"; + + // 表示启动同步操作的整数值常量，用于在根据操作类型进行判断时识别启动同步的意图 + public final static int ACTION_START_SYNC = 0; + + // 表示取消同步操作的整数值常量，用于在根据操作类型进行判断时识别取消同步的意图 + public final static int ACTION_CANCEL_SYNC = 1; + + // 表示无效操作类型的整数值常量，当获取到的操作类型不匹配已知的有效类型时使用该值来标识 + public final static int ACTION_INVALID = 2; + + // 用于广播同步服务相关状态信息的Intent的动作名称，其他组件可以通过注册监听该动作来接收同步服务的广播消息 + public final static String GTASK_SERVICE_BROADCAST_NAME = "net.micode.notes.gtask.remote.gtask_sync_service"; + + // 在广播Intent中用于传递是否正在同步状态的键名，对应的值为布尔类型，表示同步操作是否正在进行 + public final static String GTASK_SERVICE_BROADCAST_IS_SYNCING = "isSyncing"; + + // 在广播Intent中用于传递同步进度消息的键名，对应的值为字符串类型，可用于展示同步操作的进度相关文本信息 + public final static String GTASK_SERVICE_BROADCAST_PROGRESS_MSG = "progressMsg"; + + // 静态变量，用于存储正在执行的同步任务对象（GTaskASyncTask类型），方便在不同方法中对同步任务进行控制和判断状态 + private static GTaskASyncTask mSyncTask = null; + + // 静态变量，用于存储同步进度相关的消息字符串，可通过广播传递给其他关注同步进度的组件 + private static String mSyncProgress = ""; + + // 启动同步的私有方法，用于创建并执行同步任务 + private void startSync() { + // 如果当前没有正在执行的同步任务（mSyncTask为null） +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae if (mSyncTask == null) { + // 创建一个新的GTaskASyncTask对象，传入当前服务上下文（this）以及一个完成监听器（OnCompleteListener） mSyncTask = new GTaskASyncTask(this, new GTaskASyncTask.OnCompleteListener() { + // 当同步任务完成时会调用的回调方法 public void onComplete() { +<<<<<<< HEAD + // 同步任务完成后，重置任务状态并发送广播 +======= + // 将正在执行的同步任务对象置为null，表示同步已结束 +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae mSyncTask = null; + // 发送一个空消息的广播（可能用于通知其他组件同步已完成等状态变化） sendBroadcast(""); + // 停止当前服务（因为同步任务已完成，服务的主要工作完成，可以停止自身运行） stopSelf(); } }); +<<<<<<< HEAD + // 发送初始广播，表示同步开始 sendBroadcast(""); + // 执行异步任务 +======= + // 发送一个空消息的广播（可能在创建任务后就先通知其他组件同步即将开始等情况） + sendBroadcast(""); + // 执行同步任务，开始真正的同步操作流程 +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae mSyncTask.execute(); } } - - // 取消同步任务的方法 + +<<<<<<< HEAD + /** + * 取消当前同步任务的方法 + */ +======= + // 取消同步的私有方法，用于取消正在执行的同步任务（如果存在的话） +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae private void cancelSync() { + // 如果有正在进行的同步任务，则取消该任务 if (mSyncTask != null) { mSyncTask.cancelSync(); } } - - // 服务创建时的回调方法 + + // 服务创建时调用的方法，在这里将正在执行的同步任务对象初始化为null，确保服务启动时处于初始状态 @Override public void onCreate() { + // 服务创建时，初始化同步任务为空 mSyncTask = null; } - - // 服务启动命令的回调方法 + + // 当服务通过startService()方法启动时会调用此方法，用于处理传入的Intent并根据不同的操作意图执行相应操作 @Override public int onStartCommand(Intent intent, int flags, int startId) { +<<<<<<< HEAD + // 从 Intent 中获取数据 +======= + // 从传入的Intent中获取附加的Bundle数据（通常用于传递额外的参数信息） +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae Bundle bundle = intent.getExtras(); + // 如果获取到的Bundle不为null且包含表示操作类型的键（ACTION_STRING_NAME） if (bundle != null && bundle.containsKey(ACTION_STRING_NAME)) { + // 根据操作类型的值进行不同的操作分支判断 switch (bundle.getInt(ACTION_STRING_NAME, ACTION_INVALID)) { + // 如果操作类型是启动同步（ACTION_START_SYNC） case ACTION_START_SYNC: + // 开始同步操作 startSync(); break; + // 如果操作类型是取消同步（ACTION_CANCEL_SYNC） case ACTION_CANCEL_SYNC: + // 取消同步操作 cancelSync(); break; + // 其他未知或不处理的操作类型，直接跳过不做操作 default: break; } +<<<<<<< HEAD + // 返回服务的启动模式 +======= + // 返回START_STICKY表示服务在被系统意外终止后会尝试重新创建并保持启动状态（常用于需要持续运行的服务场景） +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae return START_STICKY; } + // 如果不符合上述条件或者操作类型无效等情况，调用父类的onStartCommand方法进行默认处理 return super.onStartCommand(intent, flags, startId); } - - // 服务内存不足时的回调方法 + + // 当系统内存不足时会调用此方法，在这里用于取消正在执行的同步任务（如果存在的话），释放内存资源 @Override public void onLowMemory() { + // 当系统内存不足时，取消同步任务 if (mSyncTask != null) { mSyncTask.cancelSync(); } } - - // 返回服务的 IBinder 对象 + +<<<<<<< HEAD +======= + // 用于服务绑定操作的方法，这里返回null表示不支持绑定操作（如果需要支持绑定，需要返回一个有效的IBinder对象） +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae + @Override public IBinder onBind(Intent intent) { + // 返回 null 表示不提供绑定服务的功能 return null; } - - // 发送同步进度广播的方法 + +<<<<<<< HEAD + /** + * 发送广播以更新同步状态和进度消息 + */ +======= + // 发送广播的公共方法，用于向其他组件广播同步服务的相关状态信息，包括同步进度消息、是否正在同步等 +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae public void sendBroadcast(String msg) { mSyncProgress = msg; + // 创建 Intent 用于发送广播 Intent intent = new Intent(GTASK_SERVICE_BROADCAST_NAME); + // 设置当前是否正在同步的标志 intent.putExtra(GTASK_SERVICE_BROADCAST_IS_SYNCING, mSyncTask != null); + // 设置进度消息 intent.putExtra(GTASK_SERVICE_BROADCAST_PROGRESS_MSG, msg); + // 发送广播 sendBroadcast(intent); } - - // 静态方法，用于启动同步服务 + +<<<<<<< HEAD + /** + * 启动同步操作的静态方法 + */ + public static void startSync(Activity activity) { + // 设置活动上下文 +======= + // 静态公共方法，用于在外部（比如Activity中）启动同步服务进行同步操作，需要传入对应的Activity作为上下文来启动服务 public static void startSync(Activity activity) { + // 设置GTaskManager的Activity上下文（可能用于获取相关授权等操作，与同步操作相关联） +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae GTaskManager.getInstance().setActivityContext(activity); Intent intent = new Intent(activity, GTaskSyncService.class); + // 添加启动同步的指令 intent.putExtra(GTaskSyncService.ACTION_STRING_NAME, GTaskSyncService.ACTION_START_SYNC); + // 启动服务 activity.startService(intent); } - - // 静态方法，用于取消同步服务 + +<<<<<<< HEAD + /** + * 取消同步操作的静态方法 + */ +======= + // 静态公共方法，用于在外部（比如其他组件中）取消正在进行的同步操作，需要传入上下文（Context）来启动服务发送取消同步的意图 +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae public static void cancelSync(Context context) { Intent intent = new Intent(context, GTaskSyncService.class); + // 添加取消同步的指令 intent.putExtra(GTaskSyncService.ACTION_STRING_NAME, GTaskSyncService.ACTION_CANCEL_SYNC); + // 启动服务 context.startService(intent); } - - // 检查是否正在同步的方法 + +<<<<<<< HEAD + /** + * 判断当前是否正在同步的静态方法 + */ +======= + // 静态公共方法，用于判断当前是否正在进行同步操作，通过检查正在执行的同步任务对象是否为null来返回相应的布尔值结果 +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae public static boolean isSyncing() { return mSyncTask != null; } - - // 获取同步进度信息的方法 + +<<<<<<< HEAD + /** + * 获取当前同步进度的字符串信息 + */ +======= + // 静态公共方法，用于获取当前的同步进度相关的字符串消息，返回存储同步进度消息的静态变量的值 +>>>>>>> a495b394fa4686564cc2bfe7d054eb66276713ae public static String getProgressString() { return mSyncProgress; } From f1e29fc2a4f7efc7f6f495a1898c8ff37752c842 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BC=A0=E9=B9=8F=E5=B1=95?= <2740594397@qq.com> Date: Tue, 31 Dec 2024 11:14:08 +0800 Subject: [PATCH 5/5] =?UTF-8?q?=E6=B7=BB=E5=8A=A0=E4=BA=86zpz=E4=BF=AE?= =?UTF-8?q?=E6=94=B9=E7=BB=9F=E8=AE=A1?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- 代码注释统计.txt | 2 ++ 1 file changed, 2 insertions(+) diff --git a/代码注释统计.txt b/代码注释统计.txt index 63c4222..58c1dd9 100644 --- a/代码注释统计.txt +++ b/代码注释统计.txt @@ -3,6 +3,8 @@ ui中14段代码 程星桦： 张鹏展： +gtask中exception和remote中共6段代码 +tool中4段代码 文渤乔： data中4段代码