/* * 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. */ // 包声明,该类位于net.micode.notes.data包下,用于处理笔记相关的数据库操作 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; // NotesDatabaseHelper类继承自SQLiteOpenHelper,用于管理和操作笔记应用的数据库, // 包括数据库的创建、升级以及相关表结构、触发器等的维护 public class NotesDatabaseHelper extends SQLiteOpenHelper { // 数据库名称 private static final String DB_NAME = "note.db"; // 数据库版本号,用于数据库升级时的版本判断 private static final int DB_VERSION = 4; // 定义内部接口TABLE,用于存放数据库中表的名称常量,方便统一管理和引用 public interface TABLE { // 存放笔记基本信息的表名 public static final String NOTE = "note"; // 存放笔记相关数据(如附件等内容)的表名 public static final String DATA = "data"; } // 用于日志输出的标签,方便在Logcat中识别该类相关的日志信息 private static final String TAG = "NotesDatabaseHelper"; // 采用单例模式,保存该类的唯一实例 private static NotesDatabaseHelper mInstance; // 创建note表的SQL语句,定义了表的结构,包括各个列名、数据类型、默认值以及主键等信息 private static final String CREATE_NOTE_TABLE_SQL = "CREATE TABLE " + TABLE.NOTE + "(" + NoteColumns.ID + " INTEGER PRIMARY KEY," + NoteColumns.PARENT_ID + " INTEGER NOT NULL DEFAULT 0," + NoteColumns.ALERTED_DATE + " INTEGER NOT NULL DEFAULT 0," + NoteColumns.BG_COLOR_ID + " INTEGER NOT NULL DEFAULT 0," + NoteColumns.CREATED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + NoteColumns.HAS_ATTACHMENT + " INTEGER NOT NULL DEFAULT 0," + NoteColumns.MODIFIED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + NoteColumns.NOTES_COUNT + " INTEGER NOT NULL DEFAULT 0," + NoteColumns.SNIPPET + " TEXT NOT NULL DEFAULT ''," + NoteColumns.TYPE + " INTEGER NOT NULL DEFAULT 0," + NoteColumns.WIDGET_ID + " INTEGER NOT NULL DEFAULT 0," + NoteColumns.WIDGET_TYPE + " INTEGER NOT NULL DEFAULT -1," + NoteColumns.SYNC_ID + " INTEGER NOT NULL DEFAULT 0," + NoteColumns.LOCAL_MODIFIED + " INTEGER NOT NULL DEFAULT 0," + NoteColumns.ORIGIN_PARENT_ID + " INTEGER NOT NULL DEFAULT 0," + NoteColumns.GTASK_ID + " TEXT NOT NULL DEFAULT ''," + NoteColumns.VERSION + " INTEGER NOT NULL DEFAULT 0" + ")"; // 创建data表的SQL语句,同样定义了表的结构,包含各列的详细信息,用于存储笔记相关的数据内容 private static final String CREATE_DATA_TABLE_SQL = "CREATE TABLE " + TABLE.DATA + "(" + DataColumns.ID + " INTEGER PRIMARY KEY," + DataColumns.MIME_TYPE + " TEXT NOT NULL," + DataColumns.NOTE_ID + " INTEGER NOT NULL DEFAULT 0," + NoteColumns.CREATED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + NoteColumns.MODIFIED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + DataColumns.CONTENT + " TEXT NOT NULL DEFAULT ''," + DataColumns.DATA1 + " INTEGER," + DataColumns.DATA2 + " INTEGER," + DataColumns.DATA3 + " TEXT NOT NULL DEFAULT ''," + DataColumns.DATA4 + " TEXT NOT NULL DEFAULT ''," + DataColumns.DATA5 + " TEXT NOT NULL DEFAULT ''" + ")"; // 创建基于note_id的索引的SQL语句,用于提高在DATA表中根据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 + ");"; /** * 当将笔记移动到文件夹时,增加文件夹的笔记数量的触发器SQL语句。 * 在更新note表的PARENT_ID列后触发,会根据新的父文件夹ID增加对应文件夹的笔记数量 */ 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"; /** * 当从文件夹中移出笔记时,减少文件夹的笔记数量的触发器SQL语句。 * 在更新note表的PARENT_ID列后触发,会根据旧的父文件夹ID减少对应文件夹的笔记数量, * 同时要确保笔记数量大于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"; /** * 当向文件夹中插入新笔记时,增加文件夹的笔记数量的触发器SQL语句。 * 在向note表插入新记录后触发,会根据新笔记的父文件夹ID增加对应文件夹的笔记数量 */ 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"; /** * 当从文件夹中删除笔记时,减少文件夹的笔记数量的触发器SQL语句。 * 在从note表删除记录后触发,会根据被删除笔记的旧父文件夹ID减少对应文件夹的笔记数量, * 并且要保证文件夹的笔记数量大于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"; /** * 当插入类型为{@link DataConstants#NOTE}的数据时,更新笔记内容的触发器SQL语句。 * 在向DATA表插入新记录后触发,如果插入的数据类型是笔记类型, * 则会将对应笔记的摘要(SNIPPET)更新为新插入数据的内容(CONTENT) */ 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"; /** * 当类型为{@link DataConstants#NOTE}的数据更新时,更新笔记内容的触发器SQL语句。 * 在更新DATA表的记录后触发,如果更新前的数据类型是笔记类型, * 则会将对应笔记的摘要(SNIPPET)更新为更新后的数据内容(CONTENT) */ 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"; /** * 当类型为{@link DataConstants#NOTE}的数据被删除时,更新笔记内容的触发器SQL语句。 * 在从DATA表删除记录后触发,如果被删除的数据类型是笔记类型, * 则会将对应笔记的摘要(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"; /** * 当笔记被删除时,删除该笔记相关数据的触发器SQL语句。 * 在从note表删除记录后触发,会删除DATA表中与被删除笔记相关联的数据(通过NOTE_ID关联) */ private static final String NOTE_DELETE_DATA_ON_DELETE_TRIGGER = "CREATE TRIGGER delete_data_on_delete " + " AFTER DELETE ON " + TABLE.NOTE + " BEGIN" + " DELETE FROM " + TABLE.DATA + " WHERE " + DataColumns.NOTE_ID + "=old." + NoteColumns.ID + ";" + " END"; /** * 当文件夹被删除时,删除该文件夹下所有笔记的触发器SQL语句。 * 在从note表删除记录(可能是文件夹对应的记录)后触发,会删除note表中属于该文件夹的所有笔记 */ 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"; /** * 当文件夹被移动到回收站文件夹时,移动该文件夹下所有笔记到回收站文件夹的触发器SQL语句。 * 在更新note表的PARENT_ID列(可能是文件夹移动操作)后触发,如果新的父文件夹ID是回收站文件夹ID, * 则会将原属于该文件夹的所有笔记的父文件夹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"; // 构造函数,调用父类(SQLiteOpenHelper)的构造函数来初始化数据库相关信息,传入上下文、数据库名称、游标工厂(此处为null)以及数据库版本号 public NotesDatabaseHelper(Context context) { super(context, DB_NAME, null, DB_VERSION); } // 在数据库中创建note表的方法,执行创建表的SQL语句,重新创建note表相关的触发器,并创建系统文件夹 public void createNoteTable(SQLiteDatabase db) { db.execSQL(CREATE_NOTE_TABLE_SQL); reCreateNoteTableTriggers(db); createSystemFolder(db); Log.d(TAG, "note table has been created"); } // 重新创建note表相关触发器的方法,先删除已存在的同名触发器(如果有),再重新创建所有定义的note表相关触发器 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_DELETE_DATA_ON_DELETE_TRIGGER); db.execSQL(NOTE_INCREASE_FOLDER_COUNT_ON_INSERT_TRIGGER); db.execSQL(FOLDER_DELETE_NOTES_ON_DELETE_TRIGGER); db.execSQL(FOLDER_MOVE_NOTES_ON_TRASH_TRIGGER); } // 创建系统文件夹的方法,向note表中插入不同类型的系统文件夹记录,如通话记录文件夹、根文件夹、临时文件夹、回收站文件夹等 private void createSystemFolder(SQLiteDatabase db) { ContentValues values = new ContentValues(); // 通话记录文件夹,设置相关字段值并插入到note表 /** * call record foler for call notes */ values.put(NoteColumns.ID, Notes.ID_CALL_RECORD_FOLDER); values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); db.insert(TABLE.NOTE, null, values); // 根文件夹,清空ContentValues后重新设置字段值并插入到note表,根文件夹是默认文件夹 /** * root folder which is default folder */ values.clear(); values.put(NoteColumns.ID, Notes.ID_ROOT_FOLDER); values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); db.insert(TABLE.NOTE, null, values); // 临时文件夹,用于临时移动笔记等操作,同样设置字段值后插入到note表 /** * temporary folder which is used for moving note */ values.clear(); values.put(NoteColumns.ID, Notes.ID_TEMPARAY_FOLDER); values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); db.insert(TABLE.NOTE, null, values); /** * 创建根文件夹并插入到数据库的note表中。 * 根文件夹作为默认文件夹,设置其对应的ID和类型字段值后插入。 * 先清空ContentValues对象(避免之前残留数据的影响),再设置相应字段值。 */ /** * root folder which is default folder */ values.clear(); values.put(NoteColumns.ID, Notes.ID_ROOT_FOLDER); values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); db.insert(TABLE.NOTE, null, values); /** * 创建临时文件夹并插入到数据库的note表中。 * 临时文件夹用于笔记移动等操作,同样先清空ContentValues对象,然后设置其ID和类型字段值,最后插入到表中。 */ /** * temporary folder which is used for moving note */ values.clear(); values.put(NoteColumns.ID, Notes.ID_TEMPARAY_FOLDER); values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); db.insert(TABLE.NOTE, null, values); /** * 创建回收站文件夹并插入到数据库的note表中。 * 先清空ContentValues对象,接着设置回收站文件夹的ID和类型字段值,随后将其插入到note表中,用于存放被删除或移到回收站的笔记等相关操作。 */ /** * create trash folder */ values.clear(); values.put(NoteColumns.ID, Notes.ID_TRASH_FOLER); values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); db.insert(TABLE.NOTE, null, values); } /** * 在数据库中创建data表的方法。 * 首先执行创建data表的SQL语句来定义表结构,然后重新创建与data表相关的触发器, * 最后创建基于note_id的索引,以提高查询效率,并输出日志表示data表已创建成功。 */ public void createDataTable(SQLiteDatabase db) { db.execSQL(CREATE_DATA_TABLE_SQL); reCreateDataTableTriggers(db); db.execSQL(CREATE_DATA_NOTE_ID_INDEX_SQL); Log.d(TAG, "data table has been created"); } /** * 重新创建data表相关触发器的私有方法。 * 先删除已存在的同名触发器(如果有的话),这是为了避免重复创建或旧触发器逻辑与新逻辑冲突等问题。 * 然后再执行创建相应触发器的SQL语句,用于处理如插入、更新、删除data表中数据时与note表关联字段的同步更新等操作。 */ private void reCreateDataTableTriggers(SQLiteDatabase db) { db.execSQL("DROP TRIGGER IF EXISTS update_note_content_on_insert"); db.execSQL("DROP TRIGGER IF EXISTS update_note_content_on_update"); db.execSQL("DROP TRIGGER IF EXISTS update_note_content_on_delete"); db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_INSERT_TRIGGER); db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_UPDATE_TRIGGER); db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_DELETE_TRIGGER); } /** * 采用单例模式获取NotesDatabaseHelper实例的静态同步方法。 * 如果实例mInstance为空,则创建一个新的NotesDatabaseHelper对象并赋值给mInstance, * 保证整个应用中只有一个该类的实例存在,便于统一管理数据库操作相关资源。 * 最后返回该实例,供其他地方调用数据库相关操作方法。 */ static synchronized NotesDatabaseHelper getInstance(Context context) { if (mInstance == null) { mInstance = new NotesDatabaseHelper(context); } return mInstance; } /** * 重写SQLiteOpenHelper的onCreate方法,当数据库首次创建时被调用。 * 该方法内会分别调用创建note表和data表的方法,完成数据库初始表结构的创建工作, * 使得数据库具备存储笔记基本信息和相关数据的能力。 */ @Override public void onCreate(SQLiteDatabase db) { createNoteTable(db); createDataTable(db); } /** * 重写SQLiteOpenHelper的onUpgrade方法,用于数据库升级操作。 * 根据旧版本号与新版本号的对比来执行相应的升级逻辑,比如添加新表、修改表结构、添加触发器等。 * 定义了两个布尔变量用于控制是否需要重新创建触发器以及是否跳过特定版本的升级逻辑。 */ @Override public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) { boolean reCreateTriggers = false; boolean skipV2 = false; // 如果旧版本号是1,执行升级到版本2的操作,并标记跳过单独的从版本2到版本3的升级步骤(因为此次升级可能包含了后续版本升级的部分内容),然后将旧版本号加1。 if (oldVersion == 1) { upgradeToV2(db); skipV2 = true; // this upgrade including the upgrade from v2 to v3 oldVersion++; } // 如果旧版本号是2且没有跳过版本2升级的标记,执行升级到版本3的操作,并设置需要重新创建触发器的标记为true,之后将旧版本号加1。 if (oldVersion == 2 &&!skipV2) { upgradeToV3(db); reCreateTriggers = true; oldVersion++; } // 如果旧版本号是3,执行升级到版本4的操作,然后将旧版本号加1。 if (oldVersion == 3) { upgradeToV4(db); oldVersion++; } // 如果需要重新创建触发器,分别调用重新创建note表和data表相关触发器的方法,确保触发器逻辑与升级后的数据库结构相匹配。 if (reCreateTriggers) { reCreateNoteTableTriggers(db); reCreateDataTableTriggers(db); } // 如果最终旧版本号与新版本号不相等,说明升级过程出现问题,抛出异常表示数据库升级失败。 if (oldVersion!= newVersion) { throw new IllegalStateException("Upgrade notes database to version " + newVersion + "fails"); } } /** * 执行从版本1升级到版本2的具体操作的私有方法。 * 先删除已存在的note表和data表(如果有的话),然后重新创建这两个表,以更新表结构等相关内容, * 实现数据库从版本1到版本2的升级逻辑,比如可能涉及到表结构的调整、新增字段等情况。 */ private void upgradeToV2(SQLiteDatabase db) { db.execSQL("DROP TABLE IF EXISTS " + TABLE.NOTE); db.execSQL("DROP TABLE IF EXISTS " + TABLE.DATA); createNoteTable(db); createDataTable(db); } /** * 执行从版本2升级到版本3的具体操作的私有方法。 * 首先删除一些不再使用的触发器,避免其对后续逻辑产生干扰。 * 接着向note表中添加一个新的列(gtask_id)用于存储相关任务ID信息,扩充了note表的结构。 * 最后创建一个回收站系统文件夹,完善系统文件夹相关功能设置,实现版本2到版本3的升级逻辑。 */ private void upgradeToV3(SQLiteDatabase db) { // drop unused triggers db.execSQL("DROP TRIGGER IF EXISTS update_note_modified_date_on_insert"); db.execSQL("DROP TRIGGER IF EXISTS update_note_modified_date_on_delete"); db.execSQL("DROP TRIGGER IF EXISTS update_note_modified_date_on_update"); // add a column for gtask id db.execSQL("ALTER TABLE " + TABLE.NOTE + " ADD COLUMN " + NoteColumns.GTASK_ID + " TEXT NOT NULL DEFAULT ''"); // add a trash system folder ContentValues values = new ContentValues(); values.put(NoteColumns.ID, Notes.ID_TRASH_FOLER); values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); db.insert(TABLE.NOTE, null, values); } /** * 执行从版本3升级到版本4的具体操作的私有方法。 * 通过ALTER TABLE语句向note表中添加一个新的列(version),并设置默认值为0, * 可能用于记录笔记相关的版本信息等,实现从版本3到版本4的数据库升级逻辑,完善表结构。 */ private void upgradeToV4(SQLiteDatabase db) { db.execSQL("ALTER TABLE " + TABLE.NOTE + " ADD COLUMN " + NoteColumns.VERSION + " INTEGER NOT NULL DEFAULT 0"); } }