diff --git a/src/Contact.java b/src/Contact.java new file mode 100644 index 0000000..c9100fe --- /dev/null +++ b/src/Contact.java @@ -0,0 +1,79 @@ +import android.content.Context; +import android.database.Cursor; +import android.provider.ContactsContract.CommonDataKinds.Phone; +import android.provider.ContactsContract.Data; +import android.telephony.PhoneNumberUtils; +import android.util.Log; + +import java.util.HashMap; + +// 该类用于根据电话号码从联系人数据库中获取联系人姓名 +public class Contact { + // 用于缓存已查询过的电话号码及其对应的联系人姓名，避免重复查询数据库 + private static HashMap sContactCache; + // 日志标签，方便在调试时定位该类产生的日志信息 + private static final String TAG = "Contact"; + + // 查询联系人的 SQL 选择语句模板 + 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 " + + "(SELECT raw_contact_id " + + " FROM phone_lookup" + + " WHERE min_match = '+')"; + + /** + * 根据电话号码从联系人数据库中获取联系人姓名 + * @param context 上下文对象，用于访问内容解析器 + * @param phoneNumber 要查询的电话号码 + * @return 如果找到匹配的联系人，返回联系人姓名；否则返回 null + */ + public static String getContact(Context context, String phoneNumber) { + // 如果联系人缓存为空，则初始化缓存 + if(sContactCache == null) { + sContactCache = new HashMap(); + } + + // 检查缓存中是否已经存在该电话号码对应的联系人姓名 + if(sContactCache.containsKey(phoneNumber)) { + // 如果存在，直接从缓存中获取并返回 + return sContactCache.get(phoneNumber); + } + + // 将选择语句模板中的 "+" 替换为实际电话号码的最小匹配格式 + String selection = CALLER_ID_SELECTION.replace("+", + PhoneNumberUtils.toCallerIDMinMatch(phoneNumber)); + // 使用内容解析器查询联系人数据库 + Cursor cursor = context.getContentResolver().query( + Data.CONTENT_URI, + // 只查询联系人的显示名称 + new String [] { Phone.DISPLAY_NAME }, + // 使用替换后的选择语句进行查询 + selection, + // 查询参数，即要查询的电话号码 + new String[] { phoneNumber }, + null); + + // 如果查询结果不为空且游标可以移动到第一行 + if (cursor != null && cursor.moveToFirst()) { + try { + // 获取第一行的第一个字段（即联系人的显示名称） + String name = cursor.getString(0); + // 将电话号码和对应的联系人姓名存入缓存 + sContactCache.put(phoneNumber, name); + // 返回联系人姓名 + return name; + } catch (IndexOutOfBoundsException e) { + // 若获取联系人姓名时出现索引越界异常，记录错误日志 + Log.e(TAG, " Cursor get string error " + e.toString()); + return null; + } finally { + // 无论是否成功获取联系人姓名，都关闭游标 + cursor.close(); + } + } else { + // 若未找到匹配的联系人，记录日志 + Log.d(TAG, "No contact matched with number:" + phoneNumber); + return null; + } + } \ No newline at end of file diff --git a/src/Notes.java b/src/Notes.java new file mode 100644 index 0000000..04721bd --- /dev/null +++ b/src/Notes.java @@ -0,0 +1,301 @@ +/* + * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net) + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package net.micode.notes.data; + +import android.net.Uri; +/** + * 笔记应用的数据模型类，定义核心常量、数据结构及Content Provider相关规范 + * 遵循Android Content Provider设计模式，用于统一管理应用数据 + */ +public class Notes { + + // ======================== + // 基础配置常量 + // ======================== + + /** Content Provider的唯一标识符，用于URI寻址（需与AndroidManifest.xml中配置一致） */ + public static final String AUTHORITY = "micode_notes"; + + /** 日志标签，用于Logcat过滤调试信息 */ + 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; + + + // ======================== + // 系统文件夹ID（负ID用于标识系统内置文件夹，避免与用户创建的ID冲突） + // ======================== + + /** + * 以下ID为系统文件夹标识符： + * - {@link #ID_ROOT_FOLDER} 根文件夹（默认文件夹） + * - {@link #ID_TEMPARAY_FOLDER} 临时文件夹（存放未归类笔记） + * - {@link #ID_CALL_RECORD_FOLDER} 通话记录文件夹 + * - {@link #ID_TRASH_FOLER} 回收站文件夹 + */ + public static final int ID_ROOT_FOLDER = 0; // 根文件夹（用户可见的顶级目录） + public static final int ID_TEMPARAY_FOLDER = -1; // 临时文件夹（笔记未指定归属文件夹时存放于此） + public static final int ID_CALL_RECORD_FOLDER = -2; // 通话记录专用文件夹（系统自动创建） + public static final int ID_TRASH_FOLER = -3; // 回收站文件夹（存放删除的笔记/文件夹） + + + // ======================== + // Intent传递参数常量（用于Activity/Fragment间数据交互） + // ======================== + + /** Intent额外参数：提醒日期（值为Long类型的毫秒时间戳） */ + public static final String INTENT_EXTRA_ALERT_DATE = "net.micode.notes.alert_date"; + /** Intent额外参数：背景颜色ID（值为R.color中的颜色资源ID） */ + public static final String INTENT_EXTRA_BACKGROUND_ID = "net.micode.notes.background_color_id"; + /** Intent额外参数：桌面小部件ID（用于标识关联的小部件实例） */ + public static final String INTENT_EXTRA_WIDGET_ID = "net.micode.notes.widget_id"; + /** Intent额外参数：小部件类型（值为{@link #TYPE_WIDGET_2X}或{@link #TYPE_WIDGET_4X}） */ + public static final String INTENT_EXTRA_WIDGET_TYPE = "net.micode.notes.widget_type"; + /** Intent额外参数：文件夹ID（标识目标文件夹的{@link #ID}） */ + public static final String INTENT_EXTRA_FOLDER_ID = "net.micode.notes.folder_id"; + /** Intent额外参数：通话日期（值为Long类型的通话时间戳，仅用于通话记录笔记） */ + public static final String INTENT_EXTRA_CALL_DATE = "net.micode.notes.call_date"; + + + // ======================== + // 桌面小部件类型常量（定义小部件尺寸） + // ======================== + + /** 无效小部件类型（默认值，表示未初始化） */ + public static final int TYPE_WIDGET_INVALIDE = -1; + /** 2x尺寸小部件（如2x2网格） */ + public static final int TYPE_WIDGET_2X = 0; + /** 4x尺寸小部件（如4x2网格） */ + public static final int TYPE_WIDGET_4X = 1; + + + // ======================== + // 数据类型MIME常量管理类（解耦底层实现与业务逻辑） + // ======================== + + /** + * 数据类型MIME别名常量类： + * - 集中管理不同数据类型的MIME类型字符串 + * - 避免直接引用底层实现类（如TextNote/CallNote）的常量，降低耦合度 + */ + public static class DataConstants { + /** 文本笔记的单项MIME类型（对应{@link TextNote#CONTENT_ITEM_TYPE}） */ + public static final String NOTE = TextNote.CONTENT_ITEM_TYPE; + /** 通话记录的单项MIME类型（对应{@link CallNote#CONTENT_ITEM_TYPE}） */ + public static final String CALL_NOTE = CallNote.CONTENT_ITEM_TYPE; + } + + + // ======================== + // 以下为Content Provider相关的接口和实现类（通常定义在同一个文件中） + // （注：原代码中未完整展示TextNote/CallNote类，此处仅保留注释占位） + // ======================== + + /** + * 文本笔记数据类型（实现附件数据字段接口） + * 包含文本内容、复选框模式等特有属性 + */ + // public static final class TextNote implements DataColumns { ... } + + /** + * 通话记录数据类型（实现附件数据字段接口） + * 包含通话时间、电话号码等特有属性 + */ + // public static final class CallNote implements DataColumns { ... } +} + /** + * Uri to query all notes and folders + */ +/** + * 内容URI常量：用于访问笔记和文件夹集合 + * 格式：content://micode_notes/note + * 对应ContentProvider中的路径匹配规则（如"note"对应查询所有笔记/文件夹） + */ +public static final Uri CONTENT_NOTE_URI = Uri.parse("content://" + AUTHORITY + "/note"); + +/** + * 内容URI常量：用于访问笔记关联的数据（如附件、子内容等） + * 格式：content://micode_notes/data + * 对应ContentProvider中的路径匹配规则（如"data"对应查询笔记的附件数据） + */ +public static final Uri CONTENT_DATA_URI = Uri.parse("content://" + AUTHORITY + "/data"); + +/** + * 笔记和文件夹的公共字段接口 + * 定义数据库表结构和ContentProvider查询投影的字段名 + * 所有字段类型与SQLite数据类型对应 + */ +public interface NoteColumns { + /** 数据库表主键（INTEGER PRIMARY KEY AUTOINCREMENT） */ + public static final String ID = "_id"; + + /** 父文件夹ID（对应本表的ID字段，形成树形结构） */ + public static final String PARENT_ID = "parent_id"; + + /** 创建时间戳（毫秒，System.currentTimeMillis()） */ + public static final String CREATED_DATE = "created_date"; + + /** 最后修改时间戳（毫秒，每次更新时自动更新） */ + public static final String MODIFIED_DATE = "modified_date"; + + /** 提醒时间戳（毫秒，0表示无提醒） */ + public static final String ALERTED_DATE = "alert_date"; + + /** 摘要内容（文件夹名称或笔记的简短内容） */ + public static final String SNIPPET = "snippet"; + + /** 关联的桌面小部件ID（对应AppWidgetManager中的ID） */ + public static final String WIDGET_ID = "widget_id"; + + /** 小部件类型（对应{@link Notes#TYPE_WIDGET_2X}等常量） */ + public static final String WIDGET_TYPE = "widget_type"; + + /** 背景颜色ID（对应R.color资源ID） */ + public static final String BG_COLOR_ID = "bg_color_id"; + + /** 是否有附件（1=有附件，0=纯文本） */ + public static final String HAS_ATTACHMENT = "has_attachment"; + + /** 文件夹包含的子项数量（仅对文件夹有效） */ + public static final String NOTES_COUNT = "notes_count"; + + /** 数据类型（对应{@link Notes#TYPE_NOTE}等常量） */ + public static final String TYPE = "type"; + + /** 同步ID（用于与服务器数据关联） */ + public static final String SYNC_ID = "sync_id"; + + /** 本地修改标记（1=本地修改未同步，0=已同步） */ + public static final String LOCAL_MODIFIED = "local_modified"; + + /** 移入临时文件夹前的原始父文件夹ID */ + public static final String ORIGIN_PARENT_ID = "origin_parent_id"; + + /** Google Tasks同步ID（用于与Google服务集成） */ + public static final String GTASK_ID = "gtask_id"; + + /** 数据版本号（用于冲突检测和数据升级） */ + public static final String VERSION = "version"; +} + +/** + * 笔记附件数据的公共字段接口 + * 定义与笔记关联的各种数据（如文本、图片、音频等）的通用字段 + * 通过MIME_TYPE区分具体数据类型，并使用DATA1~DATA5存储类型特定数据 + */ +public interface DataColumns { + /** 数据库表主键（INTEGER PRIMARY KEY AUTOINCREMENT） */ + public static final String ID = "_id"; + + /** 数据的MIME类型（如"text/plain"、"image/jpeg"等） */ + public static final String MIME_TYPE = "mime_type"; + + /** 关联的笔记ID（外键，对应NoteColumns.ID） */ + public static final String NOTE_ID = "note_id"; + + /** 创建时间戳（毫秒） */ + public static final String CREATED_DATE = "created_date"; + + /** 最后修改时间戳（毫秒） */ + public static final String MODIFIED_DATE = "modified_date"; + + /** 数据内容（文本内容或文件路径等） */ + public static final String CONTENT = "content"; + + /** 通用数据字段1（含义由MIME_TYPE决定） */ + public static final String DATA1 = "data1"; + + /** 通用数据字段2（含义由MIME_TYPE决定） */ + public static final String DATA2 = "data2"; + + /** 通用数据字段3（含义由MIME_TYPE决定） */ + public static final String DATA3 = "data3"; + + /** 通用数据字段4（含义由MIME_TYPE决定） */ + public static final String DATA4 = "data4"; + + /** 通用数据字段5（含义由MIME_TYPE决定） */ + public static final String DATA5 = "data5"; +} + +/** + * 文本笔记数据类型实现类 + * 继承自{@link DataColumns}接口，定义文本笔记特有的字段和MIME类型 + * 对应Content Provider中的"text_note"路径 + */ +public static final class TextNote implements DataColumns { + + /** + * 文本模式字段（复用{@link DataColumns#DATA1}通用字段） + * - 值为{@link #MODE_CHECK_LIST}（1）时表示复选框列表模式 + * - 值为0时表示普通文本模式 + */ + public static final String MODE = DATA1; + + /** 复选框列表模式标识（对应{@link #MODE}字段的有效值） */ + public static final int MODE_CHECK_LIST = 1; + + /** 文本笔记目录的MIME类型（表示返回多条记录的集合） */ + public static final String CONTENT_TYPE = "vnd.android.cursor.dir/text_note"; + + /** 文本笔记单项的MIME类型（表示返回单条记录） */ + public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/text_note"; + + /** 文本笔记的专属内容URI（用于Content Provider查询） */ + public static final Uri CONTENT_URI = + Uri.parse("content://" + AUTHORITY + "/text_note"); +} +/** + * 通话记录数据类型实现类 + * 继承自{@link DataColumns}接口，定义通话记录特有的字段和MIME类型 + * 对应Content Provider中的"call_note"路径 + */ +public static final class CallNote implements DataColumns { + + /** + * 通话时间字段（复用{@link DataColumns#DATA1}通用字段） + * 值为Long类型的毫秒时间戳（如System.currentTimeMillis()） + */ + public static final String CALL_DATE = DATA1; + + /** + * 电话号码字段（复用{@link DataColumns#DATA3}通用字段） + * 存储电话号码字符串（如"+8613800138000"） + */ + public static final String PHONE_NUMBER = DATA3; + + /** 通话记录目录的MIME类型（表示返回多条记录的集合） */ + public static final String CONTENT_TYPE = "vnd.android.cursor.dir/call_note"; + + /** 通话记录单项的MIME类型（表示返回单条记录） */ + public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/call_note"; + + /** 通话记录的专属内容URI（用于Content Provider查询） */ + public static final Uri CONTENT_URI = + Uri.parse("content://" + AUTHORITY + "/call_note"); +} +} diff --git a/src/NotesDatabaseHelper.java b/src/NotesDatabaseHelper.java new file mode 100644 index 0000000..55bea62 --- /dev/null +++ b/src/NotesDatabaseHelper.java @@ -0,0 +1,760 @@ +/* + * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net) + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package net.micode.notes.data; + +import android.content.ContentValues; +import android.content.Context; +import android.database.sqlite.SQLiteDatabase; +import android.database.sqlite.SQLiteOpenHelper; +import android.util.Log; + +import net.micode.notes.data.Notes.DataColumns; +import net.micode.notes.data.Notes.DataConstants; +import net.micode.notes.data.Notes.NoteColumns; + + +/** + * 数据库辅助类，管理SQLite数据库的创建、升级和降级 + * 继承自Android SQLiteOpenHelper抽象类，实现数据库生命周期管理 + */ +public class NotesDatabaseHelper extends SQLiteOpenHelper { + + // ======================== + // 数据库元数据（名称、版本） + // ======================== + + /** + * 数据库文件名称（存储于应用私有目录，路径为：data/data/包名/databases/note.db） + */ + private static final String DB_NAME = "note.db"; + + /** + * 数据库版本号（用于版本升级检测，必须按自然数递增） + */ + private static final int DB_VERSION = 4; + + + // ======================== + // 数据库表名接口（常量集中管理） + // ======================== + + /** + * 数据库表名常量接口 + * 集中管理表名，避免魔法字符串散落各处 + */ + public interface TABLE { + /** + * 笔记/文件夹主表（存储基础信息，如标题、类型、时间戳等） + */ + public static final String NOTE = "note"; + + /** + * 笔记附件数据表（存储多媒体内容、扩展字段等） + */ + public static final String DATA = "data"; + } + + private static final String TAG = "NotesDatabaseHelper"; // 日志标签，用于调试输出 + + private static NotesDatabaseHelper mInstance; // 单例实例，确保全局唯一数据库连接 + + /** + * 创建笔记/文件夹主表的SQL语句 + * 表结构说明： + * - 存储笔记和文件夹的基础信息，通过{@link NoteColumns#TYPE}字段区分类型 + * - 使用自增主键{@link NoteColumns#ID}，符合SQLite规范 + * - 字段默认值遵循业务逻辑（如未指定父文件夹时默认归属根目录） + */ + private static final String CREATE_NOTE_TABLE_SQL = + "CREATE TABLE " + TABLE.NOTE + "(" + + // 主键：唯一标识记录（INTEGER PRIMARY KEY 自动自增） + NoteColumns.ID + " INTEGER PRIMARY KEY," + + + // 父文件夹ID：默认值0表示根文件夹（{@link Notes#ID_ROOT_FOLDER}） + NoteColumns.PARENT_ID + " INTEGER NOT NULL DEFAULT 0," + + + // 提醒时间戳：默认0表示无提醒（毫秒级时间戳） + NoteColumns.ALERTED_DATE + " INTEGER NOT NULL DEFAULT 0," + + + // 背景颜色ID：默认0表示默认颜色（对应R.color资源ID） + NoteColumns.BG_COLOR_ID + " INTEGER NOT NULL DEFAULT 0," + + + // 创建时间：默认值为当前时间戳（strftime('%s','now')*1000 转换为毫秒） + NoteColumns.CREATED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + + + // 是否有附件：默认0表示纯文本笔记（1=有附件，0=无） + NoteColumns.HAS_ATTACHMENT + " INTEGER NOT NULL DEFAULT 0," + + + // 最后修改时间：默认值为当前时间戳（自动更新） + NoteColumns.MODIFIED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + + + // 子项数量：文件夹类型有效，默认0表示空文件夹 + NoteColumns.NOTES_COUNT + " INTEGER NOT NULL DEFAULT 0," + + + // 摘要内容：文件夹名称或笔记正文摘要，默认空字符串 + NoteColumns.SNIPPET + " TEXT NOT NULL DEFAULT '','" + + + // 数据类型：0=笔记，1=文件夹，2=系统项（默认0为普通笔记） + NoteColumns.TYPE + " INTEGER NOT NULL DEFAULT 0," + + + // 桌面小部件ID：默认0表示未关联小部件（对应AppWidgetManager的ID） + NoteColumns.WIDGET_ID + " INTEGER NOT NULL DEFAULT 0," + + + // 小部件类型：默认-1表示无效类型（对应{@link Notes#TYPE_WIDGET_INVALIDE}） + NoteColumns.WIDGET_TYPE + " INTEGER NOT NULL DEFAULT -1," + + + // 同步ID：默认0表示未同步（用于与服务器数据关联） + NoteColumns.SYNC_ID + " INTEGER NOT NULL DEFAULT 0," + + + // 本地修改标记：默认0表示已同步（1=本地修改未同步） + NoteColumns.LOCAL_MODIFIED + " INTEGER NOT NULL DEFAULT 0," + + + // 原始父文件夹ID：默认0表示未移动过（用于临时文件夹逻辑） + NoteColumns.ORIGIN_PARENT_ID + " INTEGER NOT NULL DEFAULT 0," + + + // Google Tasks ID：默认空字符串（用于同步到Google Tasks） + NoteColumns.GTASK_ID + " TEXT NOT NULL DEFAULT '','" + + + // 数据版本号：默认0（用于冲突检测和数据升级） + NoteColumns.VERSION + " INTEGER NOT NULL DEFAULT 0" + + ")"; + + /** + * 创建笔记附件数据表的SQL语句 + * 表结构说明： + * - 存储与笔记关联的扩展数据（如多媒体内容、富文本等） + * - 通过{@link DataColumns#NOTE_ID}外键关联主表（note表） + * - 使用通用字段{@link DataColumns#DATA1}~{@link DataColumns#DATA5}支持灵活数据类型扩展 + */ + private static final String CREATE_DATA_TABLE_SQL = + "CREATE TABLE " + TABLE.DATA + "(" + + // 主键：唯一标识记录（自增ID） + DataColumns.ID + " INTEGER PRIMARY KEY," + + + // MIME类型：必须非空（如"text/plain"、"image/jpeg"） + DataColumns.MIME_TYPE + " TEXT NOT NULL," + + + // 关联的笔记ID：默认0（需通过代码确保外键有效性，SQLite需启用外键约束） + DataColumns.NOTE_ID + " INTEGER NOT NULL DEFAULT 0," + + + // 创建时间：默认当前时间戳（毫秒） + NoteColumns.CREATED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + + + // 最后修改时间：默认当前时间戳（毫秒） + NoteColumns.MODIFIED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + + + // 数据内容：文本内容或文件路径（默认空字符串） + DataColumns.CONTENT + " TEXT NOT NULL DEFAULT '','" + + + // 通用整数字段：含义由MIME类型决定（如文本笔记的模式字段） + DataColumns.DATA1 + " INTEGER," + + + // 通用整数字段：备用扩展字段 + DataColumns.DATA2 + " INTEGER," + + + // 通用字符串字段：如电话号码、标签等 + DataColumns.DATA3 + " TEXT NOT NULL DEFAULT '','" + + + // 通用字符串字段：备用扩展字段 + DataColumns.DATA4 + " TEXT NOT NULL DEFAULT '','" + + + // 通用字符串字段：备用扩展字段 + DataColumns.DATA5 + " TEXT NOT NULL DEFAULT ''" + + ")"; + + /** + * 创建DATA表的note_id索引的SQL语句 + * 索引作用： + * - 加速通过{@link DataColumns#NOTE_ID}查询关联数据的速度 + * - 减少表连接操作的时间复杂度（特别是在查询笔记及其附件时） + */ + private static final String CREATE_DATA_NOTE_ID_INDEX_SQL = + "CREATE INDEX IF NOT EXISTS note_id_index ON " + + TABLE.DATA + "(" + DataColumns.NOTE_ID + ");"; + /** + * Increase folder's note count when move note to the folder + */ + /** + * 当笔记的父文件夹ID（PARENT_ID）更新时，增加目标文件夹的笔记计数 + * 触发条件： + * - 对note表执行UPDATE操作，且更新字段包含{@link NoteColumns#PARENT_ID} + * 逻辑说明： + * - `new.PARENT_ID`表示更新后的父文件夹ID + * - 通过更新目标文件夹（ID=new.PARENT_ID）的NOTES_COUNT字段实现计数增加 + */ + private static final String NOTE_INCREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER = + "CREATE TRIGGER increase_folder_count_on_update " + + "AFTER UPDATE OF " + NoteColumns.PARENT_ID + " ON " + TABLE.NOTE + + "BEGIN " + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.NOTES_COUNT + " = " + NoteColumns.NOTES_COUNT + " + 1 " + + " WHERE " + NoteColumns.ID + " = new." + NoteColumns.PARENT_ID + ";" + + "END"; + /** + * Decrease folder's note count when move note from folder + */ + /** + * 当笔记的父文件夹ID（PARENT_ID）更新时，减少原文件夹的笔记计数 + * 触发条件： + * - 对note表执行UPDATE操作，且更新字段包含{@link NoteColumns#PARENT_ID} + * 逻辑说明： + * - `old.PARENT_ID`表示更新前的父文件夹ID + * - 仅当原文件夹的NOTES_COUNT > 0时执行减少操作（避免负数） + */ + private static final String NOTE_DECREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER = + "CREATE TRIGGER decrease_folder_count_on_update " + + "AFTER UPDATE OF " + NoteColumns.PARENT_ID + " ON " + TABLE.NOTE + + "BEGIN " + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.NOTES_COUNT + " = " + NoteColumns.NOTES_COUNT + " - 1 " + + " WHERE " + NoteColumns.ID + " = old." + NoteColumns.PARENT_ID + " " + + " AND " + NoteColumns.NOTES_COUNT + " > 0;" + + "END"; + + /** + * Increase folder's note count when insert new note to the folder + */ + /** + * 当新笔记插入到note表时，增加所属文件夹的笔记计数 + * 触发条件： + * - 对note表执行INSERT操作 + * 逻辑说明： + * - `new.PARENT_ID`表示新笔记的父文件夹ID（默认0为根文件夹） + * - 通过更新所属文件夹（ID=new.PARENT_ID）的NOTES_COUNT字段实现计数增加 + */ + private static final String NOTE_INCREASE_FOLDER_COUNT_ON_INSERT_TRIGGER = + "CREATE TRIGGER increase_folder_count_on_insert " + + "AFTER INSERT ON " + TABLE.NOTE + + "BEGIN " + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.NOTES_COUNT + " = " + NoteColumns.NOTES_COUNT + " + 1 " + + " WHERE " + NoteColumns.ID + " = new." + NoteColumns.PARENT_ID + ";" + + "END"; + /** + * Decrease folder's note count when delete note from the folder + */ + /** + * 当笔记被删除时，减少其父文件夹的笔记计数 + * 触发条件： + * - 对note表执行DELETE操作 + * 逻辑说明： + * - `old.PARENT_ID`表示被删除笔记的原父文件夹ID + * - 仅当父文件夹的NOTES_COUNT > 0时执行减少操作，避免计数为负数 + * - 适用于删除笔记或文件夹时的计数维护（文件夹删除需级联处理其子项） + */ + private static final String NOTE_DECREASE_FOLDER_COUNT_ON_DELETE_TRIGGER = + "CREATE TRIGGER decrease_folder_count_on_delete " + + "AFTER DELETE ON " + TABLE.NOTE + + "BEGIN " + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.NOTES_COUNT + " = " + NoteColumns.NOTES_COUNT + " - 1 " + + " WHERE " + NoteColumns.ID + " = old." + NoteColumns.PARENT_ID + " " + + " AND " + NoteColumns.NOTES_COUNT + " > 0;" + + "END"; + /** + * Update note's content when insert data with type {@link DataConstants#NOTE} + */ + /** + * 当插入数据记录且MIME类型为文本笔记时，更新主表中的笔记内容摘要 + * 触发条件： + * - 对data表执行INSERT操作 + * - 新增记录的MIME_TYPE等于{@link DataConstants#NOTE}（即"vnd.android.cursor.item/text_note"） + * 逻辑说明： + * - `new.NOTE_ID`表示新增数据关联的笔记ID + * - `new.CONTENT`为文本笔记的内容，同步至主表的SNIPPET字段 + * - 实现数据表与主表的内容联动（如文本笔记的正文存储于data表，摘要显示于note表） + */ + private static final String DATA_UPDATE_NOTE_CONTENT_ON_INSERT_TRIGGER = + "CREATE TRIGGER update_note_content_on_insert " + + "AFTER INSERT ON " + TABLE.DATA + + "WHEN new." + DataColumns.MIME_TYPE + " = '" + DataConstants.NOTE + "' " + + "BEGIN " + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.SNIPPET + " = new." + DataColumns.CONTENT + + " WHERE " + NoteColumns.ID + " = new." + DataColumns.NOTE_ID + ";" + + "END"; + /** + * Update note's content when data with {@link DataConstants#NOTE} type has changed + */ + /** + * 当更新数据记录且原MIME类型为文本笔记时，更新主表中的笔记内容摘要 + * 触发条件： + * - 对data表执行UPDATE操作 + * - 更新前的MIME_TYPE等于{@link DataConstants#NOTE}（确保仅文本笔记数据触发） + * 逻辑说明： + * - `old.MIME_TYPE`用于判断数据类型是否为文本笔记（避免其他类型数据误触发） + * - `new.CONTENT`为更新后的内容，同步至主表的SNIPPET字段 + * - 保证数据修改后，主表摘要与附件表内容一致 + */ + private static final String DATA_UPDATE_NOTE_CONTENT_ON_UPDATE_TRIGGER = + "CREATE TRIGGER update_note_content_on_update " + + "AFTER UPDATE ON " + TABLE.DATA + + "WHEN old." + DataColumns.MIME_TYPE + " = '" + DataConstants.NOTE + "' " + + "BEGIN " + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.SNIPPET + " = new." + DataColumns.CONTENT + + " WHERE " + NoteColumns.ID + " = new." + DataColumns.NOTE_ID + ";" + + "END"; + + /** + * Update note's content when data with {@link DataConstants#NOTE} type has deleted + */ + /** + * 当删除数据记录且原MIME类型为文本笔记时，清空主表中的笔记内容摘要 + * 触发条件： + * - 对data表执行DELETE操作 + * - 删除前的记录MIME_TYPE等于{@link DataConstants#NOTE}（即文本笔记类型） + * 逻辑说明： + * - `old.NOTE_ID`表示被删除数据关联的笔记ID + * - 将主表中对应笔记的SNIPPET字段设置为空字符串（''），确保数据删除后摘要与内容一致 + * - 适用于文本笔记内容被完全删除的场景（如用户清空笔记正文） + */ + private static final String DATA_UPDATE_NOTE_CONTENT_ON_DELETE_TRIGGER = + "CREATE TRIGGER update_note_content_on_delete " + + "AFTER DELETE ON " + TABLE.DATA + + "WHEN old." + DataColumns.MIME_TYPE + " = '" + DataConstants.NOTE + "' " + + "BEGIN " + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.SNIPPET + " = '' " + + " WHERE " + NoteColumns.ID + " = old." + DataColumns.NOTE_ID + ";" + + "END"; + + /** + * Delete datas belong to note which has been deleted + */ + /** + * 当删除数据记录且原MIME类型为文本笔记时，清空主表中的笔记内容摘要 + * 触发条件： + * - 对data表执行DELETE操作 + * - 删除前的记录MIME_TYPE等于{@link DataConstants#NOTE}（即文本笔记类型） + * 逻辑说明： + * - `old.NOTE_ID`表示被删除数据关联的笔记ID + * - 将主表中对应笔记的SNIPPET字段设置为空字符串（''），确保数据删除后摘要与内容一致 + * - 适用于文本笔记内容被完全删除的场景（如用户清空笔记正文） + */ + private static final String DATA_UPDATE_NOTE_CONTENT_ON_DELETE_TRIGGER = + "CREATE TRIGGER update_note_content_on_delete " + + "AFTER DELETE ON " + TABLE.DATA + + "WHEN old." + DataColumns.MIME_TYPE + " = '" + DataConstants.NOTE + "' " + + "BEGIN " + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.SNIPPET + " = '' " + + " WHERE " + NoteColumns.ID + " = old." + DataColumns.NOTE_ID + ";" + + "END"; + + /** + * Delete notes belong to folder which has been deleted + */ + /** + * 当文件夹被删除时，自动删除其包含的所有子笔记 + * 触发条件： + * - 对note表执行DELETE操作（删除的记录类型为文件夹） + * 逻辑说明： + * - `old.ID`表示被删除文件夹的ID + * - 通过`NoteColumns.PARENT_ID`关联，删除note表中所有父文件夹为该ID的记录 + * - 实现简单的级联删除（仅处理直接子项，不递归删除子文件夹） + * - 注：需配合业务逻辑处理嵌套文件夹的递归删除 + */ + private static final String FOLDER_DELETE_NOTES_ON_DELETE_TRIGGER = + "CREATE TRIGGER folder_delete_notes_on_delete " + + "AFTER DELETE ON " + TABLE.NOTE + + "BEGIN " + + " DELETE FROM " + TABLE.NOTE + + " WHERE " + NoteColumns.PARENT_ID + " = old." + NoteColumns.ID + ";" + + "END"; + /** + * Move notes belong to folder which has been moved to trash folder + */ + /** + * 当文件夹被移动到回收站时，自动将其所有子笔记也移动到回收站 + * 触发条件： + * - 对note表执行UPDATE操作 + * - 更新后文件夹的PARENT_ID等于回收站文件夹ID（Notes.ID_TRASH_FOLER） + * 逻辑说明： + * - 将被移动文件夹的所有直接子项（PARENT_ID=old.ID）的父级也设置为回收站ID + * - 实现文件夹与子笔记的级联移动，确保数据完整性 + * 注意： + * - 仅处理直接子项，不递归处理子文件夹的子项（需业务层配合递归移动） + */ + 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_FOLER + + "BEGIN" + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.PARENT_ID + "=" + Notes.ID_TRASH_FOLER + + " WHERE " + NoteColumns.PARENT_ID + "=old." + NoteColumns.ID + ";" + + "END"; + + /** + * 构造方法 + * 初始化数据库辅助类实例 + * + * @param context 应用上下文 + */ + public NotesDatabaseHelper(Context context) { + // 调用父类构造器，传递数据库名和版本号 + super(context, DB_NAME, null, DB_VERSION); + } + + /** + * 创建笔记表及相关触发器，并初始化系统文件夹 + * 注意：此方法仅在数据库升级或重建时调用 + * + * @param db 可执行SQL的数据库对象 + */ + public void createNoteTable(SQLiteDatabase db) { + // 执行创建笔记表的SQL语句 + db.execSQL(CREATE_NOTE_TABLE_SQL); + + // 重新创建与笔记表相关的触发器（确保触发器存在且最新） + reCreateNoteTableTriggers(db); + + // 创建系统默认文件夹（如根目录、回收站等） + createSystemFolder(db); + + // 记录操作日志 + Log.d(TAG, "note table has been created"); + } + + /** + * 重新创建与笔记表相关的所有触发器 + * 操作步骤： + * 1. 先删除所有已存在的触发器（避免重复创建或定义冲突） + * 2. 按正确顺序重新创建所有触发器 + * 调用时机： + * - 在数据库创建时（onCreate） + * - 在数据库升级时（onUpgrade） + * - 当需要重置触发器逻辑时 + */ + private void reCreateNoteTableTriggers(SQLiteDatabase db) { + // ===================== + // 第一步：删除现有触发器 + // ===================== + + // 删除更新父文件夹时的计数触发器 + db.execSQL("DROP TRIGGER IF EXISTS increase_folder_count_on_update"); + db.execSQL("DROP TRIGGER IF EXISTS decrease_folder_count_on_update"); + + // 删除删除笔记时的计数触发器 + db.execSQL("DROP TRIGGER IF EXISTS decrease_folder_count_on_delete"); + + // 删除笔记时的级联删除触发器 + db.execSQL("DROP TRIGGER IF EXISTS delete_data_on_delete"); + + // 插入笔记时的计数触发器 + db.execSQL("DROP TRIGGER IF EXISTS increase_folder_count_on_insert"); + + // 删除文件夹时的级联删除触发器 + db.execSQL("DROP TRIGGER IF EXISTS folder_delete_notes_on_delete"); + + // 移动文件夹到回收站时的级联移动触发器 + db.execSQL("DROP TRIGGER IF EXISTS folder_move_notes_on_trash"); + + // ===================== + // 第二步：重新创建触发器 + // ===================== + + // 插入/更新/删除笔记时维护文件夹计数 + db.execSQL(NOTE_INCREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER); + db.execSQL(NOTE_DECREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER); + db.execSQL(NOTE_DECREASE_FOLDER_COUNT_ON_DELETE_TRIGGER); + db.execSQL(NOTE_INCREASE_FOLDER_COUNT_ON_INSERT_TRIGGER); + + // 级联删除逻辑 + db.execSQL(NOTE_DELETE_DATA_ON_DELETE_TRIGGER); // 删除笔记时删除关联数据 + db.execSQL(FOLDER_DELETE_NOTES_ON_DELETE_TRIGGER); // 删除文件夹时删除子笔记 + + // 回收站相关触发器 + db.execSQL(FOLDER_MOVE_NOTES_ON_TRASH_TRIGGER); // 移动文件夹到回收站时级联移动子项 + } + + /** + * 创建系统必要的文件夹 + * 这些文件夹是应用正常运行的基础，包含根目录、回收站等特殊文件夹 + * 特点： + * - 均为系统类型（TYPE_SYSTEM），通常不显示给用户 + * - 使用固定ID值，确保应用内引用一致性 + * 调用时机： + * - 在数据库创建时（onCreate） + * - 在数据库升级需要重置系统文件夹时 + */ + private void createSystemFolder(SQLiteDatabase db) { + ContentValues values = new ContentValues(); + + /** + * 创建通话记录文件夹 + * 用途：存储通话相关的笔记 + * 特殊属性： + * - ID固定为Notes.ID_CALL_RECORD_FOLDER + * - 类型为系统文件夹（TYPE_SYSTEM） + */ + values.put(NoteColumns.ID, Notes.ID_CALL_RECORD_FOLDER); + values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); + db.insert(TABLE.NOTE, null, values); + + /** + * 创建根文件夹 + * 用途：作为所有顶层文件夹和笔记的默认父级 + * 特殊属性： + * - ID固定为Notes.ID_ROOT_FOLDER + * - 类型为系统文件夹（TYPE_SYSTEM） + * - 通常在UI中显示为"所有笔记" + */ + values.clear(); + values.put(NoteColumns.ID, Notes.ID_ROOT_FOLDER); + values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); + db.insert(TABLE.NOTE, null, values); + + /** + * 创建临时文件夹 + * 用途：在笔记移动操作中作为中间存储位置 + * 特殊属性： + * - ID固定为Notes.ID_TEMPARAY_FOLDER + * - 类型为系统文件夹（TYPE_SYSTEM） + * - 通常不显示在UI中 + */ + values.clear(); + values.put(NoteColumns.ID, Notes.ID_TEMPARAY_FOLDER); + values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); + db.insert(TABLE.NOTE, null, values); + + /** + * 创建回收站文件夹 + * 用途：存储已删除的笔记和文件夹 + * 特殊属性： + * - ID固定为Notes.ID_TRASH_FOLER + * - 类型为系统文件夹（TYPE_SYSTEM） + * - 通常在UI中显示为"回收站"或"已删除" + */ + values.clear(); + values.put(NoteColumns.ID, Notes.ID_TRASH_FOLER); + values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); + db.insert(TABLE.NOTE, null, values); + } + + /** + * 创建附件数据表并初始化相关触发器和索引 + * 表结构：存储笔记的附件数据（如文本内容、图片、音频等） + * 执行流程： + * 1. 创建数据表结构 + * 2. 重建相关触发器（确保数据一致性） + * 3. 创建必要的索引（加速查询） + * + * @param db 可执行SQL的数据库对象 + */ + public void createDataTable(SQLiteDatabase db) { + // 执行创建数据表的SQL语句 + db.execSQL(CREATE_DATA_TABLE_SQL); + + // 重新创建与数据表相关的触发器（确保触发器逻辑最新） + reCreateDataTableTriggers(db); + + // 为DATA表的NOTE_ID字段创建索引（加速查询笔记关联的数据） + db.execSQL(CREATE_DATA_NOTE_ID_INDEX_SQL); + + // 记录操作日志 + Log.d(TAG, "data table has been created"); + } + + /** + * 重新创建与附件数据表相关的所有触发器 + * 操作步骤： + * 1. 删除已存在的触发器（避免重复创建或定义冲突） + * 2. 按正确顺序重新创建触发器 + * 触发器功能：维护主表(note)的SNIPPET字段与附件表(data)的CONTENT字段同步 + */ + private void reCreateDataTableTriggers(SQLiteDatabase db) { + // 删除现有触发器 + db.execSQL("DROP TRIGGER IF EXISTS update_note_content_on_insert"); + db.execSQL("DROP TRIGGER IF EXISTS update_note_content_on_update"); + db.execSQL("DROP TRIGGER IF EXISTS update_note_content_on_delete"); + + // 重新创建触发器： + // 1. 插入文本数据时更新主表摘要 + db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_INSERT_TRIGGER); + // 2. 更新文本数据时同步主表摘要 + db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_UPDATE_TRIGGER); + // 3. 删除文本数据时清空主表摘要 + db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_DELETE_TRIGGER); + } + + /** + * 获取数据库帮助类的单例实例 + * 实现线程安全的懒汉式单例模式 + * 特点： + * - 使用synchronized确保多线程环境下实例唯一 + * - 使用static synchronized方法保证类级锁 + * + * @param context 应用上下文 + * @return 数据库帮助类的单例实例 + */ + static synchronized NotesDatabaseHelper getInstance(Context context) { + // 双重检查锁定，确保只在实例未创建时进行同步操作 + if (mInstance == null) { + // 使用应用级上下文避免内存泄漏 + mInstance = new NotesDatabaseHelper(context.getApplicationContext()); + } + return mInstance; + } + + @Override + /** + * 数据库首次创建时调用 + * 执行流程： + * 1. 创建笔记主表（包含系统文件夹） + * 2. 创建附件数据表 + * 注意： + * - 此方法在事务中自动执行（由SQLiteOpenHelper保证） + * - 触发器会在表创建时自动重建（通过createNoteTable和createDataTable内部调用） + */ + @Override + public void onCreate(SQLiteDatabase db) { + // 创建笔记主表及系统文件夹 + createNoteTable(db); + + // 创建附件数据表及相关触发器 + createDataTable(db); + } + + @Override + /** + * 数据库版本升级时调用 + * 执行流程： + * 1. 根据当前版本和目标版本执行逐步升级 + * 2. 必要时重建触发器（确保触发器逻辑与新版本一致） + * 3. 验证最终版本是否符合预期 + * + * @param db 可执行SQL的数据库对象 + * @param oldVersion 当前数据库版本 + * @param newVersion 目标数据库版本 + */ + @Override + public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) { + boolean reCreateTriggers = false; // 是否需要重建触发器 + boolean skipV2 = false; // 是否跳过v2升级步骤 + + // 版本1 -> 版本2升级（示例：添加新字段） + if (oldVersion == 1) { + upgradeToV2(db); + skipV2 = true; // 若从v1直接升级到v3或更高，跳过v2的单独升级 + oldVersion++; + } + + // 版本2 -> 版本3升级（示例：修改表结构，需重建触发器） + if (oldVersion == 2 && !skipV2) { + upgradeToV3(db); + reCreateTriggers = true; // 标记需要重建触发器 + oldVersion++; + } + + // 版本3 -> 版本4升级（示例：添加新索引或触发器） + if (oldVersion == 3) { + upgradeToV4(db); + oldVersion++; + } + + // 若升级过程中修改了表结构，重建所有触发器 + if (reCreateTriggers) { + reCreateNoteTableTriggers(db); // 重建笔记表相关触发器 + reCreateDataTableTriggers(db); // 重建数据表相关触发器 + } + + // 验证升级后的版本是否与目标版本一致 + if (oldVersion != newVersion) { + throw new IllegalStateException("Upgrade notes database to version " + newVersion + + " fails"); + } + } + + /** + * 从版本1升级到版本2（示例：表结构重构） + * 操作说明： + * - 由于V1表结构设计存在重大缺陷，选择删除旧表并重建 + * - 重建后的数据表结构更优化（如新增字段、调整字段类型） + * - 会导致旧数据丢失，仅适用于开发阶段或测试环境 + * + * @param db 可执行SQL的数据库对象 + */ + private void upgradeToV2(SQLiteDatabase db) { + // 删除旧版本的表（V1表结构存在问题，需完全重建） + db.execSQL("DROP TABLE IF EXISTS " + TABLE.NOTE); + db.execSQL("DROP TABLE IF EXISTS " + TABLE.DATA); + + // 重新创建表结构（基于V2设计） + createNoteTable(db); + createDataTable(db); + + // 注意：此升级方式会导致数据丢失，生产环境应避免使用 + // 正确做法：通过ALTER TABLE逐步修改表结构并迁移数据 + } + + /** + * 从版本2升级到版本3（示例：新增功能字段和系统文件夹） + * 操作说明： + * 1. 删除不再使用的触发器（清理旧逻辑） + * 2. 添加Google Tasks集成字段（GTASK_ID） + * 3. 新增回收站系统文件夹（支持数据恢复功能） + * + * @param db 可执行SQL的数据库对象 + */ + private void upgradeToV3(SQLiteDatabase db) { + // ===================== + // 步骤1：清理旧触发器（不再使用的修改时间触发器） + // ===================== + db.execSQL("DROP TRIGGER IF EXISTS update_note_modified_date_on_insert"); + db.execSQL("DROP TRIGGER IF EXISTS update_note_modified_date_on_delete"); + db.execSQL("DROP TRIGGER IF EXISTS update_note_modified_date_on_update"); + + // ===================== + // 步骤2：添加新字段（支持Google Tasks同步） + // ===================== + db.execSQL("ALTER TABLE " + TABLE.NOTE + " ADD COLUMN " + NoteColumns.GTASK_ID + + " TEXT NOT NULL DEFAULT ''"); // 默认空字符串，避免NULL值 + + // ===================== + // 步骤3：创建回收站文件夹（系统级功能） + // ===================== + ContentValues values = new ContentValues(); + values.put(NoteColumns.ID, Notes.ID_TRASH_FOLER); // 固定ID标识回收站 + values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); // 标记为系统文件夹 + db.insert(TABLE.NOTE, null, values); // 插入系统表 + + // 补充说明： + // - 回收站文件夹用于存储删除的笔记，后续需配合触发器实现移动逻辑 + // - GTASK_ID字段用于存储与Google Tasks同步的任务ID + } + + /** + * 从版本3升级到版本4（示例：添加数据版本控制字段） + * 操作说明： + * - 添加VERSION字段用于数据冲突检测（乐观锁机制） + * - 默认值设为0，后续更新时通过触发器或业务逻辑递增 + * + * @param db 可执行SQL的数据库对象 + */ + private void upgradeToV4(SQLiteDatabase db) { + db.execSQL("ALTER TABLE " + TABLE.NOTE + " ADD COLUMN " + NoteColumns.VERSION + + " INTEGER NOT NULL DEFAULT 0"); // 版本号初始值为0 + + // 应用场景： + // 当多个设备同时修改同一条笔记时，通过比较VERSION字段避免数据覆盖 + // 更新时逻辑： + // UPDATE note SET content=? WHERE id=? AND version=old_version + // 成功后VERSION字段自增 + } +} \ No newline at end of file diff --git a/src/NotesProvider.java b/src/NotesProvider.java new file mode 100644 index 0000000..4f5261e --- /dev/null +++ b/src/NotesProvider.java @@ -0,0 +1,553 @@ +/* + * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net) + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package net.micode.notes.data; + + +import android.app.SearchManager; +import android.content.ContentProvider; +import android.content.ContentUris; +import android.content.ContentValues; +import android.content.Intent; +import android.content.UriMatcher; +import android.database.Cursor; +import android.database.sqlite.SQLiteDatabase; +import android.net.Uri; +import android.text.TextUtils; +import android.util.Log; + +import net.micode.notes.R; +import net.micode.notes.data.Notes.DataColumns; +import net.micode.notes.data.Notes.NoteColumns; +import net.micode.notes.data.NotesDatabaseHelper.TABLE; + + +/** + * 笔记应用的内容提供者 + * 负责管理数据访问接口，对外提供统一的URI访问方式 + * 功能： + * - 处理与笔记相关的CRUD操作 + * - 支持搜索和搜索建议功能 + * - 实现跨应用数据共享（若配置为exported=true） + */ +public class NotesProvider extends ContentProvider { + private static final UriMatcher mMatcher; // URI匹配器，用于解析不同的URI请求 + + private NotesDatabaseHelper mHelper; // 数据库辅助类实例 + + private static final String TAG = "NotesProvider"; // 日志标签 + + // URI匹配码常量（用于标识不同类型的URI请求） + private static final int URI_NOTE = 1; // 匹配所有笔记（content://authority/note） + private static final int URI_NOTE_ITEM = 2; // 匹配单个笔记（content://authority/note/123） + private static final int URI_DATA = 3; // 匹配所有附件数据（content://authority/data） + private static final int URI_DATA_ITEM = 4; // 匹配单个附件数据（content://authority/data/456） + private static final int URI_SEARCH = 5; // 匹配搜索请求（content://authority/search） + private static final int URI_SEARCH_SUGGEST = 6; // 匹配搜索建议请求（content://authority/search_suggest_query） + + // 静态初始化块：配置URI匹配规则 + static { + mMatcher = new UriMatcher(UriMatcher.NO_MATCH); // 创建URI匹配器，初始值为NO_MATCH + + // 注册笔记相关的URI匹配规则 + mMatcher.addURI(Notes.AUTHORITY, "note", URI_NOTE); // 匹配所有笔记 + mMatcher.addURI(Notes.AUTHORITY, "note/#", URI_NOTE_ITEM); // 匹配单个笔记（#表示数字通配符） + + // 注册附件数据相关的URI匹配规则 + mMatcher.addURI(Notes.AUTHORITY, "data", URI_DATA); // 匹配所有附件数据 + mMatcher.addURI(Notes.AUTHORITY, "data/#", URI_DATA_ITEM); // 匹配单个附件数据 + + // 注册搜索相关的URI匹配规则 + mMatcher.addURI(Notes.AUTHORITY, "search", URI_SEARCH); // 匹配搜索请求 + mMatcher.addURI(Notes.AUTHORITY, SearchManager.SUGGEST_URI_PATH_QUERY, URI_SEARCH_SUGGEST); // 匹配搜索建议（无参数） + mMatcher.addURI(Notes.AUTHORITY, SearchManager.SUGGEST_URI_PATH_QUERY + "/*", URI_SEARCH_SUGGEST); // 匹配带参数的搜索建议 + } + + /** + * 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. + */ + /** + * 搜索结果投影定义 + * 配置搜索建议列表的展示字段和点击行为 + * 包含：ID、标题、摘要、图标、点击动作等信息 + */ + private static final String NOTES_SEARCH_PROJECTION = + NoteColumns.ID + "," // 笔记ID（用于唯一标识） + + NoteColumns.ID + " AS " + SearchManager.SUGGEST_COLUMN_INTENT_EXTRA_DATA + "," // 点击时传递的额外数据（笔记ID） + + "TRIM(REPLACE(" + NoteColumns.SNIPPET + ", x'0A','')) AS " + SearchManager.SUGGEST_COLUMN_TEXT_1 + "," // 搜索结果第一行文本（去除换行符） + + "TRIM(REPLACE(" + NoteColumns.SNIPPET + ", x'0A','')) AS " + SearchManager.SUGGEST_COLUMN_TEXT_2 + "," // 搜索结果第二行文本（去除换行符） + + R.drawable.search_result + " AS " + SearchManager.SUGGEST_COLUMN_ICON_1 + "," // 搜索结果图标资源 + + "'" + Intent.ACTION_VIEW + "' AS " + SearchManager.SUGGEST_COLUMN_INTENT_ACTION + "," // 点击动作（查看笔记） + + "'" + Notes.TextNote.CONTENT_TYPE + "' AS " + SearchManager.SUGGEST_COLUMN_INTENT_DATA; // 点击数据类型 + + /** + * 笔记搜索SQL查询语句 + * 功能：在笔记摘要中进行模糊搜索，排除回收站中的笔记 + * 条件： + * - 摘要内容包含搜索关键词（使用LIKE） + * - 笔记不在回收站中（PARENT_ID <> 回收站ID） + * - 类型为普通笔记（TYPE = 0） + */ + private static String NOTES_SNIPPET_SEARCH_QUERY = + "SELECT " + NOTES_SEARCH_PROJECTION // 使用预定义的搜索投影 + + " FROM " + TABLE.NOTE // 从笔记表查询 + + " WHERE " + NoteColumns.SNIPPET + " LIKE ?" // 摘要模糊匹配（?为占位符） + + " AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER // 排除回收站中的笔记 + + " AND " + NoteColumns.TYPE + "=" + Notes.TYPE_NOTE; // 仅搜索普通笔记（非文件夹） + @Override + /** + * 内容提供者初始化方法 + * 功能： + * - 获取数据库辅助类的单例实例 + * - 确保数据库连接可用 + * 返回值： + * - true：初始化成功 + * - false：初始化失败（当前实现始终返回true） + */ + @Override + public boolean onCreate() { + // 获取数据库辅助类实例（使用单例模式） + mHelper = NotesDatabaseHelper.getInstance(getContext()); + + // 返回初始化状态（当前实现未检查数据库连接状态，始终返回true） + // 注意：实际应用中建议检查数据库是否可用并返回正确状态 + return true; + } + + @Override + /** + * 处理内容提供者的查询请求 + * 根据不同的 URI 匹配类型，执行对应的数据库查询操作 + * 支持的查询类型： + * - 查询所有笔记/单个笔记 + * - 查询所有附件/单个附件 + * - 搜索笔记（支持搜索建议） + * + * @param uri 请求的内容 URI + * @param projection 需要返回的列，null 表示返回所有列 + * @param selection 查询条件子句 + * @param selectionArgs 查询条件参数 + * @param sortOrder 排序方式 + * @return 查询结果 Cursor，若查询失败则返回 null + */ + @Override + public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, + String sortOrder) { + Cursor c = null; + SQLiteDatabase db = mHelper.getReadableDatabase(); // 获取可读数据库 + String id = null; // 存储从 URI 中提取的 ID + + // 根据 URI 匹配结果执行不同的查询逻辑 + switch (mMatcher.match(uri)) { + // ===================== + // 查询所有笔记 + // ===================== + case URI_NOTE: + c = db.query(TABLE.NOTE, projection, selection, selectionArgs, null, null, sortOrder); + break; + + // ===================== + // 查询单个笔记（通过 ID） + // ===================== + case URI_NOTE_ITEM: + id = uri.getPathSegments().get(1); // 从 URI 路径中提取 ID（如 /note/123 中的 123） + c = db.query(TABLE.NOTE, projection, + NoteColumns.ID + "=" + id + parseSelection(selection), // 构建 WHERE 子句 + selectionArgs, null, null, sortOrder); + break; + + // ===================== + // 查询所有附件数据 + // ===================== + case URI_DATA: + c = db.query(TABLE.DATA, projection, selection, selectionArgs, null, null, sortOrder); + break; + + // ===================== + // 查询单个附件数据（通过 ID） + // ===================== + case URI_DATA_ITEM: + id = uri.getPathSegments().get(1); // 从 URI 路径中提取 ID + c = db.query(TABLE.DATA, projection, + DataColumns.ID + "=" + id + parseSelection(selection), // 构建 WHERE 子句 + selectionArgs, null, null, sortOrder); + break; + + // ===================== + // 搜索功能（包括搜索建议） + // ===================== + case URI_SEARCH: + case URI_SEARCH_SUGGEST: + // 搜索查询不支持自定义 projection 和 sortOrder + if (sortOrder != null || projection != null) { + throw new IllegalArgumentException( + "do not specify sortOrder, selection, selectionArgs, or projection with this query"); + } + + String searchString = null; + // 从不同类型的 URI 中提取搜索关键词 + if (mMatcher.match(uri) == URI_SEARCH_SUGGEST) { + if (uri.getPathSegments().size() > 1) { + searchString = uri.getPathSegments().get(1); // 从路径段获取关键词 + } + } else { + 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) { + Log.e(TAG, "got exception: " + ex.toString()); + } + break; + + // ===================== + // 未知 URI 类型 + // ===================== + default: + throw new IllegalArgumentException("Unknown URI " + uri); + } + + // 设置 URI 通知（当数据变化时通知观察者） + if (c != null) { + c.setNotificationUri(getContext().getContentResolver(), uri); + } + + return c; + } + + @Override + /** + * 处理内容提供者的插入请求 + * 根据不同的 URI 匹配类型，执行对应的数据库插入操作 + * 插入成功后会通知所有注册的观察者数据已变更 + * + * @param uri 请求的内容 URI + * @param values 要插入的数据 + * @return 插入后的新记录的完整 URI + */ + @Override + public Uri insert(Uri uri, ContentValues values) { + SQLiteDatabase db = mHelper.getWritableDatabase(); // 获取可写数据库 + long dataId = 0, noteId = 0, insertedId = 0; // 存储插入后的记录ID + + // 根据 URI 匹配结果执行不同的插入逻辑 + switch (mMatcher.match(uri)) { + // ===================== + // 插入新笔记 + // ===================== + case URI_NOTE: + insertedId = noteId = db.insert(TABLE.NOTE, null, values); + break; + + // ===================== + // 插入新附件数据 + // ===================== + case URI_DATA: + // 检查是否包含关联的笔记ID + if (values.containsKey(DataColumns.NOTE_ID)) { + noteId = values.getAsLong(DataColumns.NOTE_ID); + } else { + Log.d(TAG, "Wrong data format without note id:" + values.toString()); + } + insertedId = dataId = db.insert(TABLE.DATA, null, values); + break; + + // ===================== + // 未知 URI 类型 + // ===================== + default: + throw new IllegalArgumentException("Unknown URI " + uri); + } + + // ===================== + // 数据变更通知 + // ===================== + // 通知笔记 URI 的观察者（如果有笔记ID） + if (noteId > 0) { + getContext().getContentResolver().notifyChange( + ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), null); + } + + // 通知附件数据 URI 的观察者（如果有数据ID） + if (dataId > 0) { + getContext().getContentResolver().notifyChange( + ContentUris.withAppendedId(Notes.CONTENT_DATA_URI, dataId), null); + } + + // 返回插入记录的完整 URI（如 content://authority/note/123） + return ContentUris.withAppendedId(uri, insertedId); + } + + @Override + /** + * 处理内容提供者的删除请求 + * 根据不同的 URI 匹配类型，执行对应的数据库删除操作 + * 支持删除单个/多个笔记或附件数据，并在删除后通知观察者 + * + * @param uri 请求的内容 URI + * @param selection 删除条件子句 + * @param selectionArgs 删除条件参数 + * @return 成功删除的记录数 + */ + @Override + public int delete(Uri uri, String selection, String[] selectionArgs) { + int count = 0; // 记录删除的行数 + String id = null; // 存储从 URI 中提取的 ID + SQLiteDatabase db = mHelper.getWritableDatabase(); // 获取可写数据库 + boolean deleteData = false; // 标记是否删除附件数据（用于通知逻辑） + + // 根据 URI 匹配结果执行不同的删除逻辑 + switch (mMatcher.match(uri)) { + // ===================== + // 删除多个笔记（批量删除） + // ===================== + case URI_NOTE: + // 添加额外条件：ID > 0（排除系统文件夹，ID 通常为负数或 0） + selection = "(" + selection + ") AND " + NoteColumns.ID + ">0 "; + count = db.delete(TABLE.NOTE, selection, selectionArgs); + break; + + // ===================== + // 删除单个笔记（通过 ID） + // ===================== + case URI_NOTE_ITEM: + id = uri.getPathSegments().get(1); // 提取路径中的 ID（如 /note/123 中的 123） + long noteId = Long.valueOf(id); + + // 保护系统文件夹（ID <= 0 的为系统保留，如回收站、根目录） + if (noteId <= 0) { + Log.w(TAG, "Attempt to delete system folder: ID=" + noteId); + break; + } + + // 构建删除条件（ID 匹配 + 额外条件） + count = db.delete(TABLE.NOTE, + NoteColumns.ID + "=" + id + parseSelection(selection), + selectionArgs); + break; + + // ===================== + // 删除多个附件数据（批量删除） + // ===================== + case URI_DATA: + count = db.delete(TABLE.DATA, selection, selectionArgs); + deleteData = true; // 标记删除的是附件数据 + break; + + // ===================== + // 删除单个附件数据（通过 ID） + // ===================== + case URI_DATA_ITEM: + id = uri.getPathSegments().get(1); // 提取路径中的 ID + count = db.delete(TABLE.DATA, + DataColumns.ID + "=" + id + parseSelection(selection), + selectionArgs); + deleteData = true; // 标记删除的是附件数据 + break; + + // ===================== + // 未知 URI 类型 + // ===================== + default: + throw new IllegalArgumentException("Unknown URI " + uri); + } + + // ===================== + // 数据变更通知 + // ===================== + if (count > 0) { + if (deleteData) { + // 删除附件数据后，通知所有笔记 URI（可能影响笔记摘要） + getContext().getContentResolver().notifyChange(Notes.CONTENT_NOTE_URI, null); + } + // 通知具体的删除 URI（单个或批量） + getContext().getContentResolver().notifyChange(uri, null); + } + + return count; + } + + @Override + /** + * 处理内容提供者的更新请求 + * 根据不同的 URI 匹配类型，执行对应的数据库更新操作 + * 支持更新单个/多个笔记或附件数据，并在更新后通知观察者 + * + * @param uri 请求的内容 URI + * @param values 要更新的数据 + * @param selection 更新条件子句 + * @param selectionArgs 更新条件参数 + * @return 成功更新的记录数 + */ + @Override + public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs) { + int count = 0; // 记录更新的行数 + String id = null; // 存储从 URI 中提取的 ID + SQLiteDatabase db = mHelper.getWritableDatabase(); // 获取可写数据库 + boolean updateData = false; // 标记是否更新附件数据（用于通知逻辑） + + // 根据 URI 匹配结果执行不同的更新逻辑 + switch (mMatcher.match(uri)) { + // ===================== + // 更新多个笔记（批量更新） + // ===================== + case URI_NOTE: + // 增加匹配笔记的版本号（用于冲突检测） + increaseNoteVersion(-1, selection, selectionArgs); + count = db.update(TABLE.NOTE, values, selection, selectionArgs); + break; + + // ===================== + // 更新单个笔记（通过 ID） + // ===================== + case URI_NOTE_ITEM: + id = uri.getPathSegments().get(1); // 提取路径中的 ID + // 增加指定笔记的版本号 + increaseNoteVersion(Long.valueOf(id), selection, selectionArgs); + count = db.update(TABLE.NOTE, values, + NoteColumns.ID + "=" + id + parseSelection(selection), + selectionArgs); + break; + + // ===================== + // 更新多个附件数据（批量更新） + // ===================== + case URI_DATA: + count = db.update(TABLE.DATA, values, selection, selectionArgs); + updateData = true; // 标记更新的是附件数据 + break; + + // ===================== + // 更新单个附件数据（通过 ID） + // ===================== + case URI_DATA_ITEM: + id = uri.getPathSegments().get(1); // 提取路径中的 ID + count = db.update(TABLE.DATA, values, + DataColumns.ID + "=" + id + parseSelection(selection), + selectionArgs); + updateData = true; // 标记更新的是附件数据 + break; + + // ===================== + // 未知 URI 类型 + // ===================== + default: + throw new IllegalArgumentException("Unknown URI " + uri); + } + + // ===================== + // 数据变更通知 + // ===================== + if (count > 0) { + if (updateData) { + // 更新附件数据后，通知所有笔记 URI（可能影响笔记摘要） + getContext().getContentResolver().notifyChange(Notes.CONTENT_NOTE_URI, null); + } + // 通知具体的更新 URI（单个或批量） + getContext().getContentResolver().notifyChange(uri, null); + } + + return count; + } + + /** + * 解析额外的查询条件，拼接为 AND 子句 + * 用途：在更新/删除操作中，将客户端传递的 selection 拼接为完整的 WHERE 条件 + * + * @param selection 客户端传递的查询条件（如 "status='archived'"） + * @return 拼接后的 AND 子句（如 " AND (status='archived')"） + */ + private String parseSelection(String selection) { + // 若 selection 不为空，包裹在括号中并添加 AND 前缀 + return (!TextUtils.isEmpty(selection) ? " AND (" + selection + ')' : ""); + } + /** + * 增加笔记的版本号（用于乐观锁冲突检测） + * 支持单条记录或批量记录的版本号自增 + * + * @param id 笔记ID（id>0时更新单条记录，id=-1时更新所有符合条件的记录） + * @param selection 批量更新的筛选条件（如 "modified_date 0 || !TextUtils.isEmpty(selection)) { + sql.append(" WHERE "); + } + + // 处理单条记录更新（id>0） + if (id > 0) { + sql.append(NoteColumns.ID + "=" + String.valueOf(id)); + } + + // 处理批量更新的筛选条件 + if (!TextUtils.isEmpty(selection)) { + // 根据是否存在id，决定是否需要解析selection（避免重复添加AND） + String selectString = id > 0 ? parseSelection(selection) : selection; + + // 替换占位符？为实际参数值（注意：此方法存在SQL注入风险！） + if (selectionArgs != null && selectionArgs.length > 0) { + for (String arg : selectionArgs) { + selectString = selectString.replaceFirst("\\?", arg); + } + } + + sql.append(selectString); + } + + // 执行SQL语句 + mHelper.getWritableDatabase().execSQL(sql.toString()); + } + + @Override + /** + * 获取 URI 对应的内容类型（未实现） + * 用途：返回数据的MIME类型，供其他应用或组件识别 + * + * @param uri 请求的内容 URI + * @return MIME类型字符串（如 "vnd.android.cursor.dir/note"） + * + * TODO：需根据URI类型实现具体逻辑，示例： + * switch (mMatcher.match(uri)) { + * case URI_NOTE: return "vnd.android.cursor.dir/vnd.com.example.notes.note"; + * case URI_NOTE_ITEM: return "vnd.android.cursor.item/vnd.com.example.notes.note"; + * // 其他类型... + * } + */ + @Override + public String getType(Uri uri) { + // TODO Auto-generated method stub + return null; + } + +}