diff --git a/src/notes/data/Contact.java b/src/notes/data/Contact.java index 206eaf3..d97ac5d 100644 --- a/src/notes/data/Contact.java +++ b/src/notes/data/Contact.java @@ -14,12 +14,6 @@ * limitations under the License. */ -/* -*文件名:Contact.java -* 修改人:蒙程 -* 修改时间:2025-12-13 -* 修改内容:增加代码注释,标注的代码行数共有21行 -*/ package net.micode.notes.data; import android.content.Context; @@ -31,22 +25,10 @@ import android.util.Log; import java.util.HashMap; -/** -*Contact类是联系人工具类 -* -*

根据“提供的电话号码反向查询联系人姓名”的能力,并带内存缓存,避免重复查库。

-* 本类所有方法均为静态,无需实例化。 -* -* @author 蒙程 - * @version 1.0 - * @since [起始版本] -*/ public class Contact { - //HashMap表示联系人和电话号码之间的映射关系。只声明,不new,是延迟初始化的表现 private static HashMap sContactCache; private static final String TAG = "Contact"; - //说明电话号码格式,可兼容国际区号、前缀0等多种格式 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 " @@ -54,31 +36,17 @@ public class Contact { + " FROM phone_lookup" + " WHERE min_match = '+')"; - /** - * 根据电话号码获取联系人姓名 - *

优先读取内存缓存,未命中时查询系统联系人数据库,并将结果写入缓存。

- * @param context 上下文,用于访问ContentResolver - * @param phoneNumber 待查询的电话号码(可为国际格式、带前缀 0 等) - * @return 联系人姓名;未匹配到或者发生异常时,返回@code null - * @throws - * @see android.provider.ContactsContract.CommonDataKinds - */ public static String getContact(Context context, String phoneNumber) { - //不到真正要用的时候,不给对象分配内存。第一次被调用时才new。 if(sContactCache == null) { sContactCache = new HashMap(); } - //缓存命中,直接返回电话号码 if(sContactCache.containsKey(phoneNumber)) { return sContactCache.get(phoneNumber); } - //构造匹配串,提取数字核心部分 String selection = CALLER_ID_SELECTION.replace("+", PhoneNumberUtils.toCallerIDMinMatch(phoneNumber)); - - //cursor是数据库游标,初始位置是-1;query把SQL拼装好后交给系统联系人Provider Cursor cursor = context.getContentResolver().query( Data.CONTENT_URI, new String [] { Phone.DISPLAY_NAME }, @@ -86,19 +54,18 @@ public class Contact { new String[] { phoneNumber }, null); - //指针移到第一行,成功返回true if (cursor != null && cursor.moveToFirst()) { try { String name = cursor.getString(0); - sContactCache.put(phoneNumber, name); //将号码-姓名键值对放进内存缓存 + sContactCache.put(phoneNumber, name); return name; - } catch (IndexOutOfBoundsException e) { //捕获异常,索引超出列范围的情况,返回错误日志 + } catch (IndexOutOfBoundsException e) { Log.e(TAG, " Cursor get string error " + e.toString()); return null; - } finally { //无论是否发生异常都必须释放cursor。 + } finally { cursor.close(); } - } else { //查询失败,输出日志信息 + } else { Log.d(TAG, "No contact matched with number:" + phoneNumber); return null; } diff --git a/src/notes/data/Notes.java b/src/notes/data/Notes.java index de21759..f240604 100644 --- a/src/notes/data/Notes.java +++ b/src/notes/data/Notes.java @@ -14,73 +14,43 @@ * limitations under the License. */ -/* -*文件名:Notes.java -* 修改人:蒙程 -* 修改时间:2025-12-06 -* 修改内容:增加代码注释,标注的代码行数共37行 -*/ package net.micode.notes.data; import android.net.Uri; - -/** -*Notes是便签数据库类 - -*

定义了URI常量、便签/文件夹类型常量、Intent扩展字段名、数据库接口、两种与业务实体

-* 本类所有字段均用static final修饰,说明字段不会变,可以直接用 - -* @author 蒙程 -* @since [起始版本] -*/ public class Notes { - - //一、ContentProvider权威域名 - public static final String AUTHORITY = "micode_notes"; //拼接URI的前缀 - public static final String TAG = "Notes"; //日志显示Notes - - //二、便签/文件夹/系统文件夹 类型常量 - public static final int TYPE_NOTE = 0; //普通文本便签类型常量为0 - public static final int TYPE_FOLDER = 1; //文件夹类型常量为1 - public static final int TYPE_SYSTEM = 2; //系统文件夹(如回收站)类型常量为2 + 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; /** * Following IDs are system folders' identifiers * {@link Notes#ID_ROOT_FOLDER } is default folder - * {@link Notes#ID_TEMPORARY_FOLDER } is for notes belonging no folder + * {@link Notes#ID_TEMPARAY_FOLDER } is for notes belonging no folder * {@link Notes#ID_CALL_RECORD_FOLDER} is to store call records */ + 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"; - //三、系统保留文件夹 ID - public static final int ID_ROOT_FOLDER = 0; //默认文件夹ID为0 - public static final int ID_TEMPORARY_FOLDER = -1; //临时文件夹 - - public static final int ID_CALL_RECORD_FOLDER = -2; //通话记录文件夹ID,保存由通话备忘功能生成的便签 - public static final int ID_TRASH_FOLDER = -3; - - //四、Intent是什么? - 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"; //便签父文件夹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; - /** - *六、便签数据MIME汇总常量类 - * Android 的 ContentResolver 在查询/插入/打开文件时会先问 URI 对应的 MIME: - */ public static class DataConstants { - public static final String NOTE = TextNote.CONTENT_ITEM_TYPE; //文本便签MIME类型 - public static final String CALL_NOTE = CallNote.CONTENT_ITEM_TYPE; //通话备忘MIME类型 + public static final String NOTE = TextNote.CONTENT_ITEM_TYPE; + public static final String CALL_NOTE = CallNote.CONTENT_ITEM_TYPE; } - //七、基础URI /** * Uri to query all notes and folders */ @@ -88,18 +58,12 @@ public class Notes { /** * Uri to query data - * 包括附件、文本、通话记录 */ public static final Uri CONTENT_DATA_URI = Uri.parse("content://" + AUTHORITY + "/data"); - //八、数据库列名接口 —— Note 表 - /** - * NoteColumns是便签数据库列名接口,只定义/声明一些方法、变量 - * 此处声明了便签数据列名有ID,PARENT_ID,创建日期,修改日期,提醒日期等 - */ public interface NoteColumns { /** - * The unique ID for a ro + * The unique ID for a row *

Type: INTEGER (long)

*/ public static final String ID = "_id"; @@ -203,18 +167,12 @@ public class Notes { public static final String VERSION = "version"; } - - //九、数据库列名接口 —— Data 表 - - /** - * DataColumns是数据库列名接口 - */ public interface DataColumns { /** * The unique ID for a row *

Type: INTEGER (long)

*/ - public static final String ID = "_id"; //主键是_id + public static final String ID = "_id"; /** * The MIME type of the item represented by this row. @@ -248,70 +206,63 @@ public class Notes { /** - * Generic data column, the meaning is {@link #MIME_TYPE} specific, used for + * Generic data column, the meaning is {@link #MIMETYPE} specific, used for * integer data type *

Type: INTEGER

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

Type: INTEGER

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

Type: TEXT

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

Type: TEXT

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

Type: TEXT

*/ public static final String DATA5 = "data5"; } - - //十、文本便签实体常量类 - //文本便签TextNote类实现DataColumns接口中声明的方法 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

*/ - public static final String MODE = DATA1; //清单模式or普通文本模式? + public static final String MODE = DATA1; public static final int MODE_CHECK_LIST = 1; - public static final String CONTENT_TYPE = "vnd.android.cursor.dir/text_note"; //MIME类型为集合(多条) + 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"; //MIME类型为单条 + 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"); } - /** - *通话记录便签实体常量类 - * 通话记录CallNote类也实现了DataColumns接口,体现了接口的多实现特性。 - */ - public static final class CallNote implements DataColumns { + public static final class CallNote implements DataColumns { /** * Call date for this record *

Type: INTEGER (long)

*/ - public static final String CALL_DATE = DATA1; //DATA1是数据库中的真实列名,将通话的时间戳存入DATA1列中 + public static final String CALL_DATE = DATA1; /** * Phone number for this record diff --git a/src/notes/data/NotesDatabaseHelper.java b/src/notes/data/NotesDatabaseHelper.java index 82aa598..ffe5d57 100644 --- a/src/notes/data/NotesDatabaseHelper.java +++ b/src/notes/data/NotesDatabaseHelper.java @@ -14,11 +14,6 @@ * limitations under the License. */ -/* -*文件名:NotesDatabaseHelper.java - * 修改人:蒙程 - * 修改时间:2025-12-13 - */ package net.micode.notes.data; import android.content.ContentValues; @@ -31,32 +26,12 @@ import net.micode.notes.data.Notes.DataColumns; import net.micode.notes.data.Notes.DataConstants; import net.micode.notes.data.Notes.NoteColumns; -/** -*便签数据库辅助类 -

- *负责以下功能: - *

-

- * - * @author 蒙程 - * @version {@link #DB_VERSION} 4 - * @since 2010-2011 - */ 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"; @@ -65,19 +40,10 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { private static final String TAG = "NotesDatabaseHelper"; - //类加载时不创建NotesDatabaseHelper实例(mInstance),真正需要使用数据库时才调用getInstance初始化,节省应用启动时的内存和资源开销。 private static NotesDatabaseHelper mInstance; - - //二、建表SQL,初始化note和data表,同时添加note_id_index索引列 - /** - * 结合在Notes中定义的NoteColumns初始化 - * 在Notes类里定义了NoteColumns,是便签数据库列名接口,ID、PARENT_ID等都是列名,表示把Notes数据库里声明的列名拿来用 - * NOT NULL约束强制列不接受NULL值,DEFAULT 0 表示默认值为0,如果字段设定NOT NULL,没有输入值时,DEFAULT后跟的默认值来填充 - * 这里的strftime是SQLite内置的时间、日期格式化函数,参数为输出格式(%s表示秒级Unix时间戳)、时间源(‘now'表示现在) - */ private static final String CREATE_NOTE_TABLE_SQL = - "CREATE TABLE " + TABLE.NOTE + "(" + //开始建表,表名是TABLE.NOTE(note) + "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," + @@ -97,13 +63,6 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { NoteColumns.VERSION + " INTEGER NOT NULL DEFAULT 0" + ")"; - /** - * 创建 Data 表 SQL,结合在Notes中定义的DataColumns初始化 - *

- * 外键:{@link DataColumns#NOTE_ID} 指向 note.id
- * 通用列 data1~data5 含义由 {@link DataColumns#MIME_TYPE} 决定。 - *

- */ private static final String CREATE_DATA_TABLE_SQL = "CREATE TABLE " + TABLE.DATA + "(" + DataColumns.ID + " INTEGER PRIMARY KEY," + @@ -119,22 +78,12 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { DataColumns.DATA5 + " TEXT NOT NULL DEFAULT ''" + ")"; - /** - *在data(NOTE_ID)这一列上创建名为note_id_index的索引(如果该索引不存在) - * 便于执行SELECT * FROM data WHERE 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 + ");"; - - //三、创建Note表触发器,在文件夹下便签数量变化时自动增减便签数量(notes_count)的值 /** * Increase folder's note count when move note to the folder - * 创建触发器,名字叫increase_folder_count_on_update - * 在note表的parent_id列更新后 - * 执行触发器体,更新Note表,设置notes_count=notes_count+1,在id=new.parent_id的地方 - * 此处用于自动更新父文件夹下的便签数量 */ private static final String NOTE_INCREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER = "CREATE TRIGGER increase_folder_count_on_update "+ @@ -183,11 +132,8 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { " AND " + NoteColumns.NOTES_COUNT + ">0;" + " END"; - //四、Data 表触发器:自动同步便签摘要(snippet) /** * Update note's content when insert data with type {@link DataConstants#NOTE} - * 仅当新插入的DATA记录的mime_type字段值为note(笔记)类型时,触发器才会执行后续逻辑,若插入的是其他数据类型,比如图片,则不触发 - * 执行触发器,将note表里的snippet列值更新为新纪录的content值,且仅更新note表里主键id=新纪录note_id的行 */ private static final String DATA_UPDATE_NOTE_CONTENT_ON_INSERT_TRIGGER = "CREATE TRIGGER update_note_content_on_insert " + @@ -226,9 +172,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { " END"; /** - * Delete data belong to note which has been deleted - * 当从note表删除一条笔记记录后,通过data表的note_id与note表的id关联 - * 自动删除data表中所有与这条被删笔记关联的记录,笔记-笔记内容 + * 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 " + @@ -240,7 +184,6 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { /** * Delete notes belong to folder which has been deleted - * 当从note表里删除一条记录后,自动级联删除note表中所有parent_id等于被删记录id的子记录 */ private static final String FOLDER_DELETE_NOTES_ON_DELETE_TRIGGER = "CREATE TRIGGER folder_delete_notes_on_delete " + @@ -256,37 +199,24 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { private static final String FOLDER_MOVE_NOTES_ON_TRASH_TRIGGER = "CREATE TRIGGER folder_move_notes_on_trash " + " AFTER UPDATE ON " + TABLE.NOTE + - " WHEN new." + NoteColumns.PARENT_ID + "=" + Notes.ID_TRASH_FOLDER + + " WHEN new." + NoteColumns.PARENT_ID + "=" + Notes.ID_TRASH_FOLER + " BEGIN" + " UPDATE " + TABLE.NOTE + - " SET " + NoteColumns.PARENT_ID + "=" + Notes.ID_TRASH_FOLDER + + " SET " + NoteColumns.PARENT_ID + "=" + Notes.ID_TRASH_FOLER + " WHERE " + NoteColumns.PARENT_ID + "=old." + NoteColumns.ID + ";" + " END"; - /** - * Android开发中自定义的数据库辅助类的构造方法,作用是初始化,指定要创建/管理的数据库名称、版本号等核心参数 - * @param context 上下文,提供应用运行的环境信息,如访问资源、数据库文件路径、系统服务等。 - */ public NotesDatabaseHelper(Context context) { - - /** super是调用的父类(SQLiteOpenHelper)构造方法 - * @param context 父类通过context确定数据库文件的存储位置 - * @param DB_NAME 数据库文件名 - * @param null 创建数据库查询的游标(cursor),传null表示默认 - * @param DB_VERSION自定义常量,数据库版本号 - */ super(context, DB_NAME, null, DB_VERSION); } - //完成note表的全量初始化 public void createNoteTable(SQLiteDatabase db) { - db.execSQL(CREATE_NOTE_TABLE_SQL); //执行SQL语句创建note表 - reCreateNoteTableTriggers(db); //重建该表关联的触发器 - createSystemFolder(db); //初始化系统默认文件夹数据 - Log.d(TAG, "note table has been created"); //打印日志,确认note表成功创建 + db.execSQL(CREATE_NOTE_TABLE_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"); @@ -305,9 +235,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { db.execSQL(FOLDER_MOVE_NOTES_ON_TRASH_TRIGGER); } - //向note表插入四个系统默认文件夹:通话记录、根、临时、回收站。保证应用首次启动时有基础的文件夹结构。 private void createSystemFolder(SQLiteDatabase db) { - //ContentValues类用于存储键值对 ContentValues values = new ContentValues(); /** @@ -315,12 +243,12 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { */ values.put(NoteColumns.ID, Notes.ID_CALL_RECORD_FOLDER); values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); - db.insert(TABLE.NOTE, null, values); //向note表插入通话记录文件夹数据 + 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); @@ -329,7 +257,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { * temporary folder which is used for moving note */ values.clear(); - values.put(NoteColumns.ID, Notes.ID_TEMPORARY_FOLDER); + values.put(NoteColumns.ID, Notes.ID_TEMPARAY_FOLDER); values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); db.insert(TABLE.NOTE, null, values); @@ -337,7 +265,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { * create trash folder */ values.clear(); - values.put(NoteColumns.ID, Notes.ID_TRASH_FOLDER); + values.put(NoteColumns.ID, Notes.ID_TRASH_FOLER); values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); db.insert(TABLE.NOTE, null, values); } @@ -359,24 +287,17 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_DELETE_TRIGGER); } - /** - * synchronized同步关键字,保证多线程安全,避免多个线程同时调用该方法时,进入if分支,创建多个实例 - * getInstance函数用于获取唯一实例 - */ - static synchronized NotesDatabaseHelper getInstance(Context context) { - //首次调用该方法时,才创建实例;若已创建,则直接复用 if (mInstance == null) { mInstance = new NotesDatabaseHelper(context); } return mInstance; } - //@override是Java中的一种注解,用于明确表示子类的方法是对父类方法的重写,实现多态性 @Override public void onCreate(SQLiteDatabase db) { - createNoteTable(db); //初始化笔记表 - createDataTable(db); //初始化数据表 + createNoteTable(db); + createDataTable(db); } @Override @@ -412,15 +333,13 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { } } - //v1到v2的升级,删除旧的note data表,清空所有用户数据,重建新的 private void upgradeToV2(SQLiteDatabase db) { - db.execSQL("DROP TABLE IF EXISTS " + TABLE.NOTE); //执行具体的SQL语句,删除旧的note表 - db.execSQL("DROP TABLE IF EXISTS " + TABLE.DATA); //删除旧的data表 + db.execSQL("DROP TABLE IF EXISTS " + TABLE.NOTE); + db.execSQL("DROP TABLE IF EXISTS " + TABLE.DATA); createNoteTable(db); createDataTable(db); } - //v2到v3的升级,清除无用触发器,新增gtask_id列,新增回收站文件夹 private void upgradeToV3(SQLiteDatabase db) { // drop unused triggers db.execSQL("DROP TRIGGER IF EXISTS update_note_modified_date_on_insert"); @@ -431,12 +350,11 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { + " TEXT NOT NULL DEFAULT ''"); // add a trash system folder ContentValues values = new ContentValues(); - values.put(NoteColumns.ID, Notes.ID_TRASH_FOLDER); + values.put(NoteColumns.ID, Notes.ID_TRASH_FOLER); values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); db.insert(TABLE.NOTE, null, values); } - //v3到v4的升级,为note表新增version列,且约束非空,默认为0 private void upgradeToV4(SQLiteDatabase db) { db.execSQL("ALTER TABLE " + TABLE.NOTE + " ADD COLUMN " + NoteColumns.VERSION + " INTEGER NOT NULL DEFAULT 0"); diff --git a/src/notes/data/NotesProvider.java b/src/notes/data/NotesProvider.java index 3ca2c60..edb0a60 100644 --- a/src/notes/data/NotesProvider.java +++ b/src/notes/data/NotesProvider.java @@ -14,12 +14,6 @@ * limitations under the License. */ -/* -* 文件名:NotesProvider.java -* 修改人:蒙程 -* 修改时间:2025-12-13 -* 修改内容:增加代码注释,标注的代码行数共68行 - */ package net.micode.notes.data; @@ -40,58 +34,24 @@ import net.micode.notes.data.Notes.DataColumns; import net.micode.notes.data.Notes.NoteColumns; import net.micode.notes.data.NotesDatabaseHelper.TABLE; -/** - * 便签内容提供类 - *

继承ContentProvider类,把本地SQLite数据库(note.db)暴露给整个安卓系统,支持以下功能:

- * - *

支持URI示例:

- *
- *     content://micode_notes/note    查询所有便签
- *     content://micode_notes/note/123    查询 ID=123 的便签
- *     content://micode_notes/data    查询所有数据行(附件、文本块、通话记录)
- *     content://micode_notes/search_suggest/xxx    系统搜索框建议接口
- * 
- * - * @author 蒙程 - * @since 2010-2011 - */ public class NotesProvider extends ContentProvider { - //UriMatcher用于匹配uri,在ContentProvider中分辨出查询者想要查询哪个数据表 private static final UriMatcher mMatcher; - //mHelper是一个便签数据库辅助类单例 private NotesDatabaseHelper mHelper; private static final String TAG = "NotesProvider"; - private static final int URI_NOTE = 1; //匹配所有note的uri标识 - private static final int URI_NOTE_ITEM = 2; //匹配单条note的uri标识 - private static final int URI_DATA = 3; //匹配所有data行的uri标识,包括文本块、附件、通话记录 - private static final int URI_DATA_ITEM = 4; //匹配单条data行的uri标识 + 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; - private static final int URI_SEARCH = 5; //执行实际搜索请求 - private static final int URI_SEARCH_SUGGEST = 6; //提供搜索建议,实时联想输入关键词的匹配项 + private static final int URI_SEARCH = 5; + private static final int URI_SEARCH_SUGGEST = 6; - /** - * static块:在这个类第一次被Android系统加载到内存时,自动执行且只执行一次, - * 专门用来初始化 UriMatcher实例,并把所有需要匹配的uri规则(比如 note、data、search 相关)一次性注册好 - * 为后续 query/insert/delete/update 方法匹配 URI 做好准备 - * 使用static块效率更高,只需要初始化一次,省内存、省时间,而且可以确保在调用query等方法之前所有类型的uri都已经注册完毕 - */ static { - //初始化,常量UriMatcher.NO_MATCH表示不匹配任何路径的返回码 mMatcher = new UriMatcher(UriMatcher.NO_MATCH); - - /** - * addURI表示添加需要匹配的uri,如果匹配就会返回匹配码(第三个参数) - * 完整uri格式为:content:///(/?) - * "note/#"中的'#'是通配符,仅匹配任意数字(这里的数字对应笔记id) - */ mMatcher.addURI(Notes.AUTHORITY, "note", URI_NOTE); mMatcher.addURI(Notes.AUTHORITY, "note/#", URI_NOTE_ITEM); mMatcher.addURI(Notes.AUTHORITY, "data", URI_DATA); @@ -105,15 +65,6 @@ public class NotesProvider extends ContentProvider { * 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. */ - /** - * 1.把note表id、snippet列名映射成SearchManager规定的搜索建议标准列名,比如把 NoteColumns.ID 改成 SearchManager.SUGGEST_COLUMN_INTENT_EXTRA_DATA; - * 2.格式化内容:SNIPPET中可能有换行符,首尾空格,所以用 REPLACE去掉x'0A'(十六进制,代表换行符 '\n'),避免建议文本显示错乱。 - * TRIM去除替换后字符串的首尾空格。 - * SUGGEST_COLUMN_TEXT_1系统规范列名,搜索建议项的主文本 - *3.预置交互逻辑:点击建议能直接跳转到笔记 - * R.drawable.search_result图标,Intent.ACTION_VIEW表示”查看笔记“这个动作, - * Notes.TextNote.CONTENT_TYPE 告诉系统要打开的是 “文本笔记” 类型的页面 - */ 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 + "," @@ -122,55 +73,30 @@ public class NotesProvider extends ContentProvider { + "'" + Intent.ACTION_VIEW + "' AS " + SearchManager.SUGGEST_COLUMN_INTENT_ACTION + "," + "'" + Notes.TextNote.CONTENT_TYPE + "' AS " + SearchManager.SUGGEST_COLUMN_INTENT_DATA; - /** - * 指定查询返回的列,复用上面定义的NOTES_SEARCH_PROJECTION - * '?'模糊匹配,占位符,关键词 - * 筛选笔记父文件夹不等于回收站文件夹 - * 筛选笔记类型为‘纯笔记’ - */ 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_FOLDER + + " AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER + " AND " + NoteColumns.TYPE + "=" + Notes.TYPE_NOTE; - //ContentProvider 返回数据库辅助类单例 @Override public boolean onCreate() { mHelper = NotesDatabaseHelper.getInstance(getContext()); return true; } - /** - * 外部组件(如 Activity、SearchView)访问应用数据库数据的统一入口。 - * 查询接口:支持note单条/批量、data单条/批量、搜索/搜索建议几种 URI,根据URI类型,拼URI,执行SQL语句, - * 返回符合要求的 Cursor 结果,并绑定数据变更通知,保证 UI 能感知数据变化。 - * @param uri 请求 URI - * @param projection 要查询的列 - * @param selection 查询条件 - * @param selectionArgs selection中?的占位符参数 - * @param sortOrder 排序规则 - * @return cursor 返回游标 - */ @Override public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder) { - //初始化游标,默认空 Cursor c = null; - - //db获取只读数据库连接(查询) SQLiteDatabase db = mHelper.getReadableDatabase(); String id = null; - - //mMatcher 在静态代码块里预注册了6种 URI 模式,通过match()返回的整数常量决定走哪条分支 switch (mMatcher.match(uri)) { case URI_NOTE: c = db.query(TABLE.NOTE, projection, selection, selectionArgs, null, null, sortOrder); break; case URI_NOTE_ITEM: - - //解析uri路径中的id,getPathSegments()返回[path,#] id = uri.getPathSegments().get(1); c = db.query(TABLE.NOTE, projection, NoteColumns.ID + "=" + id + parseSelection(selection), selectionArgs, null, null, sortOrder); @@ -191,7 +117,6 @@ public class NotesProvider extends ContentProvider { "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) { @@ -201,54 +126,36 @@ public class NotesProvider extends ContentProvider { searchString = uri.getQueryParameter("pattern"); } - //空关键词时,返回null,无需查询 if (TextUtils.isEmpty(searchString)) { return null; } try { - //关键词格式化 searchString = String.format("%%%s%%", searchString); - - //执行查询 c = db.rawQuery(NOTES_SNIPPET_SEARCH_QUERY, new String[] { searchString }); - } catch (IllegalStateException ex) { //捕获try中出现的异常,打印日志 + } catch (IllegalStateException ex) { Log.e(TAG, "got exception: " + ex.toString()); } break; - - //传了没注册过的uri,直接抛异常,防止误调用 default: throw new IllegalArgumentException("Unknown URI " + uri); } - //说明查询到结果,将查询返回的 Cursor 与 ContentResolver、当前 URI 绑定; if (c != null) { c.setNotificationUri(getContext().getContentResolver(), uri); } return c; } - /** - * 是外部组件(如 Activity、Service)向应用数据库的note、data表插入数据的统一入口。 - * 传入content URI 匹配目标表note\data,执行插入操作,校验关联字段合法性,出发数据变更通知,返回新uri - * @param uri 请求uri - * @param values 要插入的键值对,如note_id=100 - * @return 新uri - * - * @author 蒙程 - * @date 2025-12-13 - */ @Override public Uri insert(Uri uri, ContentValues values) { - SQLiteDatabase db = mHelper.getWritableDatabase(); //获取可写数据库连接 + SQLiteDatabase db = mHelper.getWritableDatabase(); long dataId = 0, noteId = 0, insertedId = 0; switch (mMatcher.match(uri)) { case URI_NOTE: insertedId = noteId = db.insert(TABLE.NOTE, null, values); break; case URI_DATA: - //插入笔记的具体内容,因此先检查values中是否包含DATA_COLUMNS.NOTE_ID if (values.containsKey(DataColumns.NOTE_ID)) { noteId = values.getAsLong(DataColumns.NOTE_ID); } else { @@ -260,39 +167,26 @@ public class NotesProvider extends ContentProvider { throw new IllegalArgumentException("Unknown URI " + uri); } // Notify the note uri - //通知所有监听该 URI 的 Cursor “数据已变更” 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); } - //返回插入的单条记录的标准uri,将插入记录的ID拼接在原始URI末尾 return ContentUris.withAppendedId(uri, insertedId); } - /** - * 删除接口:支持按条件或单 ID 删除;系统文件夹(ID≤0)禁止删除 - * @param uri 请求 URI - * @param selection 要查询的列 - * @param selectionArgs 查询条件 - * @return count 实际删除行数 - * - * @author 蒙程 - * @date 2025-12-13 - */ @Override public int delete(Uri uri, String selection, String[] selectionArgs) { int count = 0; - String id = null; //存储单条记录的ID(从uri中解析) + String id = null; SQLiteDatabase db = mHelper.getWritableDatabase(); - boolean deleteData = false; // 标记是否删除的是DATA表数据 + boolean deleteData = false; switch (mMatcher.match(uri)) { case URI_NOTE: selection = "(" + selection + ") AND " + NoteColumns.ID + ">0 "; @@ -301,8 +195,8 @@ public class NotesProvider extends ContentProvider { case URI_NOTE_ITEM: id = uri.getPathSegments().get(1); /** - * ID that smaller than 0 is system folder which is not allowed to trash - * ID<0是系统文件夹,不能删,跳出分支 + * ID that smaller than 0 is system folder which is not allowed to + * trash */ long noteId = Long.valueOf(id); if (noteId <= 0) { @@ -319,14 +213,12 @@ public class NotesProvider extends ContentProvider { id = uri.getPathSegments().get(1); count = db.delete(TABLE.DATA, DataColumns.ID + "=" + id + parseSelection(selection), selectionArgs); - deleteData = true; //标记删除的是data表数据 + deleteData = true; break; default: throw new IllegalArgumentException("Unknown URI " + uri); } if (count > 0) { - - //如果删除的是data表内容,需要关联note表,删除内容后刷新笔记列表 if (deleteData) { getContext().getContentResolver().notifyChange(Notes.CONTENT_NOTE_URI, null); } @@ -335,17 +227,6 @@ public class NotesProvider extends ContentProvider { return count; } - /** - * 更新接口:支持按条件或单 ID 更新;自动累加版本号(增量同步用) - * @param uri 请求 URI - * @param values 带查询的键值对 - * @param selection 待查询列 - * @param selectionArgs 查询条件 - * @return 实际更新行数 - * - * @author 蒙程 - * @date 2025-12-13 - */ @Override public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs) { int count = 0; @@ -386,44 +267,26 @@ public class NotesProvider extends ContentProvider { return count; } - /** - * 将外部传入的SQL筛选条件拼接为AND格式(若selection非空) - * @param selection 用户传入的WHERE子句 - * @return "AND(selection)" 或者空串 - */ private String parseSelection(String selection) { return (!TextUtils.isEmpty(selection) ? " AND (" + selection + ')' : ""); } - /** - * 根据传入的id或自定义筛选条件,把note.version字段+1,用于增量同步 - * @param id 单条便签ID - * @param selection 待查询列 - * @param selectionArgs 查询条件 - */ private void increaseNoteVersion(long id, String selection, String[] selectionArgs) { - StringBuilder sql = new StringBuilder(120); //120是初始SQL语句长度 + StringBuilder sql = new StringBuilder(120); sql.append("UPDATE "); sql.append(TABLE.NOTE); sql.append(" SET "); sql.append(NoteColumns.VERSION); sql.append("=" + NoteColumns.VERSION + "+1 "); - //有ID或者有selection时,才需要加WHERE子句 if (id > 0 || !TextUtils.isEmpty(selection)) { sql.append(" WHERE "); } - //场景1:仅有ID,精准更新单条笔记 if (id > 0) { sql.append(NoteColumns.ID + "=" + String.valueOf(id)); } - //场景2:有自定义selection(批量/组合条件更新) if (!TextUtils.isEmpty(selection)) { - - //若已有ID,拼接为AND(selection);若没有ID,直接用selection String selectString = id > 0 ? parseSelection(selection) : selection; - - //替换selection中的?占位符为实际参数 for (String args : selectionArgs) { selectString = selectString.replaceFirst("\\?", args); } @@ -433,7 +296,6 @@ public class NotesProvider extends ContentProvider { mHelper.getWritableDatabase().execSQL(sql.toString()); } - //返回给定URI的MIME类型(暂未实现,返回null) @Override public String getType(Uri uri) { // TODO Auto-generated method stub diff --git a/src/notes/gtask/data/MetaData.java b/src/notes/gtask/data/MetaData.java index e09fad8..3a2050b 100644 --- a/src/notes/gtask/data/MetaData.java +++ b/src/notes/gtask/data/MetaData.java @@ -24,31 +24,12 @@ import net.micode.notes.tool.GTaskStringUtils; import org.json.JSONException; import org.json.JSONObject; -/** - * gtask同步任务的元数据管理类 - * 存储和管理笔记与gtask同步时的元数据信息 - * MetaData是什么?描述便签属性的信息,比如创建时间、修改时间、便签ID等,而不是便签的正文内容。 - * gid是什么?google为每个同步任务分配的唯一标识,分给远端,保证同步的一致性 - * JSON是什么?一种数据封装格式,用于封装MetaData,可读性强,可被用户或其他应用读取/编辑 - * - * 继承Task类,专门用于存储同步元数据 - */ + public class MetaData extends Task { - /** - * MetaData.class拿到MetaData的class对象 - * getSimpleName返回类名不含包名的简短形式,这里就是’MetaData‘ - */ private final static String TAG = MetaData.class.getSimpleName(); - //存储当前元数据关联的gid private String mRelatedGid = null; - /** - *设置元数据的核心方法 - * 将关联的gtask ID封装到JSON对象中,并设置为Task的笔记内容和名称 - * @param gid 相当于远端的身份证号 - * @param metaInfo JSONObject对象,用来存储MetaData的JSON格式数据结构。 - */ public void setMeta(String gid, JSONObject metaInfo) { try { metaInfo.put(GTaskStringUtils.META_HEAD_GTASK_ID, gid); @@ -59,27 +40,17 @@ public class MetaData extends Task { setName(GTaskStringUtils.META_NOTE_NAME); } - /** - * 获取当前元数据关联的gtask ID - * @return 关联的远端gtask ID(返回null时,未关联) - */ public String getRelatedGid() { return mRelatedGid; } - //笔记内容不为空就保存 @Override public boolean isWorthSaving() { return getNotes() != null; } - /** - * 从远端gtask返回的JSON数据设置当前元数据内容 - * @param js 远端gtask返回的JSON对象 - */ @Override public void setContentByRemoteJSON(JSONObject js) { - //调用父类方法,初始化task基础属性 super.setContentByRemoteJSON(js); if (getNotes() != null) { try { @@ -92,23 +63,17 @@ public class MetaData extends Task { } } - /**不会将元数据单独保存为JSON文件并保存到本地, - * 而是将MetaData和正文一起存储在本地的SQLite数据库, - * 为了防止用户篡改信息,比如便签的创建时间,导致APP读取数据时出现异常 - */ @Override public void setContentByLocalJSON(JSONObject js) { // this function 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"); } - //无需计算同步动作 @Override public int getSyncAction(Cursor c) { throw new IllegalAccessError("MetaData:getSyncAction should not be called"); diff --git a/src/notes/gtask/data/Node.java b/src/notes/gtask/data/Node.java index 3b393db..63950e0 100644 --- a/src/notes/gtask/data/Node.java +++ b/src/notes/gtask/data/Node.java @@ -20,29 +20,24 @@ 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_NONE = 0; - public static final int SYNC_ACTION_ADD_REMOTE = 1; //远程添加操作 + public static final int SYNC_ACTION_ADD_REMOTE = 1; - public static final int SYNC_ACTION_ADD_LOCAL = 2; //本地添加操作 + 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_REMOTE = 3; - public static final int SYNC_ACTION_DEL_LOCAL = 4; //本地删除操作 + 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_REMOTE = 5; - public static final int SYNC_ACTION_UPDATE_LOCAL = 6; //本地更新操作 + public static final int SYNC_ACTION_UPDATE_LOCAL = 6; - public static final int SYNC_ACTION_UPDATE_CONFLICT = 7; //更新冲突 + public static final int SYNC_ACTION_UPDATE_CONFLICT = 7; - public static final int SYNC_ACTION_ERROR = 8; //同步出错 + public static final int SYNC_ACTION_ERROR = 8; private String mGid; @@ -52,30 +47,23 @@ public abstract class Node { private boolean mDeleted; - //无参构造法,创建Node对象时无需传入任何参数 public Node() { - mGid = null; //常由云端生成 - mName = ""; //不初始化为null:避免后续调用mName.length等方法时触发空指针异常 + mGid = null; + mName = ""; mLastModified = 0; mDeleted = false; } - //JSONObject是JSON实例的抽象类,生成同步创建操作JSON数据,返回操作ID public abstract JSONObject getCreateAction(int actionId); - //生成同步更新操作的JSON数据,返回操作ID 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(); - //通过游标获取同步操作类型,在前面声明为类型变量0-8 public abstract int getSyncAction(Cursor c); public void setGid(String gid) { diff --git a/src/notes/gtask/data/SqlData.java b/src/notes/gtask/data/SqlData.java index b1b4ff9..d3ec3be 100644 --- a/src/notes/gtask/data/SqlData.java +++ b/src/notes/gtask/data/SqlData.java @@ -34,11 +34,7 @@ import net.micode.notes.gtask.exception.ActionFailureException; import org.json.JSONException; import org.json.JSONObject; -/** - *管理便签应用中的数据项(如文本、图片等), - * 负责数据项的加载、从JSON解析数据、生成JSON数据、数据库交互(插入 / 更新)及版本冲突控制, - * 是便签数据在内存与数据库之间的中间层处理类。 - */ + public class SqlData { private static final String TAG = SqlData.class.getSimpleName(); @@ -51,21 +47,16 @@ public class SqlData { 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; - //存储content辅助信息,比如图片的宽度大小等 public static final int DATA_CONTENT_DATA_1_COLUMN = 3; - //更多扩展信息 public static final int DATA_CONTENT_DATA_3_COLUMN = 4; private ContentResolver mContentResolver; - //false表示新创建的未入库数据项,true表示数据库中已经创建的数据项 private boolean mIsCreate; private long mDataId; @@ -80,10 +71,6 @@ public class SqlData { private ContentValues mDiffDataValues; - /** - * mContentResolver是什么? - * @param context - */ public SqlData(Context context) { mContentResolver = context.getContentResolver(); mIsCreate = true; @@ -110,23 +97,13 @@ public class SqlData { mDataContentData3 = c.getString(DATA_CONTENT_DATA_3_COLUMN); } - /** - * 将JSON中的数据项属性映射到SqlData实例的成员变量, - * 记录变更的字段到mDifferentValues中,为后续数据库增量更新做准备 - * 数据序列化,JSON js->实例 - * @param js - * @throws JSONException - */ public void setContent(JSONObject js) throws JSONException { long dataId = js.has(DataColumns.ID) ? js.getLong(DataColumns.ID) : INVALID_ID; - - //新创建的未入库数据项或者是当前实例的已有ID和JSON中解析的ID不一样,说明该字段发生了变更 if (mIsCreate || mDataId != dataId) { mDiffDataValues.put(DataColumns.ID, dataId); } mDataId = dataId; - //判断JSON中是否包含MIME_TYPE键,否则默认为纯文本 String dataMimeType = js.has(DataColumns.MIME_TYPE) ? js.getString(DataColumns.MIME_TYPE) : DataConstants.NOTE; if (mIsCreate || !mDataMimeType.equals(dataMimeType)) { @@ -134,21 +111,18 @@ public class SqlData { } mDataMimeType = dataMimeType; - //判断JSON中是否包含CONTENT键,如便签文本等,否则赋值为空串 String dataContent = js.has(DataColumns.CONTENT) ? js.getString(DataColumns.CONTENT) : ""; if (mIsCreate || !mDataContent.equals(dataContent)) { mDiffDataValues.put(DataColumns.CONTENT, dataContent); } mDataContent = dataContent; - //判断DATA1键,如图片宽度等 long dataContentData1 = js.has(DataColumns.DATA1) ? js.getLong(DataColumns.DATA1) : 0; if (mIsCreate || mDataContentData1 != dataContentData1) { mDiffDataValues.put(DataColumns.DATA1, dataContentData1); } mDataContentData1 = dataContentData1; - //判断DATA3键 String dataContentData3 = js.has(DataColumns.DATA3) ? js.getString(DataColumns.DATA3) : ""; if (mIsCreate || !mDataContentData3.equals(dataContentData3)) { mDiffDataValues.put(DataColumns.DATA3, dataContentData3); @@ -170,39 +144,28 @@ public class SqlData { return js; } - /** - * 将数据项提交到数据库,根据数据项是否为新建,分别执行插入或者更新操作,同时支持版本验证, - * 最终清理变更记录,更新实例状态 - * @param noteId 数据项关联的便签ID - * @param validateVersion 版本验证布尔值,防止多人或者多设备同时改,避免改乱 - * @param version 要验证的版本号 - */ public void commit(long noteId, boolean validateVersion, long version) { - //新创建的项,“插入” if (mIsCreate) { - //未入库,数据库未生成主键,所以当前数据项ID为无效值 if (mDataId == INVALID_ID && mDiffDataValues.containsKey(DataColumns.ID)) { mDiffDataValues.remove(DataColumns.ID); } mDiffDataValues.put(DataColumns.NOTE_ID, noteId); Uri uri = mContentResolver.insert(Notes.CONTENT_DATA_URI, mDiffDataValues); - try { //从数据库返回的地址里抠出数据项的ID + 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"); } - } else { //数据库里本来就有这个项,只是更改内容 + } else { if (mDiffDataValues.size() > 0) { int result = 0; - - //不需要防止多设备更改冲突 if (!validateVersion) { result = mContentResolver.update(ContentUris.withAppendedId( Notes.CONTENT_DATA_URI, mDataId), mDiffDataValues, null, null); - } else { //需要防止多设备更改冲突 + } else { result = mContentResolver.update(ContentUris.withAppendedId( Notes.CONTENT_DATA_URI, mDataId), mDiffDataValues, " ? in (SELECT " + NoteColumns.ID + " FROM " + TABLE.NOTE diff --git a/src/notes/gtask/data/SqlNote.java b/src/notes/gtask/data/SqlNote.java index a854491..79a4095 100644 --- a/src/notes/gtask/data/SqlNote.java +++ b/src/notes/gtask/data/SqlNote.java @@ -37,18 +37,12 @@ import org.json.JSONObject; import java.util.ArrayList; -/** - * sqlNote类用于处理本地数据库中的笔记数据 - * 主要负责笔记的创建、加载(从数据库读数据)、数据同步、把笔记提交到数据库。 - * 相当于单个笔记的生命周期管家。 - * 与Android的ContentProvider进行交互 - */ + public class SqlNote { private static final String TAG = SqlNote.class.getSimpleName(); private static final int INVALID_ID = -99999; - //记录需要从小米便签数据库中查询的字段 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, @@ -58,7 +52,6 @@ public class SqlNote { NoteColumns.VERSION }; - //将PROJECTION_NOTE中的每个字段按顺序赋索引值0-16,便于从cursor中快速获取 public static final int ID_COLUMN = 0; public static final int ALERTED_DATE_COLUMN = 1; @@ -93,11 +86,11 @@ public class SqlNote { public static final int VERSION_COLUMN = 16; - private Context mContext; //上下文对象,用于获取系统服务(如ContentResolver) + private Context mContext; - private ContentResolver mContentResolver; //操作ContentProvider(数据库交互) + private ContentResolver mContentResolver; - private boolean mIsCreate; //标记当前笔记是否为新创建(未存入数据库) + private boolean mIsCreate; private long mId; @@ -107,15 +100,15 @@ public class SqlNote { private long mCreatedDate; - private int mHasAttachment; //是否有附件(0:无,1:有) + private int mHasAttachment; private long mModifiedDate; private long mParentId; - private String mSnippet; // 笔记摘要(简短内容,用于列表展示) + private String mSnippet; - private int mType; // 笔记类型(如:Notes.TYPE_NOTE-普通笔记,TYPE_FOLDER-文件夹) + private int mType; private int mWidgetId; @@ -125,11 +118,10 @@ public class SqlNote { private long mVersion; - private ContentValues mDiffNoteValues; //存储需要更新的字段 + private ContentValues mDiffNoteValues; - private ArrayList mDataList; // 笔记关联的数据列表(如文本内容、图片等,由SqlData管理) + private ArrayList mDataList; - //初始化新笔记 public SqlNote(Context context) { mContext = context; mContentResolver = context.getContentResolver(); @@ -151,12 +143,9 @@ public class SqlNote { mDataList = new ArrayList(); } - //从cursor加载已有笔记 public SqlNote(Context context, Cursor c) { mContext = context; mContentResolver = context.getContentResolver(); - - //从数据库加载,标记为已存在 mIsCreate = false; loadFromCursor(c); mDataList = new ArrayList(); @@ -165,13 +154,10 @@ public class SqlNote { mDiffNoteValues = new ContentValues(); } - //通过id加载已有笔记 public SqlNote(Context context, long id) { mContext = context; mContentResolver = context.getContentResolver(); mIsCreate = false; - - //根据id查询数据库并加载数据 loadFromCursor(id); mDataList = new ArrayList(); if (mType == Notes.TYPE_NOTE) @@ -183,14 +169,13 @@ public class SqlNote { private void loadFromCursor(long id) { Cursor c = null; try { - //查询指定id的笔记 c = mContentResolver.query(Notes.CONTENT_NOTE_URI, PROJECTION_NOTE, "(_id=?)", new String[] { String.valueOf(id) }, null); if (c != null) { - c.moveToNext(); //移动到第一条记录 - loadFromCursor(c); //从cursor加载数据 + c.moveToNext(); + loadFromCursor(c); } else { Log.w(TAG, "loadFromCursor: cursor = null"); } @@ -215,12 +200,10 @@ public class SqlNote { mVersion = c.getLong(VERSION_COLUMN); } - //加载笔记的关联数据(如文本内容) private void loadDataContent() { Cursor c = null; - mDataList.clear(); //清空现有数据 + mDataList.clear(); try { - //根据(note_id=mId)查询当前笔记关联的所有数据 c = mContentResolver.query(Notes.CONTENT_DATA_URI, SqlData.PROJECTION_DATA, "(note_id=?)", new String[] { String.valueOf(mId) @@ -243,26 +226,15 @@ public class SqlNote { } } - /**数据同步相关方法-从JSON对象设置笔记内容,便于同步接收数据 - * JSON解析-内存字段映射-差异记录-持久化落地。 - * setContent解析JSON到SqlNote对象:按照笔记类型解析-元数据映射-内容数据映射-差异记录 - */ public boolean setContent(JSONObject js) { try { - //解析JSON中的笔记元数据note 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) { + } else if (note.getInt(NoteColumns.TYPE) == Notes.TYPE_FOLDER) { // for folder we can only update the snnipet and type String snippet = note.has(NoteColumns.SNIPPET) ? note .getString(NoteColumns.SNIPPET) : ""; - - //如果是新创建或者内容(snippet)有变化时记录差异 if (mIsCreate || !mSnippet.equals(snippet)) { mDiffNoteValues.put(NoteColumns.SNIPPET, snippet); } @@ -274,21 +246,14 @@ public class SqlNote { mDiffNoteValues.put(NoteColumns.TYPE, type); } mType = type; - } - - //普通笔记类型,更新所有元数据和关联数据 - else if (note.getInt(NoteColumns.TYPE) == Notes.TYPE_NOTE) { - //关联数据数组 + } else if (note.getInt(NoteColumns.TYPE) == Notes.TYPE_NOTE) { JSONArray dataArray = js.getJSONArray(GTaskStringUtils.META_HEAD_DATA); - - //逐个解析元数据字段,仅仅记录变化的部分到差异容器,这里是id字段 long id = note.has(NoteColumns.ID) ? note.getLong(NoteColumns.ID) : INVALID_ID; if (mIsCreate || mId != id) { mDiffNoteValues.put(NoteColumns.ID, id); } mId = id; - //提醒日期字段 long alertDate = note.has(NoteColumns.ALERTED_DATE) ? note .getLong(NoteColumns.ALERTED_DATE) : 0; if (mIsCreate || mAlertDate != alertDate) { @@ -296,7 +261,6 @@ public class SqlNote { } mAlertDate = alertDate; - //背景颜色字段 int bgColorId = note.has(NoteColumns.BG_COLOR_ID) ? note .getInt(NoteColumns.BG_COLOR_ID) : ResourceParser.getDefaultBgId(mContext); if (mIsCreate || mBgColorId != bgColorId) { @@ -304,7 +268,6 @@ public class SqlNote { } mBgColorId = bgColorId; - //创建日期字段 long createDate = note.has(NoteColumns.CREATED_DATE) ? note .getLong(NoteColumns.CREATED_DATE) : System.currentTimeMillis(); if (mIsCreate || mCreatedDate != createDate) { @@ -312,7 +275,6 @@ public class SqlNote { } mCreatedDate = createDate; - //有无附件字段 int hasAttachment = note.has(NoteColumns.HAS_ATTACHMENT) ? note .getInt(NoteColumns.HAS_ATTACHMENT) : 0; if (mIsCreate || mHasAttachment != hasAttachment) { @@ -320,7 +282,6 @@ public class SqlNote { } mHasAttachment = hasAttachment; - //修改日期字段 long modifiedDate = note.has(NoteColumns.MODIFIED_DATE) ? note .getLong(NoteColumns.MODIFIED_DATE) : System.currentTimeMillis(); if (mIsCreate || mModifiedDate != modifiedDate) { @@ -328,7 +289,6 @@ public class SqlNote { } mModifiedDate = modifiedDate; - //父文件夹字段 long parentId = note.has(NoteColumns.PARENT_ID) ? note .getLong(NoteColumns.PARENT_ID) : 0; if (mIsCreate || mParentId != parentId) { @@ -336,7 +296,6 @@ public class SqlNote { } mParentId = parentId; - //内容字段 String snippet = note.has(NoteColumns.SNIPPET) ? note .getString(NoteColumns.SNIPPET) : ""; if (mIsCreate || !mSnippet.equals(snippet)) { @@ -344,7 +303,6 @@ public class SqlNote { } mSnippet = snippet; - //笔记类型字段 int type = note.has(NoteColumns.TYPE) ? note.getInt(NoteColumns.TYPE) : Notes.TYPE_NOTE; if (mIsCreate || mType != type) { @@ -352,7 +310,6 @@ public class SqlNote { } mType = type; - //桌面组件id字段 int widgetId = note.has(NoteColumns.WIDGET_ID) ? note.getInt(NoteColumns.WIDGET_ID) : AppWidgetManager.INVALID_APPWIDGET_ID; if (mIsCreate || mWidgetId != widgetId) { @@ -360,7 +317,6 @@ public class SqlNote { } mWidgetId = widgetId; - //桌面组件类型字段 int widgetType = note.has(NoteColumns.WIDGET_TYPE) ? note .getInt(NoteColumns.WIDGET_TYPE) : Notes.TYPE_WIDGET_INVALIDE; if (mIsCreate || mWidgetType != widgetType) { @@ -368,7 +324,6 @@ public class SqlNote { } mWidgetType = widgetType; - //原始父文件夹字段 long originParent = note.has(NoteColumns.ORIGIN_PARENT_ID) ? note .getLong(NoteColumns.ORIGIN_PARENT_ID) : 0; if (mIsCreate || mOriginParent != originParent) { @@ -379,8 +334,6 @@ public class SqlNote { for (int i = 0; i < dataArray.length(); i++) { JSONObject data = dataArray.getJSONObject(i); SqlData sqlData = null; - - //查找已存在的sqlData(通过ID匹配) if (data.has(DataColumns.ID)) { long dataId = data.getLong(DataColumns.ID); for (SqlData temp : mDataList) { @@ -390,13 +343,12 @@ public class SqlNote { } } - //不存在则创建新的sqlData if (sqlData == null) { sqlData = new SqlData(mContext); mDataList.add(sqlData); } - sqlData.setContent(data); //更新数据内容 + sqlData.setContent(data); } } } catch (JSONException e) { @@ -407,7 +359,6 @@ public class SqlNote { return true; } - //将笔记内容转换成JSON对象(用于同步发送数据) public JSONObject getContent() { try { JSONObject js = new JSONObject(); @@ -418,7 +369,6 @@ public class SqlNote { } JSONObject note = new JSONObject(); - //普通笔记:所有元数据+关联数据 if (mType == Notes.TYPE_NOTE) { note.put(NoteColumns.ID, mId); note.put(NoteColumns.ALERTED_DATE, mAlertDate); @@ -434,7 +384,6 @@ public class SqlNote { note.put(NoteColumns.ORIGIN_PARENT_ID, mOriginParent); js.put(GTaskStringUtils.META_HEAD_NOTE, note); - //关联数据转换成JSON数组 JSONArray dataArray = new JSONArray(); for (SqlData sqlData : mDataList) { JSONObject data = sqlData.getContent(); @@ -443,9 +392,7 @@ public class SqlNote { } } js.put(GTaskStringUtils.META_HEAD_DATA, dataArray); - } - //文件夹/系统文件夹:仅包含ID、类型、摘要 - else if (mType == Notes.TYPE_FOLDER || mType == Notes.TYPE_SYSTEM) { + } 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); @@ -460,16 +407,11 @@ public class SqlNote { return null; } - /** - *为什么下面这些数据设置不放在上面的setContent(JSONObject js)函数里 - */ - //设置父文件夹ID并记录差异 public void setParentId(long id) { mParentId = id; mDiffNoteValues.put(NoteColumns.PARENT_ID, id); } - //设置GTask ID 用于同步 public void setGtaskId(String gid) { mDiffNoteValues.put(NoteColumns.GTASK_ID, gid); } @@ -478,14 +420,10 @@ public class SqlNote { mDiffNoteValues.put(NoteColumns.SYNC_ID, syncId); } - //重置本地修改标记(用于修改后) public void resetLocalModified() { mDiffNoteValues.put(NoteColumns.LOCAL_MODIFIED, 0); } - /** - * 下面几个成员函数是为了获取成员变量值 - */ public long getId() { return mId; } @@ -502,20 +440,14 @@ public class SqlNote { return mType == Notes.TYPE_NOTE; } - //数据库提交方法:保存/更新笔记 public void commit(boolean validateVersion) { - //如果是新笔记,就插入到数据库 if (mIsCreate) { - - //移除无效ID,因为数据库会自动生成ID if (mId == INVALID_ID && mDiffNoteValues.containsKey(NoteColumns.ID)) { mDiffNoteValues.remove(NoteColumns.ID); } - //插入笔记元数据到ContentProvider Uri uri = mContentResolver.insert(Notes.CONTENT_NOTE_URI, mDiffNoteValues); try { - //从返回的uri里获取新生成的ID mId = Long.valueOf(uri.getPathSegments().get(1)); } catch (NumberFormatException e) { Log.e(TAG, "Get note id error :" + e.toString()); @@ -525,34 +457,25 @@ public class SqlNote { throw new IllegalStateException("Create thread id failed"); } - //提交关联数据,如文本内容 if (mType == Notes.TYPE_NOTE) { for (SqlData sqlData : mDataList) { sqlData.commit(mId, false, -1); } } - } - //不是新笔记,已经存在,就执行“更新”操作 - else { - //验证ID有效性 + } 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"); } - //有差异才更新 if (mDiffNoteValues.size() > 0) { - mVersion ++; //版本号自增 + mVersion ++; int result = 0; - - //不验证版本,直接更新 if (!validateVersion) { result = mContentResolver.update(Notes.CONTENT_NOTE_URI, mDiffNoteValues, "(" + NoteColumns.ID + "=?)", new String[] { String.valueOf(mId) }); - } - // 验证版本:当数据库版本<=当前版本时更新 - else { + } else { result = mContentResolver.update(Notes.CONTENT_NOTE_URI, mDiffNoteValues, "(" + NoteColumns.ID + "=?) AND (" + NoteColumns.VERSION + "<=?)", new String[] { @@ -564,7 +487,6 @@ public class SqlNote { } } - //提交关联数据 if (mType == Notes.TYPE_NOTE) { for (SqlData sqlData : mDataList) { sqlData.commit(mId, validateVersion, mVersion); @@ -572,12 +494,12 @@ public class SqlNote { } } - // refresh local info, + // refresh local info loadFromCursor(mId); if (mType == Notes.TYPE_NOTE) loadDataContent(); - mDiffNoteValues.clear(); //清空差异字段 - mIsCreate = false; //标记为已创建 + mDiffNoteValues.clear(); + mIsCreate = false; } } diff --git a/src/notes/gtask/data/Task.java b/src/notes/gtask/data/Task.java index acde9c3..6a19454 100644 --- a/src/notes/gtask/data/Task.java +++ b/src/notes/gtask/data/Task.java @@ -31,22 +31,19 @@ import org.json.JSONArray; import org.json.JSONException; import org.json.JSONObject; -/** - * 继承Node类,具体实现 Node类中定义的方法,包括更新、删除、添加操作等 - */ + public class Task extends Node { private static final String TAG = Task.class.getSimpleName(); - private boolean mCompleted; //Google 任务是否已完成(勾选状态) + private boolean mCompleted; - private String mNotes; //任务备注正文 + private String mNotes; - private JSONObject mMetaInfo;//定义Task的MetaData的JSON数据格式 + private JSONObject mMetaInfo; - //指向当前任务点的前兄弟任务的指针/引用,用于在内存中关联当前任务的前一个任务 private Task mPriorSibling; - private TaskList mParent; //定义所属的Google TaskList + private TaskList mParent; public Task() { super(); @@ -57,11 +54,6 @@ public class Task extends Node { mMetaInfo = null; } - /**生成“创建任务”的JSON指令,用于将本地新建任务同步到云端z - * - * @param actionId - * @return 一个JSON对象实例 包括“创建”操作信息和“业务”信息 - */ public JSONObject getCreateAction(int actionId) { JSONObject js = new JSONObject(); @@ -76,10 +68,6 @@ public class Task extends Node { // index js.put(GTaskStringUtils.GTASK_JSON_INDEX, mParent.getChildTaskIndex(this)); - /**为什么要再创建一个JSONObject实例对象? - * 分层设计:操作信息+业务实体信息 - * entity存储这个业务对象的具体数据内容,比如任务标题、任务备注、完成状态、gid - */ // entity_delta JSONObject entity = new JSONObject(); entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName()); @@ -89,7 +77,6 @@ public class Task extends Node { if (getNotes() != null) { entity.put(GTaskStringUtils.GTASK_JSON_NOTES, getNotes()); } - js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); // parent_id @@ -108,10 +95,7 @@ public class Task extends Node { } } catch (JSONException e) { - //toString输出异常本身的类型和描述 Log.e(TAG, e.toString()); - - //还原异常的发生现场,通过栈进行追踪 e.printStackTrace(); throw new ActionFailureException("fail to generate task-create jsonobject"); } @@ -119,11 +103,6 @@ public class Task extends Node { return js; } - /**生成“更新任务”的JSON指令 - * - * @param actionId - * @return 一个JSON对象实例 包括“更新”信息+业务信息 - */ public JSONObject getUpdateAction(int actionId) { JSONObject js = new JSONObject(); @@ -142,7 +121,7 @@ public class Task extends Node { JSONObject entity = new JSONObject(); 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); @@ -156,12 +135,7 @@ public class Task extends Node { return js; } - /** - * 执行具体操作,根据远端的JSON设置本地的内容 - * @param js 远端的JSON实例 - */ public void setContentByRemoteJSON(JSONObject js) { - if (js != null) { try { // id @@ -201,23 +175,13 @@ public class Task extends Node { } } - /** - * 将小米便签本地存储的JSON格式数据解析并映射为Task对象的核心属性, - * 为本地便签数据同步到云端提供数据适配和内容提取能力。 - * @param js - */ public void setContentByLocalJSON(JSONObject js) { - //若是本地JSON不含便签元信息+内容数据,输出错误日志 if (js == null || !js.has(GTaskStringUtils.META_HEAD_NOTE) || !js.has(GTaskStringUtils.META_HEAD_DATA)) { Log.w(TAG, "setContentByLocalJSON: nothing is avaiable"); } try { - /**提取同步所需的基础数据 - * note:小米便签存储本地的便签元数据,如便签类型、创建时间、同步状态等 - * dataArray:便签内容数组,可能包括文本、图片、附件等多种数据类型 - */ JSONObject note = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); JSONArray dataArray = js.getJSONArray(GTaskStringUtils.META_HEAD_DATA); @@ -240,7 +204,6 @@ public class Task extends Node { } } - //返回完整 JSON,供本地数据库保存或上传云端 public JSONObject getLocalJSONFromContent() { String name = getName(); try { @@ -284,7 +247,6 @@ public class Task extends Node { } } - //将小米便签的MetaData元数据对象中的JSON格式解析为mMetaInfo public void setMetaInfo(MetaData metaData) { if (metaData != null && metaData.getNotes() != null) { try { @@ -296,11 +258,6 @@ public class Task extends Node { } } - /** - * 对比本地数据库中的便签数据(cursor)和当前task对象中缓存的云端元数据信息(mMetaInfo), - * 从数据、修改状态、GID等多维度进行比较校验, - * 最终判断当前标签需要执行的同步操作类型,比如无操作、更新本地、更新远端等 - */ public int getSyncAction(Cursor c) { try { JSONObject noteInfo = null; @@ -324,7 +281,6 @@ public class Task extends Node { return SYNC_ACTION_UPDATE_LOCAL; } - //本地无修改 if (c.getInt(SqlNote.LOCAL_MODIFIED_COLUMN) == 0) { // there is no local update if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) { @@ -334,18 +290,12 @@ public class Task extends Node { // apply remote to local return SYNC_ACTION_UPDATE_LOCAL; } - } else { //本地有修改 + } else { // validate gtask id if (!c.getString(SqlNote.GTASK_ID_COLUMN).equals(getGid())) { Log.e(TAG, "gtask id doesn't match"); return SYNC_ACTION_ERROR; } - - /**SqlNote.SYNC_ID_COLUMN是本地数据库中SqlNote表的一个字段名 - * 存储本地记录的最后一次与云端同步的时间戳。 - * 字段名带ID是命名习惯,实际存储的是时间戳 / 同步版本号,而非普通 ID)。 - * getLastModified()返回远端任务的最后修改时间戳 - */ if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) { // local modification only return SYNC_ACTION_UPDATE_REMOTE; @@ -361,7 +311,6 @@ public class Task extends Node { return SYNC_ACTION_ERROR; } - //空任务、空备注、无元数据 → 不值得存/上传,直接跳过 public boolean isWorthSaving() { return mMetaInfo != null || (getName() != null && getName().trim().length() > 0) || (getNotes() != null && getNotes().trim().length() > 0); diff --git a/src/notes/gtask/data/TaskList.java b/src/notes/gtask/data/TaskList.java index 1726969..4ea21c5 100644 --- a/src/notes/gtask/data/TaskList.java +++ b/src/notes/gtask/data/TaskList.java @@ -33,9 +33,9 @@ import java.util.ArrayList; public class TaskList extends Node { private static final String TAG = TaskList.class.getSimpleName(); - private int mIndex; //列表索引,找到特定的task + private int mIndex; - private ArrayList mChildren; //task列表 + private ArrayList mChildren; public TaskList() { super(); @@ -43,7 +43,6 @@ public class TaskList extends Node { mIndex = 1; } - //生成TaskList“创建任务”的JSON public JSONObject getCreateAction(int actionId) { JSONObject js = new JSONObject(); @@ -75,20 +74,18 @@ public class TaskList extends Node { return js; } - //“更新操作”的JSON public JSONObject getUpdateAction(int actionId) { JSONObject js = new JSONObject(); try { // action_type - //设置操作类型,明确告诉远端此次操作为“更新” js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, GTaskStringUtils.GTASK_JSON_ACTION_TYPE_UPDATE); - // action_id 操作ID(追踪操作结果) + // action_id js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId); - // id(要更新的任务/任务列表GID) + // id js.put(GTaskStringUtils.GTASK_JSON_ID, getGid()); // entity_delta @@ -109,7 +106,7 @@ public class TaskList extends Node { public void setContentByRemoteJSON(JSONObject js) { if (js != null) { try { - // id(本地和远端ID一致) + // id if (js.has(GTaskStringUtils.GTASK_JSON_ID)) { setGid(js.getString(GTaskStringUtils.GTASK_JSON_ID)); } @@ -133,7 +130,6 @@ public class TaskList extends Node { } public void setContentByLocalJSON(JSONObject js) { - //本地JSON为空或者是否包含核心字段META_HEAD_NOTE if (js == null || !js.has(GTaskStringUtils.META_HEAD_NOTE)) { Log.w(TAG, "setContentByLocalJSON: nothing is avaiable"); } @@ -141,7 +137,6 @@ public class TaskList extends Node { 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); @@ -162,10 +157,6 @@ public class TaskList extends Node { } } - /** - * MIUI_FOLDER_PREFFIX 在远端区分小米便签同步的文件夹和其他应用创建的文件夹,避免命名冲突 - * @return 本地JSON - */ public JSONObject getLocalJSONFromContent() { try { JSONObject js = new JSONObject(); @@ -173,7 +164,6 @@ public class TaskList extends Node { String folderName = getName(); if (getName().startsWith(GTaskStringUtils.MIUI_FOLDER_PREFFIX)) - //从云端文件夹名称中去掉小米前缀,还原本地文件夹的原始名称 folderName = folderName.substring(GTaskStringUtils.MIUI_FOLDER_PREFFIX.length(), folderName.length()); folder.put(NoteColumns.SNIPPET, folderName); @@ -193,11 +183,10 @@ public class TaskList extends Node { } } - //使用游标判断 本地和远端状态,返回同步操作类型号 public int getSyncAction(Cursor c) { try { if (c.getInt(SqlNote.LOCAL_MODIFIED_COLUMN) == 0) { - // there is no local update 本地无更新 + // there is no local update if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) { // no update both side return SYNC_ACTION_NONE; @@ -205,14 +194,12 @@ public class TaskList extends Node { // apply remote to local return SYNC_ACTION_UPDATE_LOCAL; } - } else { //本地有更新,检验本地和远端ID是否一致,再决定最终的同步策略 + } else { // validate gtask id if (!c.getString(SqlNote.GTASK_ID_COLUMN).equals(getGid())) { Log.e(TAG, "gtask id doesn't match"); return SYNC_ACTION_ERROR; } - - //在本地和远端ID一致前提下,进一步判断云端数据是否有更新 if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) { // local modification only return SYNC_ACTION_UPDATE_REMOTE; @@ -233,7 +220,6 @@ public class TaskList extends Node { return mChildren.size(); } - //添加子任务 public boolean addChildTask(Task task) { boolean ret = false; if (task != null && !mChildren.contains(task)) { @@ -248,7 +234,6 @@ public class TaskList extends Node { return ret; } - //指定位置插入子任务 public boolean addChildTask(Task task, int index) { if (index < 0 || index > mChildren.size()) { Log.e(TAG, "add child task: invalid index"); @@ -256,20 +241,14 @@ public class TaskList extends Node { } int pos = mChildren.indexOf(task); - - //pos==-1说明task不在mChildren里 if (task != null && pos == -1) { mChildren.add(index, task); - // update the task list更新任务列表索引 + // update the task list Task preTask = null; Task afterTask = null; - - //如果插入位置不在第一个,前任务为index-1的位置 if (index != 0) preTask = mChildren.get(index - 1); - - //如果插入位置不在最后一个,后继任务为index+1的位置 if (index != mChildren.size() - 1) afterTask = mChildren.get(index + 1); @@ -281,12 +260,9 @@ public class TaskList extends Node { return true; } - //移除子任务 public boolean removeChildTask(Task task) { boolean ret = false; int index = mChildren.indexOf(task); - - //index!=-1说明task在mChildren里,移除操作有效 if (index != -1) { ret = mChildren.remove(task); @@ -300,13 +276,11 @@ public class TaskList extends Node { mChildren.get(index).setPriorSibling( index == 0 ? null : mChildren.get(index - 1)); } - //当移除最后一个任务时,index==mChildren.size(),没有后续任务,无需更新 } } return ret; } - //将指定task从当前位置移到mChildren列表指定的index位置 public boolean moveChildTask(Task task, int index) { if (index < 0 || index >= mChildren.size()) { @@ -320,20 +294,11 @@ public class TaskList extends Node { return false; } - //当前已经在指定位置,不用移动 if (pos == index) return true; return (removeChildTask(task) && addChildTask(task, index)); - - //这里先判断当前不在指定位置,是不是更好?至少更容易一下子看懂 - /** - * if (pos!=index) - * return (removeChildTask(task) && addChildTask(task,index)); - * else return true; - */ } - //给定云端gid快速查找子任务 public Task findChildTaskByGid(String gid) { for (int i = 0; i < mChildren.size(); i++) { Task t = mChildren.get(i); @@ -344,12 +309,10 @@ public class TaskList extends Node { return null; } - //返回给定子任务序号 public int getChildTaskIndex(Task task) { return mChildren.indexOf(task); } - //根据列表序号返回子任务 public Task getChildTaskByIndex(int index) { if (index < 0 || index >= mChildren.size()) { Log.e(TAG, "getTaskByIndex: invalid index"); @@ -358,24 +321,12 @@ public class TaskList extends Node { return mChildren.get(index); } - /**根据云端gid返回子任务 - *这个似乎和前面的findChildTaskByGid(String gid)是一样的? - */ - public Task getChildTaskByGid(String gid) { + public Task getChilTaskByGid(String gid) { for (Task task : mChildren) { if (task.getGid().equals(gid)) return task; } return null; - /* - for (int i = 0; i < mChildren.size(); i++) { - Task t = mChildren.get(i); - if (t.getGid().equals(gid)) { - return t; - } - } - return null; - */ } public ArrayList getChildTaskList() { diff --git a/src/notes/gtask/exception/ActionFailureException.java b/src/notes/gtask/exception/ActionFailureException.java index b8b51f1..15504be 100644 --- a/src/notes/gtask/exception/ActionFailureException.java +++ b/src/notes/gtask/exception/ActionFailureException.java @@ -16,11 +16,6 @@ package net.micode.notes.gtask.exception; -/**运行异常类 - * 继承自RuntimeException类, - * 专门标识“某个操作执行失败”的异常场景, - * 比如 GTask 同步失败、数据库操作失败、网络请求失败等 - */ public class ActionFailureException extends RuntimeException { private static final long serialVersionUID = 4425249765923293627L; @@ -28,15 +23,10 @@ public class ActionFailureException extends RuntimeException { super(); } - /** - * 调用父类的RuntimeException(String)构造方法 - super函数 - * @param paramString 错误描述字符串 - */ public ActionFailureException(String paramString) { super(paramString); } - //错误信息+异常原因 public ActionFailureException(String paramString, Throwable paramThrowable) { super(paramString, paramThrowable); } diff --git a/src/notes/gtask/exception/NetworkFailureException.java b/src/notes/gtask/exception/NetworkFailureException.java index 2a1e178..b08cfb1 100644 --- a/src/notes/gtask/exception/NetworkFailureException.java +++ b/src/notes/gtask/exception/NetworkFailureException.java @@ -16,11 +16,6 @@ package net.micode.notes.gtask.exception; -/**受检异常类 - * 继承自Exception类 - * 专门标识 “网络操作失败” 的异常场景, - * 比如 GTask 同步时的网络连接超时、请求失败、服务器无响应、网络断开等。 - */ public class NetworkFailureException extends Exception { private static final long serialVersionUID = 2107610287180234136L; @@ -32,7 +27,6 @@ public class NetworkFailureException extends Exception { super(paramString); } - //自定义错误信息+底层的根异常 public NetworkFailureException(String paramString, Throwable paramThrowable) { super(paramString, paramThrowable); } diff --git a/src/notes/gtask/remote/GTaskASyncTask.java b/src/notes/gtask/remote/GTaskASyncTask.java index 5a4ace7..b3b61e7 100644 --- a/src/notes/gtask/remote/GTaskASyncTask.java +++ b/src/notes/gtask/remote/GTaskASyncTask.java @@ -28,137 +28,77 @@ import net.micode.notes.R; import net.micode.notes.ui.NotesListActivity; import net.micode.notes.ui.NotesPreferenceActivity; -/** - *异步任务类,继承AsyncTask, - * doInBackground(后台执行)→ onProgressUpdate(进度更新)→ onPostExecute(结果处理) - * 在后台执行GTask的同步逻辑,通过GTaskManager实现登录、拉取、提交等操作, - * 实时通过状态栏通知向用户展示同步进度(登录中、同步中), - * 同步完成后,根据结果(成功 / 失败 / 取消)显示对应通知,并通过回调接口通知外层组件; - * 支持取消同步操作,以及同步状态的广播通知。 - */ + public class GTaskASyncTask extends AsyncTask { private static int GTASK_SYNC_NOTIFICATION_ID = 5234235; - //通知Activity等外层同步已结束,是接口 public interface OnCompleteListener { void onComplete(); } - private Context mContext; //上下文,用于获取系统服务、资源字符串、启动Activity等 + private Context mContext; - private NotificationManager mNotifiManager; //用于发送和管理状态栏通知 + private NotificationManager mNotifiManager; - private GTaskManager mTaskManager; //真正执行同步核心逻辑(登录、拉取、对比、提交等) + private GTaskManager mTaskManager; - private OnCompleteListener mOnCompleteListener; //通知外层 Activity/Service 同步结束 + private OnCompleteListener mOnCompleteListener; - //构造方法:初始化上下文和回调监听器,获取通知管理器和GTaskManager实例 public GTaskASyncTask(Context context, OnCompleteListener listener) { mContext = context; mOnCompleteListener = listener; mNotifiManager = (NotificationManager) mContext .getSystemService(Context.NOTIFICATION_SERVICE); - //获取GTaskManager单例实例 (负责实际同步逻辑) mTaskManager = GTaskManager.getInstance(); } - //终止同步的方法 public void cancelSync() { mTaskManager.cancelSync(); } - //反馈给用户当前进度(这里或许应该是Progress?) public void publishProgess(String message) { publishProgress(new String[] { message }); } -// private void showNotification(int tickerId, String content) { -// Notification notification = new Notification(R.drawable.notification, mContext -// .getString(tickerId), System.currentTimeMillis()); -// notification.defaults = Notification.DEFAULT_LIGHTS; -// notification.flags = Notification.FLAG_AUTO_CANCEL; -// PendingIntent pendingIntent; -// if (tickerId != R.string.ticker_success) { -// pendingIntent = PendingIntent.getActivity(mContext, 0, new Intent(mContext, -// NotesPreferenceActivity.class), 0); -// -// } else { -// pendingIntent = PendingIntent.getActivity(mContext, 0, new Intent(mContext, -// NotesListActivity.class), 0); -// } -// notification.setLatestEventInfo(mContext, mContext.getString(R.string.app_name), content, -// pendingIntent); -// mNotifiManager.notify(GTASK_SYNC_NOTIFICATION_ID, notification); -// } - - /** - * 显示状态栏通知的核心方法:根据同步状态显示不同内容和跳转意图 - * @param tickerId 通知类型 - * @param content - */ private void showNotification(int tickerId, String content) { - //延迟意图:点击通知时触发的页面跳转 + Notification notification = new Notification(R.drawable.notification, mContext + .getString(tickerId), System.currentTimeMillis()); + notification.defaults = Notification.DEFAULT_LIGHTS; + notification.flags = Notification.FLAG_AUTO_CANCEL; PendingIntent pendingIntent; - - //同步不成功,跳转到偏好设置页面 if (tickerId != R.string.ticker_success) { pendingIntent = PendingIntent.getActivity(mContext, 0, new Intent(mContext, - NotesPreferenceActivity.class), PendingIntent.FLAG_IMMUTABLE); - } else { //同步成功,跳转到笔记列表页 + NotesPreferenceActivity.class), 0); + + } else { pendingIntent = PendingIntent.getActivity(mContext, 0, new Intent(mContext, - NotesListActivity.class), PendingIntent.FLAG_IMMUTABLE); + NotesListActivity.class), 0); } - - //设置通知属性 - Notification.Builder builder = new Notification.Builder(mContext) - .setAutoCancel(true) - .setContentTitle(mContext.getString(R.string.app_name)) //通知标题设置 - .setContentText(content) //通知内容设置 - .setContentIntent(pendingIntent) //点击通知时的跳转意图 - .setWhen(System.currentTimeMillis()) //通知时间 - .setOngoing(true); //持续通知,不会被滑动清除,同步过程中保持显示 - Notification notification=builder.getNotification(); - - //通过通知管理器显示通知(使用固定ID,确保后续通知能覆盖之前的) + notification.setLatestEventInfo(mContext, mContext.getString(R.string.app_name), content, + pendingIntent); mNotifiManager.notify(GTASK_SYNC_NOTIFICATION_ID, notification); } - /** - * 后台执行方法:在子线程中执行同步核心逻辑 - * 调用GTaskManager的sync方法执行同步,传入上下文和当前任务实例(用于更新进度) - * @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); } - /** - * 进度更新方法:在UI线程执行,接收后台发布的进度并更新通知 - * @param progress - */ @Override protected void onProgressUpdate(String... progress) { - // 显示"同步中"的通知,内容为后台传来的进度信息 showNotification(R.string.ticker_syncing, progress[0]); - - // 若当前上下文是GTaskSyncService(同步服务),则发送广播告知进度 if (mContext instanceof GTaskSyncService) { ((GTaskSyncService) mContext).sendBroadcast(progress[0]); } } - // 任务完成方法:处理同步结果 @Override protected void onPostExecute(Integer result) { - //“同步成功”,更新偏好设置中的最后同步时间 if (result == GTaskManager.STATE_SUCCESS) { showNotification(R.string.ticker_success, mContext.getString( R.string.success_sync_account, mTaskManager.getSyncAccount())); diff --git a/src/notes/gtask/remote/GTaskClient.java b/src/notes/gtask/remote/GTaskClient.java index 13cea91..c67dfdf 100644 --- a/src/notes/gtask/remote/GTaskClient.java +++ b/src/notes/gtask/remote/GTaskClient.java @@ -60,40 +60,35 @@ import java.util.zip.GZIPInputStream; import java.util.zip.Inflater; import java.util.zip.InflaterInputStream; -/** - * Google任务客户端, - * 负责与Google任务服务的网络通信(HTTP请求/响应处理) - */ + public class GTaskClient { private static final String TAG = GTaskClient.class.getSimpleName(); - // 获取任务列表的GET请求URL private static final String GTASK_URL = "https://mail.google.com/tasks/"; - // 提交操作的POST请求URL private static final String GTASK_GET_URL = "https://mail.google.com/tasks/ig"; private static final String GTASK_POST_URL = "https://mail.google.com/tasks/r/ig"; private static GTaskClient mInstance = null; - private DefaultHttpClient mHttpClient; // HTTP客户端:用于发送HTTP请求 + private DefaultHttpClient mHttpClient; - private String mGetUrl; // 实际使用的GET请求URL(可能因域名变化) + private String mGetUrl; - private String mPostUrl; // 实际使用的POST请求URL(可能因域名变化) + private String mPostUrl; - private long mClientVersion; // 客户端版本:从Google服务获取,用于请求验证 + private long mClientVersion; - private boolean mLoggedin; // 登录状态标识 + private boolean mLoggedin; private long mLastLoginTime; private int mActionId; - private Account mAccount; // 当前登录的Google账户 + private Account mAccount; - private JSONArray mUpdateArray; // 更新队列:批量存储待提交的更新操作(减少网络请求次数) + private JSONArray mUpdateArray; private GTaskClient() { mHttpClient = null; @@ -107,7 +102,6 @@ public class GTaskClient { mUpdateArray = null; } - //保证全局一个客户端实例 public static synchronized GTaskClient getInstance() { if (mInstance == null) { mInstance = new GTaskClient(); @@ -115,33 +109,27 @@ public class GTaskClient { return mInstance; } - // 登录Google任务:处理账户认证和会话建立 public boolean login(Activity activity) { // we suppose that the cookie would expire after 5 minutes // then we need to re-login - // 登录过期检查:假设Cookie 5分钟过期,过期则需要重新登录 final long interval = 1000 * 60 * 5; if (mLastLoginTime + interval < System.currentTimeMillis()) { mLoggedin = false; } // need to re-login after account switch - // 账户切换检查:若当前账户与设置中的账户不一致,需要重新登录 if (mLoggedin && !TextUtils.equals(getSyncAccount().name, NotesPreferenceActivity .getSyncAccountName(activity))) { mLoggedin = false; } - // 已登录且有效,直接返回成功 if (mLoggedin) { Log.d(TAG, "already logged in"); return true; } - // 执行登录流程 mLastLoginTime = System.currentTimeMillis(); - // 获取Google账户的认证token String authToken = loginGoogleAccount(activity, false); if (authToken == null) { Log.e(TAG, "login google account failed"); @@ -149,24 +137,21 @@ public class GTaskClient { } // login with custom domain if necessary - // 处理自定义域名账户(非gmail/googlemail) if (!(mAccount.name.toLowerCase().endsWith("gmail.com") || mAccount.name.toLowerCase() .endsWith("googlemail.com"))) { StringBuilder url = new StringBuilder(GTASK_URL).append("a/"); int index = mAccount.name.indexOf('@') + 1; - String suffix = mAccount.name.substring(index); // 提取域名后缀 + String suffix = mAccount.name.substring(index); url.append(suffix + "/"); mGetUrl = url.toString() + "ig"; mPostUrl = url.toString() + "r/ig"; - // 尝试用自定义URL登录 if (tryToLoginGtask(activity, authToken)) { mLoggedin = true; } } // try to login with google official url - // 若自定义域名登录失败,使用官方URL重试 if (!mLoggedin) { mGetUrl = GTASK_GET_URL; mPostUrl = GTASK_POST_URL; @@ -179,19 +164,16 @@ public class GTaskClient { return true; } - // 登录Google账户:获取认证token(用于后续Google任务登录) private String loginGoogleAccount(Activity activity, boolean invalidateToken) { String authToken; - AccountManager accountManager = AccountManager.get(activity); // 获取账户管理器 - Account[] accounts = accountManager.getAccountsByType("com.google"); // 获取所有Google账户 + AccountManager accountManager = AccountManager.get(activity); + Account[] accounts = accountManager.getAccountsByType("com.google"); - // 无可用Google账户 if (accounts.length == 0) { Log.e(TAG, "there is no available google account"); return null; } - // 获取设置中配置的同步账户名 String accountName = NotesPreferenceActivity.getSyncAccountName(activity); Account account = null; for (Account a : accounts) { @@ -208,13 +190,12 @@ public class GTaskClient { } // get the token now - // 获取账户的auth token AccountManagerFuture accountManagerFuture = accountManager.getAuthToken(account, "goanna_mobile", null, activity, null, null); try { - Bundle authTokenBundle = accountManagerFuture.getResult(); // 获取token结果 + Bundle authTokenBundle = accountManagerFuture.getResult(); authToken = authTokenBundle.getString(AccountManager.KEY_AUTHTOKEN); - if (invalidateToken) { // 若需要失效旧token,重新获取 + if (invalidateToken) { accountManager.invalidateAuthToken("com.google", authToken); loginGoogleAccount(activity, false); } @@ -226,19 +207,16 @@ public class GTaskClient { return authToken; } - // 尝试登录Google任务:使用获取的auth token建立会话 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 - // 可能是token过期,失效旧token并重新获取 authToken = loginGoogleAccount(activity, true); if (authToken == null) { Log.e(TAG, "login google account failed"); return false; } - // 再次尝试登录 if (!loginGtask(authToken)) { Log.e(TAG, "login gtask failed"); return false; @@ -247,29 +225,25 @@ public class GTaskClient { return true; } - // 登录Google任务核心逻辑:使用auth token获取会话Cookie和客户端版本 private boolean loginGtask(String authToken) { - // 设置HTTP连接超时(10秒)和读取超时(15秒) int timeoutConnection = 10000; int timeoutSocket = 15000; HttpParams httpParameters = new BasicHttpParams(); HttpConnectionParams.setConnectionTimeout(httpParameters, timeoutConnection); HttpConnectionParams.setSoTimeout(httpParameters, timeoutSocket); - mHttpClient = new DefaultHttpClient(httpParameters); // 初始化HTTP客户端 + mHttpClient = new DefaultHttpClient(httpParameters); BasicCookieStore localBasicCookieStore = new BasicCookieStore(); - mHttpClient.setCookieStore(localBasicCookieStore); // 设置Cookie存储 + mHttpClient.setCookieStore(localBasicCookieStore); HttpProtocolParams.setUseExpectContinue(mHttpClient.getParams(), false); // login gtask - // 执行登录请求 try { - String loginUrl = mGetUrl + "?auth=" + authToken; // 构建带token的登录URL - HttpGet httpGet = new HttpGet(loginUrl);// 创建GET请求 + String loginUrl = mGetUrl + "?auth=" + authToken; + HttpGet httpGet = new HttpGet(loginUrl); HttpResponse response = null; - response = mHttpClient.execute(httpGet); // 发送请求 + response = mHttpClient.execute(httpGet); // get the cookie now - // 检查是否获取到认证Cookie(含"GTL"标识) List cookies = mHttpClient.getCookieStore().getCookies(); boolean hasAuthCookie = false; for (Cookie cookie : cookies) { @@ -282,18 +256,17 @@ public class GTaskClient { } // get the client version - // 解析响应获取客户端版本(用于后续请求) String resString = getResponseContent(response.getEntity()); - String jsBegin = "_setup("; // 响应中包含客户端版本的JS前缀 - String jsEnd = ")}"; // 后缀 + String jsBegin = "_setup("; + String jsEnd = ")}"; int begin = resString.indexOf(jsBegin); int end = resString.lastIndexOf(jsEnd); String jsString = null; if (begin != -1 && end != -1 && begin < end) { - jsString = resString.substring(begin + jsBegin.length(), end);// 提取JS内容 + jsString = resString.substring(begin + jsBegin.length(), end); } JSONObject js = new JSONObject(jsString); - mClientVersion = js.getLong("v"); // 获取客户端版本 + mClientVersion = js.getLong("v"); } catch (JSONException e) { Log.e(TAG, e.toString()); e.printStackTrace(); @@ -307,29 +280,25 @@ public class GTaskClient { return true; } - // 获取操作ID:每次调用递增,用于标识请求的唯一性 private int getActionId() { return mActionId++; } - // 创建POST请求:设置请求头(Content-Type等) private HttpPost createHttpPost() { HttpPost httpPost = new HttpPost(mPostUrl); httpPost.setHeader("Content-Type", "application/x-www-form-urlencoded;charset=utf-8"); - httpPost.setHeader("AT", "1"); // 自定义头,可能用于标识客户端类型 + httpPost.setHeader("AT", "1"); return httpPost; } - // 读取响应内容:处理压缩(gzip/deflate)并转换为字符串 private String getResponseContent(HttpEntity entity) throws IOException { String contentEncoding = null; if (entity.getContentEncoding() != null) { - contentEncoding = entity.getContentEncoding().getValue(); // 获取编码方式 + contentEncoding = entity.getContentEncoding().getValue(); Log.d(TAG, "encoding: " + contentEncoding); } InputStream input = entity.getContent(); - // 根据编码方式解压 if (contentEncoding != null && contentEncoding.equalsIgnoreCase("gzip")) { input = new GZIPInputStream(entity.getContent()); } else if (contentEncoding != null && contentEncoding.equalsIgnoreCase("deflate")) { @@ -338,7 +307,6 @@ public class GTaskClient { } try { - // 读取输入流并转换为字符串 InputStreamReader isr = new InputStreamReader(input); BufferedReader br = new BufferedReader(isr); StringBuilder sb = new StringBuilder(); @@ -355,37 +323,33 @@ public class GTaskClient { } } - // 发送POST请求:封装JSON请求并处理响应 private JSONObject postRequest(JSONObject js) throws NetworkFailureException { if (!mLoggedin) { Log.e(TAG, "please login first"); throw new ActionFailureException("not logged in"); } - HttpPost httpPost = createHttpPost(); // 创建POST请求 + HttpPost httpPost = createHttpPost(); try { - // 构建请求参数(将JSON作为"r"参数的值) LinkedList list = new LinkedList(); list.add(new BasicNameValuePair("r", js.toString())); - // 编码为表单格式 UrlEncodedFormEntity entity = new UrlEncodedFormEntity(list, "UTF-8"); httpPost.setEntity(entity); // execute the post - // 执行请求并获取响应 HttpResponse response = mHttpClient.execute(httpPost); String jsString = getResponseContent(response.getEntity()); return new JSONObject(jsString); - } catch (ClientProtocolException e) { // HTTP协议异常 + } catch (ClientProtocolException e) { Log.e(TAG, e.toString()); e.printStackTrace(); throw new NetworkFailureException("postRequest failed"); - } catch (IOException e) { // IO异常 + } catch (IOException e) { Log.e(TAG, e.toString()); e.printStackTrace(); throw new NetworkFailureException("postRequest failed"); - } catch (JSONException e) { // JSON解析异常 + } catch (JSONException e) { Log.e(TAG, e.toString()); e.printStackTrace(); throw new ActionFailureException("unable to convert response content to jsonobject"); @@ -396,27 +360,21 @@ public class GTaskClient { } } - // 创建远程任务:向Google任务服务发送创建任务请求 public void createTask(Task task) throws NetworkFailureException { - // 先提交之前的更新队列(避免冲突) commitUpdate(); try { JSONObject jsPost = new JSONObject(); JSONArray actionList = new JSONArray(); // action_list - // 添加创建任务的操作 actionList.put(task.getCreateAction(getActionId())); jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList); // client_version - // 添加客户端版本(用于服务端验证) jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion); // post - // 发送请求并获取响应 JSONObject jsResponse = postRequest(jsPost); - // 从响应中获取新创建任务的GID并设置到任务对象 JSONObject jsResult = (JSONObject) jsResponse.getJSONArray( GTaskStringUtils.GTASK_JSON_RESULTS).get(0); task.setGid(jsResult.getString(GTaskStringUtils.GTASK_JSON_NEW_ID)); @@ -428,27 +386,21 @@ public class GTaskClient { } } - // 创建远程任务列表:向Google任务服务发送创建列表请求 public void createTaskList(TaskList tasklist) throws NetworkFailureException { - // 先提交之前的更新队列 commitUpdate(); try { JSONObject jsPost = new JSONObject(); JSONArray actionList = new JSONArray(); // action_list - // 添加创建列表的操作 actionList.put(tasklist.getCreateAction(getActionId())); jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList); // client version - // 添加客户端版本 jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion); // post - // 发送请求并获取响应 JSONObject jsResponse = postRequest(jsPost); - // 从响应中获取新创建列表的GID并设置 JSONObject jsResult = (JSONObject) jsResponse.getJSONArray( GTaskStringUtils.GTASK_JSON_RESULTS).get(0); tasklist.setGid(jsResult.getString(GTaskStringUtils.GTASK_JSON_NEW_ID)); @@ -460,22 +412,19 @@ public class GTaskClient { } } - // 提交更新队列:将缓存的更新操作批量发送到服务端 public void commitUpdate() throws NetworkFailureException { if (mUpdateArray != null) { try { JSONObject jsPost = new JSONObject(); // action_list - // 设置更新操作列表 jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, mUpdateArray); // client_version - // 设置客户端版本 jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion); postRequest(jsPost); - mUpdateArray = null; // 清空队列 + mUpdateArray = null; } catch (JSONException e) { Log.e(TAG, e.toString()); e.printStackTrace(); @@ -484,12 +433,10 @@ public class GTaskClient { } } - // 添加更新节点到队列:将节点的更新操作加入缓存队列(批量提交) 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(避免单次请求过大) if (mUpdateArray != null && mUpdateArray.length() > 10) { commitUpdate(); } @@ -500,7 +447,6 @@ public class GTaskClient { } } - // 移动任务:将任务从原列表移动到新列表(或列表内调整位置) public void moveTask(Task task, TaskList preParent, TaskList curParent) throws NetworkFailureException { commitUpdate(); @@ -510,23 +456,17 @@ public class GTaskClient { JSONObject action = new JSONObject(); // action_list - // 设置操作类型为移动 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(调整位置) 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()); } - // 设置源列表和目标父节点 action.put(GTaskStringUtils.GTASK_JSON_SOURCE_LIST, preParent.getGid()); action.put(GTaskStringUtils.GTASK_JSON_DEST_PARENT, curParent.getGid()); - - // 跨列表移动:设置目标列表 if (preParent != curParent) { // put the dest_list only if moving between tasklists action.put(GTaskStringUtils.GTASK_JSON_DEST_LIST, curParent.getGid()); @@ -546,7 +486,6 @@ public class GTaskClient { } } - // 删除远程节点:向服务端发送删除请求 public void deleteNode(Node node) throws NetworkFailureException { commitUpdate(); try { @@ -554,7 +493,6 @@ public class GTaskClient { JSONArray actionList = new JSONArray(); // action_list - // 标记节点为已删除,并添加删除操作 node.setDeleted(true); actionList.put(node.getUpdateAction(getActionId())); jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList); @@ -571,7 +509,6 @@ public class GTaskClient { } } - // 获取远程任务列表:从服务端获取所有任务列表 public JSONArray getTaskLists() throws NetworkFailureException { if (!mLoggedin) { Log.e(TAG, "please login first"); @@ -585,13 +522,13 @@ public class GTaskClient { // get the task list String resString = getResponseContent(response.getEntity()); - String jsBegin = "_setup("; // 响应中任务列表的JS前缀 - String jsEnd = ")}"; // 后缀 + String jsBegin = "_setup("; + String jsEnd = ")}"; int begin = resString.indexOf(jsBegin); int end = resString.lastIndexOf(jsEnd); String jsString = null; if (begin != -1 && end != -1 && begin < end) { - jsString = resString.substring(begin + jsBegin.length(), end); // 提取JS内容 + jsString = resString.substring(begin + jsBegin.length(), end); } JSONObject js = new JSONObject(jsString); return js.getJSONObject("t").getJSONArray(GTaskStringUtils.GTASK_JSON_LISTS); @@ -610,7 +547,6 @@ public class GTaskClient { } } - // 获取指定任务列表下的任务:从服务端获取某个列表的所有任务 public JSONArray getTaskList(String listGid) throws NetworkFailureException { commitUpdate(); try { @@ -623,16 +559,13 @@ public class GTaskClient { GTaskStringUtils.GTASK_JSON_ACTION_TYPE_GETALL); action.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, getActionId()); action.put(GTaskStringUtils.GTASK_JSON_LIST_ID, listGid); - // 不获取已删除任务 action.put(GTaskStringUtils.GTASK_JSON_GET_DELETED, false); actionList.put(action); jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList); // client_version - // 客户端版本 jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion); - // 发送请求并返回任务数组 JSONObject jsResponse = postRequest(jsPost); return jsResponse.getJSONArray(GTaskStringUtils.GTASK_JSON_TASKS); } catch (JSONException e) { @@ -642,12 +575,10 @@ public class GTaskClient { } } - // 获取当前同步账户:返回登录的Google账户 public Account getSyncAccount() { return mAccount; } - // 重置更新队列:清空待提交的更新操作 public void resetUpdateArray() { mUpdateArray = null; } diff --git a/src/notes/gtask/remote/GTaskManager.java b/src/notes/gtask/remote/GTaskManager.java index 9bc0565..d2b4082 100644 --- a/src/notes/gtask/remote/GTaskManager.java +++ b/src/notes/gtask/remote/GTaskManager.java @@ -47,24 +47,21 @@ import java.util.HashSet; import java.util.Iterator; import java.util.Map; -/** - * Google任务同步管理器 - * 负责本地Note与Google任务的同步逻辑 - */ + public class GTaskManager { private static final String TAG = GTaskManager.class.getSimpleName(); - public static final int STATE_SUCCESS = 0; //同步成功状态 + public static final int STATE_SUCCESS = 0; - public static final int STATE_NETWORK_ERROR = 1; //网络错误 + public static final int STATE_NETWORK_ERROR = 1; - public static final int STATE_INTERNAL_ERROR = 2; //内部错误 + public static final int STATE_INTERNAL_ERROR = 2; - public static final int STATE_SYNC_IN_PROGRESS = 3; //同步中 + public static final int STATE_SYNC_IN_PROGRESS = 3; - public static final int STATE_SYNC_CANCELLED = 4; //取消同步 + public static final int STATE_SYNC_CANCELLED = 4; - private static GTaskManager mInstance = null; //单例实例 + private static GTaskManager mInstance = null; private Activity mActivity; @@ -72,25 +69,24 @@ public class GTaskManager { private ContentResolver mContentResolver; - private boolean mSyncing; //同步状态标识:是否正在同步 + private boolean mSyncing; - private boolean mCancelled; //是否已取消 + private boolean mCancelled; - private HashMap mGTaskListHashMap; //远程任务列表(key:任务列表GID) + private HashMap mGTaskListHashMap; - private HashMap mGTaskHashMap; //所有远程节点(任务/列表,key:节点GID) + private HashMap mGTaskHashMap; - private HashMap mMetaHashMap; //元数据(key:关联的任务GID) + private HashMap mMetaHashMap; - private TaskList mMetaList; //元数据列表 + private TaskList mMetaList; - private HashSet mLocalDeleteIdMap; //记录需要从远程删除的本地笔记ID + private HashSet mLocalDeleteIdMap; - private HashMap mGidToNid; //远程GID到本地笔记ID的映射关系 + private HashMap mGidToNid; - private HashMap mNidToGid; //本地笔记ID到远程GID的映射关系 + private HashMap mNidToGid; - //初始化所有集合和状态变量(单例模式防止外部实例化) private GTaskManager() { mSyncing = false; mCancelled = false; @@ -103,7 +99,6 @@ public class GTaskManager { mNidToGid = new HashMap(); } - // 单例获取方法:保证全局唯一实例 public static synchronized GTaskManager getInstance() { if (mInstance == null) { mInstance = new GTaskManager(); @@ -111,26 +106,20 @@ public class GTaskManager { return mInstance; } - // 设置Activity上下文:用于后续登录时获取认证token public synchronized void setActivityContext(Activity activity) { // used for getting authtoken mActivity = activity; } - //协调本地与远程数据同步,返回同步状态 public int sync(Context context, GTaskASyncTask asyncTask) { - // 检查是否正在同步,若正在同步则返回对应状态 if (mSyncing) { Log.d(TAG, "Sync is in progress"); return STATE_SYNC_IN_PROGRESS; } - // 初始化同步环境 mContext = context; mContentResolver = mContext.getContentResolver(); mSyncing = true; mCancelled = false; - - //清空所有存储集合(避免上次同步残留数据) mGTaskListHashMap.clear(); mGTaskHashMap.clear(); mMetaHashMap.clear(); @@ -139,9 +128,8 @@ public class GTaskManager { mNidToGid.clear(); try { - // 获取GTaskClient实例 GTaskClient client = GTaskClient.getInstance(); - client.resetUpdateArray(); //重置客户端的更新队列 + client.resetUpdateArray(); // login google task if (!mCancelled) { @@ -151,61 +139,55 @@ public class GTaskManager { } // get the task list from google - // 从远程获取任务列表并初始化(更新同步进度) asyncTask.publishProgess(mContext.getString(R.string.sync_progress_init_list)); initGTaskList(); - // do content sync work(更新同步进度) + // do content sync work asyncTask.publishProgess(mContext.getString(R.string.sync_progress_syncing)); syncContent(); - } catch (NetworkFailureException e) { // 捕获网络异常 + } catch (NetworkFailureException e) { Log.e(TAG, e.toString()); return STATE_NETWORK_ERROR; - } catch (ActionFailureException e) { // 捕获操作失败异常 + } catch (ActionFailureException e) { Log.e(TAG, e.toString()); return STATE_INTERNAL_ERROR; - } catch (Exception e) { // 返回内部错误状态 + } catch (Exception e) { Log.e(TAG, e.toString()); e.printStackTrace(); return STATE_INTERNAL_ERROR; - } finally { // 无论成功失败,清理资源 + } finally { mGTaskListHashMap.clear(); mGTaskHashMap.clear(); mMetaHashMap.clear(); mLocalDeleteIdMap.clear(); mGidToNid.clear(); mNidToGid.clear(); - mSyncing = false; // 标记为同步结束 + mSyncing = false; } return mCancelled ? STATE_SYNC_CANCELLED : STATE_SUCCESS; } - // 初始化远程任务列表:从Google服务器获取任务列表和元数据 private void initGTaskList() throws NetworkFailureException { - // 若同步已取消,直接返回 if (mCancelled) return; - GTaskClient client = GTaskClient.getInstance(); // 获取网络客户端 + GTaskClient client = GTaskClient.getInstance(); try { - // 1. 获取所有远程任务列表(JSON数组) JSONArray jsTaskLists = client.getTaskLists(); - // init meta list first(因为元数据关联其他任务) + // init meta list first 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(); - - //用远程JSON初始化元数据列表 mMetaList.setContentByRemoteJSON(object); - // load meta data(元数据本身以任务形式存储) + // load meta data JSONArray jsMetas = client.getTaskList(gid); for (int j = 0; j < jsMetas.length(); j++) { object = (JSONObject) jsMetas.getJSONObject(j); @@ -214,7 +196,6 @@ public class GTaskManager { if (metaData.isWorthSaving()) { mMetaList.addChildTask(metaData); if (metaData.getGid() != null) { - // 存储元数据(key:关联的任务GID) mMetaHashMap.put(metaData.getRelatedGid(), metaData); } } @@ -223,29 +204,26 @@ public class GTaskManager { } // create meta list if not existed - // 3. 若元数据列表不存在,则创建一个 if (mMetaList == null) { mMetaList = new TaskList(); mMetaList.setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX - + GTaskStringUtils.FOLDER_META); // 设置名称 - GTaskClient.getInstance().createTaskList(mMetaList); // 调用客户端创建列表 + + GTaskStringUtils.FOLDER_META); + GTaskClient.getInstance().createTaskList(mMetaList); } // init task list - // 4. 初始化普通任务列表(排除元数据列表) 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)) { TaskList tasklist = new TaskList(); - tasklist.setContentByRemoteJSON(object); // 用远程JSON初始化列表 - mGTaskListHashMap.put(gid, tasklist); // 存入任务列表集合 - mGTaskHashMap.put(gid, tasklist); // 同时存入全局节点集合 + tasklist.setContentByRemoteJSON(object); + mGTaskListHashMap.put(gid, tasklist); + mGTaskHashMap.put(gid, tasklist); // load tasks JSONArray jsTasks = client.getTaskList(gid); @@ -253,28 +231,27 @@ public class GTaskManager { object = (JSONObject) jsTasks.getJSONObject(j); gid = object.getString(GTaskStringUtils.GTASK_JSON_ID); Task task = new Task(); - task.setContentByRemoteJSON(object); // 用远程JSON初始化任务 + task.setContentByRemoteJSON(object); if (task.isWorthSaving()) { - task.setMetaInfo(mMetaHashMap.get(gid)); // 关联元数据 + task.setMetaInfo(mMetaHashMap.get(gid)); tasklist.addChildTask(task); - mGTaskHashMap.put(gid, task); // 存入全局节点集合 + mGTaskHashMap.put(gid, task); } } } } - } catch (JSONException e) { // 处理JSON解析异常 + } catch (JSONException e) { Log.e(TAG, e.toString()); e.printStackTrace(); throw new ActionFailureException("initGTaskList: handing JSONObject failed"); } } - // 同步内容:协调本地与远程的任务/列表数据(核心同步逻辑) private void syncContent() throws NetworkFailureException { - int syncType; // 同步类型(新增/删除/更新等) - Cursor c = null; // 数据库查询游标 - String gid; // 远程GID - Node node; // 远程节点 + int syncType; + Cursor c = null; + String gid; + Node node; mLocalDeleteIdMap.clear(); @@ -283,23 +260,20 @@ public class GTaskManager { } // for local deleted note - // 1. 处理本地已删除的笔记(在回收站中的非系统类型笔记) try { - // 查询条件:不是系统类型+父ID是回收站 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_FOLDER) + 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); // 获取笔记关联的远程GID - node = mGTaskHashMap.get(gid); // 从远程节点集合中查找对应节点 - if (node != null) { // 若远程存在该节点,需要删除远程节点 - mGTaskHashMap.remove(gid); // 从本地缓存移除 - doContentSync(Node.SYNC_ACTION_DEL_REMOTE, node, c); // 执行远程删除 + gid = c.getString(SqlNote.GTASK_ID_COLUMN); + node = mGTaskHashMap.get(gid); + if (node != null) { + mGTaskHashMap.remove(gid); + doContentSync(Node.SYNC_ACTION_DEL_REMOTE, node, c); } - // 记录本地已删除的笔记ID(后续会从本地彻底删除) mLocalDeleteIdMap.add(c.getLong(SqlNote.ID_COLUMN)); } } else { @@ -313,43 +287,32 @@ public class GTaskManager { } // sync folder first - // 2. 优先同步文件夹(任务列表) syncFolder(); // for note existing in database - // 3. 处理本地已存在的普通笔记(非回收站中的笔记类型) try { - // 查询条件:Note类型 + 父ID不是回收站 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_FOLDER) + 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); // 获取关联的远程GID + gid = c.getString(SqlNote.GTASK_ID_COLUMN); node = mGTaskHashMap.get(gid); - - // 远程存在对应节点 if (node != null) { - mGTaskHashMap.remove(gid); // 从本地缓存移除 - - // 记录GID与本地ID的映射关系 + mGTaskHashMap.remove(gid); mGidToNid.put(gid, c.getLong(SqlNote.ID_COLUMN)); mNidToGid.put(c.getLong(SqlNote.ID_COLUMN), gid); - syncType = node.getSyncAction(c); // 计算同步类型(根据本地与远程的修改时间等) - } - - // 远程不存在对应节点 - else { + syncType = node.getSyncAction(c); + } else { if (c.getString(SqlNote.GTASK_ID_COLUMN).trim().length() == 0) { - // local add 本地GID为空:本地新增,需要同步到远程 + // local add syncType = Node.SYNC_ACTION_ADD_REMOTE; } else { - // remote delete 本地有GID但远程无:远程已删除,需要删除本地 + // remote delete syncType = Node.SYNC_ACTION_DEL_LOCAL; } } - // 执行同步操作 doContentSync(syncType, node, c); } } else { @@ -364,20 +327,16 @@ public class GTaskManager { } // go through remaining items - // 4. 处理远程存在但本地不存在的节点(需要同步到本地) Iterator> iter = mGTaskHashMap.entrySet().iterator(); while (iter.hasNext()) { Map.Entry entry = iter.next(); node = entry.getValue(); - - // 执行本地新增 doContentSync(Node.SYNC_ACTION_ADD_LOCAL, node, null); } // mCancelled can be set by another thread, so we neet to check one by // one // clear local delete table - // 5. 清理本地已删除的笔记(若未取消同步) if (!mCancelled) { if (!DataUtils.batchDeleteNotes(mContentResolver, mLocalDeleteIdMap)) { throw new ActionFailureException("failed to batch-delete local deleted notes"); @@ -385,7 +344,6 @@ public class GTaskManager { } // refresh local sync id - // 6. 提交更新并刷新本地同步ID(若未取消) if (!mCancelled) { GTaskClient.getInstance().commitUpdate(); refreshLocalSyncId(); @@ -393,7 +351,6 @@ public class GTaskManager { } - // 同步文件夹(任务列表):处理本地与远程的文件夹数据 private void syncFolder() throws NetworkFailureException { Cursor c = null; String gid; @@ -405,30 +362,22 @@ public class GTaskManager { } // for root folder - // 1. 同步根文件夹 try { - // 查询根文件夹(ID固定为Notes.ID_ROOT_FOLDER) 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); node = mGTaskHashMap.get(gid); - - // 远程存在对应节点 if (node != null) { mGTaskHashMap.remove(gid); - // 记录映射关系 mGidToNid.put(gid, (long) Notes.ID_ROOT_FOLDER); mNidToGid.put((long) Notes.ID_ROOT_FOLDER, gid); // for system folder, only update remote name if necessary - // 系统文件夹只在名称不匹配时更新远程 if (!node.getName().equals( GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_DEFAULT)) doContentSync(Node.SYNC_ACTION_UPDATE_REMOTE, node, c); - } - // 远程不存在,需要新增到远程 - else { + } else { doContentSync(Node.SYNC_ACTION_ADD_REMOTE, node, c); } } else { @@ -442,9 +391,7 @@ public class GTaskManager { } // for call-note folder - // 2. 同步通话记录文件夹 try { - // 查询通话记录文件夹(ID固定为Notes.ID_CALL_RECORD_FOLDER) c = mContentResolver.query(Notes.CONTENT_NOTE_URI, SqlNote.PROJECTION_NOTE, "(_id=?)", new String[] { String.valueOf(Notes.ID_CALL_RECORD_FOLDER) @@ -453,14 +400,12 @@ public class GTaskManager { if (c.moveToNext()) { gid = c.getString(SqlNote.GTASK_ID_COLUMN); node = mGTaskHashMap.get(gid); - if (node != null) { mGTaskHashMap.remove(gid); mGidToNid.put(gid, (long) Notes.ID_CALL_RECORD_FOLDER); mNidToGid.put((long) Notes.ID_CALL_RECORD_FOLDER, gid); // for system folder, only update remote name if // necessary - // 系统文件夹只在名称不匹配时更新远程 if (!node.getName().equals( GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_CALL_NOTE)) @@ -480,12 +425,10 @@ public class GTaskManager { } // for local existing folders - // 3. 同步本地已存在的普通文件夹(非系统类型,非回收站) try { - // 查询条件:文件夹 + 父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_FOLDER) + String.valueOf(Notes.TYPE_FOLDER), String.valueOf(Notes.ID_TRASH_FOLER) }, NoteColumns.TYPE + " DESC"); if (c != null) { while (c.moveToNext()) { @@ -499,11 +442,9 @@ public class GTaskManager { } else { if (c.getString(SqlNote.GTASK_ID_COLUMN).trim().length() == 0) { // local add - // 本地GID为空:本地新增,同步到远程 syncType = Node.SYNC_ACTION_ADD_REMOTE; } else { // remote delete - // 本地有GID但远程无:远程已删除,删除本地 syncType = Node.SYNC_ACTION_DEL_LOCAL; } } @@ -520,24 +461,21 @@ public class GTaskManager { } // for remote add folders - // 4. 处理远程存在但本地不存在的文件夹(同步到本地) Iterator> iter = mGTaskListHashMap.entrySet().iterator(); while (iter.hasNext()) { Map.Entry entry = iter.next(); gid = entry.getKey(); node = entry.getValue(); - if (mGTaskHashMap.containsKey(gid)) { // 若缓存中存在(未被处理) + if (mGTaskHashMap.containsKey(gid)) { mGTaskHashMap.remove(gid); - doContentSync(Node.SYNC_ACTION_ADD_LOCAL, node, null); // 本地新增 + doContentSync(Node.SYNC_ACTION_ADD_LOCAL, node, null); } } - // 若未取消,提交所有文件夹相关的远程更新 if (!mCancelled) GTaskClient.getInstance().commitUpdate(); } - // 执行具体同步操作:根据同步类型处理本地/远程数据 private void doContentSync(int syncType, Node node, Cursor c) throws NetworkFailureException { if (mCancelled) { return; @@ -545,57 +483,52 @@ public class GTaskManager { MetaData meta; switch (syncType) { - case Node.SYNC_ACTION_ADD_LOCAL: // 远程新增,同步到本地 + case Node.SYNC_ACTION_ADD_LOCAL: addLocalNode(node); break; - case Node.SYNC_ACTION_ADD_REMOTE: // 本地新增,同步到远程 + case Node.SYNC_ACTION_ADD_REMOTE: addRemoteNode(node, c); break; - case Node.SYNC_ACTION_DEL_LOCAL: // 远程已删除,删除本地 - meta = mMetaHashMap.get(c.getString(SqlNote.GTASK_ID_COLUMN)); // 获取关联元数据 + case Node.SYNC_ACTION_DEL_LOCAL: + meta = mMetaHashMap.get(c.getString(SqlNote.GTASK_ID_COLUMN)); if (meta != null) { - GTaskClient.getInstance().deleteNode(meta); // 删除远程元数据 + GTaskClient.getInstance().deleteNode(meta); } - mLocalDeleteIdMap.add(c.getLong(SqlNote.ID_COLUMN)); // 记录本地ID待删除 + mLocalDeleteIdMap.add(c.getLong(SqlNote.ID_COLUMN)); break; - case Node.SYNC_ACTION_DEL_REMOTE: // 本地已删除,删除远程 + case Node.SYNC_ACTION_DEL_REMOTE: meta = mMetaHashMap.get(node.getGid()); if (meta != null) { GTaskClient.getInstance().deleteNode(meta); } GTaskClient.getInstance().deleteNode(node); break; - case Node.SYNC_ACTION_UPDATE_LOCAL: // 远程更新,同步到本地 + case Node.SYNC_ACTION_UPDATE_LOCAL: updateLocalNode(node, c); break; - case Node.SYNC_ACTION_UPDATE_REMOTE: // 本地更新,同步到远程 + case Node.SYNC_ACTION_UPDATE_REMOTE: updateRemoteNode(node, c); break; - case Node.SYNC_ACTION_UPDATE_CONFLICT: // 同步冲突(本地与远程都有修改) + 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: // 无同步操作 + case Node.SYNC_ACTION_NONE: break; - case Node.SYNC_ACTION_ERROR: // 同步错误 + case Node.SYNC_ACTION_ERROR: default: throw new ActionFailureException("unkown sync action type"); } } - // 本地新增节点:将远程节点同步到本地数据库 private void addLocalNode(Node node) throws NetworkFailureException { if (mCancelled) { return; } SqlNote sqlNote; - - // 节点是任务列表(文件夹) if (node instanceof TaskList) { - // 特殊文件夹处理:根目录或通话记录文件夹 if (node.getName().equals( GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_DEFAULT)) { sqlNote = new SqlNote(mContext, Notes.ID_ROOT_FOLDER); @@ -604,14 +537,13 @@ public class GTaskManager { sqlNote = new SqlNote(mContext, Notes.ID_CALL_RECORD_FOLDER); } else { sqlNote = new SqlNote(mContext); - sqlNote.setContent(node.getLocalJSONFromContent()); // 用远程数据构建本地JSON + sqlNote.setContent(node.getLocalJSONFromContent()); sqlNote.setParentId(Notes.ID_ROOT_FOLDER); } - } else { // 节点是任务(笔记) + } else { sqlNote = new SqlNote(mContext); - JSONObject js = node.getLocalJSONFromContent(); // 用远程数据构建本地JSON + JSONObject js = node.getLocalJSONFromContent(); try { - // 处理笔记ID冲突:若远程数据中的ID已在本地存在,移除ID(让本地自动生成) if (js.has(GTaskStringUtils.META_HEAD_NOTE)) { JSONObject note = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); if (note.has(NoteColumns.ID)) { @@ -623,7 +555,6 @@ public class GTaskManager { } } - // 处理数据ID冲突:同理移除已存在的ID if (js.has(GTaskStringUtils.META_HEAD_DATA)) { JSONArray dataArray = js.getJSONArray(GTaskStringUtils.META_HEAD_DATA); for (int i = 0; i < dataArray.length(); i++) { @@ -645,31 +576,26 @@ public class GTaskManager { } sqlNote.setContent(js); - // 获取父文件夹的本地ID(通过GID映射) 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.setParentId(parentId.longValue()); // 设置父目录ID + sqlNote.setParentId(parentId.longValue()); } // create the local node - // 提交本地新增 sqlNote.setGtaskId(node.getGid()); sqlNote.commit(false); // update gid-nid mapping - // 更新映射关系 mGidToNid.put(node.getGid(), sqlNote.getId()); mNidToGid.put(sqlNote.getId(), node.getGid()); // update meta - // 更新远程元数据 updateRemoteMeta(node.getGid(), sqlNote); } - // 更新本地节点:将远程更新同步到本地 private void updateLocalNode(Node node, Cursor c) throws NetworkFailureException { if (mCancelled) { return; @@ -678,10 +604,8 @@ public class GTaskManager { SqlNote sqlNote; // update the note locally sqlNote = new SqlNote(mContext, c); - // 用远程数据更新本地内容 sqlNote.setContent(node.getLocalJSONFromContent()); - // 确定父目录ID(任务的父是列表,列表的父是根目录) Long parentId = (node instanceof Task) ? mGidToNid.get(((Task) node).getParent().getGid()) : new Long(Notes.ID_ROOT_FOLDER); if (parentId == null) { @@ -689,14 +613,12 @@ public class GTaskManager { throw new ActionFailureException("cannot update local node"); } sqlNote.setParentId(parentId.longValue()); - sqlNote.commit(true); // 提交更新(覆盖本地数据) + sqlNote.commit(true); // update meta info - // 更新远程元数据 updateRemoteMeta(node.getGid(), sqlNote); } - // 远程新增节点:将本地节点同步到远程 private void addRemoteNode(Node node, Cursor c) throws NetworkFailureException { if (mCancelled) { return; @@ -706,36 +628,26 @@ public class GTaskManager { Node n; // update remotely - /** - * 区分笔记和文件夹,执行不同远程创建逻辑 - * 本地节点是笔记(对应远程任务) - */ if (sqlNote.isNoteType()) { Task task = new Task(); - task.setContentByLocalJSON(sqlNote.getContent()); // 用本地JSON初始化远程任务 + task.setContentByLocalJSON(sqlNote.getContent()); - // 获取父文件夹的远程GID(通过本地ID映射) String parentGid = mNidToGid.get(sqlNote.getParentId()); if (parentGid == null) { Log.e(TAG, "cannot find task's parent tasklist"); throw new ActionFailureException("cannot add remote task"); } - // 将任务添加到父列表 mGTaskListHashMap.get(parentGid).addChildTask(task); - // 调用客户端创建远程任务 GTaskClient.getInstance().createTask(task); n = (Node) task; // add meta updateRemoteMeta(task.getGid(), sqlNote); - } - // 本地节点是文件夹(对应远程任务列表) - else { + } else { TaskList tasklist = null; // we need to skip folder if it has already existed - // 生成文件夹名称(特定前缀+文件夹标识) String folderName = GTaskStringUtils.MIUI_FOLDER_PREFFIX; if (sqlNote.getId() == Notes.ID_ROOT_FOLDER) folderName += GTaskStringUtils.FOLDER_DEFAULT; @@ -744,14 +656,12 @@ public class GTaskManager { else folderName += sqlNote.getSnippet(); - // 检查远程是否已存在同名文件夹(避免重复创建) Iterator> iter = mGTaskListHashMap.entrySet().iterator(); while (iter.hasNext()) { Map.Entry entry = iter.next(); String gid = entry.getKey(); TaskList list = entry.getValue(); - // 已存在同名文件夹 if (list.getName().equals(folderName)) { tasklist = list; if (mGTaskHashMap.containsKey(gid)) { @@ -762,7 +672,6 @@ public class GTaskManager { } // no match we can add now - // 若远程不存在,则创建新文件夹 if (tasklist == null) { tasklist = new TaskList(); tasklist.setContentByLocalJSON(sqlNote.getContent()); @@ -773,40 +682,35 @@ public class GTaskManager { } // update local note - // 更新本地节点的远程GID sqlNote.setGtaskId(n.getGid()); - sqlNote.commit(false); // 保存GID - sqlNote.resetLocalModified(); // 重置本地修改标记(避免重复同步) - sqlNote.commit(true); // 提交修改 + sqlNote.commit(false); + sqlNote.resetLocalModified(); + sqlNote.commit(true); // gid-id mapping - // 更新映射关系 mGidToNid.put(n.getGid(), sqlNote.getId()); mNidToGid.put(sqlNote.getId(), n.getGid()); } - // 更新远程节点:将本地更新同步到远程 private void updateRemoteNode(Node node, Cursor c) throws NetworkFailureException { if (mCancelled) { return; } - SqlNote sqlNote = new SqlNote(mContext, c); // 获取本地节点数据 + SqlNote sqlNote = new SqlNote(mContext, c); // update remotely node.setContentByLocalJSON(sqlNote.getContent()); - GTaskClient.getInstance().addUpdateNode(node); // 将更新加入客户端的更新队列 + GTaskClient.getInstance().addUpdateNode(node); // update meta - // 更新远程元数据 updateRemoteMeta(node.getGid(), sqlNote); // move task if necessary if (sqlNote.isNoteType()) { Task task = (Task) node; - TaskList preParentList = task.getParent(); // 原父列表 + TaskList preParentList = task.getParent(); - // 获取当前父文件夹的远程GID(通过本地ID映射) String curParentGid = mNidToGid.get(sqlNote.getParentId()); if (curParentGid == null) { Log.e(TAG, "cannot find task's parent tasklist"); @@ -814,7 +718,6 @@ public class GTaskManager { } TaskList curParentList = mGTaskListHashMap.get(curParentGid); - // 若父列表变化,执行移动操作 if (preParentList != curParentList) { preParentList.removeChildTask(task); curParentList.addChildTask(task); @@ -827,15 +730,13 @@ public class GTaskManager { sqlNote.commit(true); } - // 更新远程元数据:同步本地笔记的元数据到远程 private void updateRemoteMeta(String gid, SqlNote sqlNote) throws NetworkFailureException { - // 仅处理笔记类型(文件夹无元数据) if (sqlNote != null && sqlNote.isNoteType()) { MetaData metaData = mMetaHashMap.get(gid); - if (metaData != null) { // 元数据已存在,更新内容 + if (metaData != null) { metaData.setMeta(gid, sqlNote.getContent()); - GTaskClient.getInstance().addUpdateNode(metaData); // 加入更新队列 - } else { // 元数据不存在,创建新的 + GTaskClient.getInstance().addUpdateNode(metaData); + } else { metaData = new MetaData(); metaData.setMeta(gid, sqlNote.getContent()); mMetaList.addChildTask(metaData); @@ -845,14 +746,12 @@ public class GTaskManager { } } - // 刷新本地同步ID:将远程的最后修改时间同步到本地(用于后续同步对比) private void refreshLocalSyncId() throws NetworkFailureException { if (mCancelled) { return; } // get the latest gtask list - // 重新获取最新的远程节点数据 mGTaskHashMap.clear(); mGTaskListHashMap.clear(); mMetaHashMap.clear(); @@ -860,18 +759,16 @@ public class GTaskManager { 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_FOLDER) + String.valueOf(Notes.TYPE_SYSTEM), String.valueOf(Notes.ID_TRASH_FOLER) }, NoteColumns.TYPE + " DESC"); if (c != null) { - while (c.moveToNext()) { // 遍历本地节点 + while (c.moveToNext()) { String gid = c.getString(SqlNote.GTASK_ID_COLUMN); Node node = mGTaskHashMap.get(gid); if (node != null) { mGTaskHashMap.remove(gid); - // 更新本地节点的同步ID(远程最后修改时间) ContentValues values = new ContentValues(); values.put(NoteColumns.SYNC_ID, node.getLastModified()); mContentResolver.update(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, @@ -893,7 +790,6 @@ public class GTaskManager { } } - // 获取同步账户:返回当前登录的Google账户名 public String getSyncAccount() { return GTaskClient.getInstance().getSyncAccount().name; } diff --git a/src/notes/gtask/remote/GTaskSyncService.java b/src/notes/gtask/remote/GTaskSyncService.java index a34a8b4..cca36f7 100644 --- a/src/notes/gtask/remote/GTaskSyncService.java +++ b/src/notes/gtask/remote/GTaskSyncService.java @@ -23,10 +23,6 @@ import android.content.Intent; import android.os.Bundle; import android.os.IBinder; -/** - * 继承Service类(Android系统) - * 用于处理GTask的同步逻辑,如启动/取消同步、发送同步状态广播等 - */ public class GTaskSyncService extends Service { public final static String ACTION_STRING_NAME = "sync_action_type"; @@ -36,34 +32,27 @@ public class GTaskSyncService extends Service { public final static int ACTION_INVALID = 2; - //同步服务发送广播的action名称(用于标识该广播的唯一标识) 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 GTaskASyncTask mSyncTask = null; - private static String mSyncProgress = ""; //同步进度的字符串(记录和传递进度信息) + private static String mSyncProgress = ""; - //启动同步任务 private void startSync() { - //当前没有同步任务执行,创建新任务 - if (mSyncTask == null) { mSyncTask = new GTaskASyncTask(this, new GTaskASyncTask.OnCompleteListener() { - //任务完成时的回调方法:清理任务实例,发送空进度广播,停止当前服务 public void onComplete() { mSyncTask = null; sendBroadcast(""); stopSelf(); } }); - sendBroadcast(""); // 发送初始广播(此时任务已创建,通知外界同步开始) - mSyncTask.execute(); //执行 + sendBroadcast(""); + mSyncTask.execute(); } } @@ -78,27 +67,10 @@ public class GTaskSyncService extends Service { mSyncTask = null; } - /** - * 处理启动服务的意图 - * 解析意图中的动作类型,执行对应的启动/取消同步操作 - * @param intent The Intent supplied to {@link android.content.Context#startService}, - * as given. This may be null if the service is being restarted after - * its process has gone away, and it had previously returned anything - * except {@link #START_STICKY_COMPATIBILITY}. - * @param flags 启动标志 - * @param startId A unique integer representing this specific request to - * start. Use with {@link #stopSelfResult(int)}. - * - * @return 服务的启动模式 - */ @Override public int onStartCommand(Intent intent, int flags, int startId) { - // 获取意图中携带的额外数据(键值对集合) Bundle bundle = intent.getExtras(); - - // 检查bundle是否存在且包含动作类型的键 if (bundle != null && bundle.containsKey(ACTION_STRING_NAME)) { - //根据动作类型执行对应操作 switch (bundle.getInt(ACTION_STRING_NAME, ACTION_INVALID)) { case ACTION_START_SYNC: startSync(); @@ -111,10 +83,9 @@ public class GTaskSyncService extends Service { } return START_STICKY; } - return super.onStartCommand(intent, flags, startId); //没有有效数据,则调用父类方法 + return super.onStartCommand(intent, flags, startId); } - //系统内存不足时的回调方法 @Override public void onLowMemory() { if (mSyncTask != null) { @@ -126,7 +97,6 @@ public class GTaskSyncService extends Service { return null; } - //向外界发送包含同步状态(是否正在同步)和进度消息的广播 public void sendBroadcast(String msg) { mSyncProgress = msg; Intent intent = new Intent(GTASK_SERVICE_BROADCAST_NAME); @@ -135,32 +105,23 @@ public class GTaskSyncService extends Service { sendBroadcast(intent); } - //供外部(如界面)调用,触发同步操作 public static void startSync(Activity activity) { - // 设置GTaskManager的上下文为当前Activity GTaskManager.getInstance().setActivityContext(activity); - - // 创建启动GTaskSyncService的意图,指定服务类 Intent intent = new Intent(activity, GTaskSyncService.class); - - // 在意图中添加"启动同步"的动作类型 intent.putExtra(GTaskSyncService.ACTION_STRING_NAME, GTaskSyncService.ACTION_START_SYNC); activity.startService(intent); } - //供外部(如界面)调用,取消正在进行的同步操作 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); } - //断是否正在同步 public static boolean isSyncing() { return mSyncTask != null; } - //获取当前同步进度字符串 public static String getProgressString() { return mSyncProgress; } diff --git a/src/notes/model/Note.java b/src/notes/model/Note.java index ecf9c21..6706cf6 100644 --- a/src/notes/model/Note.java +++ b/src/notes/model/Note.java @@ -33,24 +33,13 @@ import net.micode.notes.data.Notes.TextNote; import java.util.ArrayList; -/** - * 笔记数据模型类,负责的底层数据操作的模型类, - * 封装了笔记的基础数据(文本、通话记录)和核心属性(修改时间等) - * 与ContentProvider交互,实现笔记数据的创建、更新、同步等底层逻辑, - * 仅处理数据存储逻辑,不包含UI交互或业务判断,不包含业务逻辑 - */ + public class Note { - private ContentValues mNoteDiffValues; //存储Note属性变化,修改时间等 - private NoteData mNoteData; //封装Note具体数据,文本内容、通话记录等 + private ContentValues mNoteDiffValues; + private NoteData mNoteData; private static final String TAG = "Note"; - /** * Create a new note id for adding a new note to databases - * 静态同步方法:创建新笔记并返回其ID - * 作用:在数据库中初始化一条笔记记录,为后续添加内容(文本/通话记录)做准备 - * @param context 上下文(用于获取内容解析器) - * @param folderId 笔记所属文件夹ID(用于归类) - * @return 新创建的笔记ID */ public static synchronized long getNewNoteId(Context context, long folderId) { // Create a new note in the database @@ -76,7 +65,6 @@ public class Note { return noteId; } - //初始化Note数据容器,存储属性变化和具体数据 public Note() { mNoteDiffValues = new ContentValues(); mNoteData = new NoteData(); @@ -88,12 +76,10 @@ public class Note { mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis()); } - //设置Note的文本数据(如笔记内容) public void setTextData(String key, String value) { mNoteData.setTextData(key, value); } - //设置文本数据的ID(用于更新已有文本数据时定位记录) public void setTextDataId(long id) { mNoteData.setTextDataId(id); } @@ -110,12 +96,10 @@ public class Note { mNoteData.setCallData(key, value); } - //是否有本地修改 public boolean isLocalModified() { return mNoteDiffValues.size() > 0 || mNoteData.isLocalModified(); } - //同步Note数据到数据库 public boolean syncNote(Context context, long noteId) { if (noteId <= 0) { throw new IllegalArgumentException("Wrong note id:" + noteId); @@ -130,7 +114,6 @@ public class Note { * {@link NoteColumns#MODIFIED_DATE}. For data safety, though update note fails, we also update the * note data info */ - //更新笔记属性(如修改时间、本地修改标记等) if (context.getContentResolver().update( ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), mNoteDiffValues, null, null) == 0) { @@ -139,7 +122,6 @@ public class Note { } mNoteDiffValues.clear(); - //同步具体数据(文本/通话记录),若数据有修改且同步失败,返回false if (mNoteData.isLocalModified() && (mNoteData.pushIntoContentResolver(context, noteId) == null)) { return false; @@ -148,18 +130,14 @@ public class Note { return true; } - /**内部类 - * 管理笔记的具体数据(文本内容、通话记录) - * 封装文本和通话数据的存储、修改、同步逻辑,与Note类协同工作 - */ private class NoteData { - private long mTextDataId;// 文本数据在数据库中的ID(0表示未创建) + private long mTextDataId; - private ContentValues mTextDataValues; // 存储文本数据的变化 + private ContentValues mTextDataValues; - private long mCallDataId; // 通话记录数据在数据库中的ID(0表示未创建) + private long mCallDataId; - private ContentValues mCallDataValues; // 存储通话数据的变化(如号码更新) + private ContentValues mCallDataValues; private static final String TAG = "NoteData"; @@ -200,39 +178,24 @@ public class Note { mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis()); } - /** - * 将文本/通话数据的变化同步到数据库 - * 若数据未创建(ID=0)则插入新记录;若已创建(ID>0)则更新记录 - * @param context 上下文 - * @param noteId 所属笔记ID(关联数据到具体笔记) - * @return 同步成功返回笔记Uri;失败返回null - */ Uri pushIntoContentResolver(Context context, long noteId) { /** * Check for safety */ - // 校验笔记ID有效性 if (noteId <= 0) { throw new IllegalArgumentException("Wrong note id:" + noteId); } - // 创建批量操作列表(支持同时更新文本和通话数据) ArrayList operationList = new ArrayList(); ContentProviderOperation.Builder builder = null; - //处理文本数据同步 if(mTextDataValues.size() > 0) { - // 关联文本数据到当前笔记 mTextDataValues.put(DataColumns.NOTE_ID, noteId); - - //文本数据未创建 if (mTextDataId == 0) { - // 插入数据到ContentProvider,获取返回的Uri mTextDataValues.put(DataColumns.MIME_TYPE, TextNote.CONTENT_ITEM_TYPE); Uri uri = context.getContentResolver().insert(Notes.CONTENT_DATA_URI, mTextDataValues); try { - // 从Uri解析新插入的文本数据ID并存储 setTextDataId(Long.valueOf(uri.getPathSegments().get(1))); } catch (NumberFormatException e) { Log.e(TAG, "Insert new text data fail with noteId" + noteId); @@ -240,17 +203,14 @@ public class Note { return null; } } else { - // 文本数据已存在:更新记录 - // 构建更新操作(指定数据ID对应的Uri) builder = ContentProviderOperation.newUpdate(ContentUris.withAppendedId( Notes.CONTENT_DATA_URI, mTextDataId)); - builder.withValues(mTextDataValues); // 设置要更新的内容 - operationList.add(builder.build()); // 添加到批量操作列表 + builder.withValues(mTextDataValues); + operationList.add(builder.build()); } mTextDataValues.clear(); } - //处理通话数据同步(逻辑同处理文本数据同步) if(mCallDataValues.size() > 0) { mCallDataValues.put(DataColumns.NOTE_ID, noteId); if (mCallDataId == 0) { @@ -273,25 +233,21 @@ public class Note { mCallDataValues.clear(); } - //执行批量更新操作 if (operationList.size() > 0) { try { - // 应用批量操作到ContentProvider ContentProviderResult[] results = context.getContentResolver().applyBatch( Notes.AUTHORITY, operationList); return (results == null || results.length == 0 || results[0] == null) ? null : ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId); } catch (RemoteException e) { - // 远程异常(如ContentProvider断开连接) Log.e(TAG, String.format("%s: %s", e.toString(), e.getMessage())); return null; } catch (OperationApplicationException e) { - // 操作执行异常(如数据约束冲突) Log.e(TAG, String.format("%s: %s", e.toString(), e.getMessage())); return null; } } - return null; // 无批量操作需执行(如仅插入了新数据,未更新) + return null; } } } diff --git a/src/notes/model/WorkingNote.java b/src/notes/model/WorkingNote.java index b86eb9e..be081e4 100644 --- a/src/notes/model/WorkingNote.java +++ b/src/notes/model/WorkingNote.java @@ -31,17 +31,14 @@ import net.micode.notes.data.Notes.NoteColumns; import net.micode.notes.data.Notes.TextNote; import net.micode.notes.tool.ResourceParser.NoteBgResources; -/** - * 与Note类之间是组合关系,WorkingNote中的所有底层数据操作(如同步、属性变更记录)均通过mNote完成 - * 专注于业务逻辑处理,封装用户可见的业务属性,如内容、背景色等 - */ + public class WorkingNote { // Note for the working note private Note mNote; // Note Id private long mNoteId; // Note content - private String mContent; //笔记模式,如普通模式、清单模式 + private String mContent; // Note mode private int mMode; @@ -65,7 +62,6 @@ public class WorkingNote { private NoteSettingChangedListener mNoteSettingStatusListener; - //指定查询Data表时需要返回的字段 public static final String[] DATA_PROJECTION = new String[] { DataColumns.ID, DataColumns.CONTENT, @@ -76,7 +72,6 @@ public class WorkingNote { DataColumns.DATA4, }; - //指定查询Note表时需要返回的字段 public static final String[] NOTE_PROJECTION = new String[] { NoteColumns.PARENT_ID, NoteColumns.ALERTED_DATE, @@ -129,19 +124,14 @@ public class WorkingNote { loadNote(); } - //从数据库加载Note的基本信息(从Note表查询) private void loadNote() { - //构建查询URI Cursor cursor = mContext.getContentResolver().query( - ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, mNoteId), - NOTE_PROJECTION, - null, - null, - null); + ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, mNoteId), NOTE_PROJECTION, null, + null, null); if (cursor != null) { if (cursor.moveToFirst()) { - mFolderId = cursor.getLong(NOTE_PARENT_ID_COLUMN); //文件夹ID + mFolderId = cursor.getLong(NOTE_PARENT_ID_COLUMN); mBgColorId = cursor.getInt(NOTE_BG_COLOR_ID_COLUMN); mWidgetId = cursor.getInt(NOTE_WIDGET_ID_COLUMN); mWidgetType = cursor.getInt(NOTE_WIDGET_TYPE_COLUMN); @@ -153,10 +143,9 @@ public class WorkingNote { Log.e(TAG, "No note with id:" + mNoteId); throw new IllegalArgumentException("Unable to find note with id " + mNoteId); } - loadNoteData(); //继续加载笔记的详细数据(从Data表查询) + loadNoteData(); } - //从数据库加载笔记的详细数据(从Data表查询) private void loadNoteData() { Cursor cursor = mContext.getContentResolver().query(Notes.CONTENT_DATA_URI, DATA_PROJECTION, DataColumns.NOTE_ID + "=?", new String[] { @@ -167,16 +156,11 @@ public class WorkingNote { if (cursor.moveToFirst()) { do { String type = cursor.getString(DATA_MIME_TYPE_COLUMN); - - //如果是text类型 if (DataConstants.NOTE.equals(type)) { mContent = cursor.getString(DATA_CONTENT_COLUMN); mMode = cursor.getInt(DATA_MODE_COLUMN); mNote.setTextDataId(cursor.getLong(DATA_ID_COLUMN)); - } - - //如果是通话记录类型 - else if (DataConstants.CALL_NOTE.equals(type)) { + } else if (DataConstants.CALL_NOTE.equals(type)) { mNote.setCallDataId(cursor.getLong(DATA_ID_COLUMN)); } else { Log.d(TAG, "Wrong note type with type:" + type); @@ -190,7 +174,6 @@ public class WorkingNote { } } - //创建空Note public static WorkingNote createEmptyNote(Context context, long folderId, int widgetId, int widgetType, int defaultBgColorId) { WorkingNote note = new WorkingNote(context, folderId); @@ -200,24 +183,19 @@ public class WorkingNote { return note; } - //加载已有Note public static WorkingNote load(Context context, long id) { return new WorkingNote(context, id, 0); } - //保存Note到数据库(同步方法) public synchronized boolean saveNote() { if (isWorthSaving()) { - // 若笔记不存在于数据库(新笔记) if (!existInDatabase()) { - // 获取新笔记ID(若失败则返回0) if ((mNoteId = Note.getNewNoteId(mContext, mFolderId)) == 0) { Log.e(TAG, "Create new note fail with id:" + mNoteId); return false; } } - // 通过Note对象同步数据到数据库 mNote.syncNote(mContext, mNoteId); /** @@ -239,7 +217,6 @@ public class WorkingNote { } private boolean isWorthSaving() { - //若已删除、(新笔记且内容为空)、(已存在且无本地修改),则无需保存 if (mIsDeleted || (!existInDatabase() && TextUtils.isEmpty(mContent)) || (existInDatabase() && !mNote.isLocalModified())) { return false; @@ -252,32 +229,24 @@ public class WorkingNote { mNoteSettingStatusListener = l; } - //设置提醒时间 public void setAlertDate(long date, boolean set) { - //有时间变化才更新 if (date != mAlertDate) { mAlertDate = date; mNote.setNoteValue(NoteColumns.ALERTED_DATE, String.valueOf(mAlertDate)); } - - // 若监听器不为空,触发提醒变更回调 if (mNoteSettingStatusListener != null) { mNoteSettingStatusListener.onClockAlertChanged(date, set); } } - // 标记笔记是否被删除 public void markDeleted(boolean mark) { mIsDeleted = mark; - - // 若存在关联的小部件且监听器不为空,通知小部件变更 if (mWidgetId != AppWidgetManager.INVALID_APPWIDGET_ID && mWidgetType != Notes.TYPE_WIDGET_INVALIDE && mNoteSettingStatusListener != null) { mNoteSettingStatusListener.onWidgetChanged(); } } - // 设置背景色ID public void setBgColorId(int id) { if (id != mBgColorId) { mBgColorId = id; @@ -288,7 +257,6 @@ public class WorkingNote { } } - // 设置清单模式(切换普通/清单模式) public void setCheckListMode(int mode) { if (mMode != mode) { if (mNoteSettingStatusListener != null) { @@ -299,7 +267,6 @@ public class WorkingNote { } } - // 设置小部件类型 public void setWidgetType(int type) { if (type != mWidgetType) { mWidgetType = type; @@ -307,7 +274,6 @@ public class WorkingNote { } } - //设置小部件ID public void setWidgetId(int id) { if (id != mWidgetId) { mWidgetId = id; @@ -315,7 +281,6 @@ public class WorkingNote { } } - //设置笔记内容 public void setWorkingText(String text) { if (!TextUtils.equals(mContent, text)) { mContent = text; @@ -323,7 +288,6 @@ public class WorkingNote { } } - // 将笔记转换为通话笔记(设置通话相关数据) public void convertToCallNote(String phoneNumber, long callDate) { mNote.setCallData(CallNote.CALL_DATE, String.valueOf(callDate)); mNote.setCallData(CallNote.PHONE_NUMBER, phoneNumber); @@ -378,7 +342,6 @@ public class WorkingNote { return mWidgetType; } - // 笔记设置变更监听器接口(定义属性变化时的回调方法) public interface NoteSettingChangedListener { /** * Called when the background color of current note has just changed diff --git a/src/notes/tool/BackupUtils.java b/src/notes/tool/BackupUtils.java index 11053a9..39f6ec4 100644 --- a/src/notes/tool/BackupUtils.java +++ b/src/notes/tool/BackupUtils.java @@ -35,31 +35,14 @@ import java.io.FileOutputStream; import java.io.IOException; import java.io.PrintStream; -/** - * 笔记备份工具类,采用单例模式设计 - * 负责将笔记数据从数据库导出为可读的文本格式文件 - */ public class BackupUtils { - // 日志标签,用于调试时在 Logcat 中标识本类的日志输出 private static final String TAG = "BackupUtils"; - - // 单例模式:持有 BackupUtils 的唯一实例 + // Singleton stuff private static BackupUtils sInstance; - /** - * 获取 BackupUtils 的全局唯一实例(线程安全)。 - * - *

采用懒加载方式,首次调用时才创建实例。 - * 注意:为避免内存泄漏,建议传入 Application Context, - * 但即使传入 Activity Context,内部也应转换为 ApplicationContext 使用(需在构造函数中处理)。 - * - * @param context 上下文,用于初始化 BackupUtils 所需的系统服务或资源 - * @return BackupUtils 的单例对象 - */ public static synchronized BackupUtils getInstance(Context context) { if (sInstance == null) { - // 首次调用时创建实例 sInstance = new BackupUtils(context); } return sInstance; @@ -86,17 +69,14 @@ public class BackupUtils { mTextExport = new TextExport(context); } - //判断外部存储(如 SD 卡)是否已挂载且可读写 private static boolean externalStorageAvailable() { return Environment.MEDIA_MOUNTED.equals(Environment.getExternalStorageState()); } - //执行导出 public int exportToText() { return mTextExport.exportToText(); } - //获取导出文件的文件名和目录路径 public String getExportedTextFileName() { return mTextExport.mFileName; } @@ -105,27 +85,12 @@ public class BackupUtils { return mTextExport.mFileDirectory; } - /** - * 负责将笔记数据从数据库导出为格式化纯文本文件的内部工具类。 - * - *

该类通过 ContentProvider 查询笔记主表(Notes)和数据明细表(Data), - * 按照资源文件中定义的模板格式,将内容拼接并写入外部存储的 .txt 文件。 - * 所有数据库查询均使用投影(Projection)限制字段,提升性能与安全性; - * 列索引通过命名常量定义,避免魔法数字,增强可读性与可维护性。 - */ private static class TextExport { - - // === 笔记主表(Notes Table)查询配置 === - - /** - * 查询笔记主表时使用的字段投影(只获取必要字段)。 - * 顺序必须与下方索引常量保持一致。 - */ private static final String[] NOTE_PROJECTION = { - NoteColumns.ID, // 笔记唯一ID - NoteColumns.MODIFIED_DATE, // 最后修改时间 - NoteColumns.SNIPPET, // 笔记摘要/标题 - NoteColumns.TYPE // 笔记类型(用于分组或过滤) + NoteColumns.ID, + NoteColumns.MODIFIED_DATE, + NoteColumns.SNIPPET, + NoteColumns.TYPE }; private static final int NOTE_COLUMN_ID = 0; @@ -134,16 +99,9 @@ public class BackupUtils { private static final int NOTE_COLUMN_SNIPPET = 2; - // === 数据明细表(Data Table)查询配置 === - - /** - * 查询笔记数据明细表时使用的字段投影。 - * 采用类似 Android Contacts Provider 的 EAV 模型, - * 具体字段含义由 MIME_TYPE 决定(如文本、电话等)。 - */ private static final String[] DATA_PROJECTION = { - DataColumns.CONTENT, // 主内容(如文本) - DataColumns.MIME_TYPE, // 数据类型(决定 DATA1~DATA4 的语义) + DataColumns.CONTENT, + DataColumns.MIME_TYPE, DataColumns.DATA1, DataColumns.DATA2, DataColumns.DATA3, @@ -154,33 +112,19 @@ public class BackupUtils { private static final int DATA_COLUMN_MIME_TYPE = 1; - private static final int DATA_COLUMN_CALL_DATE = 2; //通话日期字段的列索引 - - private static final int DATA_COLUMN_PHONE_NUMBER = 4; //电话号码字段的列索引 + private static final int DATA_COLUMN_CALL_DATE = 2; - // === 文本格式模板配置 === + private static final int DATA_COLUMN_PHONE_NUMBER = 4; - /** - * 从资源文件加载的导出文本格式模板数组,支持多语言。 - * 定义在 res/values/arrays.xml 中的 R.array.format_for_exported_note。 - */ private final String [] TEXT_FORMAT; private static final int FORMAT_FOLDER_NAME = 0; private static final int FORMAT_NOTE_DATE = 1; private static final int FORMAT_NOTE_CONTENT = 2; - private Context mContext; //保存上下文,用于访问系统服务 - private String mFileName; //存储最近一次成功导出的文件名 - private String mFileDirectory; //存储导出文件所在的目录路径 + private Context mContext; + private String mFileName; + private String mFileDirectory; - /** - * 构造一个 TextExport 实例,用于执行笔记数据的文本导出任务。 - * - *

该方法从应用资源中加载多语言支持的导出格式模板(R.array.format_for_exported_note), - * 并初始化导出结果的文件名与目录路径为空字符串(将在导出成功后填充)。 - * - * @param context 上下文对象,用于访问字符串数组资源; - */ public TextExport(Context context) { TEXT_FORMAT = context.getResources().getStringArray(R.array.format_for_exported_note); mContext = context; @@ -188,9 +132,6 @@ public class BackupUtils { mFileDirectory = ""; } - /** - * 根据指定的格式类型 ID,从资源加载的模板数组中获取对应的文本格式字符串。 - */ private String getFormat(int id) { return TEXT_FORMAT[id]; } @@ -205,9 +146,7 @@ public class BackupUtils { folderId }, null); - // 检查查询结果是否有效(非 null) if (notesCursor != null) { - // 尝试将游标移动到第一条记录;若结果集为空,则 moveToFirst() 返回 false,跳过循环 if (notesCursor.moveToFirst()) { do { // Print note's last modified date @@ -217,9 +156,8 @@ public class BackupUtils { // Query data belong to this note String noteId = notesCursor.getString(NOTE_COLUMN_ID); exportNoteToText(noteId, ps); - } while (notesCursor.moveToNext()); // 移动到下一条笔记,直到遍历完所有记录 + } while (notesCursor.moveToNext()); } - // 关闭 Cursor 以释放数据库资源,防止内存泄漏 notesCursor.close(); } } @@ -228,20 +166,16 @@ public class BackupUtils { * Export note identified by id to a print stream */ private void exportNoteToText(String noteId, PrintStream ps) { - // 查询属于该笔记的所有明细数据(Data 表),每条数据可能代表文本、电话记录等 Cursor dataCursor = mContext.getContentResolver().query(Notes.CONTENT_DATA_URI, DATA_PROJECTION, DataColumns.NOTE_ID + "=?", new String[] { noteId }, null); if (dataCursor != null) { - // 遍历该笔记关联的所有数据行(一个笔记可能包含多条 Data 记录) if (dataCursor.moveToFirst()) { do { - // 根据 MIME 类型区分数据类型 String mimeType = dataCursor.getString(DATA_COLUMN_MIME_TYPE); if (DataConstants.CALL_NOTE.equals(mimeType)) { - // 处理“通话笔记”类型:包含电话号码、通话时间、附加位置信息 // Print phone number String phoneNumber = dataCursor.getString(DATA_COLUMN_PHONE_NUMBER); long callDate = dataCursor.getLong(DATA_COLUMN_CALL_DATE); @@ -261,7 +195,6 @@ public class BackupUtils { location)); } } else if (DataConstants.NOTE.equals(mimeType)) { - // 处理普通文本笔记 String content = dataCursor.getString(DATA_COLUMN_CONTENT); if (!TextUtils.isEmpty(content)) { ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT), @@ -273,13 +206,6 @@ public class BackupUtils { dataCursor.close(); } // print a line separator between note - // 注意:当前实现存在两个问题: - // 1. Character.LINE_SEPARATOR 是 Unicode 行分隔符 '\u2028',多数文本编辑器不识别为换行; - // 2. Character.LETTER_NUMBER 实际值为字符 '1'(ASCII 49),会意外输出数字 "1"。 - // 正确做法应使用标准换行符,例如: - // ps.println(); // 推荐:输出平台兼容换行 - // 或 ps.write('\n'); // 简单 LF 换行(适用于纯文本导出) - // 建议后续重构此逻辑以避免导出文件包含乱码或多余字符。 try { ps.write(new byte[] { Character.LINE_SEPARATOR, Character.LETTER_NUMBER @@ -293,22 +219,17 @@ public class BackupUtils { * Note will be exported as text which is user readable */ public int exportToText() { - // 检查外部存储是否可用(如 SD 卡是否挂载) if (!externalStorageAvailable()) { Log.d(TAG, "Media was not mounted"); return STATE_SD_CARD_UNMOUONTED; } - // 获取用于写入导出文本的 PrintStream + PrintStream ps = getExportToTextPrintStream(); if (ps == null) { Log.e(TAG, "get print stream error"); return STATE_SYSTEM_ERROR; } // First export folder and its notes - // 查询所有“非回收站”的文件夹 + 通话记录专用文件夹(即使它可能不满足普通文件夹条件) - // 条件说明: - // - 类型为 TYPE_FOLDER 且父 ID 不是回收站(排除回收站本身) - // - 或者是固定的通话记录文件夹(ID = ID_CALL_RECORD_FOLDER) Cursor folderCursor = mContext.getContentResolver().query( Notes.CONTENT_NOTE_URI, NOTE_PROJECTION, @@ -320,7 +241,6 @@ public class BackupUtils { if (folderCursor.moveToFirst()) { do { // Print folder's name - // 获取文件夹名称:通话记录文件夹使用固定字符串,其他取自 SNIPPET 字段 String folderName = ""; if(folderCursor.getLong(NOTE_COLUMN_ID) == Notes.ID_CALL_RECORD_FOLDER) { folderName = mContext.getString(R.string.call_record_folder_name); @@ -328,11 +248,9 @@ public class BackupUtils { folderName = folderCursor.getString(NOTE_COLUMN_SNIPPET); } if (!TextUtils.isEmpty(folderName)) { - // 使用预定义模板输出文件夹标题 ps.println(String.format(getFormat(FORMAT_FOLDER_NAME), folderName)); } String folderId = folderCursor.getString(NOTE_COLUMN_ID); - // 递归导出该文件夹下的所有笔记 exportFolderToText(folderId, ps); } while (folderCursor.moveToNext()); } @@ -340,7 +258,6 @@ public class BackupUtils { } // Export notes in root's folder - // 查询“根目录”下的普通笔记(即 PARENT_ID = 0 且类型为普通笔记) Cursor noteCursor = mContext.getContentResolver().query( Notes.CONTENT_NOTE_URI, NOTE_PROJECTION, @@ -350,7 +267,6 @@ public class BackupUtils { if (noteCursor != null) { if (noteCursor.moveToFirst()) { do { - // 输出根目录笔记的最后修改时间 ps.println(String.format(getFormat(FORMAT_NOTE_DATE), DateFormat.format( mContext.getString(R.string.format_datetime_mdhm), noteCursor.getLong(NOTE_COLUMN_MODIFIED_DATE)))); @@ -370,28 +286,22 @@ public class BackupUtils { * Get a print stream pointed to the file {@generateExportedTextFile} */ private PrintStream getExportToTextPrintStream() { - // 生成导出文件的完整路径(位于外部存储指定目录下) File file = generateFileMountedOnSDcard(mContext, R.string.file_path, R.string.file_name_txt_format); if (file == null) { Log.e(TAG, "create file to exported failed"); return null; } - // 缓存文件名和目录路径 mFileName = file.getName(); mFileDirectory = mContext.getString(R.string.file_path); PrintStream ps = null; try { - // 创建指向该文件的输出流(覆盖写入模式) FileOutputStream fos = new FileOutputStream(file); - // 包装为 PrintStream,便于使用 println() 等文本写入方法 ps = new PrintStream(fos); } catch (FileNotFoundException e) { - // 文件无法创建(如路径无效、权限不足、存储未挂载等) e.printStackTrace(); return null; } catch (NullPointerException e) { - // 通常由 generateFileMountedOnSDcard 返回 null 或上下文异常导致 e.printStackTrace(); return null; } @@ -403,13 +313,10 @@ public class BackupUtils { * Generate the text file to store imported data */ private static File generateFileMountedOnSDcard(Context context, int filePathResId, int fileNameFormatResId) { - // 构建文件完整路径:外部存储根目录 + 资源中定义的子路径 StringBuilder sb = new StringBuilder(); sb.append(Environment.getExternalStorageDirectory()); sb.append(context.getString(filePathResId)); File filedir = new File(sb.toString()); - - // 在路径后追加格式化后的文件名 sb.append(context.getString( fileNameFormatResId, DateFormat.format(context.getString(R.string.format_date_ymd), @@ -417,24 +324,21 @@ public class BackupUtils { File file = new File(sb.toString()); try { - // 确保目标目录存在,不存在则尝试创建 if (!filedir.exists()) { - filedir.mkdir(); // 注意:mkdir() 只能创建单层目录,若需多级应使用 mkdirs() + filedir.mkdir(); } - // 创建空文件(如果尚不存在) if (!file.exists()) { file.createNewFile(); } return file; } catch (SecurityException e) { - // 通常因缺少 WRITE_EXTERNAL_STORAGE 权限(Android 6.0+ 需动态申请) e.printStackTrace(); } catch (IOException e) { - // 可能原因:磁盘空间不足、路径为只读、文件被占用等 e.printStackTrace(); } - // 任一异常发生或创建失败时,返回 null 表示文件准备失败 return null; } } + + diff --git a/src/notes/tool/DataUtils.java b/src/notes/tool/DataUtils.java index 94c08d7..2a14982 100644 --- a/src/notes/tool/DataUtils.java +++ b/src/notes/tool/DataUtils.java @@ -34,21 +34,10 @@ import net.micode.notes.ui.NotesListAdapter.AppWidgetAttribute; import java.util.ArrayList; import java.util.HashSet; -/** - * 数据操作工具类,提供对笔记数据库的各种常用操作 - * 包括批量删除、移动、查询等数据库操作方法 - */ -public class DataUtils { - private static final String TAG = "DataUtils"; // 日志标签 - /** - * 批量删除笔记 - * @param resolver 内容解析器,用于访问ContentProvider - * @param ids 要删除的笔记ID集合 - * @return 删除成功返回true,失败返回false - */ +public class DataUtils { + public static final String TAG = "DataUtils"; public static boolean batchDeleteNotes(ContentResolver resolver, HashSet ids) { - // 参数检查:如果ID集合为空,直接返回成功 if (ids == null) { Log.d(TAG, "the ids is null"); return true; @@ -58,24 +47,18 @@ public class DataUtils { return true; } - // 创建批量操作列表 ArrayList operationList = new ArrayList(); for (long id : ids) { - // 安全检查:不允许删除系统根文件夹 if(id == Notes.ID_ROOT_FOLDER) { Log.e(TAG, "Don't delete system folder root"); continue; } - // 为每个笔记创建删除操作 ContentProviderOperation.Builder builder = ContentProviderOperation .newDelete(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, id)); operationList.add(builder.build()); } - try { - // 执行批量删除操作 ContentProviderResult[] results = resolver.applyBatch(Notes.AUTHORITY, operationList); - // 检查操作结果 if (results == null || results.length == 0 || results[0] == null) { Log.d(TAG, "delete notes failed, ids:" + ids.toString()); return false; @@ -89,52 +72,32 @@ public class DataUtils { return false; } - /** - * 将笔记移动到指定文件夹 - * @param resolver 内容解析器 - * @param id 要移动的笔记ID - * @param srcFolderId 源文件夹ID - * @param desFolderId 目标文件夹ID - */ public static void moveNoteToFoler(ContentResolver resolver, long id, long srcFolderId, long desFolderId) { ContentValues values = new ContentValues(); - values.put(NoteColumns.PARENT_ID, desFolderId); // 设置新的父文件夹ID - values.put(NoteColumns.ORIGIN_PARENT_ID, srcFolderId); // 记录原始父文件夹ID - values.put(NoteColumns.LOCAL_MODIFIED, 1); // 标记为本地已修改(用于同步) - // 执行更新操作 + values.put(NoteColumns.PARENT_ID, desFolderId); + values.put(NoteColumns.ORIGIN_PARENT_ID, srcFolderId); + values.put(NoteColumns.LOCAL_MODIFIED, 1); resolver.update(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, id), values, null, null); } - /** - * 批量移动笔记到指定文件夹 - * @param resolver 内容解析器 - * @param ids 要移动的笔记ID集合 - * @param folderId 目标文件夹ID - * @return 移动成功返回true,失败返回false - */ public static boolean batchMoveToFolder(ContentResolver resolver, HashSet ids, - long folderId) { - // 参数检查 + long folderId) { if (ids == null) { Log.d(TAG, "the ids is null"); return true; } - // 创建批量操作列表 ArrayList operationList = new ArrayList(); for (long id : ids) { - // 为每个笔记创建更新操作 ContentProviderOperation.Builder builder = ContentProviderOperation .newUpdate(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, id)); - builder.withValue(NoteColumns.PARENT_ID, folderId); // 设置目标文件夹ID - builder.withValue(NoteColumns.LOCAL_MODIFIED, 1); // 标记为本地已修改 + builder.withValue(NoteColumns.PARENT_ID, folderId); + builder.withValue(NoteColumns.LOCAL_MODIFIED, 1); operationList.add(builder.build()); } try { - // 执行批量移动操作 ContentProviderResult[] results = resolver.applyBatch(Notes.AUTHORITY, operationList); - // 检查操作结果 if (results == null || results.length == 0 || results[0] == null) { Log.d(TAG, "delete notes failed, ids:" + ids.toString()); return false; @@ -149,12 +112,9 @@ public class DataUtils { } /** - * 获取用户文件夹数量(排除系统文件夹) - * @param resolver 内容解析器 - * @return 用户文件夹的数量 + * Get the all folder count except system folders {@link Notes#TYPE_SYSTEM}} */ public static int getUserFolderCount(ContentResolver resolver) { - // 查询条件:类型为文件夹且不在垃圾箱中 Cursor cursor =resolver.query(Notes.CONTENT_NOTE_URI, new String[] { "COUNT(*)" }, NoteColumns.TYPE + "=? AND " + NoteColumns.PARENT_ID + "<>?", @@ -165,24 +125,17 @@ public class DataUtils { if(cursor != null) { if(cursor.moveToFirst()) { try { - count = cursor.getInt(0); // 获取数量 + count = cursor.getInt(0); } catch (IndexOutOfBoundsException e) { Log.e(TAG, "get folder count failed:" + e.toString()); } finally { - cursor.close(); // 确保游标被关闭 + cursor.close(); } } } return count; } - /** - * 检查指定类型和ID的笔记是否在数据库中可见(不在垃圾箱中) - * @param resolver 内容解析器 - * @param noteId 笔记ID - * @param type 笔记类型 - * @return 如果存在且可见返回true,否则返回false - */ public static boolean visibleInNoteDatabase(ContentResolver resolver, long noteId, int type) { Cursor cursor = resolver.query(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), null, @@ -193,19 +146,13 @@ public class DataUtils { boolean exist = false; if (cursor != null) { if (cursor.getCount() > 0) { - exist = true; // 有记录存在 + exist = true; } cursor.close(); } return exist; } - /** - * 检查指定ID的笔记是否存在于数据库中 - * @param resolver 内容解析器 - * @param noteId 笔记ID - * @return 如果存在返回true,否则返回false - */ public static boolean existInNoteDatabase(ContentResolver resolver, long noteId) { Cursor cursor = resolver.query(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), null, null, null, null); @@ -220,12 +167,6 @@ public class DataUtils { return exist; } - /** - * 检查指定ID的数据项是否存在于数据表中 - * @param resolver 内容解析器 - * @param dataId 数据项ID - * @return 如果存在返回true,否则返回false - */ public static boolean existInDataDatabase(ContentResolver resolver, long dataId) { Cursor cursor = resolver.query(ContentUris.withAppendedId(Notes.CONTENT_DATA_URI, dataId), null, null, null, null); @@ -240,17 +181,11 @@ public class DataUtils { return exist; } - /** - * 检查指定名称的文件夹是否已存在(可见文件夹,不在垃圾箱中) - * @param resolver 内容解析器 - * @param name 文件夹名称 - * @return 如果存在返回true,否则返回false - */ public static boolean checkVisibleFolderName(ContentResolver resolver, String name) { Cursor cursor = resolver.query(Notes.CONTENT_NOTE_URI, null, NoteColumns.TYPE + "=" + Notes.TYPE_FOLDER + - " AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER + - " AND " + NoteColumns.SNIPPET + "=?", + " AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER + + " AND " + NoteColumns.SNIPPET + "=?", new String[] { name }, null); boolean exist = false; if(cursor != null) { @@ -262,14 +197,7 @@ public class DataUtils { return exist; } - /** - * 获取文件夹中所有笔记关联的小部件属性 - * @param resolver 内容解析器 - * @param folderId 文件夹ID - * @return 小部件属性集合,如果没有返回null - */ public static HashSet getFolderNoteWidget(ContentResolver resolver, long folderId) { - // 查询文件夹中所有笔记的小部件信息 Cursor c = resolver.query(Notes.CONTENT_NOTE_URI, new String[] { NoteColumns.WIDGET_ID, NoteColumns.WIDGET_TYPE }, NoteColumns.PARENT_ID + "=?", @@ -282,10 +210,9 @@ public class DataUtils { set = new HashSet(); do { try { - // 创建小部件属性对象并添加到集合 AppWidgetAttribute widget = new AppWidgetAttribute(); - widget.widgetId = c.getInt(0); // 小部件ID - widget.widgetType = c.getInt(1); // 小部件类型 + widget.widgetId = c.getInt(0); + widget.widgetType = c.getInt(1); set.add(widget); } catch (IndexOutOfBoundsException e) { Log.e(TAG, e.toString()); @@ -297,14 +224,7 @@ public class DataUtils { return set; } - /** - * 根据笔记ID获取对应的电话号码(用于通话记录笔记) - * @param resolver 内容解析器 - * @param noteId 笔记ID - * @return 电话号码,如果不存在返回空字符串 - */ public static String getCallNumberByNoteId(ContentResolver resolver, long noteId) { - // 查询通话记录数据 Cursor cursor = resolver.query(Notes.CONTENT_DATA_URI, new String [] { CallNote.PHONE_NUMBER }, CallNote.NOTE_ID + "=? AND " + CallNote.MIME_TYPE + "=?", @@ -313,52 +233,37 @@ public class DataUtils { if (cursor != null && cursor.moveToFirst()) { try { - return cursor.getString(0); // 返回电话号码 + return cursor.getString(0); } catch (IndexOutOfBoundsException e) { Log.e(TAG, "Get call number fails " + e.toString()); } finally { - cursor.close(); // 确保游标被关闭 + cursor.close(); } } - return ""; // 没有找到返回空字符串 + return ""; } - /** - * 根据电话号码和通话日期获取对应的笔记ID - * @param resolver 内容解析器 - * @param phoneNumber 电话号码 - * @param callDate 通话日期 - * @return 笔记ID,如果不存在返回0 - */ public static long getNoteIdByPhoneNumberAndCallDate(ContentResolver resolver, String phoneNumber, long callDate) { - // 使用自定义的PHONE_NUMBERS_EQUAL函数比较电话号码 Cursor cursor = resolver.query(Notes.CONTENT_DATA_URI, new String [] { CallNote.NOTE_ID }, CallNote.CALL_DATE + "=? AND " + CallNote.MIME_TYPE + "=? AND PHONE_NUMBERS_EQUAL(" - + CallNote.PHONE_NUMBER + ",?)", + + CallNote.PHONE_NUMBER + ",?)", new String [] { String.valueOf(callDate), CallNote.CONTENT_ITEM_TYPE, phoneNumber }, null); if (cursor != null) { if (cursor.moveToFirst()) { try { - return cursor.getLong(0); // 返回笔记ID + return cursor.getLong(0); } catch (IndexOutOfBoundsException e) { Log.e(TAG, "Get call note id fails " + e.toString()); } } cursor.close(); } - return 0; // 没有找到返回0 + return 0; } - /** - * 根据笔记ID获取内容摘要 - * @param resolver 内容解析器 - * @param noteId 笔记ID - * @return 笔记内容摘要 - * @throws IllegalArgumentException 如果笔记不存在抛出异常 - */ public static String getSnippetById(ContentResolver resolver, long noteId) { Cursor cursor = resolver.query(Notes.CONTENT_NOTE_URI, new String [] { NoteColumns.SNIPPET }, @@ -369,7 +274,7 @@ public class DataUtils { if (cursor != null) { String snippet = ""; if (cursor.moveToFirst()) { - snippet = cursor.getString(0); // 获取内容摘要 + snippet = cursor.getString(0); } cursor.close(); return snippet; @@ -377,19 +282,14 @@ public class DataUtils { throw new IllegalArgumentException("Note is not found with id: " + noteId); } - /** - * 格式化内容摘要(去除首尾空格,只保留第一行) - * @param snippet 原始内容摘要 - * @return 格式化后的内容摘要 - */ public static String getFormattedSnippet(String snippet) { if (snippet != null) { - snippet = snippet.trim(); // 去除首尾空格 - int index = snippet.indexOf('\n'); // 查找第一个换行符 + snippet = snippet.trim(); + int index = snippet.indexOf('\n'); if (index != -1) { - snippet = snippet.substring(0, index); // 只保留第一行 + snippet = snippet.substring(0, index); } } return snippet; } -} \ No newline at end of file +} diff --git a/src/notes/tool/GTaskStringUtils.java b/src/notes/tool/GTaskStringUtils.java index 30e53f6..666b729 100644 --- a/src/notes/tool/GTaskStringUtils.java +++ b/src/notes/tool/GTaskStringUtils.java @@ -16,112 +16,98 @@ package net.micode.notes.tool; -/** - * GTask字符串常量定义类 - * 定义Google Task API相关的JSON字段名和常量值 - * 用于便签与Google Task服务的数据同步 - */ public class GTaskStringUtils { - // ==================== 动作相关常量 ==================== - /** 动作ID字段名 */ public final static String GTASK_JSON_ACTION_ID = "action_id"; - /** 动作列表字段名 */ + public final static String GTASK_JSON_ACTION_LIST = "action_list"; - /** 动作类型字段名 */ + public final static String GTASK_JSON_ACTION_TYPE = "action_type"; - /** 创建动作类型 */ + public final static String GTASK_JSON_ACTION_TYPE_CREATE = "create"; - /** 获取所有动作类型 */ + public final static String GTASK_JSON_ACTION_TYPE_GETALL = "get_all"; - /** 移动动作类型 */ + public final static String GTASK_JSON_ACTION_TYPE_MOVE = "move"; - /** 更新动作类型 */ + public final static String GTASK_JSON_ACTION_TYPE_UPDATE = "update"; - // ==================== 实体属性相关常量 ==================== - /** 创建者ID字段名 */ public final static String GTASK_JSON_CREATOR_ID = "creator_id"; - /** 子实体字段名 */ + public final static String GTASK_JSON_CHILD_ENTITY = "child_entity"; - /** 客户端版本字段名 */ + public final static String GTASK_JSON_CLIENT_VERSION = "client_version"; - /** 完成状态字段名 */ + public final static String GTASK_JSON_COMPLETED = "completed"; - /** 当前列表ID字段名 */ + public final static String GTASK_JSON_CURRENT_LIST_ID = "current_list_id"; - /** 默认列表ID字段名 */ + public final static String GTASK_JSON_DEFAULT_LIST_ID = "default_list_id"; - /** 删除状态字段名 */ + public final static String GTASK_JSON_DELETED = "deleted"; - /** 目标列表字段名 */ + public final static String GTASK_JSON_DEST_LIST = "dest_list"; - /** 目标父级字段名 */ + public final static String GTASK_JSON_DEST_PARENT = "dest_parent"; - /** 目标父级类型字段名 */ + public final static String GTASK_JSON_DEST_PARENT_TYPE = "dest_parent_type"; - /** 实体增量字段名 */ + public final static String GTASK_JSON_ENTITY_DELTA = "entity_delta"; - /** 实体类型字段名 */ + public final static String GTASK_JSON_ENTITY_TYPE = "entity_type"; - /** 获取已删除项字段名 */ + public final static String GTASK_JSON_GET_DELETED = "get_deleted"; - /** ID字段名 */ + public final static String GTASK_JSON_ID = "id"; - /** 索引字段名 */ + public final static String GTASK_JSON_INDEX = "index"; - /** 最后修改时间字段名 */ + public final static String GTASK_JSON_LAST_MODIFIED = "last_modified"; - /** 最新同步点字段名 */ + public final static String GTASK_JSON_LATEST_SYNC_POINT = "latest_sync_point"; - /** 列表ID字段名 */ + public final static String GTASK_JSON_LIST_ID = "list_id"; - // ==================== 数据结构相关常量 ==================== - /** 列表集合字段名 */ public final static String GTASK_JSON_LISTS = "lists"; - /** 名称字段名 */ + public final static String GTASK_JSON_NAME = "name"; - /** 新ID字段名 */ + public final static String GTASK_JSON_NEW_ID = "new_id"; - /** 便签字段名 */ + public final static String GTASK_JSON_NOTES = "notes"; - /** 父级ID字段名 */ + public final static String GTASK_JSON_PARENT_ID = "parent_id"; - /** 前一个兄弟节点ID字段名 */ + public final static String GTASK_JSON_PRIOR_SIBLING_ID = "prior_sibling_id"; - /** 结果字段名 */ + public final static String GTASK_JSON_RESULTS = "results"; - /** 源列表字段名 */ + public final static String GTASK_JSON_SOURCE_LIST = "source_list"; - /** 任务字段名 */ + public final static String GTASK_JSON_TASKS = "tasks"; - /** 类型字段名 */ + public final static String GTASK_JSON_TYPE = "type"; - /** 组类型(文件夹) */ + public final static String GTASK_JSON_TYPE_GROUP = "GROUP"; - /** 任务类型(便签) */ + public final static String GTASK_JSON_TYPE_TASK = "TASK"; - /** 用户字段名 */ + public final static String GTASK_JSON_USER = "user"; - // ==================== MIUI便签特定常量 ==================== - /** MIUI文件夹前缀,用于标识MIUI便签创建的文件夹 */ public final static String MIUI_FOLDER_PREFFIX = "[MIUI_Notes]"; - /** 默认文件夹名称 */ + public final static String FOLDER_DEFAULT = "Default"; - /** 通话记录便签文件夹名称 */ + public final static String FOLDER_CALL_NOTE = "Call_Note"; - /** 元数据文件夹名称 */ + public final static String FOLDER_META = "METADATA"; - // ==================== 元数据相关常量 ==================== - /** 元数据头:Google Task ID */ public final static String META_HEAD_GTASK_ID = "meta_gid"; - /** 元数据头:便签信息 */ + public final static String META_HEAD_NOTE = "meta_note"; - /** 元数据头:数据信息 */ + public final static String META_HEAD_DATA = "meta_data"; - /** 元数据便签名称,提示用户不要修改或删除 */ + public final static String META_NOTE_NAME = "[META INFO] DON'T UPDATE AND DELETE"; -} \ No newline at end of file + +} diff --git a/src/notes/tool/ResourceParser.java b/src/notes/tool/ResourceParser.java index 445a271..1ad3ad6 100644 --- a/src/notes/tool/ResourceParser.java +++ b/src/notes/tool/ResourceParser.java @@ -22,253 +22,151 @@ import android.preference.PreferenceManager; import net.micode.notes.R; import net.micode.notes.ui.NotesPreferenceActivity; -/** - * 资源映射器工具类 - * 统一管理便签应用中的颜色、字体大小、背景图片等资源 - * 提供根据ID获取对应资源的方法 - */ public class ResourceParser { - // ==================== 颜色常量定义 ==================== - /** 黄色 - 便签背景颜色标识 */ public static final int YELLOW = 0; - /** 蓝色 - 便签背景颜色标识 */ public static final int BLUE = 1; - /** 白色 - 便签背景颜色标识 */ public static final int WHITE = 2; - /** 绿色 - 便签背景颜色标识 */ public static final int GREEN = 3; - /** 红色 - 便签背景颜色标识 */ public static final int RED = 4; - /** 默认背景颜色 - 黄色 */ public static final int BG_DEFAULT_COLOR = YELLOW; - // ==================== 字体大小常量定义 ==================== - /** 小号字体 */ public static final int TEXT_SMALL = 0; - /** 中号字体 */ public static final int TEXT_MEDIUM = 1; - /** 大号字体 */ public static final int TEXT_LARGE = 2; - /** 超大号字体 */ public static final int TEXT_SUPER = 3; - /** 默认字体大小 - 中号 */ public static final int BG_DEFAULT_FONT_SIZE = TEXT_MEDIUM; - /** - * 便签编辑界面背景资源类 - * 管理便签编辑页面的背景图片资源 - */ public static class NoteBgResources { - /** 便签编辑区域背景资源数组,按颜色顺序排列 */ private final static int [] BG_EDIT_RESOURCES = new int [] { - R.drawable.edit_yellow, // 黄色背景 - R.drawable.edit_blue, // 蓝色背景 - R.drawable.edit_white, // 白色背景 - R.drawable.edit_green, // 绿色背景 - R.drawable.edit_red // 红色背景 + R.drawable.edit_yellow, + R.drawable.edit_blue, + R.drawable.edit_white, + R.drawable.edit_green, + R.drawable.edit_red }; - /** 便签标题区域背景资源数组,按颜色顺序排列 */ private final static int [] BG_EDIT_TITLE_RESOURCES = new int [] { - R.drawable.edit_title_yellow, // 黄色标题背景 - R.drawable.edit_title_blue, // 蓝色标题背景 - R.drawable.edit_title_white, // 白色标题背景 - R.drawable.edit_title_green, // 绿色标题背景 - R.drawable.edit_title_red // 红色标题背景 + R.drawable.edit_title_yellow, + R.drawable.edit_title_blue, + R.drawable.edit_title_white, + R.drawable.edit_title_green, + R.drawable.edit_title_red }; - /** - * 根据颜色ID获取便签编辑区域背景资源 - * @param id 颜色ID (YELLOW, BLUE, WHITE, GREEN, RED) - * @return 对应的背景资源ID - */ public static int getNoteBgResource(int id) { return BG_EDIT_RESOURCES[id]; } - /** - * 根据颜色ID获取便签标题区域背景资源 - * @param id 颜色ID (YELLOW, BLUE, WHITE, GREEN, RED) - * @return 对应的标题背景资源ID - */ public static int getNoteTitleBgResource(int id) { return BG_EDIT_TITLE_RESOURCES[id]; } } - /** - * 获取默认背景颜色ID - * 根据用户设置决定使用随机颜色还是默认颜色 - * @param context 上下文对象 - * @return 背景颜色ID - */ public static int getDefaultBgId(Context context) { - // 检查用户是否启用了随机背景颜色功能 if (PreferenceManager.getDefaultSharedPreferences(context).getBoolean( NotesPreferenceActivity.PREFERENCE_SET_BG_COLOR_KEY, false)) { - // 启用随机颜色:返回0-4之间的随机数 return (int) (Math.random() * NoteBgResources.BG_EDIT_RESOURCES.length); } else { - // 使用默认颜色:黄色 return BG_DEFAULT_COLOR; } } - /** - * 便签列表项背景资源类 - * 管理便签列表中不同位置项的背景图片(第一个、中间、最后一个、单独项) - */ public static class NoteItemBgResources { - /** 列表第一个项的背景资源数组 */ private final static int [] BG_FIRST_RESOURCES = new int [] { - R.drawable.list_yellow_up, // 黄色第一个项 - R.drawable.list_blue_up, // 蓝色第一个项 - R.drawable.list_white_up, // 白色第一个项 - R.drawable.list_green_up, // 绿色第一个项 - R.drawable.list_red_up // 红色第一个项 + R.drawable.list_yellow_up, + R.drawable.list_blue_up, + R.drawable.list_white_up, + R.drawable.list_green_up, + R.drawable.list_red_up }; - /** 列表中间项的背景资源数组 */ private final static int [] BG_NORMAL_RESOURCES = new int [] { - R.drawable.list_yellow_middle, // 黄色中间项 - R.drawable.list_blue_middle, // 蓝色中间项 - R.drawable.list_white_middle, // 白色中间项 - R.drawable.list_green_middle, // 绿色中间项 - R.drawable.list_red_middle // 红色中间项 + R.drawable.list_yellow_middle, + R.drawable.list_blue_middle, + R.drawable.list_white_middle, + R.drawable.list_green_middle, + R.drawable.list_red_middle }; - /** 列表最后一个项的背景资源数组 */ private final static int [] BG_LAST_RESOURCES = new int [] { - R.drawable.list_yellow_down, // 黄色最后一个项 - R.drawable.list_blue_down, // 蓝色最后一个项 - R.drawable.list_white_down, // 白色最后一个项 - R.drawable.list_green_down, // 绿色最后一个项 - R.drawable.list_red_down, // 红色最后一个项 + R.drawable.list_yellow_down, + R.drawable.list_blue_down, + R.drawable.list_white_down, + R.drawable.list_green_down, + R.drawable.list_red_down, }; - /** 单独一项的背景资源数组(列表只有一项时使用) */ private final static int [] BG_SINGLE_RESOURCES = new int [] { - R.drawable.list_yellow_single, // 黄色单独项 - R.drawable.list_blue_single, // 蓝色单独项 - R.drawable.list_white_single, // 白色单独项 - R.drawable.list_green_single, // 绿色单独项 - R.drawable.list_red_single // 红色单独项 + R.drawable.list_yellow_single, + R.drawable.list_blue_single, + R.drawable.list_white_single, + R.drawable.list_green_single, + R.drawable.list_red_single }; - /** - * 获取列表第一个项的背景资源 - * @param id 颜色ID - * @return 对应的背景资源ID - */ public static int getNoteBgFirstRes(int id) { return BG_FIRST_RESOURCES[id]; } - /** - * 获取列表最后一个项的背景资源 - * @param id 颜色ID - * @return 对应的背景资源ID - */ public static int getNoteBgLastRes(int id) { return BG_LAST_RESOURCES[id]; } - /** - * 获取单独一项的背景资源(列表只有一项时使用) - * @param id 颜色ID - * @return 对应的背景资源ID - */ public static int getNoteBgSingleRes(int id) { return BG_SINGLE_RESOURCES[id]; } - /** - * 获取列表中间项的背景资源 - * @param id 颜色ID - * @return 对应的背景资源ID - */ public static int getNoteBgNormalRes(int id) { return BG_NORMAL_RESOURCES[id]; } - /** - * 获取文件夹项的背景资源 - * @return 文件夹背景资源ID - */ public static int getFolderBgRes() { return R.drawable.list_folder; } } - /** - * 小部件背景资源类 - * 管理不同尺寸小部件的背景图片资源 - */ public static class WidgetBgResources { - /** 2x尺寸小部件的背景资源数组 */ private final static int [] BG_2X_RESOURCES = new int [] { - R.drawable.widget_2x_yellow, // 黄色2x小部件 - R.drawable.widget_2x_blue, // 蓝色2x小部件 - R.drawable.widget_2x_white, // 白色2x小部件 - R.drawable.widget_2x_green, // 绿色2x小部件 - R.drawable.widget_2x_red, // 红色2x小部件 + R.drawable.widget_2x_yellow, + R.drawable.widget_2x_blue, + R.drawable.widget_2x_white, + R.drawable.widget_2x_green, + R.drawable.widget_2x_red, }; - /** - * 获取2x尺寸小部件的背景资源 - * @param id 颜色ID - * @return 对应的背景资源ID - */ public static int getWidget2xBgResource(int id) { return BG_2X_RESOURCES[id]; } - /** 4x尺寸小部件的背景资源数组 */ private final static int [] BG_4X_RESOURCES = new int [] { - R.drawable.widget_4x_yellow, // 黄色4x小部件 - R.drawable.widget_4x_blue, // 蓝色4x小部件 - R.drawable.widget_4x_white, // 白色4x小部件 - R.drawable.widget_4x_green, // 绿色4x小部件 - R.drawable.widget_4x_red // 红色4x小部件 + R.drawable.widget_4x_yellow, + R.drawable.widget_4x_blue, + R.drawable.widget_4x_white, + R.drawable.widget_4x_green, + R.drawable.widget_4x_red }; - /** - * 获取4x尺寸小部件的背景资源 - * @param id 颜色ID - * @return 对应的背景资源ID - */ public static int getWidget4xBgResource(int id) { return BG_4X_RESOURCES[id]; } } - /** - * 文本外观资源类 - * 管理不同字体大小的样式资源 - */ public static class TextAppearanceResources { - /** 文本外观样式资源数组,按字体大小顺序排列 */ private final static int [] TEXTAPPEARANCE_RESOURCES = new int [] { - R.style.TextAppearanceNormal, // 正常字体样式 - R.style.TextAppearanceMedium, // 中等字体样式 - R.style.TextAppearanceLarge, // 大字体样式 - R.style.TextAppearanceSuper // 超大字体样式 + R.style.TextAppearanceNormal, + R.style.TextAppearanceMedium, + R.style.TextAppearanceLarge, + R.style.TextAppearanceSuper }; - /** - * 根据字体大小ID获取对应的文本外观资源 - * 包含边界检查,防止数组越界 - * @param id 字体大小ID (TEXT_SMALL, TEXT_MEDIUM, TEXT_LARGE, TEXT_SUPER) - * @return 对应的文本外观资源ID - */ public static int getTexAppearanceResource(int id) { /** - * HACKME: 修复在SharedPreference中存储资源ID的bug - * ID可能大于资源数组的长度,在这种情况下返回默认字体大小 - * 这是一个临时的修复方案,需要后续优化 + * HACKME: Fix bug of store the resource id in shared preference. + * The id may larger than the length of resources, in this case, + * return the {@link ResourceParser#BG_DEFAULT_FONT_SIZE} */ if (id >= TEXTAPPEARANCE_RESOURCES.length) { return BG_DEFAULT_FONT_SIZE; @@ -276,12 +174,8 @@ public class ResourceParser { return TEXTAPPEARANCE_RESOURCES[id]; } - /** - * 获取文本外观资源的总数量 - * @return 资源数组的长度 - */ public static int getResourcesSize() { return TEXTAPPEARANCE_RESOURCES.length; } } -} \ No newline at end of file +} diff --git a/src/notes/ui/AlarmAlertActivity.java b/src/notes/ui/AlarmAlertActivity.java index 46f4884..85723be 100644 --- a/src/notes/ui/AlarmAlertActivity.java +++ b/src/notes/ui/AlarmAlertActivity.java @@ -39,26 +39,21 @@ import net.micode.notes.tool.DataUtils; import java.io.IOException; -/** - * 闹钟提醒活动 - 当便签闹钟触发时显示的提醒界面 - * 负责播放闹钟声音并显示提醒对话框 - */ + public class AlarmAlertActivity extends Activity implements OnClickListener, OnDismissListener { - private long mNoteId; // 便签ID - private String mSnippet; // 便签内容片段 - private static final int SNIPPET_PREW_MAX_LEN = 60; // 片段预览最大长度 - MediaPlayer mPlayer; // 媒体播放器,用于播放闹钟声音 + private long mNoteId; + private String mSnippet; + private static final int SNIPPET_PREW_MAX_LEN = 60; + MediaPlayer mPlayer; @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); - requestWindowFeature(Window.FEATURE_NO_TITLE); // 设置无标题栏 + requestWindowFeature(Window.FEATURE_NO_TITLE); final Window win = getWindow(); - // 添加窗口标志,允许在锁屏界面显示 win.addFlags(WindowManager.LayoutParams.FLAG_SHOW_WHEN_LOCKED); - // 如果屏幕未开启,设置相关标志以唤醒屏幕 if (!isScreenOn()) { win.addFlags(WindowManager.LayoutParams.FLAG_KEEP_SCREEN_ON | WindowManager.LayoutParams.FLAG_TURN_SCREEN_ON @@ -69,10 +64,8 @@ public class AlarmAlertActivity extends Activity implements OnClickListener, OnD Intent intent = getIntent(); try { - // 从Intent中获取便签ID和内容片段 mNoteId = Long.valueOf(intent.getData().getPathSegments().get(1)); mSnippet = DataUtils.getSnippetById(this.getContentResolver(), mNoteId); - // 截取片段内容,如果过长则添加省略号 mSnippet = mSnippet.length() > SNIPPET_PREW_MAX_LEN ? mSnippet.substring(0, SNIPPET_PREW_MAX_LEN) + getResources().getString(R.string.notelist_string_info) : mSnippet; @@ -82,106 +75,84 @@ public class AlarmAlertActivity extends Activity implements OnClickListener, OnD } mPlayer = new MediaPlayer(); - // 检查便签是否仍然存在于数据库中且为普通类型 if (DataUtils.visibleInNoteDatabase(getContentResolver(), mNoteId, Notes.TYPE_NOTE)) { - showActionDialog(); // 显示操作对话框 - playAlarmSound(); // 播放闹钟声音 + showActionDialog(); + playAlarmSound(); } else { - finish(); // 如果便签不存在,直接结束活动 + finish(); } } - /** - * 检查屏幕是否已开启 - */ private boolean isScreenOn() { PowerManager pm = (PowerManager) getSystemService(Context.POWER_SERVICE); return pm.isScreenOn(); } - /** - * 播放闹钟声音 - */ private void playAlarmSound() { - // 获取默认的闹钟铃声URI Uri url = RingtoneManager.getActualDefaultRingtoneUri(this, RingtoneManager.TYPE_ALARM); - // 获取受静音模式影响的音频流设置 int silentModeStreams = Settings.System.getInt(getContentResolver(), Settings.System.MODE_RINGER_STREAMS_AFFECTED, 0); - // 设置音频流类型,考虑静音模式设置 if ((silentModeStreams & (1 << AudioManager.STREAM_ALARM)) != 0) { mPlayer.setAudioStreamType(silentModeStreams); } else { mPlayer.setAudioStreamType(AudioManager.STREAM_ALARM); } - try { - // 设置数据源并准备播放 mPlayer.setDataSource(this, url); mPlayer.prepare(); - mPlayer.setLooping(true); // 设置循环播放 - mPlayer.start(); // 开始播放 + mPlayer.setLooping(true); + mPlayer.start(); } catch (IllegalArgumentException e) { + // TODO Auto-generated catch block e.printStackTrace(); } catch (SecurityException e) { + // TODO Auto-generated catch block e.printStackTrace(); } catch (IllegalStateException e) { + // TODO Auto-generated catch block e.printStackTrace(); } catch (IOException e) { + // TODO Auto-generated catch block e.printStackTrace(); } } - /** - * 显示操作对话框 - */ private void showActionDialog() { AlertDialog.Builder dialog = new AlertDialog.Builder(this); - dialog.setTitle(R.string.app_name); // 设置应用名称作为标题 - dialog.setMessage(mSnippet); // 设置便签片段作为内容 - dialog.setPositiveButton(R.string.notealert_ok, this); // 确定按钮 - - // 如果屏幕已开启,显示进入按钮(用于跳转到便签编辑界面) + dialog.setTitle(R.string.app_name); + dialog.setMessage(mSnippet); + dialog.setPositiveButton(R.string.notealert_ok, this); if (isScreenOn()) { dialog.setNegativeButton(R.string.notealert_enter, this); } - dialog.show().setOnDismissListener(this); // 设置对话框关闭监听器 + dialog.show().setOnDismissListener(this); } - /** - * 对话框按钮点击事件处理 - */ public void onClick(DialogInterface dialog, int which) { switch (which) { - case DialogInterface.BUTTON_NEGATIVE: // 点击"进入"按钮 + case DialogInterface.BUTTON_NEGATIVE: Intent intent = new Intent(this, NoteEditActivity.class); intent.setAction(Intent.ACTION_VIEW); - intent.putExtra(Intent.EXTRA_UID, mNoteId); // 传递便签ID - startActivity(intent); // 跳转到便签编辑界面 + intent.putExtra(Intent.EXTRA_UID, mNoteId); + startActivity(intent); break; default: - break; // 确定按钮或其他按钮,不执行特殊操作 + break; } } - /** - * 对话框关闭事件处理 - */ public void onDismiss(DialogInterface dialog) { - stopAlarmSound(); // 停止闹钟声音 - finish(); // 结束活动 + stopAlarmSound(); + finish(); } - /** - * 停止闹钟声音播放 - */ private void stopAlarmSound() { if (mPlayer != null) { - mPlayer.stop(); // 停止播放 - mPlayer.release(); // 释放资源 - mPlayer = null; // 置空引用 + mPlayer.stop(); + mPlayer.release(); + mPlayer = null; } } -} \ No newline at end of file +} diff --git a/src/notes/ui/AlarmInitReceiver.java b/src/notes/ui/AlarmInitReceiver.java index 6020082..f221202 100644 --- a/src/notes/ui/AlarmInitReceiver.java +++ b/src/notes/ui/AlarmInitReceiver.java @@ -27,64 +27,39 @@ import android.database.Cursor; import net.micode.notes.data.Notes; import net.micode.notes.data.Notes.NoteColumns; -/** - * 闹钟初始化接收器 - 在系统启动或应用初始化时重新设置所有未来的便签提醒 - * 这是一个广播接收器,用于在设备重启后恢复所有未触发的闹钟提醒 - */ + public class AlarmInitReceiver extends BroadcastReceiver { - // 数据库查询的列投影,只需要ID和提醒日期 private static final String [] PROJECTION = new String [] { - NoteColumns.ID, // 便签ID - NoteColumns.ALERTED_DATE // 提醒日期时间戳 + NoteColumns.ID, + NoteColumns.ALERTED_DATE }; - // 列索引常量,提高代码可读性 - private static final int COLUMN_ID = 0; // ID列索引 - private static final int COLUMN_ALERTED_DATE = 1; // 提醒日期列索引 + private static final int COLUMN_ID = 0; + private static final int COLUMN_ALERTED_DATE = 1; - /** - * 广播接收器的核心方法,当接收到系统启动广播时被调用 - * @param context 上下文对象 - * @param intent 接收到的广播意图 - */ @Override public void onReceive(Context context, Intent intent) { - long currentDate = System.currentTimeMillis(); // 获取当前时间戳 - - // 查询数据库:查找所有未来需要提醒的普通便签 - // 条件:提醒日期 > 当前时间 且 类型为普通便签 + long currentDate = System.currentTimeMillis(); Cursor c = context.getContentResolver().query(Notes.CONTENT_NOTE_URI, PROJECTION, NoteColumns.ALERTED_DATE + ">? AND " + NoteColumns.TYPE + "=" + Notes.TYPE_NOTE, - new String[] { String.valueOf(currentDate) }, // 参数:当前时间 + new String[] { String.valueOf(currentDate) }, null); if (c != null) { - // 遍历查询结果,为每个未来的提醒设置闹钟 if (c.moveToFirst()) { do { - long alertDate = c.getLong(COLUMN_ALERTED_DATE); // 获取提醒时间 - long noteId = c.getLong(COLUMN_ID); // 获取便签ID - - // 创建闹钟触发时的广播意图 + long alertDate = c.getLong(COLUMN_ALERTED_DATE); Intent sender = new Intent(context, AlarmReceiver.class); - // 设置数据URI,便于AlarmReceiver识别具体便签 - sender.setData(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId)); - - // 创建待定意图,用于闹钟管理器 + sender.setData(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, c.getLong(COLUMN_ID))); PendingIntent pendingIntent = PendingIntent.getBroadcast(context, 0, sender, 0); - - // 获取闹钟管理器服务 - AlarmManager alarmManager = (AlarmManager) context + AlarmManager alermManager = (AlarmManager) context .getSystemService(Context.ALARM_SERVICE); - - // 设置精确闹钟:RTC_WAKEUP表示即使设备休眠也会唤醒并触发 - alarmManager.set(AlarmManager.RTC_WAKEUP, alertDate, pendingIntent); - - } while (c.moveToNext()); // 继续处理下一条记录 + alermManager.set(AlarmManager.RTC_WAKEUP, alertDate, pendingIntent); + } while (c.moveToNext()); } - c.close(); // 关闭游标,释放资源 + c.close(); } } -} \ No newline at end of file +} diff --git a/src/notes/ui/AlarmReceiver.java b/src/notes/ui/AlarmReceiver.java index 8461d2b..54e503b 100644 --- a/src/notes/ui/AlarmReceiver.java +++ b/src/notes/ui/AlarmReceiver.java @@ -20,29 +20,11 @@ import android.content.BroadcastReceiver; import android.content.Context; import android.content.Intent; -/** - * 闹钟接收器 - 接收AlarmManager发出的闹钟广播,并启动闹钟提醒界面 - * 这是一个简单的广播接收器,作为闹钟触发时的中转站 - */ public class AlarmReceiver extends BroadcastReceiver { - - /** - * 当闹钟触发时,系统会调用此方法 - * 主要功能:将广播意图转换为活动意图,并启动闹钟提醒界面 - * - * @param context 上下文对象,用于启动新的Activity - * @param intent 接收到的广播意图,包含便签信息(通过URI传递) - */ @Override public void onReceive(Context context, Intent intent) { - // 将当前意图的类设置为闹钟提醒活动 intent.setClass(context, AlarmAlertActivity.class); - - // 添加标志,确保在新的任务栈中启动Activity - // 这是必要的,因为广播接收器本身没有Activity上下文 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK); - - // 启动闹钟提醒界面 context.startActivity(intent); } -} \ No newline at end of file +} diff --git a/src/notes/ui/DateTimePicker.java b/src/notes/ui/DateTimePicker.java index 0e8a210..496b0cd 100644 --- a/src/notes/ui/DateTimePicker.java +++ b/src/notes/ui/DateTimePicker.java @@ -21,122 +21,92 @@ import java.util.Calendar; import net.micode.notes.R; + import android.content.Context; import android.text.format.DateFormat; import android.view.View; import android.widget.FrameLayout; import android.widget.NumberPicker; -/** - * 自定义日期时间选择器控件 - * 提供日期、小时、分钟和AM/PM的选择功能 - * 支持12小时制和24小时制两种显示模式 - */ public class DateTimePicker extends FrameLayout { - // 默认启用状态 + private static final boolean DEFAULT_ENABLE_STATE = true; - // 时间相关常量定义 - private static final int HOURS_IN_HALF_DAY = 12; // 半天的小时数(12小时制) - private static final int HOURS_IN_ALL_DAY = 24; // 全天小时数(24小时制) - private static final int DAYS_IN_ALL_WEEK = 7; // 一周天数 - - // 各选择器的数值范围常量 - private static final int DATE_SPINNER_MIN_VAL = 0; // 日期选择器最小值 - private static final int DATE_SPINNER_MAX_VAL = DAYS_IN_ALL_WEEK - 1; // 日期选择器最大值 - private static final int HOUR_SPINNER_MIN_VAL_24_HOUR_VIEW = 0; // 24小时制小时最小值 - private static final int HOUR_SPINNER_MAX_VAL_24_HOUR_VIEW = 23; // 24小时制小时最大值 - private static final int HOUR_SPINNER_MIN_VAL_12_HOUR_VIEW = 1; // 12小时制小时最小值 - private static final int HOUR_SPINNER_MAX_VAL_12_HOUR_VIEW = 12; // 12小时制小时最大值 - private static final int MINUT_SPINNER_MIN_VAL = 0; // 分钟选择器最小值 - private static final int MINUT_SPINNER_MAX_VAL = 59; // 分钟选择器最大值 - private static final int AMPM_SPINNER_MIN_VAL = 0; // AM/PM选择器最小值 - private static final int AMPM_SPINNER_MAX_VAL = 1; // AM/PM选择器最大值 - - // UI组件 - private final NumberPicker mDateSpinner; // 日期选择器 - private final NumberPicker mHourSpinner; // 小时选择器 - private final NumberPicker mMinuteSpinner; // 分钟选择器 - private final NumberPicker mAmPmSpinner; // AM/PM选择器 - - // 数据状态 - private Calendar mDate; // 当前选择的日期时间 - private String[] mDateDisplayValues = new String[DAYS_IN_ALL_WEEK]; // 日期显示文本数组 - private boolean mIsAm; // 是否为上午(AM) - private boolean mIs24HourView; // 是否为24小时制显示 - private boolean mIsEnabled = DEFAULT_ENABLE_STATE; // 控件是否启用 - private boolean mInitialising; // 初始化状态标志,防止初始化期间触发回调 - - // 回调接口 + private static final int HOURS_IN_HALF_DAY = 12; + private static final int HOURS_IN_ALL_DAY = 24; + private static final int DAYS_IN_ALL_WEEK = 7; + private static final int DATE_SPINNER_MIN_VAL = 0; + private static final int DATE_SPINNER_MAX_VAL = DAYS_IN_ALL_WEEK - 1; + private static final int HOUR_SPINNER_MIN_VAL_24_HOUR_VIEW = 0; + private static final int HOUR_SPINNER_MAX_VAL_24_HOUR_VIEW = 23; + private static final int HOUR_SPINNER_MIN_VAL_12_HOUR_VIEW = 1; + private static final int HOUR_SPINNER_MAX_VAL_12_HOUR_VIEW = 12; + private static final int MINUT_SPINNER_MIN_VAL = 0; + private static final int MINUT_SPINNER_MAX_VAL = 59; + private static final int AMPM_SPINNER_MIN_VAL = 0; + private static final int AMPM_SPINNER_MAX_VAL = 1; + + private final NumberPicker mDateSpinner; + private final NumberPicker mHourSpinner; + private final NumberPicker mMinuteSpinner; + private final NumberPicker mAmPmSpinner; + private Calendar mDate; + + private String[] mDateDisplayValues = new String[DAYS_IN_ALL_WEEK]; + + private boolean mIsAm; + + private boolean mIs24HourView; + + private boolean mIsEnabled = DEFAULT_ENABLE_STATE; + + private boolean mInitialising; + private OnDateTimeChangedListener mOnDateTimeChangedListener; - /** - * 日期变化监听器 - * 处理日期选择器的值变化,调整日期并更新显示 - */ private NumberPicker.OnValueChangeListener mOnDateChangedListener = new NumberPicker.OnValueChangeListener() { @Override public void onValueChange(NumberPicker picker, int oldVal, int newVal) { - // 根据新旧值差异调整日期 mDate.add(Calendar.DAY_OF_YEAR, newVal - oldVal); - updateDateControl(); // 更新日期显示 - onDateTimeChanged(); // 触发日期时间变化回调 + updateDateControl(); + onDateTimeChanged(); } }; - /** - * 小时变化监听器 - * 处理小时选择器的值变化,包括12/24小时制转换和日期边界处理 - */ private NumberPicker.OnValueChangeListener mOnHourChangedListener = new NumberPicker.OnValueChangeListener() { @Override public void onValueChange(NumberPicker picker, int oldVal, int newVal) { - boolean isDateChanged = false; // 标记是否需要调整日期 + boolean isDateChanged = false; Calendar cal = Calendar.getInstance(); - if (!mIs24HourView) { - // 12小时制下的特殊处理 - // 下午11点->12点:需要增加一天 if (!mIsAm && oldVal == HOURS_IN_HALF_DAY - 1 && newVal == HOURS_IN_HALF_DAY) { cal.setTimeInMillis(mDate.getTimeInMillis()); cal.add(Calendar.DAY_OF_YEAR, 1); isDateChanged = true; - } - // 上午12点->11点:需要减少一天 - else if (mIsAm && oldVal == HOURS_IN_HALF_DAY && newVal == HOURS_IN_HALF_DAY - 1) { + } else if (mIsAm && oldVal == HOURS_IN_HALF_DAY && newVal == HOURS_IN_HALF_DAY - 1) { cal.setTimeInMillis(mDate.getTimeInMillis()); cal.add(Calendar.DAY_OF_YEAR, -1); isDateChanged = true; } - - // 处理AM/PM切换(11点<->12点) - if ((oldVal == HOURS_IN_HALF_DAY - 1 && newVal == HOURS_IN_HALF_DAY) || - (oldVal == HOURS_IN_HALF_DAY && newVal == HOURS_IN_HALF_DAY - 1)) { - mIsAm = !mIsAm; // 切换AM/PM状态 - updateAmPmControl(); // 更新AM/PM显示 + if (oldVal == HOURS_IN_HALF_DAY - 1 && newVal == HOURS_IN_HALF_DAY || + oldVal == HOURS_IN_HALF_DAY && newVal == HOURS_IN_HALF_DAY - 1) { + mIsAm = !mIsAm; + updateAmPmControl(); } } else { - // 24小时制下的特殊处理 - // 23点->0点:需要增加一天 if (oldVal == HOURS_IN_ALL_DAY - 1 && newVal == 0) { cal.setTimeInMillis(mDate.getTimeInMillis()); cal.add(Calendar.DAY_OF_YEAR, 1); isDateChanged = true; - } - // 0点->23点:需要减少一天 - else if (oldVal == 0 && newVal == HOURS_IN_ALL_DAY - 1) { + } else if (oldVal == 0 && newVal == HOURS_IN_ALL_DAY - 1) { cal.setTimeInMillis(mDate.getTimeInMillis()); cal.add(Calendar.DAY_OF_YEAR, -1); isDateChanged = true; } } - - // 计算实际的小时值(12小时制需要转换为24小时制) int newHour = mHourSpinner.getValue() % HOURS_IN_HALF_DAY + (mIsAm ? 0 : HOURS_IN_HALF_DAY); mDate.set(Calendar.HOUR_OF_DAY, newHour); - onDateTimeChanged(); // 触发回调 - - // 如果需要调整日期,则更新年月日 + onDateTimeChanged(); if (isDateChanged) { setCurrentYear(cal.get(Calendar.YEAR)); setCurrentMonth(cal.get(Calendar.MONTH)); @@ -145,169 +115,111 @@ public class DateTimePicker extends FrameLayout { } }; - /** - * 分钟变化监听器 - * 处理分钟选择器的值变化,包括分钟循环边界处理 - */ private NumberPicker.OnValueChangeListener mOnMinuteChangedListener = new NumberPicker.OnValueChangeListener() { @Override public void onValueChange(NumberPicker picker, int oldVal, int newVal) { int minValue = mMinuteSpinner.getMinValue(); int maxValue = mMinuteSpinner.getMaxValue(); - int offset = 0; // 小时调整偏移量 - - // 处理分钟循环:59->0需要增加1小时,0->59需要减少1小时 + int offset = 0; if (oldVal == maxValue && newVal == minValue) { - offset += 1; // 向前滚动:增加1小时 + offset += 1; } else if (oldVal == minValue && newVal == maxValue) { - offset -= 1; // 向后滚动:减少1小时 + offset -= 1; } - - // 如果需要调整小时 if (offset != 0) { - mDate.add(Calendar.HOUR_OF_DAY, offset); // 调整小时 - mHourSpinner.setValue(getCurrentHour()); // 更新小时显示 - updateDateControl(); // 更新日期显示(可能因小时调整而跨天) - - // 检查并更新AM/PM状态 + mDate.add(Calendar.HOUR_OF_DAY, offset); + mHourSpinner.setValue(getCurrentHour()); + updateDateControl(); int newHour = getCurrentHourOfDay(); if (newHour >= HOURS_IN_HALF_DAY) { - mIsAm = false; // 下午 + mIsAm = false; updateAmPmControl(); } else { - mIsAm = true; // 上午 + mIsAm = true; updateAmPmControl(); } } - - // 设置新的分钟值 mDate.set(Calendar.MINUTE, newVal); - onDateTimeChanged(); // 触发回调 + onDateTimeChanged(); } }; - /** - * AM/PM变化监听器 - * 处理AM/PM选择器的值变化,调整12小时 - */ private NumberPicker.OnValueChangeListener mOnAmPmChangedListener = new NumberPicker.OnValueChangeListener() { @Override public void onValueChange(NumberPicker picker, int oldVal, int newVal) { - mIsAm = !mIsAm; // 切换AM/PM状态 - - // 根据AM/PM切换调整12小时 + mIsAm = !mIsAm; if (mIsAm) { - mDate.add(Calendar.HOUR_OF_DAY, -HOURS_IN_HALF_DAY); // PM->AM:减少12小时 + mDate.add(Calendar.HOUR_OF_DAY, -HOURS_IN_HALF_DAY); } else { - mDate.add(Calendar.HOUR_OF_DAY, HOURS_IN_HALF_DAY); // AM->PM:增加12小时 + mDate.add(Calendar.HOUR_OF_DAY, HOURS_IN_HALF_DAY); } - - updateAmPmControl(); // 更新AM/PM显示 - onDateTimeChanged(); // 触发回调 + updateAmPmControl(); + onDateTimeChanged(); } }; - /** - * 日期时间变化回调接口 - */ public interface OnDateTimeChangedListener { - /** - * 当日期时间发生变化时调用 - * @param view 触发变化的DateTimePicker实例 - * @param year 年份 - * @param month 月份(0-11) - * @param dayOfMonth 日期(1-31) - * @param hourOfDay 小时(0-23) - * @param minute 分钟(0-59) - */ void onDateTimeChanged(DateTimePicker view, int year, int month, - int dayOfMonth, int hourOfDay, int minute); + int dayOfMonth, int hourOfDay, int minute); } - /** - * 构造函数 - 使用当前时间初始化 - * @param context 上下文环境 - */ public DateTimePicker(Context context) { this(context, System.currentTimeMillis()); } - /** - * 构造函数 - 使用指定时间初始化 - * @param context 上下文环境 - * @param date 初始时间(毫秒时间戳) - */ public DateTimePicker(Context context, long date) { this(context, date, DateFormat.is24HourFormat(context)); } - /** - * 主构造函数 - 完整初始化 - * @param context 上下文环境 - * @param date 初始时间(毫秒时间戳) - * @param is24HourView 是否为24小时制显示 - */ public DateTimePicker(Context context, long date, boolean is24HourView) { super(context); - mDate = Calendar.getInstance(); // 创建日历实例 - mInitialising = true; // 标记开始初始化 - - // 根据当前时间判断初始AM/PM状态 - mIsAm = (getCurrentHourOfDay() < HOURS_IN_HALF_DAY); - - // 加载布局文件 + mDate = Calendar.getInstance(); + mInitialising = true; + mIsAm = getCurrentHourOfDay() >= HOURS_IN_HALF_DAY; inflate(context, R.layout.datetime_picker, this); - // 初始化日期选择器 mDateSpinner = (NumberPicker) findViewById(R.id.date); mDateSpinner.setMinValue(DATE_SPINNER_MIN_VAL); mDateSpinner.setMaxValue(DATE_SPINNER_MAX_VAL); mDateSpinner.setOnValueChangedListener(mOnDateChangedListener); - // 初始化小时选择器 mHourSpinner = (NumberPicker) findViewById(R.id.hour); mHourSpinner.setOnValueChangedListener(mOnHourChangedListener); - - // 初始化分钟选择器 mMinuteSpinner = (NumberPicker) findViewById(R.id.minute); mMinuteSpinner.setMinValue(MINUT_SPINNER_MIN_VAL); mMinuteSpinner.setMaxValue(MINUT_SPINNER_MAX_VAL); - mMinuteSpinner.setOnLongPressUpdateInterval(100); // 设置长按更新间隔 + mMinuteSpinner.setOnLongPressUpdateInterval(100); mMinuteSpinner.setOnValueChangedListener(mOnMinuteChangedListener); - // 初始化AM/PM选择器 - String[] stringsForAmPm = new DateFormatSymbols().getAmPmStrings(); // 获取本地化的AM/PM文本 + String[] stringsForAmPm = new DateFormatSymbols().getAmPmStrings(); mAmPmSpinner = (NumberPicker) findViewById(R.id.amPm); mAmPmSpinner.setMinValue(AMPM_SPINNER_MIN_VAL); mAmPmSpinner.setMaxValue(AMPM_SPINNER_MAX_VAL); - mAmPmSpinner.setDisplayedValues(stringsForAmPm); // 设置显示文本 + mAmPmSpinner.setDisplayedValues(stringsForAmPm); mAmPmSpinner.setOnValueChangedListener(mOnAmPmChangedListener); - // 更新各控件到初始状态 - updateDateControl(); // 更新日期显示 - updateHourControl(); // 更新小时显示范围 - updateAmPmControl(); // 更新AM/PM显示 + // update controls to initial state + updateDateControl(); + updateHourControl(); + updateAmPmControl(); - set24HourView(is24HourView); // 设置时间显示格式 + set24HourView(is24HourView); - setCurrentDate(date); // 设置初始时间 + // set to current time + setCurrentDate(date); - setEnabled(isEnabled()); // 设置启用状态 + setEnabled(isEnabled()); - mInitialising = false; // 标记初始化完成 + // set the content descriptions + mInitialising = false; } - /** - * 设置控件启用状态 - * @param enabled true启用,false禁用 - */ @Override public void setEnabled(boolean enabled) { if (mIsEnabled == enabled) { - return; // 状态未变化,直接返回 + return; } super.setEnabled(enabled); - // 设置各子组件的启用状态 mDateSpinner.setEnabled(enabled); mMinuteSpinner.setEnabled(enabled); mHourSpinner.setEnabled(enabled); @@ -315,45 +227,43 @@ public class DateTimePicker extends FrameLayout { mIsEnabled = enabled; } - /** - * 获取控件启用状态 - * @return true启用,false禁用 - */ @Override public boolean isEnabled() { return mIsEnabled; } /** - * 获取当前日期时间的毫秒时间戳 - * @return 当前日期时间的毫秒时间戳 + * Get the current date in millis + * + * @return the current date in millis */ public long getCurrentDateInTimeMillis() { return mDate.getTimeInMillis(); } /** - * 设置当前日期时间(通过毫秒时间戳) - * @param date 日期时间的毫秒时间戳 + * Set the current date + * + * @param date The current date in millis */ public void setCurrentDate(long date) { Calendar cal = Calendar.getInstance(); cal.setTimeInMillis(date); - // 分解设置年月日时分 setCurrentDate(cal.get(Calendar.YEAR), cal.get(Calendar.MONTH), cal.get(Calendar.DAY_OF_MONTH), cal.get(Calendar.HOUR_OF_DAY), cal.get(Calendar.MINUTE)); } /** - * 设置当前日期时间(通过具体参数) - * @param year 年份 - * @param month 月份(0-11) - * @param dayOfMonth 日期(1-31) - * @param hourOfDay 小时(0-23) - * @param minute 分钟(0-59) + * Set the current date + * + * @param year The current year + * @param month The current month + * @param dayOfMonth The current dayOfMonth + * @param hourOfDay The current hourOfDay + * @param minute The current minute */ public void setCurrentDate(int year, int month, - int dayOfMonth, int hourOfDay, int minute) { + int dayOfMonth, int hourOfDay, int minute) { setCurrentYear(year); setCurrentMonth(month); setCurrentDay(dayOfMonth); @@ -362,38 +272,41 @@ public class DateTimePicker extends FrameLayout { } /** - * 获取当前年份 - * @return 当前年份 + * Get current year + * + * @return The current year */ public int getCurrentYear() { return mDate.get(Calendar.YEAR); } /** - * 设置当前年份 - * @param year 要设置的年份 + * Set current year + * + * @param year The current year */ public void setCurrentYear(int year) { - // 初始化期间或年份未变化时跳过回调 if (!mInitialising && year == getCurrentYear()) { return; } mDate.set(Calendar.YEAR, year); - updateDateControl(); // 更新日期显示 - onDateTimeChanged(); // 触发回调 + updateDateControl(); + onDateTimeChanged(); } /** - * 获取当前月份 - * @return 当前月份(0-11) + * Get current month in the year + * + * @return The current month in the year */ public int getCurrentMonth() { return mDate.get(Calendar.MONTH); } /** - * 设置当前月份 - * @param month 要设置的月份(0-11) + * Set current month in the year + * + * @param month The month in the year */ public void setCurrentMonth(int month) { if (!mInitialising && month == getCurrentMonth()) { @@ -405,16 +318,18 @@ public class DateTimePicker extends FrameLayout { } /** - * 获取当前日期 - * @return 当前日期(1-31) + * Get current day of the month + * + * @return The day of the month */ public int getCurrentDay() { return mDate.get(Calendar.DAY_OF_MONTH); } /** - * 设置当前日期 - * @param dayOfMonth 要设置的日期(1-31) + * Set current day of the month + * + * @param dayOfMonth The day of the month */ public void setCurrentDay(int dayOfMonth) { if (!mInitialising && dayOfMonth == getCurrentDay()) { @@ -426,179 +341,145 @@ public class DateTimePicker extends FrameLayout { } /** - * 获取当前小时(24小时制) - * @return 当前小时(0-23) + * Get current hour in 24 hour mode, in the range (0~23) + * @return The current hour in 24 hour mode */ public int getCurrentHourOfDay() { return mDate.get(Calendar.HOUR_OF_DAY); } - /** - * 获取当前显示的小时值(根据12/24小时制格式) - * @return 12小时制返回1-12,24小时制返回0-23 - */ private int getCurrentHour() { if (mIs24HourView){ - return getCurrentHourOfDay(); // 24小时制直接返回 + return getCurrentHourOfDay(); } else { int hour = getCurrentHourOfDay(); - // 12小时制转换:0点显示为12,13-23点转换为1-11 if (hour > HOURS_IN_HALF_DAY) { - return hour - HOURS_IN_HALF_DAY; // 下午时间:13-23 -> 1-11 + return hour - HOURS_IN_HALF_DAY; } else { - return hour == 0 ? HOURS_IN_HALF_DAY : hour; // 0点显示为12,1-11点不变 + return hour == 0 ? HOURS_IN_HALF_DAY : hour; } } } /** - * 设置当前小时(24小时制) - * @param hourOfDay 要设置的小时(0-23) + * Set current hour in 24 hour mode, in the range (0~23) + * + * @param hourOfDay */ public void setCurrentHour(int hourOfDay) { if (!mInitialising && hourOfDay == getCurrentHourOfDay()) { return; } mDate.set(Calendar.HOUR_OF_DAY, hourOfDay); - - // 12小时制需要额外处理AM/PM状态 if (!mIs24HourView) { if (hourOfDay >= HOURS_IN_HALF_DAY) { - mIsAm = false; // 下午 + mIsAm = false; if (hourOfDay > HOURS_IN_HALF_DAY) { - hourOfDay -= HOURS_IN_HALF_DAY; // 13-23点转换为1-11点 + hourOfDay -= HOURS_IN_HALF_DAY; } } else { - mIsAm = true; // 上午 + mIsAm = true; if (hourOfDay == 0) { - hourOfDay = HOURS_IN_HALF_DAY; // 0点转换为12点 + hourOfDay = HOURS_IN_HALF_DAY; } } - updateAmPmControl(); // 更新AM/PM显示 + updateAmPmControl(); } - - mHourSpinner.setValue(hourOfDay); // 设置小时选择器值 - onDateTimeChanged(); // 触发回调 + mHourSpinner.setValue(hourOfDay); + onDateTimeChanged(); } /** - * 获取当前分钟 - * @return 当前分钟(0-59) + * Get currentMinute + * + * @return The Current Minute */ public int getCurrentMinute() { return mDate.get(Calendar.MINUTE); } /** - * 设置当前分钟 - * @param minute 要设置的分钟(0-59) + * Set current minute */ public void setCurrentMinute(int minute) { if (!mInitialising && minute == getCurrentMinute()) { return; } - mMinuteSpinner.setValue(minute); // 设置分钟选择器值 - mDate.set(Calendar.MINUTE, minute); // 设置日历分钟 - onDateTimeChanged(); // 触发回调 + mMinuteSpinner.setValue(minute); + mDate.set(Calendar.MINUTE, minute); + onDateTimeChanged(); } /** - * 检查是否为24小时制显示 - * @return true为24小时制,false为12小时制 + * @return true if this is in 24 hour view else false. */ public boolean is24HourView () { return mIs24HourView; } /** - * 设置时间显示格式 - * @param is24HourView true为24小时制,false为12小时制 + * Set whether in 24 hour or AM/PM mode. + * + * @param is24HourView True for 24 hour mode. False for AM/PM mode. */ public void set24HourView(boolean is24HourView) { if (mIs24HourView == is24HourView) { - return; // 显示模式未变化,直接返回 + return; } mIs24HourView = is24HourView; - - // 显示/隐藏AM/PM选择器 mAmPmSpinner.setVisibility(is24HourView ? View.GONE : View.VISIBLE); - - int hour = getCurrentHourOfDay(); // 保存当前小时 - updateHourControl(); // 更新小时选择器范围 - setCurrentHour(hour); // 重新设置小时(会进行格式转换) - updateAmPmControl(); // 更新AM/PM显示 + int hour = getCurrentHourOfDay(); + updateHourControl(); + setCurrentHour(hour); + updateAmPmControl(); } - /** - * 更新日期显示控制 - * 以当前日期为中心,显示前后各3天的日期范围(共7天) - */ private void updateDateControl() { Calendar cal = Calendar.getInstance(); cal.setTimeInMillis(mDate.getTimeInMillis()); - // 从当前日期前3天开始计算(中间项为当前日期) cal.add(Calendar.DAY_OF_YEAR, -DAYS_IN_ALL_WEEK / 2 - 1); - - mDateSpinner.setDisplayedValues(null); // 清空显示值 - - // 生成7天的日期显示文本 + mDateSpinner.setDisplayedValues(null); for (int i = 0; i < DAYS_IN_ALL_WEEK; ++i) { - cal.add(Calendar.DAY_OF_YEAR, 1); // 增加一天 - // 格式化为"月.日 星期几"的格式 + cal.add(Calendar.DAY_OF_YEAR, 1); mDateDisplayValues[i] = (String) DateFormat.format("MM.dd EEEE", cal); } - - mDateSpinner.setDisplayedValues(mDateDisplayValues); // 设置显示文本 - mDateSpinner.setValue(DAYS_IN_ALL_WEEK / 2); // 选中中间项(当前日期) - mDateSpinner.invalidate(); // 刷新显示 + mDateSpinner.setDisplayedValues(mDateDisplayValues); + mDateSpinner.setValue(DAYS_IN_ALL_WEEK / 2); + mDateSpinner.invalidate(); } - /** - * 更新AM/PM显示控制 - * 根据24小时制设置显示或隐藏AM/PM选择器 - */ private void updateAmPmControl() { if (mIs24HourView) { - mAmPmSpinner.setVisibility(View.GONE); // 24小时制隐藏AM/PM + mAmPmSpinner.setVisibility(View.GONE); } else { - int index = mIsAm ? Calendar.AM : Calendar.PM; // 计算AM/PM索引 - mAmPmSpinner.setValue(index); // 设置AM/PM选择器值 - mAmPmSpinner.setVisibility(View.VISIBLE); // 显示AM/PM选择器 + int index = mIsAm ? Calendar.AM : Calendar.PM; + mAmPmSpinner.setValue(index); + mAmPmSpinner.setVisibility(View.VISIBLE); } } - /** - * 更新小时显示控制 - * 根据12/24小时制设置小时选择器的数值范围 - */ private void updateHourControl() { if (mIs24HourView) { - // 24小时制:0-23 mHourSpinner.setMinValue(HOUR_SPINNER_MIN_VAL_24_HOUR_VIEW); mHourSpinner.setMaxValue(HOUR_SPINNER_MAX_VAL_24_HOUR_VIEW); } else { - // 12小时制:1-12 mHourSpinner.setMinValue(HOUR_SPINNER_MIN_VAL_12_HOUR_VIEW); mHourSpinner.setMaxValue(HOUR_SPINNER_MAX_VAL_12_HOUR_VIEW); } } /** - * 设置日期时间变化监听器 - * @param callback 监听器回调接口 + * Set the callback that indicates the 'Set' button has been pressed. + * @param callback the callback, if null will do nothing */ public void setOnDateTimeChangedListener(OnDateTimeChangedListener callback) { mOnDateTimeChangedListener = callback; } - /** - * 日期时间变化回调方法 - * 当任何日期时间组件发生变化时调用,通知监听器 - */ private void onDateTimeChanged() { if (mOnDateTimeChangedListener != null) { mOnDateTimeChangedListener.onDateTimeChanged(this, getCurrentYear(), getCurrentMonth(), getCurrentDay(), getCurrentHourOfDay(), getCurrentMinute()); } } -} \ No newline at end of file +} diff --git a/src/notes/ui/DateTimePickerDialog.java b/src/notes/ui/DateTimePickerDialog.java index dec755f..2c47ba4 100644 --- a/src/notes/ui/DateTimePickerDialog.java +++ b/src/notes/ui/DateTimePickerDialog.java @@ -29,133 +29,62 @@ import android.content.DialogInterface.OnClickListener; import android.text.format.DateFormat; import android.text.format.DateUtils; -/** - * 日期时间选择对话框 - * 封装 DateTimePicker 控件,提供完整的日期时间选择对话框功能 - * 包含确定/取消按钮和实时标题更新 - */ public class DateTimePickerDialog extends AlertDialog implements OnClickListener { - // 当前选择的日期时间 + private Calendar mDate = Calendar.getInstance(); - // 是否为24小时制显示 private boolean mIs24HourView; - // 日期时间设置回调接口 private OnDateTimeSetListener mOnDateTimeSetListener; - // 内嵌的日期时间选择器 private DateTimePicker mDateTimePicker; - /** - * 日期时间设置回调接口 - * 当用户点击确定按钮时调用 - */ public interface OnDateTimeSetListener { - /** - * 日期时间设置完成回调 - * @param dialog 对话框实例 - * @param date 选择的日期时间(毫秒时间戳) - */ void OnDateTimeSet(AlertDialog dialog, long date); } - /** - * 构造函数 - * @param context 上下文环境 - * @param date 初始日期时间(毫秒时间戳) - */ public DateTimePickerDialog(Context context, long date) { super(context); - - // 创建日期时间选择器实例 mDateTimePicker = new DateTimePicker(context); - setView(mDateTimePicker); // 将选择器设置为对话框内容视图 - - // 设置日期时间变化监听器 + setView(mDateTimePicker); mDateTimePicker.setOnDateTimeChangedListener(new OnDateTimeChangedListener() { - /** - * 当日期时间选择器的值发生变化时调用 - * 更新内部日期对象并刷新对话框标题 - */ public void onDateTimeChanged(DateTimePicker view, int year, int month, - int dayOfMonth, int hourOfDay, int minute) { - // 更新内部 Calendar 对象 + int dayOfMonth, int hourOfDay, int minute) { mDate.set(Calendar.YEAR, year); mDate.set(Calendar.MONTH, month); mDate.set(Calendar.DAY_OF_MONTH, dayOfMonth); mDate.set(Calendar.HOUR_OF_DAY, hourOfDay); mDate.set(Calendar.MINUTE, minute); - - // 更新对话框标题显示新的日期时间 updateTitle(mDate.getTimeInMillis()); } }); - - // 设置初始日期时间 mDate.setTimeInMillis(date); - mDate.set(Calendar.SECOND, 0); // 秒数设为0,确保时间精度一致 - - // 更新日期时间选择器的显示 + mDate.set(Calendar.SECOND, 0); mDateTimePicker.setCurrentDate(mDate.getTimeInMillis()); - - // 设置对话框按钮 - setButton(DialogInterface.BUTTON_POSITIVE, context.getString(R.string.datetime_dialog_ok), this); - setButton(DialogInterface.BUTTON_NEGATIVE, context.getString(R.string.datetime_dialog_cancel), (OnClickListener)null); - - // 根据系统设置确定时间显示格式 + setButton(context.getString(R.string.datetime_dialog_ok), this); + setButton2(context.getString(R.string.datetime_dialog_cancel), (OnClickListener)null); set24HourView(DateFormat.is24HourFormat(this.getContext())); - - // 初始化对话框标题 updateTitle(mDate.getTimeInMillis()); } - /** - * 设置时间显示格式 - * @param is24HourView true为24小时制,false为12小时制 - */ public void set24HourView(boolean is24HourView) { mIs24HourView = is24HourView; - // 注意:这里应该调用 mDateTimePicker.set24HourView(is24HourView) 来同步内部选择器 - // 当前实现可能存在问题,只更新了本地变量而没有更新内部选择器 } - /** - * 设置日期时间设置完成监听器 - * @param callBack 回调接口 - */ public void setOnDateTimeSetListener(OnDateTimeSetListener callBack) { mOnDateTimeSetListener = callBack; } - /** - * 更新对话框标题 - * 显示当前选择的日期时间信息 - * @param date 要显示的日期时间(毫秒时间戳) - */ private void updateTitle(long date) { - // 设置日期时间显示格式标志 int flag = - DateUtils.FORMAT_SHOW_YEAR | // 显示年份 - DateUtils.FORMAT_SHOW_DATE | // 显示日期 - DateUtils.FORMAT_SHOW_TIME; // 显示时间 - - // 设置时间格式(24小时制或12小时制) + DateUtils.FORMAT_SHOW_YEAR | + DateUtils.FORMAT_SHOW_DATE | + DateUtils.FORMAT_SHOW_TIME; flag |= mIs24HourView ? DateUtils.FORMAT_24HOUR : DateUtils.FORMAT_24HOUR; - // 注意:上面的逻辑有误,应该是 FORMAT_24HOUR 或 FORMAT_12HOUR - // 正确写法:flag |= mIs24HourView ? DateUtils.FORMAT_24HOUR : DateUtils.FORMAT_12HOUR; - - // 格式化日期时间并设置为对话框标题 setTitle(DateUtils.formatDateTime(this.getContext(), date, flag)); } - /** - * 对话框按钮点击事件处理 - * 当用户点击确定按钮时调用 - * @param arg0 对话框实例 - * @param arg1 按钮ID - */ public void onClick(DialogInterface arg0, int arg1) { - // 触发日期时间设置完成回调 if (mOnDateTimeSetListener != null) { mOnDateTimeSetListener.OnDateTimeSet(this, mDate.getTimeInMillis()); } } + } \ No newline at end of file diff --git a/src/notes/ui/DropdownMenu.java b/src/notes/ui/DropdownMenu.java index 9799c16..613dc74 100644 --- a/src/notes/ui/DropdownMenu.java +++ b/src/notes/ui/DropdownMenu.java @@ -27,33 +27,17 @@ import android.widget.PopupMenu.OnMenuItemClickListener; import net.micode.notes.R; -/** - * 自定义下拉菜单控件 - * 封装了PopupMenu的创建和基本操作,提供更简洁的接口 - * 主要用于笔记列表的多选操作菜单 - */ public class DropdownMenu { - private Button mButton; // 触发下拉菜单的按钮 - private PopupMenu mPopupMenu; // Android原生弹出菜单 - private Menu mMenu; // 菜单对象 + private Button mButton; + private PopupMenu mPopupMenu; + private Menu mMenu; - /** - * 构造函数 - * @param context 上下文环境 - * @param button 用于触发菜单的按钮 - * @param menuId 菜单资源ID(R.menu.xxx) - */ public DropdownMenu(Context context, Button button, int menuId) { mButton = button; - // 设置按钮背景为下拉图标 mButton.setBackgroundResource(R.drawable.dropdown_icon); - // 创建弹出菜单,锚点为按钮 mPopupMenu = new PopupMenu(context, mButton); - // 获取菜单对象 mMenu = mPopupMenu.getMenu(); - // 从资源文件加载菜单项 mPopupMenu.getMenuInflater().inflate(menuId, mMenu); - // 设置按钮点击事件:点击时显示下拉菜单 mButton.setOnClickListener(new OnClickListener() { public void onClick(View v) { mPopupMenu.show(); @@ -61,30 +45,17 @@ public class DropdownMenu { }); } - /** - * 设置菜单项点击监听器 - * @param listener 菜单项点击监听器 - */ public void setOnDropdownMenuItemClickListener(OnMenuItemClickListener listener) { if (mPopupMenu != null) { mPopupMenu.setOnMenuItemClickListener(listener); } } - /** - * 根据ID查找菜单项 - * @param id 菜单项资源ID - * @return 找到的菜单项,未找到返回null - */ public MenuItem findItem(int id) { return mMenu.findItem(id); } - /** - * 设置按钮显示的标题文本 - * @param title 要显示的标题 - */ public void setTitle(CharSequence title) { mButton.setText(title); } -} \ No newline at end of file +} diff --git a/src/notes/ui/FoldersListAdapter.java b/src/notes/ui/FoldersListAdapter.java index ec48509..96b77da 100644 --- a/src/notes/ui/FoldersListAdapter.java +++ b/src/notes/ui/FoldersListAdapter.java @@ -28,102 +28,53 @@ import net.micode.notes.R; import net.micode.notes.data.Notes; import net.micode.notes.data.Notes.NoteColumns; -/** - * 文件夹列表适配器,用于在对话框或列表中选择目标文件夹 - * 主要用于笔记移动操作时的文件夹选择界面 - */ + public class FoldersListAdapter extends CursorAdapter { - // 数据库查询的列投影,只需要ID和名称两列 public static final String [] PROJECTION = { - NoteColumns.ID, // 文件夹ID - NoteColumns.SNIPPET // 文件夹名称(存储在snippet字段中) + NoteColumns.ID, + NoteColumns.SNIPPET }; - // 列索引常量 - public static final int ID_COLUMN = 0; // ID列的索引 - public static final int NAME_COLUMN = 1; // 名称列的索引 + public static final int ID_COLUMN = 0; + public static final int NAME_COLUMN = 1; - /** - * 构造函数 - * @param context 上下文环境 - * @param c 包含文件夹数据的游标 - */ public FoldersListAdapter(Context context, Cursor c) { super(context, c); // TODO Auto-generated constructor stub } - /** - * 创建新的列表项视图 - * @param context 上下文环境 - * @param cursor 数据游标 - * @param parent 父视图容器 - * @return 新创建的文件夹列表项视图 - */ @Override public View newView(Context context, Cursor cursor, ViewGroup parent) { - // 创建自定义的文件夹列表项 return new FolderListItem(context); } - /** - * 将数据绑定到已有的列表项视图 - * @param view 要绑定数据的视图 - * @param context 上下文环境 - * @param cursor 数据游标 - */ @Override public void bindView(View view, Context context, Cursor cursor) { - // 检查视图类型是否正确 if (view instanceof FolderListItem) { - // 根据ID判断文件夹名称:根文件夹显示特殊文本,其他文件夹显示实际名称 String folderName = (cursor.getLong(ID_COLUMN) == Notes.ID_ROOT_FOLDER) ? context .getString(R.string.menu_move_parent_folder) : cursor.getString(NAME_COLUMN); - // 绑定文件夹名称到视图 ((FolderListItem) view).bind(folderName); } } - /** - * 根据位置获取文件夹名称 - * @param context 上下文环境,用于获取资源字符串 - * @param position 列表位置 - * @return 文件夹名称 - */ public String getFolderName(Context context, int position) { - // 获取指定位置的数据游标 Cursor cursor = (Cursor) getItem(position); - // 根据ID判断文件夹名称:根文件夹显示"父文件夹",其他显示实际名称 return (cursor.getLong(ID_COLUMN) == Notes.ID_ROOT_FOLDER) ? context .getString(R.string.menu_move_parent_folder) : cursor.getString(NAME_COLUMN); } - /** - * 自定义文件夹列表项视图 - * 用于显示单个文件夹的名称 - */ private class FolderListItem extends LinearLayout { - private TextView mName; // 显示文件夹名称的文本视图 + private TextView mName; - /** - * 构造函数 - * @param context 上下文环境 - */ public FolderListItem(Context context) { super(context); - // 从布局文件加载视图 inflate(context, R.layout.folder_list_item, this); - // 查找名称文本视图 mName = (TextView) findViewById(R.id.tv_folder_name); } - /** - * 绑定文件夹名称到视图 - * @param name 文件夹名称 - */ public void bind(String name) { - // 设置文件夹名称文本 mName.setText(name); } } -} \ No newline at end of file + +} diff --git a/src/notes/ui/NoteEditActivity.java b/src/notes/ui/NoteEditActivity.java index 8f2e9d8..96a9ff8 100644 --- a/src/notes/ui/NoteEditActivity.java +++ b/src/notes/ui/NoteEditActivity.java @@ -71,24 +71,19 @@ import java.util.Map; import java.util.regex.Matcher; import java.util.regex.Pattern; -/** - * 笔记编辑活动,负责笔记的创建、编辑、删除、分享等功能 - * 支持普通文本模式和清单模式两种编辑方式 - */ + public class NoteEditActivity extends Activity implements OnClickListener, NoteSettingChangedListener, OnTextViewChangeListener { - - /** - * 头部视图持有者内部类,用于管理笔记头部的UI组件 - */ private class HeadViewHolder { - public TextView tvModified; // 显示修改时间的文本视图 - public ImageView ivAlertIcon; // 提醒图标 - public TextView tvAlertDate; // 提醒日期文本 - public ImageView ibSetBgColor; // 设置背景颜色的按钮 + public TextView tvModified; + + public ImageView ivAlertIcon; + + public TextView tvAlertDate; + + public ImageView ibSetBgColor; } - // 背景颜色选择按钮与颜色ID的映射 private static final Map sBgSelectorBtnsMap = new HashMap(); static { sBgSelectorBtnsMap.put(R.id.iv_bg_yellow, ResourceParser.YELLOW); @@ -98,7 +93,6 @@ public class NoteEditActivity extends Activity implements OnClickListener, sBgSelectorBtnsMap.put(R.id.iv_bg_white, ResourceParser.WHITE); } - // 颜色ID与选中状态视图的映射 private static final Map sBgSelectorSelectionMap = new HashMap(); static { sBgSelectorSelectionMap.put(ResourceParser.YELLOW, R.id.iv_bg_yellow_select); @@ -108,7 +102,6 @@ public class NoteEditActivity extends Activity implements OnClickListener, sBgSelectorSelectionMap.put(ResourceParser.WHITE, R.id.iv_bg_white_select); } - // 字体大小选择布局与字体大小ID的映射 private static final Map sFontSizeBtnsMap = new HashMap(); static { sFontSizeBtnsMap.put(R.id.ll_font_large, ResourceParser.TEXT_LARGE); @@ -117,7 +110,6 @@ public class NoteEditActivity extends Activity implements OnClickListener, sFontSizeBtnsMap.put(R.id.ll_font_super, ResourceParser.TEXT_SUPER); } - // 字体大小ID与选中状态图标的映射 private static final Map sFontSelectorSelectionMap = new HashMap(); static { sFontSelectorSelectionMap.put(ResourceParser.TEXT_LARGE, R.id.iv_large_select); @@ -128,51 +120,55 @@ public class NoteEditActivity extends Activity implements OnClickListener, private static final String TAG = "NoteEditActivity"; - private HeadViewHolder mNoteHeaderHolder; // 头部视图持有者实例 - private View mHeadViewPanel; // 头部面板视图 - private View mNoteBgColorSelector; // 背景颜色选择器面板 - private View mFontSizeSelector; // 字体大小选择器面板 - private EditText mNoteEditor; // 笔记内容编辑器(普通模式) - private View mNoteEditorPanel; // 编辑器面板 - private WorkingNote mWorkingNote; // 当前正在编辑的笔记数据模型 - private SharedPreferences mSharedPrefs; // 偏好设置 - private int mFontSizeId; // 当前字体大小ID + private HeadViewHolder mNoteHeaderHolder; - private static final String PREFERENCE_FONT_SIZE = "pref_font_size"; // 字体大小偏好设置键 - private static final int SHORTCUT_ICON_TITLE_MAX_LEN = 10; // 桌面快捷方式标题最大长度 + private View mHeadViewPanel; - // 清单模式下的标记符号 - public static final String TAG_CHECKED = String.valueOf('\u221A'); // 对勾符号 √ - public static final String TAG_UNCHECKED = String.valueOf('\u25A1'); // 方框符号 □ + private View mNoteBgColorSelector; - private LinearLayout mEditTextList; // 清单模式下的编辑框列表容器 - private String mUserQuery; // 用户搜索查询词(从搜索跳转过来时使用) - private Pattern mPattern; // 用于高亮搜索词的正则表达式模式 + private View mFontSizeSelector; + + private EditText mNoteEditor; + + private View mNoteEditorPanel; + + private WorkingNote mWorkingNote; + + private SharedPreferences mSharedPrefs; + private int mFontSizeId; + + private static final String PREFERENCE_FONT_SIZE = "pref_font_size"; + + private static final int SHORTCUT_ICON_TITLE_MAX_LEN = 10; + + public static final String TAG_CHECKED = String.valueOf('\u221A'); + public static final String TAG_UNCHECKED = String.valueOf('\u25A1'); + + private LinearLayout mEditTextList; + + private String mUserQuery; + private Pattern mPattern; - /** - * Activity创建时的初始化方法 - */ @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); this.setContentView(R.layout.note_edit); - // 初始化活动状态,如果是第一次创建且初始化失败则结束活动 if (savedInstanceState == null && !initActivityState(getIntent())) { finish(); return; } - initResources(); // 初始化视图资源 + initResources(); } /** - * 恢复被系统杀死的活动状态 + * Current activity may be killed when the memory is low. Once it is killed, for another time + * user load this activity, we should restore the former state */ @Override protected void onRestoreInstanceState(Bundle savedInstanceState) { super.onRestoreInstanceState(savedInstanceState); if (savedInstanceState != null && savedInstanceState.containsKey(Intent.EXTRA_UID)) { - // 从保存的状态中恢复笔记ID Intent intent = new Intent(Intent.ACTION_VIEW); intent.putExtra(Intent.EXTRA_UID, savedInstanceState.getLong(Intent.EXTRA_UID)); if (!initActivityState(intent)) { @@ -183,26 +179,24 @@ public class NoteEditActivity extends Activity implements OnClickListener, } } - /** - * 根据Intent初始化活动状态 - * @param intent 启动活动的Intent - * @return 初始化是否成功 - */ private boolean initActivityState(Intent intent) { + /** + * If the user specified the {@link Intent#ACTION_VIEW} but not provided with id, + * then jump to the NotesListActivity + */ mWorkingNote = null; - // 根据Intent的Action类型进行不同处理 if (TextUtils.equals(Intent.ACTION_VIEW, intent.getAction())) { - // 查看现有笔记 long noteId = intent.getLongExtra(Intent.EXTRA_UID, 0); mUserQuery = ""; - // 处理从搜索结果跳转过来的情况 + /** + * Starting from the searched result + */ if (intent.hasExtra(SearchManager.EXTRA_DATA_KEY)) { noteId = Long.parseLong(intent.getStringExtra(SearchManager.EXTRA_DATA_KEY)); mUserQuery = intent.getStringExtra(SearchManager.USER_QUERY); } - // 检查笔记是否存在 if (!DataUtils.visibleInNoteDatabase(getContentResolver(), noteId, Notes.TYPE_NOTE)) { Intent jump = new Intent(this, NotesListActivity.class); startActivity(jump); @@ -210,7 +204,6 @@ public class NoteEditActivity extends Activity implements OnClickListener, finish(); return false; } else { - // 加载现有笔记 mWorkingNote = WorkingNote.load(this, noteId); if (mWorkingNote == null) { Log.e(TAG, "load note failed with note id" + noteId); @@ -218,12 +211,11 @@ public class NoteEditActivity extends Activity implements OnClickListener, return false; } } - // 隐藏软键盘 getWindow().setSoftInputMode( WindowManager.LayoutParams.SOFT_INPUT_STATE_HIDDEN | WindowManager.LayoutParams.SOFT_INPUT_ADJUST_RESIZE); } else if(TextUtils.equals(Intent.ACTION_INSERT_OR_EDIT, intent.getAction())) { - // 创建新笔记或编辑 + // New note long folderId = intent.getLongExtra(Notes.INTENT_EXTRA_FOLDER_ID, 0); int widgetId = intent.getIntExtra(Notes.INTENT_EXTRA_WIDGET_ID, AppWidgetManager.INVALID_APPWIDGET_ID); @@ -232,7 +224,7 @@ public class NoteEditActivity extends Activity implements OnClickListener, int bgResId = intent.getIntExtra(Notes.INTENT_EXTRA_BACKGROUND_ID, ResourceParser.getDefaultBgId(this)); - // 处理通话记录笔记 + // Parse call-record note String phoneNumber = intent.getStringExtra(Intent.EXTRA_PHONE_NUMBER); long callDate = intent.getLongExtra(Notes.INTENT_EXTRA_CALL_DATE, 0); if (callDate != 0 && phoneNumber != null) { @@ -240,7 +232,6 @@ public class NoteEditActivity extends Activity implements OnClickListener, Log.w(TAG, "The call record number is null"); } long noteId = 0; - // 检查是否已存在对应的通话记录笔记 if ((noteId = DataUtils.getNoteIdByPhoneNumberAndCallDate(getContentResolver(), phoneNumber, callDate)) > 0) { mWorkingNote = WorkingNote.load(this, noteId); @@ -250,18 +241,15 @@ public class NoteEditActivity extends Activity implements OnClickListener, return false; } } else { - // 创建新的通话记录笔记 mWorkingNote = WorkingNote.createEmptyNote(this, folderId, widgetId, widgetType, bgResId); mWorkingNote.convertToCallNote(phoneNumber, callDate); } } else { - // 创建普通新笔记 mWorkingNote = WorkingNote.createEmptyNote(this, folderId, widgetId, widgetType, bgResId); } - // 显示软键盘 getWindow().setSoftInputMode( WindowManager.LayoutParams.SOFT_INPUT_ADJUST_RESIZE | WindowManager.LayoutParams.SOFT_INPUT_STATE_VISIBLE); @@ -274,55 +262,39 @@ public class NoteEditActivity extends Activity implements OnClickListener, return true; } - /** - * Activity恢复时刷新界面 - */ @Override protected void onResume() { super.onResume(); initNoteScreen(); } - /** - * 初始化笔记编辑界面 - */ private void initNoteScreen() { - // 设置编辑器字体大小 mNoteEditor.setTextAppearance(this, TextAppearanceResources .getTexAppearanceResource(mFontSizeId)); - - // 根据笔记模式初始化界面 if (mWorkingNote.getCheckListMode() == TextNote.MODE_CHECK_LIST) { - // 清单模式 switchToListMode(mWorkingNote.getContent()); } else { - // 普通文本模式,高亮搜索词 mNoteEditor.setText(getHighlightQueryResult(mWorkingNote.getContent(), mUserQuery)); mNoteEditor.setSelection(mNoteEditor.getText().length()); } - - // 隐藏所有背景颜色选中标记 for (Integer id : sBgSelectorSelectionMap.keySet()) { findViewById(sBgSelectorSelectionMap.get(id)).setVisibility(View.GONE); } - - // 设置背景颜色 mHeadViewPanel.setBackgroundResource(mWorkingNote.getTitleBgResId()); mNoteEditorPanel.setBackgroundResource(mWorkingNote.getBgColorResId()); - // 设置修改时间显示 mNoteHeaderHolder.tvModified.setText(DateUtils.formatDateTime(this, mWorkingNote.getModifiedDate(), DateUtils.FORMAT_SHOW_DATE | DateUtils.FORMAT_NUMERIC_DATE | DateUtils.FORMAT_SHOW_TIME | DateUtils.FORMAT_SHOW_YEAR)); - // 显示提醒信息 + /** + * TODO: Add the menu for setting alert. Currently disable it because the DateTimePicker + * is not ready + */ showAlertHeader(); } - /** - * 显示或隐藏提醒相关的UI组件 - */ private void showAlertHeader() { if (mWorkingNote.hasClockAlert()) { long time = System.currentTimeMillis(); @@ -340,22 +312,20 @@ public class NoteEditActivity extends Activity implements OnClickListener, }; } - /** - * 处理新的Intent(活动被重新启动时) - */ @Override protected void onNewIntent(Intent intent) { super.onNewIntent(intent); initActivityState(intent); } - /** - * 保存活动状态 - */ @Override protected void onSaveInstanceState(Bundle outState) { super.onSaveInstanceState(outState); - // 保存新笔记的ID + /** + * For new note without note id, we should firstly save it to + * generate a id. If the editing note is not worth saving, there + * is no id which is equivalent to create new note + */ if (!mWorkingNote.existInDatabase()) { saveNote(); } @@ -363,9 +333,6 @@ public class NoteEditActivity extends Activity implements OnClickListener, Log.d(TAG, "Save working note id: " + mWorkingNote.getNoteId() + " onSaveInstanceState"); } - /** - * 触摸事件分发,用于点击选择器外部时关闭选择器 - */ @Override public boolean dispatchTouchEvent(MotionEvent ev) { if (mNoteBgColorSelector.getVisibility() == View.VISIBLE @@ -382,9 +349,6 @@ public class NoteEditActivity extends Activity implements OnClickListener, return super.dispatchTouchEvent(ev); } - /** - * 判断触摸点是否在指定视图范围内 - */ private boolean inRangeOfView(View view, MotionEvent ev) { int []location = new int[2]; view.getLocationOnScreen(location); @@ -394,14 +358,11 @@ public class NoteEditActivity extends Activity implements OnClickListener, || ev.getX() > (x + view.getWidth()) || ev.getY() < y || ev.getY() > (y + view.getHeight())) { - return false; - } + return false; + } return true; } - /** - * 初始化视图资源和事件监听 - */ private void initResources() { mHeadViewPanel = findViewById(R.id.note_title); mNoteHeaderHolder = new HeadViewHolder(); @@ -413,49 +374,40 @@ public class NoteEditActivity extends Activity implements OnClickListener, mNoteEditor = (EditText) findViewById(R.id.note_edit_view); mNoteEditorPanel = findViewById(R.id.sv_note_edit); mNoteBgColorSelector = findViewById(R.id.note_bg_color_selector); - - // 设置背景颜色选择按钮的点击监听 for (int id : sBgSelectorBtnsMap.keySet()) { ImageView iv = (ImageView) findViewById(id); iv.setOnClickListener(this); } mFontSizeSelector = findViewById(R.id.font_size_selector); - // 设置字体大小选择项的点击监听 for (int id : sFontSizeBtnsMap.keySet()) { View view = findViewById(id); view.setOnClickListener(this); }; - mSharedPrefs = PreferenceManager.getDefaultSharedPreferences(this); mFontSizeId = mSharedPrefs.getInt(PREFERENCE_FONT_SIZE, ResourceParser.BG_DEFAULT_FONT_SIZE); - - // 修复字体大小ID可能超出范围的问题 + /** + * HACKME: Fix bug of store the resource id in shared preference. + * The id may larger than the length of resources, in this case, + * return the {@link ResourceParser#BG_DEFAULT_FONT_SIZE} + */ if(mFontSizeId >= TextAppearanceResources.getResourcesSize()) { mFontSizeId = ResourceParser.BG_DEFAULT_FONT_SIZE; } mEditTextList = (LinearLayout) findViewById(R.id.note_edit_list); } - /** - * Activity暂停时保存笔记 - */ @Override protected void onPause() { super.onPause(); - // 保存当前编辑的笔记 if(saveNote()) { Log.d(TAG, "Note data was saved with length:" + mWorkingNote.getContent().length()); } - clearSettingState(); // 清理设置面板状态 + clearSettingState(); } - /** - * 更新关联的桌面小部件 - */ private void updateWidget() { Intent intent = new Intent(AppWidgetManager.ACTION_APPWIDGET_UPDATE); - // 根据小部件类型设置对应的广播接收器 if (mWorkingNote.getWidgetType() == Notes.TYPE_WIDGET_2X) { intent.setClass(this, NoteWidgetProvider_2x.class); } else if (mWorkingNote.getWidgetType() == Notes.TYPE_WIDGET_4X) { @@ -465,77 +417,51 @@ public class NoteEditActivity extends Activity implements OnClickListener, return; } - // 设置要更新的小部件ID intent.putExtra(AppWidgetManager.EXTRA_APPWIDGET_IDS, new int[] { - mWorkingNote.getWidgetId() + mWorkingNote.getWidgetId() }); - sendBroadcast(intent); // 发送广播通知小部件更新 - setResult(RESULT_OK, intent); // 设置活动结果 + sendBroadcast(intent); + setResult(RESULT_OK, intent); } - /** - * 点击事件处理 - */ public void onClick(View v) { int id = v.getId(); if (id == R.id.btn_set_bg_color) { - // 点击背景颜色设置按钮,显示颜色选择器 mNoteBgColorSelector.setVisibility(View.VISIBLE); - // 显示当前选中颜色的标记 findViewById(sBgSelectorSelectionMap.get(mWorkingNote.getBgColorId())).setVisibility( - View.VISIBLE); + - View.VISIBLE); } else if (sBgSelectorBtnsMap.containsKey(id)) { - // 点击了某个背景颜色按钮 - // 隐藏之前选中颜色的标记 findViewById(sBgSelectorSelectionMap.get(mWorkingNote.getBgColorId())).setVisibility( View.GONE); - // 更新笔记的背景颜色ID mWorkingNote.setBgColorId(sBgSelectorBtnsMap.get(id)); - mNoteBgColorSelector.setVisibility(View.GONE); // 隐藏选择器 + mNoteBgColorSelector.setVisibility(View.GONE); } else if (sFontSizeBtnsMap.containsKey(id)) { - // 点击了字体大小选项 - // 隐藏之前选中字体的标记 findViewById(sFontSelectorSelectionMap.get(mFontSizeId)).setVisibility(View.GONE); - // 更新字体大小ID并保存到偏好设置 mFontSizeId = sFontSizeBtnsMap.get(id); mSharedPrefs.edit().putInt(PREFERENCE_FONT_SIZE, mFontSizeId).commit(); - // 显示新选中字体的标记 findViewById(sFontSelectorSelectionMap.get(mFontSizeId)).setVisibility(View.VISIBLE); - - // 应用新的字体大小 if (mWorkingNote.getCheckListMode() == TextNote.MODE_CHECK_LIST) { - // 清单模式:重新加载文本并切换到列表模式 getWorkingText(); switchToListMode(mWorkingNote.getContent()); } else { - // 普通模式:直接设置编辑器的文本外观 mNoteEditor.setTextAppearance(this, TextAppearanceResources.getTexAppearanceResource(mFontSizeId)); } - mFontSizeSelector.setVisibility(View.GONE); // 隐藏字体选择器 + mFontSizeSelector.setVisibility(View.GONE); } } - /** - * 返回键按下事件处理 - */ @Override public void onBackPressed() { - // 如果有设置面板打开,先关闭面板 if(clearSettingState()) { return; } - // 保存笔记后执行默认返回操作 saveNote(); super.onBackPressed(); } - /** - * 清理设置面板状态(关闭打开的面板) - * @return 是否有面板被关闭 - */ private boolean clearSettingState() { if (mNoteBgColorSelector.getVisibility() == View.VISIBLE) { mNoteBgColorSelector.setVisibility(View.GONE); @@ -547,66 +473,45 @@ public class NoteEditActivity extends Activity implements OnClickListener, return false; } - /** - * 背景颜色改变回调(NoteSettingChangedListener接口方法) - */ public void onBackgroundColorChanged() { - // 显示新选中颜色的标记 findViewById(sBgSelectorSelectionMap.get(mWorkingNote.getBgColorId())).setVisibility( View.VISIBLE); - // 更新编辑器面板和头部面板的背景 mNoteEditorPanel.setBackgroundResource(mWorkingNote.getBgColorResId()); mHeadViewPanel.setBackgroundResource(mWorkingNote.getTitleBgResId()); } - /** - * 准备选项菜单 - */ @Override public boolean onPrepareOptionsMenu(Menu menu) { if (isFinishing()) { return true; } - clearSettingState(); // 清理设置面板状态 - menu.clear(); // 清空菜单 - - // 根据笔记类型加载不同的菜单 + clearSettingState(); + menu.clear(); if (mWorkingNote.getFolderId() == Notes.ID_CALL_RECORD_FOLDER) { getMenuInflater().inflate(R.menu.call_note_edit, menu); } else { getMenuInflater().inflate(R.menu.note_edit, menu); } - - // 设置清单模式/普通模式菜单项标题 if (mWorkingNote.getCheckListMode() == TextNote.MODE_CHECK_LIST) { menu.findItem(R.id.menu_list_mode).setTitle(R.string.menu_normal_mode); } else { menu.findItem(R.id.menu_list_mode).setTitle(R.string.menu_list_mode); } - - // 根据是否有提醒设置菜单项显示 if (mWorkingNote.hasClockAlert()) { menu.findItem(R.id.menu_alert).setVisible(false); - menu.findItem(R.id.menu_delete_remind).setVisible(true); } else { - menu.findItem(R.id.menu_alert).setVisible(true); menu.findItem(R.id.menu_delete_remind).setVisible(false); } return true; } - /** - * 菜单项点击处理 - */ @Override public boolean onOptionsItemSelected(MenuItem item) { switch (item.getItemId()) { case R.id.menu_new_note: - // 创建新笔记 createNewNote(); break; case R.id.menu_delete: - // 删除笔记,弹出确认对话框 AlertDialog.Builder builder = new AlertDialog.Builder(this); builder.setTitle(getString(R.string.alert_title_delete)); builder.setIcon(android.R.drawable.ic_dialog_alert); @@ -614,38 +519,32 @@ public class NoteEditActivity extends Activity implements OnClickListener, builder.setPositiveButton(android.R.string.ok, new DialogInterface.OnClickListener() { public void onClick(DialogInterface dialog, int which) { - deleteCurrentNote(); // 删除当前笔记 - finish(); // 结束活动 + deleteCurrentNote(); + finish(); } }); builder.setNegativeButton(android.R.string.cancel, null); builder.show(); break; case R.id.menu_font_size: - // 显示字体大小选择器 mFontSizeSelector.setVisibility(View.VISIBLE); findViewById(sFontSelectorSelectionMap.get(mFontSizeId)).setVisibility(View.VISIBLE); break; case R.id.menu_list_mode: - // 切换清单模式/普通模式 mWorkingNote.setCheckListMode(mWorkingNote.getCheckListMode() == 0 ? TextNote.MODE_CHECK_LIST : 0); break; case R.id.menu_share: - // 分享笔记内容 getWorkingText(); sendTo(this, mWorkingNote.getContent()); break; case R.id.menu_send_to_desktop: - // 发送到桌面快捷方式 sendToDesktop(); break; case R.id.menu_alert: - // 设置提醒 setReminder(); break; case R.id.menu_delete_remind: - // 删除提醒 mWorkingNote.setAlertDate(0, false); break; default: @@ -654,39 +553,32 @@ public class NoteEditActivity extends Activity implements OnClickListener, return true; } - /** - * 设置提醒时间 - */ private void setReminder() { - // 创建日期时间选择对话框 DateTimePickerDialog d = new DateTimePickerDialog(this, System.currentTimeMillis()); d.setOnDateTimeSetListener(new OnDateTimeSetListener() { public void OnDateTimeSet(AlertDialog dialog, long date) { - // 设置提醒日期 - mWorkingNote.setAlertDate(date, true); + mWorkingNote.setAlertDate(date , true); } }); d.show(); } /** - * 分享笔记内容到其他应用 + * Share note to apps that support {@link Intent#ACTION_SEND} action + * and {@text/plain} type */ private void sendTo(Context context, String info) { Intent intent = new Intent(Intent.ACTION_SEND); - intent.putExtra(Intent.EXTRA_TEXT, info); // 设置分享文本 - intent.setType("text/plain"); // 设置MIME类型 - context.startActivity(intent); // 启动分享选择器 + intent.putExtra(Intent.EXTRA_TEXT, info); + intent.setType("text/plain"); + context.startActivity(intent); } - /** - * 创建新笔记 - */ private void createNewNote() { - // 先保存当前编辑的笔记 + // Firstly, save current editing notes saveNote(); - // 结束当前活动并启动新的编辑活动 + // For safety, start a new NoteEditActivity finish(); Intent intent = new Intent(this, NoteEditActivity.class); intent.setAction(Intent.ACTION_INSERT_OR_EDIT); @@ -694,9 +586,6 @@ public class NoteEditActivity extends Activity implements OnClickListener, startActivity(intent); } - /** - * 删除当前笔记 - */ private void deleteCurrentNote() { if (mWorkingNote.existInDatabase()) { HashSet ids = new HashSet(); @@ -706,155 +595,125 @@ public class NoteEditActivity extends Activity implements OnClickListener, } else { Log.d(TAG, "Wrong note id, should not happen"); } - - // 根据同步模式选择删除方式 if (!isSyncMode()) { - // 非同步模式:直接删除 if (!DataUtils.batchDeleteNotes(getContentResolver(), ids)) { Log.e(TAG, "Delete Note error"); } } else { - // 同步模式:移动到垃圾箱 if (!DataUtils.batchMoveToFolder(getContentResolver(), ids, Notes.ID_TRASH_FOLER)) { Log.e(TAG, "Move notes to trash folder error, should not happens"); } } } - mWorkingNote.markDeleted(true); // 标记为已删除 + mWorkingNote.markDeleted(true); } - /** - * 检查是否处于同步模式 - */ private boolean isSyncMode() { return NotesPreferenceActivity.getSyncAccountName(this).trim().length() > 0; } - /** - * 提醒时间改变回调(NoteSettingChangedListener接口方法) - */ public void onClockAlertChanged(long date, boolean set) { - // 对于未保存的笔记,先保存再设置提醒 + /** + * User could set clock to an unsaved note, so before setting the + * alert clock, we should save the note first + */ if (!mWorkingNote.existInDatabase()) { saveNote(); } - if (mWorkingNote.getNoteId() > 0) { - // 创建闹钟意图 Intent intent = new Intent(this, AlarmReceiver.class); intent.setData(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, mWorkingNote.getNoteId())); PendingIntent pendingIntent = PendingIntent.getBroadcast(this, 0, intent, 0); AlarmManager alarmManager = ((AlarmManager) getSystemService(ALARM_SERVICE)); - - showAlertHeader(); // 更新提醒显示 + showAlertHeader(); if(!set) { - // 取消提醒 alarmManager.cancel(pendingIntent); } else { - // 设置提醒 alarmManager.set(AlarmManager.RTC_WAKEUP, date, pendingIntent); } } else { - // 笔记为空,无法设置提醒 + /** + * There is the condition that user has input nothing (the note is + * not worthy saving), we have no note id, remind the user that he + * should input something + */ Log.e(TAG, "Clock alert setting error"); showToast(R.string.error_note_empty_for_clock); } } - /** - * 小部件改变回调(NoteSettingChangedListener接口方法) - */ public void onWidgetChanged() { - updateWidget(); // 更新关联的小部件 + updateWidget(); } - /** - * 清单模式下删除编辑项(OnTextViewChangeListener接口方法) - */ public void onEditTextDelete(int index, String text) { int childCount = mEditTextList.getChildCount(); if (childCount == 1) { - return; // 只有一个项时不删除 + return; } - // 更新后面所有项的索引 for (int i = index + 1; i < childCount; i++) { ((NoteEditText) mEditTextList.getChildAt(i).findViewById(R.id.et_edit_text)) .setIndex(i - 1); } - // 移除指定位置的视图 mEditTextList.removeViewAt(index); NoteEditText edit = null; - // 决定焦点给哪个编辑框 if(index == 0) { - edit = (NoteEditText) mEditTextList.getChildAt(0).findViewById(R.id.et_edit_text); + edit = (NoteEditText) mEditTextList.getChildAt(0).findViewById( + R.id.et_edit_text); } else { - edit = (NoteEditText) mEditTextList.getChildAt(index - 1).findViewById(R.id.et_edit_text); + edit = (NoteEditText) mEditTextList.getChildAt(index - 1).findViewById( + R.id.et_edit_text); } - // 将删除的文本追加到获得焦点的编辑框 int length = edit.length(); edit.append(text); edit.requestFocus(); edit.setSelection(length); } - /** - * 清单模式下插入新编辑项(OnTextViewChangeListener接口方法) - */ public void onEditTextEnter(int index, String text) { - // 安全检查 + /** + * Should not happen, check for debug + */ if(index > mEditTextList.getChildCount()) { Log.e(TAG, "Index out of mEditTextList boundrary, should not happen"); } - // 创建新列表项并插入到指定位置 View view = getListItem(text, index); mEditTextList.addView(view, index); NoteEditText edit = (NoteEditText) view.findViewById(R.id.et_edit_text); edit.requestFocus(); edit.setSelection(0); - - // 更新后面所有项的索引 for (int i = index + 1; i < mEditTextList.getChildCount(); i++) { ((NoteEditText) mEditTextList.getChildAt(i).findViewById(R.id.et_edit_text)) .setIndex(i); } } - /** - * 切换到清单模式 - */ private void switchToListMode(String text) { - mEditTextList.removeAllViews(); // 清空现有视图 - String[] items = text.split("\n"); // 按换行符分割文本 + mEditTextList.removeAllViews(); + String[] items = text.split("\n"); int index = 0; for (String item : items) { if(!TextUtils.isEmpty(item)) { - // 为每个非空段落创建列表项 mEditTextList.addView(getListItem(item, index)); index++; } } - // 添加一个空的列表项用于输入新内容 mEditTextList.addView(getListItem("", index)); mEditTextList.getChildAt(index).findViewById(R.id.et_edit_text).requestFocus(); - // 切换显示模式 mNoteEditor.setVisibility(View.GONE); mEditTextList.setVisibility(View.VISIBLE); } - /** - * 高亮显示搜索关键词 - */ private Spannable getHighlightQueryResult(String fullText, String userQuery) { SpannableString spannable = new SpannableString(fullText == null ? "" : fullText); if (!TextUtils.isEmpty(userQuery)) { mPattern = Pattern.compile(userQuery); Matcher m = mPattern.matcher(fullText); int start = 0; - // 为所有匹配的文本设置背景色 while (m.find(start)) { spannable.setSpan( new BackgroundColorSpan(this.getResources().getColor( @@ -866,35 +725,27 @@ public class NoteEditActivity extends Activity implements OnClickListener, return spannable; } - /** - * 创建清单模式下的列表项视图 - */ private View getListItem(String item, int index) { View view = LayoutInflater.from(this).inflate(R.layout.note_edit_list_item, null); final NoteEditText edit = (NoteEditText) view.findViewById(R.id.et_edit_text); edit.setTextAppearance(this, TextAppearanceResources.getTexAppearanceResource(mFontSizeId)); - - // 设置复选框状态改变监听 CheckBox cb = ((CheckBox) view.findViewById(R.id.cb_edit_item)); cb.setOnCheckedChangeListener(new OnCheckedChangeListener() { public void onCheckedChanged(CompoundButton buttonView, boolean isChecked) { if (isChecked) { - // 选中时添加删除线 edit.setPaintFlags(edit.getPaintFlags() | Paint.STRIKE_THRU_TEXT_FLAG); } else { - // 取消选中时恢复正常样式 edit.setPaintFlags(Paint.ANTI_ALIAS_FLAG | Paint.DEV_KERN_TEXT_FLAG); } } }); - // 解析清单标记符号 if (item.startsWith(TAG_CHECKED)) { - cb.setChecked(true); // 已完成的项 + cb.setChecked(true); edit.setPaintFlags(edit.getPaintFlags() | Paint.STRIKE_THRU_TEXT_FLAG); item = item.substring(TAG_CHECKED.length(), item.length()).trim(); } else if (item.startsWith(TAG_UNCHECKED)) { - cb.setChecked(false); // 未完成的项 + cb.setChecked(false); edit.setPaintFlags(Paint.ANTI_ALIAS_FLAG | Paint.DEV_KERN_TEXT_FLAG); item = item.substring(TAG_UNCHECKED.length(), item.length()).trim(); } @@ -905,15 +756,11 @@ public class NoteEditActivity extends Activity implements OnClickListener, return view; } - /** - * 文本变化回调(OnTextViewChangeListener接口方法) - */ public void onTextChange(int index, boolean hasText) { if (index >= mEditTextList.getChildCount()) { Log.e(TAG, "Wrong index, should not happen"); return; } - // 根据是否有文本显示或隐藏复选框 if(hasText) { mEditTextList.getChildAt(index).findViewById(R.id.cb_edit_item).setVisibility(View.VISIBLE); } else { @@ -921,17 +768,11 @@ public class NoteEditActivity extends Activity implements OnClickListener, } } - /** - * 清单模式改变回调(NoteSettingChangedListener接口方法) - */ public void onCheckListModeChanged(int oldMode, int newMode) { if (newMode == TextNote.MODE_CHECK_LIST) { - // 切换到清单模式 switchToListMode(mNoteEditor.getText().toString()); } else { - // 切换到普通模式 if (!getWorkingText()) { - // 清理清单标记符号 mWorkingNote.setWorkingText(mWorkingNote.getContent().replace(TAG_UNCHECKED + " ", "")); } @@ -941,98 +782,87 @@ public class NoteEditActivity extends Activity implements OnClickListener, } } - /** - * 从UI获取当前编辑的文本内容 - * @return 是否存在已完成的项 - */ private boolean getWorkingText() { boolean hasChecked = false; if (mWorkingNote.getCheckListMode() == TextNote.MODE_CHECK_LIST) { - // 清单模式:构建格式化的文本 StringBuilder sb = new StringBuilder(); for (int i = 0; i < mEditTextList.getChildCount(); i++) { View view = mEditTextList.getChildAt(i); NoteEditText edit = (NoteEditText) view.findViewById(R.id.et_edit_text); if (!TextUtils.isEmpty(edit.getText())) { if (((CheckBox) view.findViewById(R.id.cb_edit_item)).isChecked()) { - // 已完成的项 sb.append(TAG_CHECKED).append(" ").append(edit.getText()).append("\n"); hasChecked = true; } else { - // 未完成的项 sb.append(TAG_UNCHECKED).append(" ").append(edit.getText()).append("\n"); } } } mWorkingNote.setWorkingText(sb.toString()); } else { - // 普通模式:直接获取编辑器文本 mWorkingNote.setWorkingText(mNoteEditor.getText().toString()); } return hasChecked; } - /** - * 保存笔记到数据库 - * @return 保存是否成功 - */ private boolean saveNote() { - getWorkingText(); // 从UI获取最新文本 - boolean saved = mWorkingNote.saveNote(); // 保存到数据库 + getWorkingText(); + boolean saved = mWorkingNote.saveNote(); if (saved) { - setResult(RESULT_OK); // 设置活动结果 + /** + * There are two modes from List view to edit view, open one note, + * create/edit a node. Opening node requires to the original + * position in the list when back from edit view, while creating a + * new node requires to the top of the list. This code + * {@link #RESULT_OK} is used to identify the create/edit state + */ + setResult(RESULT_OK); } return saved; } - /** - * 发送笔记到桌面快捷方式 - */ private void sendToDesktop() { - // 确保笔记已保存到数据库 + /** + * Before send message to home, we should make sure that current + * editing note is exists in databases. So, for new note, firstly + * save it + */ if (!mWorkingNote.existInDatabase()) { saveNote(); } if (mWorkingNote.getNoteId() > 0) { Intent sender = new Intent(); - // 创建快捷方式意图 Intent shortcutIntent = new Intent(this, NoteEditActivity.class); shortcutIntent.setAction(Intent.ACTION_VIEW); shortcutIntent.putExtra(Intent.EXTRA_UID, mWorkingNote.getNoteId()); - sender.putExtra(Intent.EXTRA_SHORTCUT_INTENT, shortcutIntent); sender.putExtra(Intent.EXTRA_SHORTCUT_NAME, makeShortcutIconTitle(mWorkingNote.getContent())); sender.putExtra(Intent.EXTRA_SHORTCUT_ICON_RESOURCE, Intent.ShortcutIconResource.fromContext(this, R.drawable.icon_app)); - sender.putExtra("duplicate", true); // 允许重复创建 + sender.putExtra("duplicate", true); sender.setAction("com.android.launcher.action.INSTALL_SHORTCUT"); - showToast(R.string.info_note_enter_desktop); sendBroadcast(sender); } else { - // 笔记为空,无法创建快捷方式 + /** + * There is the condition that user has input nothing (the note is + * not worthy saving), we have no note id, remind the user that he + * should input something + */ Log.e(TAG, "Send to desktop error"); showToast(R.string.error_note_empty_for_send_to_desktop); } } - /** - * 生成桌面快捷方式的标题 - */ private String makeShortcutIconTitle(String content) { - // 清理清单标记符号 content = content.replace(TAG_CHECKED, ""); content = content.replace(TAG_UNCHECKED, ""); - // 截取标题长度 return content.length() > SHORTCUT_ICON_TITLE_MAX_LEN ? content.substring(0, SHORTCUT_ICON_TITLE_MAX_LEN) : content; } - /** - * 显示Toast提示 - */ private void showToast(int resId) { showToast(resId, Toast.LENGTH_SHORT); } @@ -1040,4 +870,4 @@ public class NoteEditActivity extends Activity implements OnClickListener, private void showToast(int resId, int duration) { Toast.makeText(this, resId, duration).show(); } -} \ No newline at end of file +} diff --git a/src/notes/ui/NoteEditText.java b/src/notes/ui/NoteEditText.java index 8122993..2afe2a8 100644 --- a/src/notes/ui/NoteEditText.java +++ b/src/notes/ui/NoteEditText.java @@ -37,167 +37,115 @@ import net.micode.notes.R; import java.util.HashMap; import java.util.Map; -/** - * 自定义编辑文本框,用于笔记应用的清单模式 - * 支持特殊的删除和回车逻辑,以及链接处理功能 - */ public class NoteEditText extends EditText { private static final String TAG = "NoteEditText"; - private int mIndex; // 当前编辑框在清单列表中的索引位置 - private int mSelectionStartBeforeDelete; // 记录删除操作前光标起始位置 + private int mIndex; + private int mSelectionStartBeforeDelete; - // 链接协议常量定义 - private static final String SCHEME_TEL = "tel:" ; // 电话协议 - private static final String SCHEME_HTTP = "http:" ; // 网页协议 - private static final String SCHEME_EMAIL = "mailto:" ; // 邮件协议 + private static final String SCHEME_TEL = "tel:" ; + private static final String SCHEME_HTTP = "http:" ; + private static final String SCHEME_EMAIL = "mailto:" ; - // 链接协议与对应字符串资源的映射表 private static final Map sSchemaActionResMap = new HashMap(); static { - sSchemaActionResMap.put(SCHEME_TEL, R.string.note_link_tel); // 电话 -> "拨打电话" - sSchemaActionResMap.put(SCHEME_HTTP, R.string.note_link_web); // 网页 -> "打开网页" - sSchemaActionResMap.put(SCHEME_EMAIL, R.string.note_link_email); // 邮件 -> "发送邮件" + sSchemaActionResMap.put(SCHEME_TEL, R.string.note_link_tel); + sSchemaActionResMap.put(SCHEME_HTTP, R.string.note_link_web); + sSchemaActionResMap.put(SCHEME_EMAIL, R.string.note_link_email); } /** - * 文本变化监听器接口 - * 由NoteEditActivity实现,用于处理清单模式下的特殊编辑逻辑 + * Call by the {@link NoteEditActivity} to delete or add edit text */ public interface OnTextViewChangeListener { /** - * 当在行首按删除键且文本为空时,删除当前编辑框 - * @param index 被删除的编辑框索引 - * @param text 被删除的文本内容 + * Delete current edit text when {@link KeyEvent#KEYCODE_DEL} happens + * and the text is null */ void onEditTextDelete(int index, String text); /** - * 当按回车键时,在当前编辑框后插入新编辑框 - * @param index 新编辑框的索引(当前索引+1) - * @param text 从当前光标位置截取的文本(将移动到新编辑框) + * Add edit text after current edit text when {@link KeyEvent#KEYCODE_ENTER} + * happen */ void onEditTextEnter(int index, String text); /** - * 当文本内容变化时,显示或隐藏选项(如复选框) - * @param index 发生变化的编辑框索引 - * @param hasText 变化后是否有文本 + * Hide or show item option when text change */ void onTextChange(int index, boolean hasText); } private OnTextViewChangeListener mOnTextViewChangeListener; - /** - * 构造函数1:仅通过Context创建 - */ public NoteEditText(Context context) { super(context, null); - mIndex = 0; // 初始化索引为0 + mIndex = 0; } - /** - * 设置当前编辑框在列表中的索引 - * @param index 索引位置 - */ public void setIndex(int index) { mIndex = index; } - /** - * 设置文本变化监听器 - * @param listener 监听器实例 - */ public void setOnTextViewChangeListener(OnTextViewChangeListener listener) { mOnTextViewChangeListener = listener; } - /** - * 构造函数2:通过Context和AttributeSet创建(XML布局使用) - */ public NoteEditText(Context context, AttributeSet attrs) { super(context, attrs, android.R.attr.editTextStyle); } - /** - * 构造函数3:通过Context、AttributeSet和样式定义创建 - */ public NoteEditText(Context context, AttributeSet attrs, int defStyle) { super(context, attrs, defStyle); // TODO Auto-generated constructor stub } - /** - * 触摸事件处理 - 用于精确的链接点击定位 - * 当手指按下时,计算点击位置对应的字符偏移量,并设置光标到那里 - */ @Override public boolean onTouchEvent(MotionEvent event) { switch (event.getAction()) { - case MotionEvent.ACTION_DOWN: // 手指按下动作 - // 计算点击处在文本内容中的准确坐标 + case MotionEvent.ACTION_DOWN: + int x = (int) event.getX(); int y = (int) event.getY(); - // 减去内边距,得到文本区域内的坐标 x -= getTotalPaddingLeft(); y -= getTotalPaddingTop(); - // 加上滚动偏移量,得到文本内容中的绝对坐标 x += getScrollX(); y += getScrollY(); - // 获取文本布局对象 Layout layout = getLayout(); - // 根据y坐标找到对应的行号 int line = layout.getLineForVertical(y); - // 根据x坐标在该行找到对应的字符偏移量 int off = layout.getOffsetForHorizontal(line, x); - // 将光标设置到计算出的偏移量位置 Selection.setSelection(getText(), off); break; } - // 调用父类方法处理其他触摸逻辑(如长按弹出菜单) return super.onTouchEvent(event); } - /** - * 按键按下事件处理 - * 主要记录删除键按下时光标的位置 - */ @Override public boolean onKeyDown(int keyCode, KeyEvent event) { switch (keyCode) { - case KeyEvent.KEYCODE_ENTER: // 回车键 + case KeyEvent.KEYCODE_ENTER: if (mOnTextViewChangeListener != null) { - // 如果监听器存在,返回false让onKeyUp处理 return false; } break; - case KeyEvent.KEYCODE_DEL: // 删除键(退格键) - // 记录删除前光标的起始位置,用于在onKeyUp中判断是否在行首 + case KeyEvent.KEYCODE_DEL: mSelectionStartBeforeDelete = getSelectionStart(); break; default: break; } - // 其他按键交给父类处理 return super.onKeyDown(keyCode, event); } - /** - * 按键抬起事件处理 - 核心逻辑实现 - * 处理删除键和回车键的特殊行为 - */ @Override public boolean onKeyUp(int keyCode, KeyEvent event) { switch(keyCode) { case KeyEvent.KEYCODE_DEL: if (mOnTextViewChangeListener != null) { - // 判断条件:光标在行首(位置0)且不是第一个编辑框(索引不为0) if (0 == mSelectionStartBeforeDelete && mIndex != 0) { - // 触发删除监听,通知Activity删除当前编辑框 mOnTextViewChangeListener.onEditTextDelete(mIndex, getText().toString()); - return true; // 消费此事件,阻止父类处理 + return true; } } else { Log.d(TAG, "OnTextViewChangeListener was not seted"); @@ -205,13 +153,9 @@ public class NoteEditText extends EditText { break; case KeyEvent.KEYCODE_ENTER: if (mOnTextViewChangeListener != null) { - // 获取当前光标位置 int selectionStart = getSelectionStart(); - // 截取从光标位置到文本末尾的内容 String text = getText().subSequence(selectionStart, length()).toString(); - // 将当前编辑框的文本设置为光标前的内容 setText(getText().subSequence(0, selectionStart)); - // 触发回车监听,通知Activity插入新编辑框,并传递截取的文本 mOnTextViewChangeListener.onEditTextEnter(mIndex + 1, text); } else { Log.d(TAG, "OnTextViewChangeListener was not seted"); @@ -223,72 +167,51 @@ public class NoteEditText extends EditText { return super.onKeyUp(keyCode, event); } - /** - * 焦点变化事件处理 - * 当编辑框获得或失去焦点时,根据文本内容通知监听器 - */ @Override protected void onFocusChanged(boolean focused, int direction, Rect previouslyFocusedRect) { if (mOnTextViewChangeListener != null) { - // 如果失去焦点且文本为空,通知无文本状态 if (!focused && TextUtils.isEmpty(getText())) { mOnTextViewChangeListener.onTextChange(mIndex, false); } else { - // 其他情况(获得焦点,或失去焦点但文本不为空),通知有文本状态 mOnTextViewChangeListener.onTextChange(mIndex, true); } } super.onFocusChanged(focused, direction, previouslyFocusedRect); } - /** - * 创建上下文菜单(长按编辑框时弹出的菜单) - * 特别处理文本中的链接,为链接添加对应的操作菜单项 - */ @Override protected void onCreateContextMenu(ContextMenu menu) { - // 检查当前文本是否包含样式(如链接) if (getText() instanceof Spanned) { - // 获取选区的开始和结束位置 int selStart = getSelectionStart(); int selEnd = getSelectionEnd(); - // 计算选区的最小和最大位置(考虑用户可能从右向左选择) int min = Math.min(selStart, selEnd); int max = Math.max(selStart, selEnd); - // 从文本中获取选区范围内的所有链接 final URLSpan[] urls = ((Spanned) getText()).getSpans(min, max, URLSpan.class); - // 如果选区内有且仅有一个链接 if (urls.length == 1) { - int defaultResId = 0; // 菜单项文本的资源ID - - // 遍历协议映射,检查链接的URL包含哪种协议 + int defaultResId = 0; for(String schema: sSchemaActionResMap.keySet()) { if(urls[0].getURL().indexOf(schema) >= 0) { - // 找到匹配的协议,获取对应的字符串资源ID defaultResId = sSchemaActionResMap.get(schema); break; } } - // 如果没有匹配到预定义的协议,使用"其他"选项 if (defaultResId == 0) { defaultResId = R.string.note_link_other; } - // 向菜单中添加链接操作项,并设置点击监听器 menu.add(0, 0, 0, defaultResId).setOnMenuItemClickListener( new OnMenuItemClickListener() { public boolean onMenuItemClick(MenuItem item) { - // 触发链接的默认行为(如打开浏览器、拨号盘等) + // goto a new intent urls[0].onClick(NoteEditText.this); - return true; // 消费此事件 + return true; } }); } } - // 调用父类方法添加系统默认的菜单项(复制、粘贴等) super.onCreateContextMenu(menu); } -} \ No newline at end of file +} diff --git a/src/notes/ui/NoteItemData.java b/src/notes/ui/NoteItemData.java index c1601e9..0f5a878 100644 --- a/src/notes/ui/NoteItemData.java +++ b/src/notes/ui/NoteItemData.java @@ -25,343 +25,200 @@ import net.micode.notes.data.Notes; import net.micode.notes.data.Notes.NoteColumns; import net.micode.notes.tool.DataUtils; -/** - * 笔记列表项的数据封装类。 - * 这个类的主要作用是将数据库查询结果(Cursor对象)中的原始数据 - * 封装成一个易于使用的Java对象(POJO),并添加一些业务逻辑判断。 - * 它代表了笔记列表中的一个条目,这个条目可能是一条笔记、一个文件夹或系统文件夹。 - */ + public class NoteItemData { - /** - * 数据库查询的列投影(Projection),定义了要从数据库中查询哪些列。 - * 这个数组中的列名顺序很重要,后面的列索引常量要与之对应。 - */ static final String [] PROJECTION = new String [] { - NoteColumns.ID, // 笔记ID - NoteColumns.ALERTED_DATE, // 提醒日期 - NoteColumns.BG_COLOR_ID, // 背景颜色ID - NoteColumns.CREATED_DATE, // 创建日期 - NoteColumns.HAS_ATTACHMENT, // 是否有附件 - NoteColumns.MODIFIED_DATE, // 最后修改日期 - NoteColumns.NOTES_COUNT, // 包含的笔记数量(针对文件夹) - NoteColumns.PARENT_ID, // 父文件夹ID - NoteColumns.SNIPPET, // 内容摘要/片段 - NoteColumns.TYPE, // 类型(笔记、文件夹、系统文件夹等) - NoteColumns.WIDGET_ID, // 关联的小部件ID - NoteColumns.WIDGET_TYPE, // 小部件类型 + NoteColumns.ID, + NoteColumns.ALERTED_DATE, + NoteColumns.BG_COLOR_ID, + NoteColumns.CREATED_DATE, + NoteColumns.HAS_ATTACHMENT, + NoteColumns.MODIFIED_DATE, + NoteColumns.NOTES_COUNT, + NoteColumns.PARENT_ID, + NoteColumns.SNIPPET, + NoteColumns.TYPE, + NoteColumns.WIDGET_ID, + NoteColumns.WIDGET_TYPE, }; - /** - * 列索引常量,对应上面PROJECTION数组中各列的位置。 - * 使用常量而不是直接写数字(如0,1,2)可以提高代码可读性和可维护性。 - */ - private static final int ID_COLUMN = 0; // ID列的索引 - private static final int ALERTED_DATE_COLUMN = 1; // 提醒日期列的索引 - private static final int BG_COLOR_ID_COLUMN = 2; // 背景颜色ID列的索引 - private static final int CREATED_DATE_COLUMN = 3; // 创建日期列的索引 - private static final int HAS_ATTACHMENT_COLUMN = 4; // 是否有附件列的索引 - private static final int MODIFIED_DATE_COLUMN = 5; // 修改日期列的索引 - private static final int NOTES_COUNT_COLUMN = 6; // 笔记数量列的索引 - private static final int PARENT_ID_COLUMN = 7; // 父文件夹ID列的索引 - private static final int SNIPPET_COLUMN = 8; // 内容摘要列的索引 - private static final int TYPE_COLUMN = 9; // 类型列的索引 - private static final int WIDGET_ID_COLUMN = 10; // 小部件ID列的索引 - private static final int WIDGET_TYPE_COLUMN = 11; // 小部件类型列的索引 - - // 成员变量,对应数据库中的各个字段 - private long mId; // 笔记/文件夹的唯一标识ID - private long mAlertDate; // 提醒时间戳(毫秒) - private int mBgColorId; // 背景颜色资源ID - private long mCreatedDate; // 创建时间戳(毫秒) - private boolean mHasAttachment; // 是否有附件(true/false) - private long mModifiedDate; // 最后修改时间戳(毫秒) - private int mNotesCount; // 文件夹中包含的笔记数量(如果是文件夹的话) - private long mParentId; // 父文件夹的ID - private String mSnippet; // 笔记内容的摘要/片段(用于列表显示) - private int mType; // 类型(笔记、文件夹、系统文件夹等) - private int mWidgetId; // 关联的桌面小部件ID - private int mWidgetType; // 桌面小部件的类型 - - // 额外添加的业务逻辑相关字段(不直接来自数据库) - private String mName; // 联系人姓名(如果是通话记录笔记) - private String mPhoneNumber; // 电话号码(如果是通话记录笔记) - - // 位置状态标志,用于判断当前项在列表中的位置关系 - private boolean mIsLastItem; // 是否是列表中的最后一项 - private boolean mIsFirstItem; // 是否是列表中的第一项 - private boolean mIsOnlyOneItem; // 是否是列表中唯一的一项 - private boolean mIsOneNoteFollowingFolder; // 是否是一个紧跟在文件夹后面的笔记 - private boolean mIsMultiNotesFollowingFolder; // 是否是多个紧跟在文件夹后面的笔记之一 - - /** - * 构造函数:从数据库游标(Cursor)中加载数据并初始化对象 - * @param context 上下文,用于获取内容解析器等系统服务 - * @param cursor 数据库查询结果游标,指向当前要处理的数据行 - */ + private static final int ID_COLUMN = 0; + private static final int ALERTED_DATE_COLUMN = 1; + private static final int BG_COLOR_ID_COLUMN = 2; + private static final int CREATED_DATE_COLUMN = 3; + private static final int HAS_ATTACHMENT_COLUMN = 4; + private static final int MODIFIED_DATE_COLUMN = 5; + private static final int NOTES_COUNT_COLUMN = 6; + private static final int PARENT_ID_COLUMN = 7; + private static final int SNIPPET_COLUMN = 8; + private static final int TYPE_COLUMN = 9; + private static final int WIDGET_ID_COLUMN = 10; + private static final int WIDGET_TYPE_COLUMN = 11; + + private long mId; + private long mAlertDate; + private int mBgColorId; + private long mCreatedDate; + private boolean mHasAttachment; + private long mModifiedDate; + private int mNotesCount; + private long mParentId; + private String mSnippet; + private int mType; + private int mWidgetId; + private int mWidgetType; + private String mName; + private String mPhoneNumber; + + private boolean mIsLastItem; + private boolean mIsFirstItem; + private boolean mIsOnlyOneItem; + private boolean mIsOneNoteFollowingFolder; + private boolean mIsMultiNotesFollowingFolder; + public NoteItemData(Context context, Cursor cursor) { - // 从游标中按列索引获取数据,并赋值给对应的成员变量 mId = cursor.getLong(ID_COLUMN); mAlertDate = cursor.getLong(ALERTED_DATE_COLUMN); mBgColorId = cursor.getInt(BG_COLOR_ID_COLUMN); mCreatedDate = cursor.getLong(CREATED_DATE_COLUMN); - // 将整数值转换为布尔值:大于0表示有附件(true),否则为false mHasAttachment = (cursor.getInt(HAS_ATTACHMENT_COLUMN) > 0) ? true : false; mModifiedDate = cursor.getLong(MODIFIED_DATE_COLUMN); mNotesCount = cursor.getInt(NOTES_COUNT_COLUMN); mParentId = cursor.getLong(PARENT_ID_COLUMN); mSnippet = cursor.getString(SNIPPET_COLUMN); - // 清理摘要文本中的清单标记符号(对勾和方框),让显示更干净 mSnippet = mSnippet.replace(NoteEditActivity.TAG_CHECKED, "").replace( NoteEditActivity.TAG_UNCHECKED, ""); mType = cursor.getInt(TYPE_COLUMN); mWidgetId = cursor.getInt(WIDGET_ID_COLUMN); mWidgetType = cursor.getInt(WIDGET_TYPE_COLUMN); - // 初始化电话号码和姓名为空 mPhoneNumber = ""; - // 如果当前项属于"通话记录"文件夹 if (mParentId == Notes.ID_CALL_RECORD_FOLDER) { - // 根据笔记ID查询对应的电话号码 mPhoneNumber = DataUtils.getCallNumberByNoteId(context.getContentResolver(), mId); if (!TextUtils.isEmpty(mPhoneNumber)) { - // 如果电话号码不为空,通过联系人提供者查询对应的联系人姓名 mName = Contact.getContact(context, mPhoneNumber); if (mName == null) { - // 如果查询不到联系人,则用电话号码本身作为显示名称 mName = mPhoneNumber; } } } - // 确保姓名不为null,避免后续使用时报错 if (mName == null) { mName = ""; } - - // 检查当前项在列表中的位置状态(如是否是第一项、最后一项等) checkPostion(cursor); } - /** - * 检查当前数据项在游标(列表)中的位置状态 - * 这些状态信息可能用于控制列表项的UI显示(如分割线、边距等) - * @param cursor 数据库游标 - */ private void checkPostion(Cursor cursor) { - // 使用游标的方法判断位置 - mIsLastItem = cursor.isLast() ? true : false; // 是否是最后一项 - mIsFirstItem = cursor.isFirst() ? true : false; // 是否是第一项 - mIsOnlyOneItem = (cursor.getCount() == 1); // 是否只有一项 - - // 初始化位置关系标志为false + mIsLastItem = cursor.isLast() ? true : false; + mIsFirstItem = cursor.isFirst() ? true : false; + mIsOnlyOneItem = (cursor.getCount() == 1); mIsMultiNotesFollowingFolder = false; mIsOneNoteFollowingFolder = false; - // 只有当当前项是笔记类型(不是文件夹),且不是第一项时,才需要检查前面的项 if (mType == Notes.TYPE_NOTE && !mIsFirstItem) { - // 记录当前位置 int position = cursor.getPosition(); - // 将游标移动到前一项(即列表中的上一行) if (cursor.moveToPrevious()) { - // 检查前一项的类型是否是文件夹或系统文件夹 if (cursor.getInt(TYPE_COLUMN) == Notes.TYPE_FOLDER || cursor.getInt(TYPE_COLUMN) == Notes.TYPE_SYSTEM) { - // 判断当前项后面是否还有其他项 if (cursor.getCount() > (position + 1)) { - // 如果后面还有项,说明有多个笔记跟在文件夹后面 mIsMultiNotesFollowingFolder = true; } else { - // 如果后面没有项了,说明只有一个笔记跟在文件夹后面 mIsOneNoteFollowingFolder = true; } } - // 将游标移回原来的位置 if (!cursor.moveToNext()) { - // 理论上不应该发生,如果发生了说明游标状态有问题 throw new IllegalStateException("cursor move to previous but can't move back"); } } } } - // ========== 以下是一系列的getter方法,用于外部获取对象的属性值 ========== - - /** - * 判断当前笔记是否是唯一一个紧跟在文件夹后面的笔记 - * @return 如果是,返回true - */ public boolean isOneFollowingFolder() { return mIsOneNoteFollowingFolder; } - /** - * 判断当前笔记是否是多个紧跟在文件夹后面的笔记之一 - * @return 如果是,返回true - */ public boolean isMultiFollowingFolder() { return mIsMultiNotesFollowingFolder; } - /** - * 判断当前项是否是列表中的最后一项 - * @return 如果是最后一项,返回true - */ public boolean isLast() { return mIsLastItem; } - /** - * 获取通话记录对应的联系人姓名(如果不是通话记录,返回空字符串) - * @return 联系人姓名 - */ public String getCallName() { return mName; } - /** - * 判断当前项是否是列表中的第一项 - * @return 如果是第一项,返回true - */ public boolean isFirst() { return mIsFirstItem; } - /** - * 判断当前项是否是列表中唯一的一项 - * @return 如果是唯一项,返回true - */ public boolean isSingle() { return mIsOnlyOneItem; } - /** - * 获取笔记/文件夹的ID - * @return 唯一标识ID - */ public long getId() { return mId; } - /** - * 获取提醒日期时间戳 - * @return 提醒时间(毫秒) - */ public long getAlertDate() { return mAlertDate; } - /** - * 获取创建日期时间戳 - * @return 创建时间(毫秒) - */ public long getCreatedDate() { return mCreatedDate; } - /** - * 判断是否有附件 - * @return 有附件返回true,否则false - */ public boolean hasAttachment() { return mHasAttachment; } - /** - * 获取最后修改日期时间戳 - * @return 最后修改时间(毫秒) - */ public long getModifiedDate() { return mModifiedDate; } - /** - * 获取背景颜色ID - * @return 背景颜色资源ID - */ public int getBgColorId() { return mBgColorId; } - /** - * 获取父文件夹ID - * @return 父文件夹ID - */ public long getParentId() { return mParentId; } - /** - * 获取文件夹中的笔记数量(如果是文件夹的话) - * @return 包含的笔记数量 - */ public int getNotesCount() { return mNotesCount; } - /** - * 获取文件夹ID(与getParentId()功能相同,可能是为了语义清晰) - * @return 文件夹ID - */ public long getFolderId () { return mParentId; } - /** - * 获取类型(笔记、文件夹、系统文件夹等) - * @return 类型常量值 - */ public int getType() { return mType; } - /** - * 获取小部件类型 - * @return 小部件类型常量值 - */ public int getWidgetType() { return mWidgetType; } - /** - * 获取小部件ID - * @return 小部件ID - */ public int getWidgetId() { return mWidgetId; } - /** - * 获取内容摘要/片段(已清理清单标记) - * @return 清理后的内容摘要 - */ public String getSnippet() { return mSnippet; } - /** - * 判断是否有设置提醒 - * @return 有提醒返回true(mAlertDate > 0) - */ public boolean hasAlert() { return (mAlertDate > 0); } - /** - * 判断是否是通话记录笔记 - * 条件:属于通话记录文件夹 且 有有效的电话号码 - * @return 是通话记录笔记返回true - */ public boolean isCallRecord() { return (mParentId == Notes.ID_CALL_RECORD_FOLDER && !TextUtils.isEmpty(mPhoneNumber)); } - /** - * 静态方法:直接从游标中获取笔记类型 - * 这个方法不需要创建NoteItemData对象,效率更高 - * @param cursor 数据库游标 - * @return 笔记类型 - */ public static int getNoteType(Cursor cursor) { return cursor.getInt(TYPE_COLUMN); } -} \ No newline at end of file +} diff --git a/src/notes/ui/NotesListActivity.java b/src/notes/ui/NotesListActivity.java index 56ecd10..e843aec 100644 --- a/src/notes/ui/NotesListActivity.java +++ b/src/notes/ui/NotesListActivity.java @@ -78,119 +78,99 @@ import java.io.InputStream; import java.io.InputStreamReader; import java.util.HashSet; -/** - * 笔记列表主活动,显示笔记和文件夹的列表,是应用的入口界面之一。 - * 实现了笔记的浏览、创建、删除、移动、多选操作等功能。 - */ public class NotesListActivity extends Activity implements OnClickListener, OnItemLongClickListener { + private static final int FOLDER_NOTE_LIST_QUERY_TOKEN = 0; + + private static final int FOLDER_LIST_QUERY_TOKEN = 1; - // 异步查询的令牌,用于区分不同类型的查询 - private static final int FOLDER_NOTE_LIST_QUERY_TOKEN = 0; // 查询文件夹下的笔记列表 - private static final int FOLDER_LIST_QUERY_TOKEN = 1; // 查询可用的文件夹列表(用于移动操作) + private static final int MENU_FOLDER_DELETE = 0; - // 文件夹上下文菜单的菜单项ID - private static final int MENU_FOLDER_DELETE = 0; // 删除文件夹 - private static final int MENU_FOLDER_VIEW = 1; // 查看文件夹(打开) - private static final int MENU_FOLDER_CHANGE_NAME = 2; // 修改文件夹名称 + private static final int MENU_FOLDER_VIEW = 1; + + private static final int MENU_FOLDER_CHANGE_NAME = 2; - // 偏好设置的键名,用于标记是否已经添加过应用介绍笔记 private static final String PREFERENCE_ADD_INTRODUCTION = "net.micode.notes.introduction"; - /** - * 列表编辑状态枚举,表示当前显示的列表类型 - */ private enum ListEditState { - NOTE_LIST, // 根目录下的笔记列表(显示文件夹和笔记) - SUB_FOLDER, // 子文件夹内的笔记列表 - CALL_RECORD_FOLDER // 通话记录文件夹内的列表 + NOTE_LIST, SUB_FOLDER, CALL_RECORD_FOLDER }; - // 成员变量声明 - private ListEditState mState; // 当前列表状态 - private BackgroundQueryHandler mBackgroundQueryHandler; // 后台查询处理器 - private NotesListAdapter mNotesListAdapter; // 列表适配器,负责数据与列表项的绑定 - private ListView mNotesListView; // 列表视图 - private Button mAddNewNote; // "新建笔记"按钮 - private boolean mDispatch; // 触摸事件分发标志(用于处理"新建笔记"按钮的特殊触摸区域) - private int mOriginY; // 触摸起始Y坐标 - private int mDispatchY; // 分发后的Y坐标 - private TextView mTitleBar; // 标题栏(在子文件夹内显示当前文件夹名称) - private long mCurrentFolderId; // 当前显示的文件夹ID - private ContentResolver mContentResolver; // 内容解析器 - private ModeCallback mModeCallBack; // 多选模式的回调(动作模式) - - private static final String TAG = "NotesListActivity"; // 日志标签 - - // 列表滚动速率常量(可能用于控制滚动速度,但代码中未直接使用) + private ListEditState mState; + + private BackgroundQueryHandler mBackgroundQueryHandler; + + private NotesListAdapter mNotesListAdapter; + + private ListView mNotesListView; + + private Button mAddNewNote; + + private boolean mDispatch; + + private int mOriginY; + + private int mDispatchY; + + private TextView mTitleBar; + + private long mCurrentFolderId; + + private ContentResolver mContentResolver; + + private ModeCallback mModeCallBack; + + private static final String TAG = "NotesListActivity"; + public static final int NOTES_LISTVIEW_SCROLL_RATE = 30; - private NoteItemData mFocusNoteDataItem; // 当前获得焦点的数据项(长按时记录) + private NoteItemData mFocusNoteDataItem; + + private static final String NORMAL_SELECTION = NoteColumns.PARENT_ID + "=?"; - // 数据库查询条件(Selection) - private static final String NORMAL_SELECTION = NoteColumns.PARENT_ID + "=?"; // 普通查询:父文件夹ID=? private static final String ROOT_FOLDER_SELECTION = "(" + NoteColumns.TYPE + "<>" + Notes.TYPE_SYSTEM + " AND " + NoteColumns.PARENT_ID + "=?)" + " OR (" + NoteColumns.ID + "=" + Notes.ID_CALL_RECORD_FOLDER + " AND " + NoteColumns.NOTES_COUNT + ">0)"; - // 根目录查询条件:包含普通文件夹/笔记 或者 有内容的通话记录文件夹 - // 请求码,用于startActivityForResult - private final static int REQUEST_CODE_OPEN_NODE = 102; // 打开已有笔记 - private final static int REQUEST_CODE_NEW_NODE = 103; // 创建新笔记 + private final static int REQUEST_CODE_OPEN_NODE = 102; + private final static int REQUEST_CODE_NEW_NODE = 103; - /** - * Activity生命周期方法:创建时调用 - */ @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); - // 设置活动布局 setContentView(R.layout.note_list); - // 初始化视图、变量等资源 initResources(); /** - * 当用户第一次使用此应用时,插入一个介绍性的笔记 + * Insert an introduction when user firstly use this application */ setAppInfoFromRawRes(); } - /** - * 处理从其他活动返回的结果 - */ @Override protected void onActivityResult(int requestCode, int resultCode, Intent data) { - // 如果是从笔记编辑活动返回并且操作成功,刷新列表 if (resultCode == RESULT_OK && (requestCode == REQUEST_CODE_OPEN_NODE || requestCode == REQUEST_CODE_NEW_NODE)) { - // 将适配器的游标设为null,触发重新查询 mNotesListAdapter.changeCursor(null); } else { super.onActivityResult(requestCode, resultCode, data); } } - /** - * 从raw资源文件夹读取介绍文本,并创建为笔记(仅第一次使用时执行) - */ private void setAppInfoFromRawRes() { - // 获取偏好设置 SharedPreferences sp = PreferenceManager.getDefaultSharedPreferences(this); - // 检查是否已经添加过介绍笔记 if (!sp.getBoolean(PREFERENCE_ADD_INTRODUCTION, false)) { - StringBuilder sb = new StringBuilder(); // 用于拼接读取的文本 + StringBuilder sb = new StringBuilder(); InputStream in = null; try { - // 从raw资源文件夹打开介绍文件 - in = getResources().openRawResource(R.raw.introduction); + in = getResources().openRawResource(R.raw.introduction); if (in != null) { - // 使用缓冲读取器逐行读取文件内容 InputStreamReader isr = new InputStreamReader(in); BufferedReader br = new BufferedReader(isr); - char [] buf = new char[1024]; // 缓冲区 + char [] buf = new char[1024]; int len = 0; while ((len = br.read(buf)) > 0) { - sb.append(buf, 0, len); // 将读取的内容追加到StringBuilder + sb.append(buf, 0, len); } } else { Log.e(TAG, "Read introduction file error"); @@ -200,25 +180,21 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt e.printStackTrace(); return; } finally { - // 确保输入流被关闭 if(in != null) { try { in.close(); } catch (IOException e) { + // TODO Auto-generated catch block e.printStackTrace(); } } } - // 创建一个新的空笔记(在根目录下) WorkingNote note = WorkingNote.createEmptyNote(this, Notes.ID_ROOT_FOLDER, AppWidgetManager.INVALID_APPWIDGET_ID, Notes.TYPE_WIDGET_INVALIDE, ResourceParser.RED); - // 设置笔记内容为读取的介绍文本 note.setWorkingText(sb.toString()); - // 保存笔记 if (note.saveNote()) { - // 保存成功,在偏好设置中标记已添加介绍 sp.edit().putBoolean(PREFERENCE_ADD_INTRODUCTION, true).commit(); } else { Log.e(TAG, "Save introduction note error"); @@ -227,168 +203,116 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } } - /** - * Activity生命周期方法:开始时调用 - */ @Override protected void onStart() { super.onStart(); - // 开始异步查询笔记列表 startAsyncNotesListQuery(); } - /** - * 初始化所有视图资源和变量 - */ private void initResources() { - mContentResolver = this.getContentResolver(); // 获取内容解析器实例 - mBackgroundQueryHandler = new BackgroundQueryHandler(this.getContentResolver()); // 创建后台查询处理器 - mCurrentFolderId = Notes.ID_ROOT_FOLDER; // 初始当前文件夹为根目录 - mNotesListView = (ListView) findViewById(R.id.notes_list); // 查找列表视图 - // 为列表添加脚部视图(可能用于显示空白区域或加载更多) + mContentResolver = this.getContentResolver(); + mBackgroundQueryHandler = new BackgroundQueryHandler(this.getContentResolver()); + mCurrentFolderId = Notes.ID_ROOT_FOLDER; + mNotesListView = (ListView) findViewById(R.id.notes_list); mNotesListView.addFooterView(LayoutInflater.from(this).inflate(R.layout.note_list_footer, null), null, false); - // 设置列表项点击监听器 mNotesListView.setOnItemClickListener(new OnListItemClickListener()); - // 设置列表项长按监听器(本活动实现了该接口) mNotesListView.setOnItemLongClickListener(this); - // 创建列表适配器 mNotesListAdapter = new NotesListAdapter(this); - mNotesListView.setAdapter(mNotesListAdapter); // 为列表设置适配器 - mAddNewNote = (Button) findViewById(R.id.btn_new_note); // "新建笔记"按钮 - mAddNewNote.setOnClickListener(this); // 设置按钮点击监听器 - // 设置按钮触摸监听器,用于处理特殊触摸区域的事件分发 + mNotesListView.setAdapter(mNotesListAdapter); + mAddNewNote = (Button) findViewById(R.id.btn_new_note); + mAddNewNote.setOnClickListener(this); mAddNewNote.setOnTouchListener(new NewNoteOnTouchListener()); - mDispatch = false; // 初始化事件分发标志 + mDispatch = false; mDispatchY = 0; mOriginY = 0; - mTitleBar = (TextView) findViewById(R.id.tv_title_bar); // 标题栏 - mState = ListEditState.NOTE_LIST; // 初始状态为根目录笔记列表 - mModeCallBack = new ModeCallback(); // 创建多选模式回调实例 + mTitleBar = (TextView) findViewById(R.id.tv_title_bar); + mState = ListEditState.NOTE_LIST; + mModeCallBack = new ModeCallback(); } - /** - * 多选模式回调类,实现了MultiChoiceModeListener接口 - * 当用户长按笔记进入多选模式时,顶部会出现一个上下文操作栏(ActionMode) - */ private class ModeCallback implements ListView.MultiChoiceModeListener, OnMenuItemClickListener { - private DropdownMenu mDropDownMenu; // 下拉菜单(用于全选/取消全选) - private ActionMode mActionMode; // 动作模式实例 - private MenuItem mMoveMenu; // "移动"菜单项 + private DropdownMenu mDropDownMenu; + private ActionMode mActionMode; + private MenuItem mMoveMenu; - /** - * 创建动作模式时调用(进入多选模式时) - */ public boolean onCreateActionMode(ActionMode mode, Menu menu) { - // 从菜单资源文件加载多选模式下的菜单项 getMenuInflater().inflate(R.menu.note_list_options, menu); - // 为"删除"菜单项设置点击监听器 menu.findItem(R.id.delete).setOnMenuItemClickListener(this); - // 获取"移动"菜单项 mMoveMenu = menu.findItem(R.id.move); - // 判断是否显示"移动"菜单项:通话记录笔记或没有用户文件夹时隐藏 if (mFocusNoteDataItem.getParentId() == Notes.ID_CALL_RECORD_FOLDER || DataUtils.getUserFolderCount(mContentResolver) == 0) { mMoveMenu.setVisible(false); } else { mMoveMenu.setVisible(true); - mMoveMenu.setOnMenuItemClickListener(this); // 设置点击监听器 + mMoveMenu.setOnMenuItemClickListener(this); } - mActionMode = mode; // 保存动作模式实例 - mNotesListAdapter.setChoiceMode(true); // 通知适配器进入多选模式 - mNotesListView.setLongClickable(false); // 禁用长按(避免冲突) - mAddNewNote.setVisibility(View.GONE); // 隐藏"新建笔记"按钮 + mActionMode = mode; + mNotesListAdapter.setChoiceMode(true); + mNotesListView.setLongClickable(false); + mAddNewNote.setVisibility(View.GONE); - // 设置自定义视图(包含下拉菜单) View customView = LayoutInflater.from(NotesListActivity.this).inflate( R.layout.note_list_dropdown_menu, null); mode.setCustomView(customView); - // 初始化下拉菜单 mDropDownMenu = new DropdownMenu(NotesListActivity.this, (Button) customView.findViewById(R.id.selection_menu), R.menu.note_list_dropdown); - // 设置下拉菜单项点击监听器 mDropDownMenu.setOnDropdownMenuItemClickListener(new PopupMenu.OnMenuItemClickListener(){ public boolean onMenuItemClick(MenuItem item) { - // 切换全选/取消全选状态 mNotesListAdapter.selectAll(!mNotesListAdapter.isAllSelected()); - updateMenu(); // 更新菜单显示 + updateMenu(); return true; } + }); return true; } - /** - * 更新菜单显示(主要是更新选中数量和全选状态) - */ private void updateMenu() { - int selectedCount = mNotesListAdapter.getSelectedCount(); // 获取选中数量 - // 更新下拉菜单标题(显示选中数量) + int selectedCount = mNotesListAdapter.getSelectedCount(); + // Update dropdown menu String format = getResources().getString(R.string.menu_select_title, selectedCount); mDropDownMenu.setTitle(format); - // 获取全选菜单项 MenuItem item = mDropDownMenu.findItem(R.id.action_select_all); if (item != null) { if (mNotesListAdapter.isAllSelected()) { - // 如果已全选,显示"取消全选" item.setChecked(true); item.setTitle(R.string.menu_deselect_all); } else { - // 如果未全选,显示"全选" item.setChecked(false); item.setTitle(R.string.menu_select_all); } } } - /** - * 准备动作模式时调用(每次显示菜单前) - */ public boolean onPrepareActionMode(ActionMode mode, Menu menu) { // TODO Auto-generated method stub return false; } - /** - * 动作模式菜单项点击处理(由于我们为每个菜单项单独设置了监听器,这里可能不需要处理) - */ public boolean onActionItemClicked(ActionMode mode, MenuItem item) { // TODO Auto-generated method stub return false; } - /** - * 销毁动作模式时调用(退出多选模式时) - */ public void onDestroyActionMode(ActionMode mode) { - mNotesListAdapter.setChoiceMode(false); // 通知适配器退出多选模式 - mNotesListView.setLongClickable(true); // 恢复长按功能 - mAddNewNote.setVisibility(View.VISIBLE); // 显示"新建笔记"按钮 + mNotesListAdapter.setChoiceMode(false); + mNotesListView.setLongClickable(true); + mAddNewNote.setVisibility(View.VISIBLE); } - /** - * 手动结束动作模式(用于操作完成后退出多选模式) - */ public void finishActionMode() { mActionMode.finish(); } - /** - * 当列表项选中状态改变时调用 - */ public void onItemCheckedStateChanged(ActionMode mode, int position, long id, - boolean checked) { - // 通知适配器更新指定位置的选中状态 + boolean checked) { mNotesListAdapter.setCheckedItem(position, checked); - updateMenu(); // 更新菜单显示 + updateMenu(); } - /** - * 处理菜单项点击事件(OnMenuItemClickListener接口方法) - */ public boolean onMenuItemClick(MenuItem item) { - // 检查是否有选中的项 if (mNotesListAdapter.getSelectedCount() == 0) { Toast.makeText(NotesListActivity.this, getString(R.string.menu_select_none), Toast.LENGTH_SHORT).show(); @@ -397,24 +321,22 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt switch (item.getItemId()) { case R.id.delete: - // 批量删除:弹出确认对话框 AlertDialog.Builder builder = new AlertDialog.Builder(NotesListActivity.this); builder.setTitle(getString(R.string.alert_title_delete)); builder.setIcon(android.R.drawable.ic_dialog_alert); builder.setMessage(getString(R.string.alert_message_delete_notes, - mNotesListAdapter.getSelectedCount())); + mNotesListAdapter.getSelectedCount())); builder.setPositiveButton(android.R.string.ok, - new DialogInterface.OnClickListener() { - public void onClick(DialogInterface dialog, - int which) { - batchDelete(); // 执行批量删除 - } - }); + new DialogInterface.OnClickListener() { + public void onClick(DialogInterface dialog, + int which) { + batchDelete(); + } + }); builder.setNegativeButton(android.R.string.cancel, null); builder.show(); break; case R.id.move: - // 批量移动:查询可用的目标文件夹 startQueryDestinationFolders(); break; default: @@ -424,55 +346,48 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } } - /** - * "新建笔记"按钮的触摸监听器,用于处理按钮透明区域的特殊触摸事件分发 - * HACKME: 这是一个针对特定UI设计的 hack - */ private class NewNoteOnTouchListener implements OnTouchListener { public boolean onTouch(View v, MotionEvent event) { switch (event.getAction()) { case MotionEvent.ACTION_DOWN: { - // 获取屏幕高度和按钮高度 Display display = getWindowManager().getDefaultDisplay(); int screenHeight = display.getHeight(); int newNoteViewHeight = mAddNewNote.getHeight(); - int start = screenHeight - newNoteViewHeight; // 按钮顶部Y坐标 - int eventY = start + (int) event.getY(); // 触摸点在屏幕中的Y坐标 - + int start = screenHeight - newNoteViewHeight; + int eventY = start + (int) event.getY(); /** - * 减去标题栏的高度(如果在子文件夹状态下) + * Minus TitleBar's height */ if (mState == ListEditState.SUB_FOLDER) { eventY -= mTitleBar.getHeight(); start -= mTitleBar.getHeight(); } - /** - * HACKME: 当点击"新建笔记"按钮的透明部分时,将触摸事件分发给后面的列表视图。 - * 按钮的透明部分可以用公式 y=-0.12x+94(单位:像素)和按钮顶部线表示。 - * 坐标基于按钮左侧。94代表透明部分的最大高度。 - * 注意:如果按钮背景改变,公式也应该改变。这很糟糕,只是为了满足UI设计师的强烈要求。 + * HACKME:When click the transparent part of "New Note" button, dispatch + * the event to the list view behind this button. The transparent part of + * "New Note" button could be expressed by formula y=-0.12x+94(Unit:pixel) + * and the line top of the button. The coordinate based on left of the "New + * Note" button. The 94 represents maximum height of the transparent part. + * Notice that, if the background of the button changes, the formula should + * also change. This is very bad, just for the UI designer's strong requirement. */ if (event.getY() < (event.getX() * (-0.12) + 94)) { - // 获取列表的最后一个子视图(最底部的项) View view = mNotesListView.getChildAt(mNotesListView.getChildCount() - 1 - mNotesListView.getFooterViewsCount()); if (view != null && view.getBottom() > start && (view.getTop() < (start + 94))) { - // 记录原始坐标,计算分发后的坐标 mOriginY = (int) event.getY(); mDispatchY = eventY; - event.setLocation(event.getX(), mDispatchY); // 修改事件坐标 - mDispatch = true; // 标记开始分发 - return mNotesListView.dispatchTouchEvent(event); // 分发给列表视图 + event.setLocation(event.getX(), mDispatchY); + mDispatch = true; + return mNotesListView.dispatchTouchEvent(event); } } break; } case MotionEvent.ACTION_MOVE: { if (mDispatch) { - // 继续分发移动事件,更新坐标 mDispatchY += (int) event.getY() - mOriginY; event.setLocation(event.getX(), mDispatchY); return mNotesListView.dispatchTouchEvent(event); @@ -481,7 +396,6 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } default: { if (mDispatch) { - // 分发结束事件,并重置标志 event.setLocation(event.getX(), mDispatchY); mDispatch = false; return mNotesListView.dispatchTouchEvent(event); @@ -489,45 +403,32 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt break; } } - return false; // 不消费事件,让按钮的onClick正常处理 + return false; } + }; - /** - * 开始异步查询当前文件夹下的笔记列表 - */ private void startAsyncNotesListQuery() { - // 根据当前文件夹ID选择查询条件 String selection = (mCurrentFolderId == Notes.ID_ROOT_FOLDER) ? ROOT_FOLDER_SELECTION : NORMAL_SELECTION; - // 执行异步查询 mBackgroundQueryHandler.startQuery(FOLDER_NOTE_LIST_QUERY_TOKEN, null, Notes.CONTENT_NOTE_URI, NoteItemData.PROJECTION, selection, new String[] { - String.valueOf(mCurrentFolderId) // 参数:当前文件夹ID - }, NoteColumns.TYPE + " DESC," + NoteColumns.MODIFIED_DATE + " DESC"); // 排序:类型降序,修改日期降序 + String.valueOf(mCurrentFolderId) + }, NoteColumns.TYPE + " DESC," + NoteColumns.MODIFIED_DATE + " DESC"); } - /** - * 后台异步查询处理器,继承自AsyncQueryHandler - * 用于在后台线程执行数据库查询,避免阻塞UI线程 - */ private final class BackgroundQueryHandler extends AsyncQueryHandler { public BackgroundQueryHandler(ContentResolver contentResolver) { super(contentResolver); } - /** - * 查询完成时的回调方法(在UI线程执行) - */ @Override protected void onQueryComplete(int token, Object cookie, Cursor cursor) { switch (token) { case FOLDER_NOTE_LIST_QUERY_TOKEN: - // 笔记列表查询完成:更新适配器的游标(会自动刷新列表) mNotesListAdapter.changeCursor(cursor); break; case FOLDER_LIST_QUERY_TOKEN: - // 文件夹列表查询完成(用于移动操作):显示文件夹选择对话框 if (cursor != null && cursor.getCount() > 0) { showFolderListMenu(cursor); } else { @@ -540,93 +441,71 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } } - /** - * 显示文件夹列表选择对话框(用于移动笔记到其他文件夹) - * @param cursor 包含可用文件夹的游标 - */ private void showFolderListMenu(Cursor cursor) { AlertDialog.Builder builder = new AlertDialog.Builder(NotesListActivity.this); - builder.setTitle(R.string.menu_title_select_folder); // 设置对话框标题 - // 创建文件夹列表适配器 + builder.setTitle(R.string.menu_title_select_folder); final FoldersListAdapter adapter = new FoldersListAdapter(this, cursor); - // 设置对话框的列表适配器和项点击监听器 builder.setAdapter(adapter, new DialogInterface.OnClickListener() { + public void onClick(DialogInterface dialog, int which) { - // 执行批量移动到选中的文件夹 DataUtils.batchMoveToFolder(mContentResolver, mNotesListAdapter.getSelectedItemIds(), adapter.getItemId(which)); - // 显示移动成功的提示 Toast.makeText( NotesListActivity.this, getString(R.string.format_move_notes_to_folder, mNotesListAdapter.getSelectedCount(), adapter.getFolderName(NotesListActivity.this, which)), Toast.LENGTH_SHORT).show(); - // 退出多选模式 mModeCallBack.finishActionMode(); } }); - builder.show(); // 显示对话框 + builder.show(); } - /** - * 创建新笔记 - */ private void createNewNote() { Intent intent = new Intent(this, NoteEditActivity.class); - intent.setAction(Intent.ACTION_INSERT_OR_EDIT); // 设置动作为插入或编辑 - intent.putExtra(Notes.INTENT_EXTRA_FOLDER_ID, mCurrentFolderId); // 传递当前文件夹ID - this.startActivityForResult(intent, REQUEST_CODE_NEW_NODE); // 启动笔记编辑活动 + intent.setAction(Intent.ACTION_INSERT_OR_EDIT); + intent.putExtra(Notes.INTENT_EXTRA_FOLDER_ID, mCurrentFolderId); + this.startActivityForResult(intent, REQUEST_CODE_NEW_NODE); } - /** - * 批量删除选中的笔记 - */ private void batchDelete() { - // 使用AsyncTask在后台执行删除操作 new AsyncTask>() { protected HashSet doInBackground(Void... unused) { - // 获取选中的笔记关联的小部件信息 HashSet widgets = mNotesListAdapter.getSelectedWidget(); if (!isSyncMode()) { - // 非同步模式:直接删除笔记 + // if not synced, delete notes directly if (DataUtils.batchDeleteNotes(mContentResolver, mNotesListAdapter .getSelectedItemIds())) { - // 删除成功 } else { Log.e(TAG, "Delete notes error, should not happens"); } } else { - // 同步模式:将笔记移动到垃圾箱文件夹(而不是直接删除) + // in sync mode, we'll move the deleted note into the trash + // folder if (!DataUtils.batchMoveToFolder(mContentResolver, mNotesListAdapter .getSelectedItemIds(), Notes.ID_TRASH_FOLER)) { Log.e(TAG, "Move notes to trash folder error, should not happens"); } } - return widgets; // 返回小部件信息,用于后续更新 + return widgets; } @Override protected void onPostExecute(HashSet widgets) { - // 在UI线程执行,更新关联的小部件 if (widgets != null) { for (AppWidgetAttribute widget : widgets) { if (widget.widgetId != AppWidgetManager.INVALID_APPWIDGET_ID && widget.widgetType != Notes.TYPE_WIDGET_INVALIDE) { - updateWidget(widget.widgetId, widget.widgetType); // 更新小部件 + updateWidget(widget.widgetId, widget.widgetType); } } } - // 退出多选模式 mModeCallBack.finishActionMode(); } }.execute(); } - /** - * 删除文件夹 - * @param folderId 要删除的文件夹ID - */ private void deleteFolder(long folderId) { if (folderId == Notes.ID_ROOT_FOLDER) { Log.e(TAG, "Wrong folder id, should not happen " + folderId); @@ -635,17 +514,15 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt HashSet ids = new HashSet(); ids.add(folderId); - // 获取文件夹内笔记关联的小部件信息 HashSet widgets = DataUtils.getFolderNoteWidget(mContentResolver, folderId); if (!isSyncMode()) { - // 非同步模式:直接删除文件夹 + // if not synced, delete folder directly DataUtils.batchDeleteNotes(mContentResolver, ids); } else { - // 同步模式:将文件夹移动到垃圾箱 + // in sync mode, we'll move the deleted folder into the trash folder DataUtils.batchMoveToFolder(mContentResolver, ids, Notes.ID_TRASH_FOLER); } - // 更新关联的小部件 if (widgets != null) { for (AppWidgetAttribute widget : widgets) { if (widget.widgetId != AppWidgetManager.INVALID_APPWIDGET_ID @@ -656,56 +533,40 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } } - /** - * 打开笔记(进入编辑界面) - * @param data 笔记数据项 - */ private void openNode(NoteItemData data) { Intent intent = new Intent(this, NoteEditActivity.class); - intent.setAction(Intent.ACTION_VIEW); // 设置动作为查看 - intent.putExtra(Intent.EXTRA_UID, data.getId()); // 传递笔记ID - this.startActivityForResult(intent, REQUEST_CODE_OPEN_NODE); // 启动笔记编辑活动 + intent.setAction(Intent.ACTION_VIEW); + intent.putExtra(Intent.EXTRA_UID, data.getId()); + this.startActivityForResult(intent, REQUEST_CODE_OPEN_NODE); } - /** - * 打开文件夹(进入子文件夹) - * @param data 文件夹数据项 - */ private void openFolder(NoteItemData data) { - mCurrentFolderId = data.getId(); // 更新当前文件夹ID - startAsyncNotesListQuery(); // 重新查询该文件夹下的内容 - // 根据文件夹类型更新状态 + mCurrentFolderId = data.getId(); + startAsyncNotesListQuery(); if (data.getId() == Notes.ID_CALL_RECORD_FOLDER) { - mState = ListEditState.CALL_RECORD_FOLDER; // 通话记录文件夹 - mAddNewNote.setVisibility(View.GONE); // 隐藏新建笔记按钮(不能在通话记录文件夹新建笔记) + mState = ListEditState.CALL_RECORD_FOLDER; + mAddNewNote.setVisibility(View.GONE); } else { - mState = ListEditState.SUB_FOLDER; // 普通子文件夹 + mState = ListEditState.SUB_FOLDER; } - // 设置标题栏文本 if (data.getId() == Notes.ID_CALL_RECORD_FOLDER) { mTitleBar.setText(R.string.call_record_folder_name); } else { - mTitleBar.setText(data.getSnippet()); // 使用文件夹名称作为标题 + mTitleBar.setText(data.getSnippet()); } - mTitleBar.setVisibility(View.VISIBLE); // 显示标题栏 + mTitleBar.setVisibility(View.VISIBLE); } - /** - * 点击事件处理(OnClickListener接口方法) - */ public void onClick(View v) { switch (v.getId()) { case R.id.btn_new_note: - createNewNote(); // 点击新建笔记按钮 + createNewNote(); break; default: break; } } - /** - * 显示软键盘 - */ private void showSoftInput() { InputMethodManager inputMethodManager = (InputMethodManager) getSystemService(Context.INPUT_METHOD_SERVICE); if (inputMethodManager != null) { @@ -713,100 +574,82 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } } - /** - * 隐藏软键盘 - * @param view 当前获得焦点的视图 - */ private void hideSoftInput(View view) { InputMethodManager inputMethodManager = (InputMethodManager) getSystemService(Context.INPUT_METHOD_SERVICE); inputMethodManager.hideSoftInputFromWindow(view.getWindowToken(), 0); } - /** - * 显示创建或修改文件夹的对话框 - * @param create true表示创建新文件夹,false表示修改现有文件夹名称 - */ private void showCreateOrModifyFolderDialog(final boolean create) { final AlertDialog.Builder builder = new AlertDialog.Builder(this); - // 加载对话框布局 View view = LayoutInflater.from(this).inflate(R.layout.dialog_edit_text, null); final EditText etName = (EditText) view.findViewById(R.id.et_foler_name); - showSoftInput(); // 显示软键盘 - // 根据是创建还是修改设置不同的初始文本和标题 + showSoftInput(); if (!create) { - // 修改文件夹名称 if (mFocusNoteDataItem != null) { - etName.setText(mFocusNoteDataItem.getSnippet()); // 设置当前文件夹名称为初始文本 + etName.setText(mFocusNoteDataItem.getSnippet()); builder.setTitle(getString(R.string.menu_folder_change_name)); } else { Log.e(TAG, "The long click data item is null"); return; } } else { - // 创建新文件夹 - etName.setText(""); // 清空文本 + etName.setText(""); builder.setTitle(this.getString(R.string.menu_create_folder)); } - builder.setPositiveButton(android.R.string.ok, null); // 确定按钮(稍后设置监听器) + builder.setPositiveButton(android.R.string.ok, null); builder.setNegativeButton(android.R.string.cancel, new DialogInterface.OnClickListener() { public void onClick(DialogInterface dialog, int which) { - hideSoftInput(etName); // 取消时隐藏软键盘 + hideSoftInput(etName); } }); - // 显示对话框并获取对话框实例 final Dialog dialog = builder.setView(view).show(); - // 获取确定按钮 final Button positive = (Button)dialog.findViewById(android.R.id.button1); positive.setOnClickListener(new OnClickListener() { public void onClick(View v) { - hideSoftInput(etName); // 隐藏软键盘 - String name = etName.getText().toString(); // 获取输入的文件夹名称 - // 检查文件夹名称是否已存在 + hideSoftInput(etName); + String name = etName.getText().toString(); if (DataUtils.checkVisibleFolderName(mContentResolver, name)) { Toast.makeText(NotesListActivity.this, getString(R.string.folder_exist, name), Toast.LENGTH_LONG).show(); - etName.setSelection(0, etName.length()); // 选中全部文本,方便修改 + etName.setSelection(0, etName.length()); return; } if (!create) { - // 修改现有文件夹名称 if (!TextUtils.isEmpty(name)) { ContentValues values = new ContentValues(); - values.put(NoteColumns.SNIPPET, name); // 新名称 + values.put(NoteColumns.SNIPPET, name); values.put(NoteColumns.TYPE, Notes.TYPE_FOLDER); - values.put(NoteColumns.LOCAL_MODIFIED, 1); // 标记为本地已修改(用于同步) + values.put(NoteColumns.LOCAL_MODIFIED, 1); mContentResolver.update(Notes.CONTENT_NOTE_URI, values, NoteColumns.ID + "=?", new String[] { - String.valueOf(mFocusNoteDataItem.getId()) // 更新指定ID的文件夹 + String.valueOf(mFocusNoteDataItem.getId()) }); } } else if (!TextUtils.isEmpty(name)) { - // 创建新文件夹 ContentValues values = new ContentValues(); - values.put(NoteColumns.SNIPPET, name); // 文件夹名称 + values.put(NoteColumns.SNIPPET, name); values.put(NoteColumns.TYPE, Notes.TYPE_FOLDER); - mContentResolver.insert(Notes.CONTENT_NOTE_URI, values); // 插入新记录 + mContentResolver.insert(Notes.CONTENT_NOTE_URI, values); } - dialog.dismiss(); // 关闭对话框 + dialog.dismiss(); } }); - // 初始时如果文本为空,禁用确定按钮 if (TextUtils.isEmpty(etName.getText())) { positive.setEnabled(false); } /** - * 当名称编辑框文本为空时,禁用确定按钮 + * When the name edit text is null, disable the positive button */ etName.addTextChangedListener(new TextWatcher() { public void beforeTextChanged(CharSequence s, int start, int count, int after) { // TODO Auto-generated method stub + } public void onTextChanged(CharSequence s, int start, int before, int count) { - // 根据文本是否为空启用或禁用确定按钮 if (TextUtils.isEmpty(etName.getText())) { positive.setEnabled(false); } else { @@ -816,33 +659,28 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt public void afterTextChanged(Editable s) { // TODO Auto-generated method stub + } }); } - /** - * 处理返回键按下事件 - */ @Override public void onBackPressed() { switch (mState) { case SUB_FOLDER: - // 在子文件夹内:返回根目录 mCurrentFolderId = Notes.ID_ROOT_FOLDER; mState = ListEditState.NOTE_LIST; - startAsyncNotesListQuery(); // 重新查询根目录内容 - mTitleBar.setVisibility(View.GONE); // 隐藏标题栏 + startAsyncNotesListQuery(); + mTitleBar.setVisibility(View.GONE); break; case CALL_RECORD_FOLDER: - // 在通话记录文件夹内:返回根目录 mCurrentFolderId = Notes.ID_ROOT_FOLDER; mState = ListEditState.NOTE_LIST; - mAddNewNote.setVisibility(View.VISIBLE); // 显示新建笔记按钮 - mTitleBar.setVisibility(View.GONE); // 隐藏标题栏 + mAddNewNote.setVisibility(View.VISIBLE); + mTitleBar.setVisibility(View.GONE); startAsyncNotesListQuery(); break; case NOTE_LIST: - // 在根目录:执行默认的返回操作(退出应用) super.onBackPressed(); break; default: @@ -850,14 +688,8 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } } - /** - * 更新桌面小部件 - * @param appWidgetId 小部件ID - * @param appWidgetType 小部件类型 - */ private void updateWidget(int appWidgetId, int appWidgetType) { Intent intent = new Intent(AppWidgetManager.ACTION_APPWIDGET_UPDATE); - // 根据小部件类型设置对应的广播接收器 if (appWidgetType == Notes.TYPE_WIDGET_2X) { intent.setClass(this, NoteWidgetProvider_2x.class); } else if (appWidgetType == Notes.TYPE_WIDGET_4X) { @@ -867,43 +699,33 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt return; } - // 设置要更新的小部件ID intent.putExtra(AppWidgetManager.EXTRA_APPWIDGET_IDS, new int[] { - appWidgetId + appWidgetId }); - sendBroadcast(intent); // 发送广播更新小部件 - setResult(RESULT_OK, intent); // 设置活动结果 + sendBroadcast(intent); + setResult(RESULT_OK, intent); } - /** - * 文件夹的上下文菜单创建监听器(长按文件夹时弹出) - */ private final OnCreateContextMenuListener mFolderOnCreateContextMenuListener = new OnCreateContextMenuListener() { public void onCreateContextMenu(ContextMenu menu, View v, ContextMenuInfo menuInfo) { if (mFocusNoteDataItem != null) { - menu.setHeaderTitle(mFocusNoteDataItem.getSnippet()); // 设置菜单标题为文件夹名称 - menu.add(0, MENU_FOLDER_VIEW, 0, R.string.menu_folder_view); // 查看文件夹 - menu.add(0, MENU_FOLDER_DELETE, 0, R.string.menu_folder_delete); // 删除文件夹 - menu.add(0, MENU_FOLDER_CHANGE_NAME, 0, R.string.menu_folder_change_name); // 修改名称 + menu.setHeaderTitle(mFocusNoteDataItem.getSnippet()); + menu.add(0, MENU_FOLDER_VIEW, 0, R.string.menu_folder_view); + menu.add(0, MENU_FOLDER_DELETE, 0, R.string.menu_folder_delete); + menu.add(0, MENU_FOLDER_CHANGE_NAME, 0, R.string.menu_folder_change_name); } } }; - /** - * 上下文菜单关闭时调用 - */ @Override public void onContextMenuClosed(Menu menu) { if (mNotesListView != null) { - mNotesListView.setOnCreateContextMenuListener(null); // 移除上下文菜单监听器 + mNotesListView.setOnCreateContextMenuListener(null); } super.onContextMenuClosed(menu); } - /** - * 处理上下文菜单项选择 - */ @Override public boolean onContextItemSelected(MenuItem item) { if (mFocusNoteDataItem == null) { @@ -912,10 +734,9 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } switch (item.getItemId()) { case MENU_FOLDER_VIEW: - openFolder(mFocusNoteDataItem); // 打开文件夹 + openFolder(mFocusNoteDataItem); break; case MENU_FOLDER_DELETE: - // 删除文件夹:弹出确认对话框 AlertDialog.Builder builder = new AlertDialog.Builder(this); builder.setTitle(getString(R.string.alert_title_delete)); builder.setIcon(android.R.drawable.ic_dialog_alert); @@ -923,81 +744,73 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt builder.setPositiveButton(android.R.string.ok, new DialogInterface.OnClickListener() { public void onClick(DialogInterface dialog, int which) { - deleteFolder(mFocusNoteDataItem.getId()); // 执行删除 + deleteFolder(mFocusNoteDataItem.getId()); } }); builder.setNegativeButton(android.R.string.cancel, null); builder.show(); break; case MENU_FOLDER_CHANGE_NAME: - showCreateOrModifyFolderDialog(false); // 显示修改名称对话框 + showCreateOrModifyFolderDialog(false); break; default: break; } + return true; } - /** - * 准备选项菜单(每次打开菜单时调用) - */ @Override public boolean onPrepareOptionsMenu(Menu menu) { - menu.clear(); // 清空现有菜单项 - // 根据当前状态加载不同的菜单 + menu.clear(); if (mState == ListEditState.NOTE_LIST) { - getMenuInflater().inflate(R.menu.note_list, menu); // 根目录菜单 - // 设置同步或取消同步菜单项标题 + getMenuInflater().inflate(R.menu.note_list, menu); + // set sync or sync_cancel menu.findItem(R.id.menu_sync).setTitle( GTaskSyncService.isSyncing() ? R.string.menu_sync_cancel : R.string.menu_sync); } else if (mState == ListEditState.SUB_FOLDER) { - getMenuInflater().inflate(R.menu.sub_folder, menu); // 子文件夹菜单 + getMenuInflater().inflate(R.menu.sub_folder, menu); } else if (mState == ListEditState.CALL_RECORD_FOLDER) { - getMenuInflater().inflate(R.menu.call_record_folder, menu); // 通话记录文件夹菜单 + getMenuInflater().inflate(R.menu.call_record_folder, menu); } else { Log.e(TAG, "Wrong state:" + mState); } return true; } - /** - * 处理选项菜单项点击 - */ @Override public boolean onOptionsItemSelected(MenuItem item) { switch (item.getItemId()) { case R.id.menu_new_folder: { - showCreateOrModifyFolderDialog(true); // 创建新文件夹 + showCreateOrModifyFolderDialog(true); break; } case R.id.menu_export_text: { - exportNoteToText(); // 导出笔记为文本文件 + exportNoteToText(); break; } case R.id.menu_sync: { if (isSyncMode()) { - // 同步模式:根据当前状态执行同步或取消同步 if (TextUtils.equals(item.getTitle(), getString(R.string.menu_sync))) { - GTaskSyncService.startSync(this); // 开始同步 + GTaskSyncService.startSync(this); } else { - GTaskSyncService.cancelSync(this); // 取消同步 + GTaskSyncService.cancelSync(this); } } else { - // 非同步模式:跳转到设置界面 startPreferenceActivity(); } break; } case R.id.menu_setting: { - startPreferenceActivity(); // 跳转到设置界面 + startPreferenceActivity(); break; } case R.id.menu_new_note: { - createNewNote(); // 新建笔记(在子文件夹菜单中) + createNewNote(); break; } case R.id.menu_search: - onSearchRequested(); // 触发搜索 + onSearchRequested(); break; default: break; @@ -1005,32 +818,24 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt return true; } - /** - * 处理搜索请求 - */ @Override public boolean onSearchRequested() { startSearch(null, false, null /* appData */, false); return true; } - /** - * 将笔记导出为文本文件 - */ private void exportNoteToText() { final BackupUtils backup = BackupUtils.getInstance(NotesListActivity.this); - // 使用AsyncTask在后台执行导出操作 new AsyncTask() { + @Override protected Integer doInBackground(Void... unused) { - return backup.exportToText(); // 执行导出 + return backup.exportToText(); } @Override protected void onPostExecute(Integer result) { - // 在UI线程显示导出结果 if (result == BackupUtils.STATE_SD_CARD_UNMOUONTED) { - // SD卡未挂载 AlertDialog.Builder builder = new AlertDialog.Builder(NotesListActivity.this); builder.setTitle(NotesListActivity.this .getString(R.string.failed_sdcard_export)); @@ -1039,7 +844,6 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt builder.setPositiveButton(android.R.string.ok, null); builder.show(); } else if (result == BackupUtils.STATE_SUCCESS) { - // 导出成功 AlertDialog.Builder builder = new AlertDialog.Builder(NotesListActivity.this); builder.setTitle(NotesListActivity.this .getString(R.string.success_sdcard_export)); @@ -1049,7 +853,6 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt builder.setPositiveButton(android.R.string.ok, null); builder.show(); } else if (result == BackupUtils.STATE_SYSTEM_ERROR) { - // 系统错误 AlertDialog.Builder builder = new AlertDialog.Builder(NotesListActivity.this); builder.setTitle(NotesListActivity.this .getString(R.string.failed_sdcard_export)); @@ -1059,63 +862,47 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt builder.show(); } } + }.execute(); } - /** - * 判断是否处于同步模式(是否设置了同步账户) - */ private boolean isSyncMode() { return NotesPreferenceActivity.getSyncAccountName(this).trim().length() > 0; } - /** - * 启动设置活动 - */ private void startPreferenceActivity() { Activity from = getParent() != null ? getParent() : this; Intent intent = new Intent(from, NotesPreferenceActivity.class); from.startActivityIfNeeded(intent, -1); } - /** - * 列表项点击监听器 - */ private class OnListItemClickListener implements OnItemClickListener { + public void onItemClick(AdapterView parent, View view, int position, long id) { - // 检查点击的视图是否是NotesListItem(我们的自定义列表项视图) if (view instanceof NotesListItem) { - NoteItemData item = ((NotesListItem) view).getItemData(); // 获取对应的数据项 - - // 如果当前处于多选模式 + NoteItemData item = ((NotesListItem) view).getItemData(); if (mNotesListAdapter.isInChoiceMode()) { - // 只允许选择笔记(不能选择文件夹) if (item.getType() == Notes.TYPE_NOTE) { - // 调整位置(考虑头部视图) position = position - mNotesListView.getHeaderViewsCount(); - // 切换选中状态 mModeCallBack.onItemCheckedStateChanged(null, position, id, !mNotesListAdapter.isSelectedItem(position)); } - return; // 在多选模式下不执行其他操作 + return; } - // 根据当前状态处理点击 switch (mState) { case NOTE_LIST: - // 根目录下:点击文件夹则打开,点击笔记则编辑 if (item.getType() == Notes.TYPE_FOLDER || item.getType() == Notes.TYPE_SYSTEM) { - openFolder(item); // 打开文件夹 + openFolder(item); } else if (item.getType() == Notes.TYPE_NOTE) { - openNode(item); // 打开笔记 + openNode(item); } else { Log.e(TAG, "Wrong note type in NOTE_LIST"); } break; case SUB_FOLDER: case CALL_RECORD_FOLDER: - // 在文件夹内:只能点击笔记进行编辑 if (item.getType() == Notes.TYPE_NOTE) { openNode(item); } else { @@ -1127,17 +914,13 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } } } + } - /** - * 开始查询可用的目标文件夹(用于移动操作) - */ private void startQueryDestinationFolders() { - // 基本查询条件:类型是文件夹,且不是垃圾箱,且不是当前文件夹 String selection = NoteColumns.TYPE + "=? AND " + NoteColumns.PARENT_ID + "<>? AND " + NoteColumns.ID + "<>?"; - // 如果在子文件夹状态,额外包含根目录 selection = (mState == ListEditState.NOTE_LIST) ? selection: - "(" + selection + ") OR (" + NoteColumns.ID + "=" + Notes.ID_ROOT_FOLDER + ")"; + "(" + selection + ") OR (" + NoteColumns.ID + "=" + Notes.ID_ROOT_FOLDER + ")"; mBackgroundQueryHandler.startQuery(FOLDER_LIST_QUERY_TOKEN, null, @@ -1145,34 +928,27 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt FoldersListAdapter.PROJECTION, selection, new String[] { - String.valueOf(Notes.TYPE_FOLDER), // 类型:文件夹 - String.valueOf(Notes.ID_TRASH_FOLER), // 排除垃圾箱 - String.valueOf(mCurrentFolderId) // 排除当前文件夹 + String.valueOf(Notes.TYPE_FOLDER), + String.valueOf(Notes.ID_TRASH_FOLER), + String.valueOf(mCurrentFolderId) }, - NoteColumns.MODIFIED_DATE + " DESC"); // 按修改日期降序排序 + NoteColumns.MODIFIED_DATE + " DESC"); } - /** - * 列表项长按监听器(OnItemLongClickListener接口方法) - */ public boolean onItemLongClick(AdapterView parent, View view, int position, long id) { if (view instanceof NotesListItem) { - mFocusNoteDataItem = ((NotesListItem) view).getItemData(); // 记录长按的数据项 - // 如果长按的是笔记且不在多选模式下,启动多选模式 + mFocusNoteDataItem = ((NotesListItem) view).getItemData(); if (mFocusNoteDataItem.getType() == Notes.TYPE_NOTE && !mNotesListAdapter.isInChoiceMode()) { if (mNotesListView.startActionMode(mModeCallBack) != null) { - // 启动成功,设置当前项为选中状态 mModeCallBack.onItemCheckedStateChanged(null, position, id, true); - // 提供触觉反馈(震动) mNotesListView.performHapticFeedback(HapticFeedbackConstants.LONG_PRESS); } else { Log.e(TAG, "startActionMode fails"); } } else if (mFocusNoteDataItem.getType() == Notes.TYPE_FOLDER) { - // 如果长按的是文件夹,设置上下文菜单监听器 mNotesListView.setOnCreateContextMenuListener(mFolderOnCreateContextMenuListener); } } - return false; // 返回false,让系统继续处理长按事件(显示上下文菜单等) + return false; } -} \ No newline at end of file +} diff --git a/src/notes/ui/NotesListAdapter.java b/src/notes/ui/NotesListAdapter.java index 44bfb13..51c9cb9 100644 --- a/src/notes/ui/NotesListAdapter.java +++ b/src/notes/ui/NotesListAdapter.java @@ -30,110 +30,58 @@ import java.util.HashMap; import java.util.HashSet; import java.util.Iterator; -/** - * 笔记列表适配器,用于管理笔记列表的显示和多选操作 - * 继承自CursorAdapter,专门处理数据库游标数据 - */ + public class NotesListAdapter extends CursorAdapter { private static final String TAG = "NotesListAdapter"; - private Context mContext; // 上下文对象 - // 存储选中状态的映射表,key为位置索引,value为是否选中 + private Context mContext; private HashMap mSelectedIndex; - private int mNotesCount; // 笔记总数(不包括文件夹) - private boolean mChoiceMode; // 标记是否处于多选模式 + private int mNotesCount; + private boolean mChoiceMode; - /** - * 小部件属性内部类,用于存储笔记关联的桌面小部件信息 - */ public static class AppWidgetAttribute { - public int widgetId; // 小部件的唯一标识ID - public int widgetType; // 小部件的类型(如2x2、4x4等) + public int widgetId; + public int widgetType; }; - /** - * 构造函数 - * @param context 上下文环境 - */ public NotesListAdapter(Context context) { - super(context, null); // 调用父类构造函数,初始游标为null - mSelectedIndex = new HashMap(); // 初始化选中状态记录表 + super(context, null); + mSelectedIndex = new HashMap(); mContext = context; - mNotesCount = 0; // 初始笔记数量为0 + mNotesCount = 0; } - /** - * 创建新的列表项视图 - * @param context 上下文环境 - * @param cursor 数据库游标 - * @param parent 父视图容器 - * @return 新创建的笔记列表项视图 - */ @Override public View newView(Context context, Cursor cursor, ViewGroup parent) { - // 创建自定义的笔记列表项视图 return new NotesListItem(context); } - /** - * 将数据绑定到已有的列表项视图 - * @param view 要绑定数据的视图 - * @param context 上下文环境 - * @param cursor 数据库游标 - */ @Override public void bindView(View view, Context context, Cursor cursor) { - // 检查视图类型是否正确 if (view instanceof NotesListItem) { - // 从游标数据创建笔记数据对象 NoteItemData itemData = new NoteItemData(context, cursor); - // 将数据绑定到列表项,并传递多选状态信息 ((NotesListItem) view).bind(context, itemData, mChoiceMode, isSelectedItem(cursor.getPosition())); } } - /** - * 设置指定位置的选中状态 - * @param position 列表中的位置索引 - * @param checked 是否选中(true为选中,false为取消选中) - */ public void setCheckedItem(final int position, final boolean checked) { - // 更新选中状态映射表 mSelectedIndex.put(position, checked); - // 通知数据发生变化,需要刷新列表显示 notifyDataSetChanged(); } - /** - * 检查当前是否处于多选模式 - * @return 如果处于多选模式返回true,否则返回false - */ public boolean isInChoiceMode() { return mChoiceMode; } - /** - * 设置多选模式开关 - * @param mode true进入多选模式,false退出多选模式 - */ public void setChoiceMode(boolean mode) { - // 清空所有选中状态记录 mSelectedIndex.clear(); mChoiceMode = mode; } - /** - * 全选或取消全选所有笔记(不包括文件夹) - * @param checked true全选所有笔记,false取消全选 - */ public void selectAll(boolean checked) { - // 获取当前数据游标 Cursor cursor = getCursor(); - // 遍历所有列表项 for (int i = 0; i < getCount(); i++) { - // 将游标移动到指定位置 if (cursor.moveToPosition(i)) { - // 只对笔记类型进行选中操作,跳过文件夹 if (NoteItemData.getNoteType(cursor) == Notes.TYPE_NOTE) { setCheckedItem(i, checked); } @@ -141,24 +89,14 @@ public class NotesListAdapter extends CursorAdapter { } } - /** - * 获取所有选中项的ID集合 - * @return 包含选中项ID的集合 - */ public HashSet getSelectedItemIds() { - // 创建ID集合 HashSet itemSet = new HashSet(); - // 遍历所有记录的位置 for (Integer position : mSelectedIndex.keySet()) { - // 检查该位置是否被选中 if (mSelectedIndex.get(position) == true) { - // 获取该项的笔记ID Long id = getItemId(position); - // 安全检查:确保不是根文件夹的ID if (id == Notes.ID_ROOT_FOLDER) { Log.d(TAG, "Wrong item id, should not happen"); } else { - // 将有效ID添加到集合中 itemSet.add(id); } } @@ -167,30 +105,19 @@ public class NotesListAdapter extends CursorAdapter { return itemSet; } - /** - * 获取所有选中项关联的小部件属性 - * @return 小部件属性集合,用于更新桌面小部件 - */ public HashSet getSelectedWidget() { - // 创建小部件属性集合 HashSet itemSet = new HashSet(); - // 遍历所有选中项 for (Integer position : mSelectedIndex.keySet()) { if (mSelectedIndex.get(position) == true) { - // 获取对应位置的数据游标 Cursor c = (Cursor) getItem(position); if (c != null) { - // 创建小部件属性对象 AppWidgetAttribute widget = new AppWidgetAttribute(); - // 从游标数据创建笔记对象 NoteItemData item = new NoteItemData(mContext, c); - // 设置小部件属性 widget.widgetId = item.getWidgetId(); widget.widgetType = item.getWidgetType(); itemSet.add(widget); /** - * 重要:不要在这里关闭游标! - * 游标由适配器统一管理,外部关闭会导致适配器出错 + * Don't close cursor here, only the adapter could close it */ } else { Log.e(TAG, "Invalid cursor"); @@ -201,21 +128,14 @@ public class NotesListAdapter extends CursorAdapter { return itemSet; } - /** - * 获取选中项的数量 - * @return 选中项的数量 - */ public int getSelectedCount() { - // 获取所有选中状态值 Collection values = mSelectedIndex.values(); if (null == values) { return 0; } - // 使用迭代器遍历统计选中数量 Iterator iter = values.iterator(); int count = 0; while (iter.hasNext()) { - // 如果状态为true,计数加1 if (true == iter.next()) { count++; } @@ -223,65 +143,37 @@ public class NotesListAdapter extends CursorAdapter { return count; } - /** - * 检查是否所有笔记都已被选中 - * @return 如果全部选中返回true,否则返回false - */ public boolean isAllSelected() { - // 获取当前选中数量 int checkedCount = getSelectedCount(); - // 全选条件:选中数量等于笔记总数且不为0 return (checkedCount != 0 && checkedCount == mNotesCount); } - /** - * 检查指定位置是否被选中 - * @param position 要检查的位置 - * @return 如果选中返回true,否则返回false - */ public boolean isSelectedItem(final int position) { - // 如果映射表中没有该位置的记录,说明未选中 if (null == mSelectedIndex.get(position)) { return false; } return mSelectedIndex.get(position); } - /** - * 当数据内容发生变化时自动调用 - */ @Override protected void onContentChanged() { super.onContentChanged(); - // 重新计算笔记数量 calcNotesCount(); } - /** - * 更换数据游标时调用 - * @param cursor 新的数据游标 - */ @Override public void changeCursor(Cursor cursor) { super.changeCursor(cursor); - // 重新计算笔记数量 calcNotesCount(); } - /** - * 计算当前列表中笔记(非文件夹)的总数量 - * 这个方法用于支持全选功能的状态判断 - */ private void calcNotesCount() { - mNotesCount = 0; // 重置计数器 - // 遍历所有列表项 + mNotesCount = 0; for (int i = 0; i < getCount(); i++) { - // 获取指定位置的数据 Cursor c = (Cursor) getItem(i); if (c != null) { - // 只统计笔记类型,排除文件夹 if (NoteItemData.getNoteType(c) == Notes.TYPE_NOTE) { - mNotesCount++; // 笔记数量加1 + mNotesCount++; } } else { Log.e(TAG, "Invalid cursor"); @@ -289,4 +181,4 @@ public class NotesListAdapter extends CursorAdapter { } } } -} \ No newline at end of file +} diff --git a/src/notes/ui/NotesListItem.java b/src/notes/ui/NotesListItem.java index 52a530e..1221e80 100644 --- a/src/notes/ui/NotesListItem.java +++ b/src/notes/ui/NotesListItem.java @@ -29,143 +29,94 @@ import net.micode.notes.data.Notes; import net.micode.notes.tool.DataUtils; import net.micode.notes.tool.ResourceParser.NoteItemBgResources; -/** - * 笔记列表项自定义视图,用于显示单个笔记或文件夹项 - * 继承自LinearLayout,包含标题、时间、提醒图标等子视图 - */ + public class NotesListItem extends LinearLayout { - private ImageView mAlert; // 提醒图标(时钟或通话记录图标) - private TextView mTitle; // 标题/内容文本 - private TextView mTime; // 修改时间文本 - private TextView mCallName; // 通话记录联系人姓名 - private NoteItemData mItemData; // 绑定的数据对象 - private CheckBox mCheckBox; // 多选模式下的复选框 + private ImageView mAlert; + private TextView mTitle; + private TextView mTime; + private TextView mCallName; + private NoteItemData mItemData; + private CheckBox mCheckBox; - /** - * 构造函数 - * @param context 上下文环境 - */ public NotesListItem(Context context) { super(context); - // 从布局文件加载视图 inflate(context, R.layout.note_item, this); - // 初始化各个子视图组件 mAlert = (ImageView) findViewById(R.id.iv_alert_icon); mTitle = (TextView) findViewById(R.id.tv_title); mTime = (TextView) findViewById(R.id.tv_time); mCallName = (TextView) findViewById(R.id.tv_name); - // 使用系统预定义的checkbox ID mCheckBox = (CheckBox) findViewById(android.R.id.checkbox); } - /** - * 将数据绑定到视图上,根据数据类型和状态显示不同的UI - * @param context 上下文环境 - * @param data 笔记或文件夹数据 - * @param choiceMode 是否处于多选模式 - * @param checked 在多选模式下是否被选中 - */ public void bind(Context context, NoteItemData data, boolean choiceMode, boolean checked) { - // 处理多选模式下的复选框显示 if (choiceMode && data.getType() == Notes.TYPE_NOTE) { - // 多选模式且是笔记类型:显示复选框并设置选中状态 mCheckBox.setVisibility(View.VISIBLE); mCheckBox.setChecked(checked); } else { - // 非多选模式或文件夹类型:隐藏复选框 mCheckBox.setVisibility(View.GONE); } - // 保存数据引用 mItemData = data; - - // 根据数据类型显示不同的UI布局 if (data.getId() == Notes.ID_CALL_RECORD_FOLDER) { - // 通话记录文件夹的特殊显示 - mCallName.setVisibility(View.GONE); // 隐藏联系人姓名 - mAlert.setVisibility(View.VISIBLE); // 显示图标 - mTitle.setTextAppearance(context, R.style.TextAppearancePrimaryItem); // 设置主文本样式 - // 设置文件夹名称和文件数量显示 + mCallName.setVisibility(View.GONE); + mAlert.setVisibility(View.VISIBLE); + mTitle.setTextAppearance(context, R.style.TextAppearancePrimaryItem); mTitle.setText(context.getString(R.string.call_record_folder_name) + context.getString(R.string.format_folder_files_count, data.getNotesCount())); - mAlert.setImageResource(R.drawable.call_record); // 设置通话记录图标 + mAlert.setImageResource(R.drawable.call_record); } else if (data.getParentId() == Notes.ID_CALL_RECORD_FOLDER) { - // 通话记录笔记的特殊显示 - mCallName.setVisibility(View.VISIBLE); // 显示联系人姓名 - mCallName.setText(data.getCallName()); // 设置联系人姓名 - mTitle.setTextAppearance(context,R.style.TextAppearanceSecondaryItem); // 设置次文本样式 - mTitle.setText(DataUtils.getFormattedSnippet(data.getSnippet())); // 设置格式化后的内容摘要 - // 根据是否有提醒设置提醒图标 + mCallName.setVisibility(View.VISIBLE); + mCallName.setText(data.getCallName()); + mTitle.setTextAppearance(context,R.style.TextAppearanceSecondaryItem); + mTitle.setText(DataUtils.getFormattedSnippet(data.getSnippet())); if (data.hasAlert()) { - mAlert.setImageResource(R.drawable.clock); // 时钟图标 + mAlert.setImageResource(R.drawable.clock); mAlert.setVisibility(View.VISIBLE); } else { mAlert.setVisibility(View.GONE); } } else { - // 普通笔记或文件夹的显示 - mCallName.setVisibility(View.GONE); // 隐藏联系人姓名 - mTitle.setTextAppearance(context, R.style.TextAppearancePrimaryItem); // 设置主文本样式 + mCallName.setVisibility(View.GONE); + mTitle.setTextAppearance(context, R.style.TextAppearancePrimaryItem); if (data.getType() == Notes.TYPE_FOLDER) { - // 文件夹显示:名称 + 文件数量 mTitle.setText(data.getSnippet() + context.getString(R.string.format_folder_files_count, - data.getNotesCount())); - mAlert.setVisibility(View.GONE); // 文件夹不显示提醒图标 + data.getNotesCount())); + mAlert.setVisibility(View.GONE); } else { - // 普通笔记显示:内容摘要 mTitle.setText(DataUtils.getFormattedSnippet(data.getSnippet())); - // 根据是否有提醒设置提醒图标 if (data.hasAlert()) { - mAlert.setImageResource(R.drawable.clock); // 时钟图标 + mAlert.setImageResource(R.drawable.clock); mAlert.setVisibility(View.VISIBLE); } else { mAlert.setVisibility(View.GONE); } } } - - // 设置相对时间显示(如"2分钟前"、"昨天"等) mTime.setText(DateUtils.getRelativeTimeSpanString(data.getModifiedDate())); - // 根据位置和类型设置背景 setBackground(data); } - /** - * 根据数据项的位置和类型设置不同的背景 - * 实现列表项的分组视觉效果(第一个、最后一个、中间项等) - * @param data 笔记数据项 - */ private void setBackground(NoteItemData data) { - int id = data.getBgColorId(); // 获取背景颜色ID + int id = data.getBgColorId(); if (data.getType() == Notes.TYPE_NOTE) { - // 笔记类型的背景设置 if (data.isSingle() || data.isOneFollowingFolder()) { - // 单个笔记或紧跟在文件夹后的单个笔记:单一样式背景 setBackgroundResource(NoteItemBgResources.getNoteBgSingleRes(id)); } else if (data.isLast()) { - // 列表中的最后一个笔记:底部样式背景 setBackgroundResource(NoteItemBgResources.getNoteBgLastRes(id)); } else if (data.isFirst() || data.isMultiFollowingFolder()) { - // 列表中的第一个笔记或多个紧跟在文件夹后的笔记:顶部样式背景 setBackgroundResource(NoteItemBgResources.getNoteBgFirstRes(id)); } else { - // 中间位置的笔记:普通样式背景 setBackgroundResource(NoteItemBgResources.getNoteBgNormalRes(id)); } } else { - // 文件夹类型的背景:统一使用文件夹背景 setBackgroundResource(NoteItemBgResources.getFolderBgRes()); } } - /** - * 获取当前绑定的数据对象 - * @return NoteItemData对象 - */ public NoteItemData getItemData() { return mItemData; } -} \ No newline at end of file +} diff --git a/src/notes/ui/NotesPreferenceActivity.java b/src/notes/ui/NotesPreferenceActivity.java index f67f37b..07c5f7e 100644 --- a/src/notes/ui/NotesPreferenceActivity.java +++ b/src/notes/ui/NotesPreferenceActivity.java @@ -47,67 +47,55 @@ import net.micode.notes.data.Notes; import net.micode.notes.data.Notes.NoteColumns; import net.micode.notes.gtask.remote.GTaskSyncService; -/** - * 笔记应用的设置活动,用于管理同步账户和偏好设置 - * 继承自PreferenceActivity,提供Google任务同步功能配置 - */ + public class NotesPreferenceActivity extends PreferenceActivity { - // 偏好设置文件名 public static final String PREFERENCE_NAME = "notes_preferences"; - // 同步账户名称的键 + public static final String PREFERENCE_SYNC_ACCOUNT_NAME = "pref_key_account_name"; - // 最后同步时间的键 + public static final String PREFERENCE_LAST_SYNC_TIME = "pref_last_sync_time"; - // 背景颜色设置的键 + public static final String PREFERENCE_SET_BG_COLOR_KEY = "pref_key_bg_random_appear"; - // 同步账户分类的键 private static final String PREFERENCE_SYNC_ACCOUNT_KEY = "pref_sync_account_key"; - // 账户权限过滤器键 + private static final String AUTHORITIES_FILTER_KEY = "authorities"; - private PreferenceCategory mAccountCategory; // 账户设置分类 - private GTaskReceiver mReceiver; // 同步服务广播接收器 - private Account[] mOriAccounts; // 原始账户列表 - private boolean mHasAddedAccount; // 标记是否添加了新账户 + private PreferenceCategory mAccountCategory; + + private GTaskReceiver mReceiver; + + private Account[] mOriAccounts; + + private boolean mHasAddedAccount; - /** - * Activity创建时的初始化方法 - */ @Override protected void onCreate(Bundle icicle) { super.onCreate(icicle); - // 在ActionBar中显示返回按钮 + /* using the app icon for navigation */ getActionBar().setDisplayHomeAsUpEnabled(true); - // 从XML资源加载偏好设置 addPreferencesFromResource(R.xml.preferences); - // 查找账户设置分类 mAccountCategory = (PreferenceCategory) findPreference(PREFERENCE_SYNC_ACCOUNT_KEY); - // 创建广播接收器监听同步状态变化 mReceiver = new GTaskReceiver(); IntentFilter filter = new IntentFilter(); filter.addAction(GTaskSyncService.GTASK_SERVICE_BROADCAST_NAME); registerReceiver(mReceiver, filter); mOriAccounts = null; - // 加载设置页面的自定义头部布局 View header = LayoutInflater.from(this).inflate(R.layout.settings_header, null); getListView().addHeaderView(header, null, true); } - /** - * Activity恢复时调用,处理账户变化 - */ @Override protected void onResume() { super.onResume(); - // 如果用户添加了新账户,自动设置同步账户 + // need to set sync account automatically if user has added a new + // account if (mHasAddedAccount) { Account[] accounts = getGoogleAccounts(); - // 比较新旧账户列表,找到新添加的账户 if (mOriAccounts != null && accounts.length > mOriAccounts.length) { for (Account accountNew : accounts) { boolean found = false; @@ -118,7 +106,6 @@ public class NotesPreferenceActivity extends PreferenceActivity { } } if (!found) { - // 设置新账户为同步账户 setSyncAccount(accountNew.name); break; } @@ -126,13 +113,9 @@ public class NotesPreferenceActivity extends PreferenceActivity { } } - // 刷新界面显示 refreshUI(); } - /** - * Activity销毁时清理资源 - */ @Override protected void onDestroy() { if (mReceiver != null) { @@ -141,11 +124,8 @@ public class NotesPreferenceActivity extends PreferenceActivity { super.onDestroy(); } - /** - * 加载账户设置项 - */ private void loadAccountPreference() { - mAccountCategory.removeAll(); // 清空现有设置项 + mAccountCategory.removeAll(); Preference accountPref = new Preference(this); final String defaultAccount = getSyncAccountName(this); @@ -153,18 +133,18 @@ public class NotesPreferenceActivity extends PreferenceActivity { accountPref.setSummary(getString(R.string.preferences_account_summary)); accountPref.setOnPreferenceClickListener(new OnPreferenceClickListener() { public boolean onPreferenceClick(Preference preference) { - // 检查是否正在同步,同步过程中不允许修改账户 if (!GTaskSyncService.isSyncing()) { if (TextUtils.isEmpty(defaultAccount)) { - // 首次设置账户,显示选择账户对话框 + // the first time to set account showSelectAccountAlertDialog(); } else { - // 已设置过账户,显示确认对话框 + // if the account has already been set, we need to promp + // user about the risk showChangeAccountConfirmAlertDialog(); } } else { Toast.makeText(NotesPreferenceActivity.this, - R.string.preferences_toast_cannot_change_account, Toast.LENGTH_SHORT) + R.string.preferences_toast_cannot_change_account, Toast.LENGTH_SHORT) .show(); } return true; @@ -174,14 +154,11 @@ public class NotesPreferenceActivity extends PreferenceActivity { mAccountCategory.addPreference(accountPref); } - /** - * 加载同步按钮状态 - */ private void loadSyncButton() { Button syncButton = (Button) findViewById(R.id.preference_sync_button); TextView lastSyncTimeView = (TextView) findViewById(R.id.prefenerece_sync_status_textview); - // 根据同步状态设置按钮文本和点击事件 + // set button state if (GTaskSyncService.isSyncing()) { syncButton.setText(getString(R.string.preferences_button_sync_cancel)); syncButton.setOnClickListener(new View.OnClickListener() { @@ -197,44 +174,33 @@ public class NotesPreferenceActivity extends PreferenceActivity { } }); } - // 只有设置了同步账户才能启用同步按钮 syncButton.setEnabled(!TextUtils.isEmpty(getSyncAccountName(this))); - // 设置最后同步时间显示 + // set last sync time if (GTaskSyncService.isSyncing()) { - // 显示同步进度 lastSyncTimeView.setText(GTaskSyncService.getProgressString()); lastSyncTimeView.setVisibility(View.VISIBLE); } else { long lastSyncTime = getLastSyncTime(this); if (lastSyncTime != 0) { - // 格式化显示最后同步时间 lastSyncTimeView.setText(getString(R.string.preferences_last_sync_time, DateFormat.format(getString(R.string.preferences_last_sync_time_format), lastSyncTime))); lastSyncTimeView.setVisibility(View.VISIBLE); } else { - // 从未同步过,隐藏时间显示 lastSyncTimeView.setVisibility(View.GONE); } } } - /** - * 刷新整个界面 - */ private void refreshUI() { loadAccountPreference(); loadSyncButton(); } - /** - * 显示选择账户对话框 - */ private void showSelectAccountAlertDialog() { AlertDialog.Builder dialogBuilder = new AlertDialog.Builder(this); - // 设置自定义标题布局 View titleView = LayoutInflater.from(this).inflate(R.layout.account_dialog_title, null); TextView titleTextView = (TextView) titleView.findViewById(R.id.account_dialog_title); titleTextView.setText(getString(R.string.preferences_dialog_select_account_title)); @@ -242,49 +208,45 @@ public class NotesPreferenceActivity extends PreferenceActivity { subtitleTextView.setText(getString(R.string.preferences_dialog_select_account_tips)); dialogBuilder.setCustomTitle(titleView); - dialogBuilder.setPositiveButton(null, null); // 不显示确定按钮 + dialogBuilder.setPositiveButton(null, null); Account[] accounts = getGoogleAccounts(); String defAccount = getSyncAccountName(this); - mOriAccounts = accounts; // 保存当前账户列表 - mHasAddedAccount = false; // 重置添加账户标记 + mOriAccounts = accounts; + mHasAddedAccount = false; if (accounts.length > 0) { - // 创建账户选择列表 CharSequence[] items = new CharSequence[accounts.length]; final CharSequence[] itemMapping = items; int checkedItem = -1; int index = 0; for (Account account : accounts) { if (TextUtils.equals(account.name, defAccount)) { - checkedItem = index; // 标记当前选中的账户 + checkedItem = index; } items[index++] = account.name; } dialogBuilder.setSingleChoiceItems(items, checkedItem, new DialogInterface.OnClickListener() { public void onClick(DialogInterface dialog, int which) { - // 用户选择账户后设置同步账户 setSyncAccount(itemMapping[which].toString()); dialog.dismiss(); - refreshUI(); // 刷新界面 + refreshUI(); } }); } - // 添加"添加账户"选项 View addAccountView = LayoutInflater.from(this).inflate(R.layout.add_account_text, null); dialogBuilder.setView(addAccountView); final AlertDialog dialog = dialogBuilder.show(); addAccountView.setOnClickListener(new View.OnClickListener() { public void onClick(View v) { - mHasAddedAccount = true; // 标记正在添加账户 - // 启动系统添加账户界面 + mHasAddedAccount = true; Intent intent = new Intent("android.settings.ADD_ACCOUNT_SETTINGS"); intent.putExtra(AUTHORITIES_FILTER_KEY, new String[] { - "gmail-ls" // 限制只显示Gmail账户 + "gmail-ls" }); startActivityForResult(intent, -1); dialog.dismiss(); @@ -292,21 +254,17 @@ public class NotesPreferenceActivity extends PreferenceActivity { }); } - /** - * 显示更改账户确认对话框 - */ private void showChangeAccountConfirmAlertDialog() { AlertDialog.Builder dialogBuilder = new AlertDialog.Builder(this); View titleView = LayoutInflater.from(this).inflate(R.layout.account_dialog_title, null); TextView titleTextView = (TextView) titleView.findViewById(R.id.account_dialog_title); titleTextView.setText(getString(R.string.preferences_dialog_change_account_title, - getSyncAccountName(this))); // 显示当前账户名 + getSyncAccountName(this))); TextView subtitleTextView = (TextView) titleView.findViewById(R.id.account_dialog_subtitle); subtitleTextView.setText(getString(R.string.preferences_dialog_change_account_warn_msg)); dialogBuilder.setCustomTitle(titleView); - // 提供三个操作选项:更改账户、移除账户、取消 CharSequence[] menuItemArray = new CharSequence[] { getString(R.string.preferences_menu_change_account), getString(R.string.preferences_menu_remove_account), @@ -315,32 +273,22 @@ public class NotesPreferenceActivity extends PreferenceActivity { dialogBuilder.setItems(menuItemArray, new DialogInterface.OnClickListener() { public void onClick(DialogInterface dialog, int which) { if (which == 0) { - // 更改账户 showSelectAccountAlertDialog(); } else if (which == 1) { - // 移除账户 removeSyncAccount(); refreshUI(); } - // which == 2 取消操作,不做任何事 } }); dialogBuilder.show(); } - /** - * 获取设备上的Google账户列表 - */ private Account[] getGoogleAccounts() { AccountManager accountManager = AccountManager.get(this); - return accountManager.getAccountsByType("com.google"); // Google账户类型 + return accountManager.getAccountsByType("com.google"); } - /** - * 设置同步账户 - */ private void setSyncAccount(String account) { - // 只有当账户发生变化时才更新 if (!getSyncAccountName(this).equals(account)) { SharedPreferences settings = getSharedPreferences(PREFERENCE_NAME, Context.MODE_PRIVATE); SharedPreferences.Editor editor = settings.edit(); @@ -351,15 +299,15 @@ public class NotesPreferenceActivity extends PreferenceActivity { } editor.commit(); - // 重置最后同步时间 + // clean up last sync time setLastSyncTime(this, 0); - // 在新线程中清理本地同步信息 + // clean up local gtask related info new Thread(new Runnable() { public void run() { ContentValues values = new ContentValues(); - values.put(NoteColumns.GTASK_ID, ""); // 清空任务ID - values.put(NoteColumns.SYNC_ID, 0); // 重置同步ID + values.put(NoteColumns.GTASK_ID, ""); + values.put(NoteColumns.SYNC_ID, 0); getContentResolver().update(Notes.CONTENT_NOTE_URI, values, null, null); } }).start(); @@ -370,13 +318,9 @@ public class NotesPreferenceActivity extends PreferenceActivity { } } - /** - * 移除同步账户 - */ private void removeSyncAccount() { SharedPreferences settings = getSharedPreferences(PREFERENCE_NAME, Context.MODE_PRIVATE); SharedPreferences.Editor editor = settings.edit(); - // 移除账户相关设置 if (settings.contains(PREFERENCE_SYNC_ACCOUNT_NAME)) { editor.remove(PREFERENCE_SYNC_ACCOUNT_NAME); } @@ -385,7 +329,7 @@ public class NotesPreferenceActivity extends PreferenceActivity { } editor.commit(); - // 在新线程中清理本地同步信息 + // clean up local gtask related info new Thread(new Runnable() { public void run() { ContentValues values = new ContentValues(); @@ -396,18 +340,12 @@ public class NotesPreferenceActivity extends PreferenceActivity { }).start(); } - /** - * 静态方法:获取当前同步账户名称 - */ public static String getSyncAccountName(Context context) { SharedPreferences settings = context.getSharedPreferences(PREFERENCE_NAME, Context.MODE_PRIVATE); return settings.getString(PREFERENCE_SYNC_ACCOUNT_NAME, ""); } - /** - * 静态方法:设置最后同步时间 - */ public static void setLastSyncTime(Context context, long time) { SharedPreferences settings = context.getSharedPreferences(PREFERENCE_NAME, Context.MODE_PRIVATE); @@ -416,38 +354,29 @@ public class NotesPreferenceActivity extends PreferenceActivity { editor.commit(); } - /** - * 静态方法:获取最后同步时间 - */ public static long getLastSyncTime(Context context) { SharedPreferences settings = context.getSharedPreferences(PREFERENCE_NAME, Context.MODE_PRIVATE); return settings.getLong(PREFERENCE_LAST_SYNC_TIME, 0); } - /** - * 同步服务广播接收器,用于监听同步状态变化 - */ private class GTaskReceiver extends BroadcastReceiver { + @Override public void onReceive(Context context, Intent intent) { - refreshUI(); // 收到广播后刷新界面 + refreshUI(); if (intent.getBooleanExtra(GTaskSyncService.GTASK_SERVICE_BROADCAST_IS_SYNCING, false)) { - // 更新同步进度显示 TextView syncStatus = (TextView) findViewById(R.id.prefenerece_sync_status_textview); syncStatus.setText(intent .getStringExtra(GTaskSyncService.GTASK_SERVICE_BROADCAST_PROGRESS_MSG)); } + } } - /** - * 选项菜单项选择处理 - */ public boolean onOptionsItemSelected(MenuItem item) { switch (item.getItemId()) { case android.R.id.home: - // 点击返回按钮,返回到笔记列表 Intent intent = new Intent(this, NotesListActivity.class); intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP); startActivity(intent); @@ -456,4 +385,4 @@ public class NotesPreferenceActivity extends PreferenceActivity { return false; } } -} \ No newline at end of file +} diff --git a/src/notes/widget/NoteWidgetProvider.java b/src/notes/widget/NoteWidgetProvider.java index fa5c64a..ec6f819 100644 --- a/src/notes/widget/NoteWidgetProvider.java +++ b/src/notes/widget/NoteWidgetProvider.java @@ -15,7 +15,6 @@ */ package net.micode.notes.widget; - import android.app.PendingIntent; import android.appwidget.AppWidgetManager; import android.appwidget.AppWidgetProvider; @@ -33,181 +32,101 @@ import net.micode.notes.tool.ResourceParser; import net.micode.notes.ui.NoteEditActivity; import net.micode.notes.ui.NotesListActivity; -/** - * 便签小部件提供者抽象基类 - * 定义便签小部件的通用行为,具体的小部件类型由子类实现 - * 负责管理小部件的生命周期和数据显示 - */ public abstract class NoteWidgetProvider extends AppWidgetProvider { - /** - * 数据库查询投影字段 - 定义需要查询的列 - */ public static final String [] PROJECTION = new String [] { - NoteColumns.ID, // 便签ID - NoteColumns.BG_COLOR_ID, // 背景颜色ID - NoteColumns.SNIPPET // 便签内容摘要 + NoteColumns.ID, + NoteColumns.BG_COLOR_ID, + NoteColumns.SNIPPET }; - /** - * 投影字段索引常量 - */ - public static final int COLUMN_ID = 0; // ID列索引 - public static final int COLUMN_BG_COLOR_ID = 1; // 背景颜色ID列索引 - public static final int COLUMN_SNIPPET = 2; // 内容摘要列索引 + public static final int COLUMN_ID = 0; + public static final int COLUMN_BG_COLOR_ID = 1; + public static final int COLUMN_SNIPPET = 2; - /** - * 日志标签 - */ private static final String TAG = "NoteWidgetProvider"; @Override public void onDeleted(Context context, int[] appWidgetIds) { - /** - * 处理小部件删除事件 - * 当用户从桌面移除小部件时调用,清理数据库中的小部件关联 - */ - // 创建内容值,用于清除小部件ID关联 ContentValues values = new ContentValues(); values.put(NoteColumns.WIDGET_ID, AppWidgetManager.INVALID_APPWIDGET_ID); - - // 遍历所有被删除的小部件ID for (int i = 0; i < appWidgetIds.length; i++) { - // 更新数据库,将对应的小部件ID设为无效值 context.getContentResolver().update(Notes.CONTENT_NOTE_URI, values, - NoteColumns.WIDGET_ID + "=?", // 条件:小部件ID匹配 + NoteColumns.WIDGET_ID + "=?", new String[] { String.valueOf(appWidgetIds[i])}); } } - /** - * 获取小部件关联的便签信息 - * @param context 上下文对象 - * @param widgetId 小部件ID - * @return 包含便签信息的Cursor对象 - */ private Cursor getNoteWidgetInfo(Context context, int widgetId) { - /** - * 查询数据库获取指定小部件关联的便签信息 - * 条件:小部件ID匹配且不在回收站中 - */ return context.getContentResolver().query(Notes.CONTENT_NOTE_URI, - PROJECTION, // 查询的列 - NoteColumns.WIDGET_ID + "=? AND " + NoteColumns.PARENT_ID + "<>?", // 查询条件 + PROJECTION, + NoteColumns.WIDGET_ID + "=? AND " + NoteColumns.PARENT_ID + "<>?", new String[] { String.valueOf(widgetId), String.valueOf(Notes.ID_TRASH_FOLER) }, - null); // 排序方式(无) + null); } - /** - * 更新小部件显示(公开方法) - * @param context 上下文对象 - * @param appWidgetManager 小部件管理器 - * @param appWidgetIds 要更新的小部件ID数组 - */ protected void update(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) { - // 调用私有更新方法,默认非隐私模式 update(context, appWidgetManager, appWidgetIds, false); } - /** - * 更新小部件显示(私有方法) - * @param context 上下文对象 - * @param appWidgetManager 小部件管理器 - * @param appWidgetIds 要更新的小部件ID数组 - * @param privacyMode 是否为隐私模式(true:显示保护文本,false:显示便签内容) - */ private void update(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds, - boolean privacyMode) { - // 遍历所有需要更新的小部件 + boolean privacyMode) { for (int i = 0; i < appWidgetIds.length; i++) { - // 检查小部件ID是否有效 if (appWidgetIds[i] != AppWidgetManager.INVALID_APPWIDGET_ID) { - // 初始化默认背景颜色和内容摘要 int bgId = ResourceParser.getDefaultBgId(context); String snippet = ""; - - // 创建点击小部件时启动的Intent(指向便签编辑页面) Intent intent = new Intent(context, NoteEditActivity.class); - intent.setFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP); // 单例模式 - intent.putExtra(Notes.INTENT_EXTRA_WIDGET_ID, appWidgetIds[i]); // 传递小部件ID - intent.putExtra(Notes.INTENT_EXTRA_WIDGET_TYPE, getWidgetType()); // 传递小部件类型 + intent.setFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP); + intent.putExtra(Notes.INTENT_EXTRA_WIDGET_ID, appWidgetIds[i]); + intent.putExtra(Notes.INTENT_EXTRA_WIDGET_TYPE, getWidgetType()); - // 查询数据库获取小部件关联的便签信息 Cursor c = getNoteWidgetInfo(context, appWidgetIds[i]); if (c != null && c.moveToFirst()) { - // 安全检查:确保一个小部件只关联一个便签 if (c.getCount() > 1) { Log.e(TAG, "Multiple message with same widget id:" + appWidgetIds[i]); c.close(); - return; // 发现数据异常,直接返回 + return; } - // 从数据库读取便签信息 - snippet = c.getString(COLUMN_SNIPPET); // 获取内容摘要 - bgId = c.getInt(COLUMN_BG_COLOR_ID); // 获取背景颜色ID - intent.putExtra(Intent.EXTRA_UID, c.getLong(COLUMN_ID)); // 传递便签ID - intent.setAction(Intent.ACTION_VIEW); // 设置为查看动作 + snippet = c.getString(COLUMN_SNIPPET); + bgId = c.getInt(COLUMN_BG_COLOR_ID); + intent.putExtra(Intent.EXTRA_UID, c.getLong(COLUMN_ID)); + intent.setAction(Intent.ACTION_VIEW); } else { - // 没有找到关联的便签,显示默认内容 snippet = context.getResources().getString(R.string.widget_havenot_content); - intent.setAction(Intent.ACTION_INSERT_OR_EDIT); // 设置为新建/编辑动作 + intent.setAction(Intent.ACTION_INSERT_OR_EDIT); } - // 关闭Cursor释放资源 if (c != null) { c.close(); } - // 创建RemoteViews对象,用于更新小部件界面 RemoteViews rv = new RemoteViews(context.getPackageName(), getLayoutId()); - // 设置小部件背景图片 rv.setImageViewResource(R.id.widget_bg_image, getBgResourceId(bgId)); - intent.putExtra(Notes.INTENT_EXTRA_BACKGROUND_ID, bgId); // 传递背景颜色ID - + intent.putExtra(Notes.INTENT_EXTRA_BACKGROUND_ID, bgId); /** - * 生成启动宿主Activity的PendingIntent - * 用于处理小部件的点击事件 + * Generate the pending intent to start host for the widget */ PendingIntent pendingIntent = null; if (privacyMode) { - // 隐私模式:显示保护文本,点击进入主列表页面 rv.setTextViewText(R.id.widget_text, context.getString(R.string.widget_under_visit_mode)); pendingIntent = PendingIntent.getActivity(context, appWidgetIds[i], new Intent( context, NotesListActivity.class), PendingIntent.FLAG_UPDATE_CURRENT); } else { - // 正常模式:显示便签内容,点击进入编辑页面 rv.setTextViewText(R.id.widget_text, snippet); pendingIntent = PendingIntent.getActivity(context, appWidgetIds[i], intent, PendingIntent.FLAG_UPDATE_CURRENT); } - // 设置小部件文本的点击事件 rv.setOnClickPendingIntent(R.id.widget_text, pendingIntent); - // 更新小部件显示 appWidgetManager.updateAppWidget(appWidgetIds[i], rv); } } } - /** - * 根据背景颜色ID获取对应的背景资源ID - * 抽象方法,由具体子类实现不同小部件的背景资源映射 - * @param bgId 背景颜色ID - * @return 背景图片资源ID - */ protected abstract int getBgResourceId(int bgId); - /** - * 获取小部件的布局资源ID - * 抽象方法,由具体子类实现不同小部件的布局 - * @return 布局资源ID - */ protected abstract int getLayoutId(); - /** - * 获取小部件类型标识 - * 抽象方法,由具体子类实现不同类型的小部件标识 - * @return 小部件类型常量 - */ protected abstract int getWidgetType(); -} \ No newline at end of file +} diff --git a/src/notes/widget/NoteWidgetProvider_2x.java b/src/notes/widget/NoteWidgetProvider_2x.java index 5e30e10..adcb2f7 100644 --- a/src/notes/widget/NoteWidgetProvider_2x.java +++ b/src/notes/widget/NoteWidgetProvider_2x.java @@ -23,65 +23,25 @@ import net.micode.notes.R; import net.micode.notes.data.Notes; import net.micode.notes.tool.ResourceParser; -/** - * 2x2尺寸便签小部件提供者 - * 继承自NoteWidgetProvider抽象基类,实现2x2小部件的具体行为 - * 负责管理桌面2x2网格尺寸的便签小部件显示和交互 - */ -public class NoteWidgetProvider_2x extends NoteWidgetProvider { - /** - * 小部件更新回调方法 - * 当小部件需要更新显示内容时调用,委托给父类的通用更新逻辑 - * - * @param context 上下文对象 - * @param appWidgetManager 小部件管理器,用于操作小部件 - * @param appWidgetIds 需要更新的一组小部件ID - */ +public class NoteWidgetProvider_2x extends NoteWidgetProvider { @Override public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) { - // 调用父类的通用更新逻辑,避免重复代码 - // 父类已经实现了数据查询、界面更新等通用功能 super.update(context, appWidgetManager, appWidgetIds); } - /** - * 获取小部件布局资源ID - * 实现抽象方法,返回2x2小部件专用的布局文件 - * - * @return 2x2小部件的布局资源ID - */ @Override protected int getLayoutId() { - // 返回2x2尺寸小部件的布局文件 - // R.layout.widget_2x 定义了2x2小部件的界面结构 return R.layout.widget_2x; } - /** - * 根据背景颜色ID获取2x2小部件的背景资源ID - * 实现抽象方法,提供2x2尺寸专用的背景图片映射 - * - * @param bgId 背景颜色ID(Notes.COLOR_YELLOW, Notes.COLOR_BLUE等) - * @return 对应颜色的2x2小部件背景图片资源ID - */ @Override protected int getBgResourceId(int bgId) { - // 通过资源解析器获取2x2尺寸专用的背景图片 - // 不同的颜色ID对应不同的背景图片资源 return ResourceParser.WidgetBgResources.getWidget2xBgResource(bgId); } - /** - * 获取小部件类型标识 - * 实现抽象方法,返回2x2小部件的类型常量 - * - * @return 2x2小部件的类型标识符 - */ @Override protected int getWidgetType() { - // 返回2x2小部件的类型常量,用于区分不同尺寸的小部件 - // 在数据存储和Intent传递中标识这是2x2尺寸的小部件 return Notes.TYPE_WIDGET_2X; } -} \ No newline at end of file +} diff --git a/src/notes/widget/NoteWidgetProvider_4x.java b/src/notes/widget/NoteWidgetProvider_4x.java index 3fabf31..c12a02e 100644 --- a/src/notes/widget/NoteWidgetProvider_4x.java +++ b/src/notes/widget/NoteWidgetProvider_4x.java @@ -23,69 +23,24 @@ import net.micode.notes.R; import net.micode.notes.data.Notes; import net.micode.notes.tool.ResourceParser; -/** - * 4x4尺寸便签小部件提供者 - * 继承自NoteWidgetProvider抽象基类,实现4x4大尺寸小部件的具体行为 - * 负责管理桌面4x4网格尺寸的便签小部件显示和交互,提供更大的显示区域 - */ -public class NoteWidgetProvider_4x extends NoteWidgetProvider { - /** - * 小部件更新回调方法 - * 当小部件需要更新显示内容时调用,复用父类的通用更新逻辑 - * 4x4小部件使用与2x2相同的更新机制,但显示布局和背景资源不同 - * - * @param context 上下文对象,用于访问应用资源和服务 - * @param appWidgetManager 小部件管理器实例,用于执行小部件更新操作 - * @param appWidgetIds 需要更新的小部件ID数组,支持批量更新多个小部件实例 - */ +public class NoteWidgetProvider_4x extends NoteWidgetProvider { @Override public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) { - // 直接调用父类的通用更新逻辑,避免代码重复 - // 父类已实现数据查询、界面绑定、点击事件等完整的小部件更新流程 super.update(context, appWidgetManager, appWidgetIds); } - /** - * 获取4x4小部件专用布局资源ID - * 实现抽象方法,返回针对4x4网格尺寸优化的布局文件 - * 4x4布局相比2x2具有更大的显示区域,可以展示更多内容 - * - * @return 4x4小部件的布局资源ID,定义在R.layout.widget_4x中 - */ - @Override protected int getLayoutId() { - // 返回4x4尺寸专用的布局文件 - // 该布局针对4x4网格进行了优化,可能包含更大的文本区域或额外的显示元素 return R.layout.widget_4x; } - /** - * 根据背景颜色ID获取4x4小部件的背景资源ID - * 实现抽象方法,提供4x4尺寸专用的背景图片映射 - * 4x4背景图片在尺寸和比例上与2x2不同,适配更大的显示区域 - * - * @param bgId 背景颜色ID(Notes.COLOR_YELLOW, Notes.COLOR_BLUE等颜色常量) - * @return 对应颜色的4x4小部件背景图片资源ID - */ @Override protected int getBgResourceId(int bgId) { - // 通过资源解析器获取4x4尺寸专用的背景图片资源 - // ResourceParser.WidgetBgResources.getWidget4xBgResource()专门处理4x4尺寸的背景映射 return ResourceParser.WidgetBgResources.getWidget4xBgResource(bgId); } - /** - * 获取小部件类型标识符 - * 实现抽象方法,返回4x4小部件的唯一类型常量 - * 该标识符用于在数据库和Intent中区分不同尺寸的小部件 - * - * @return 4x4小部件的类型标识符,值为Notes.TYPE_WIDGET_4X - */ @Override protected int getWidgetType() { - // 返回4x4小部件的类型常量 - // 这个值会存储在数据库中,用于关联便签数据和小部件实例 return Notes.TYPE_WIDGET_4X; } -} \ No newline at end of file +}