diff --git a/代码解读/MiNotes-master/app/src/main/java/net/micode/notes/data/NotesDatabaseHelper.java b/代码解读/MiNotes-master/app/src/main/java/net/micode/notes/data/NotesDatabaseHelper.java index 4721b0c..aa5a860 100644 --- a/代码解读/MiNotes-master/app/src/main/java/net/micode/notes/data/NotesDatabaseHelper.java +++ b/代码解读/MiNotes-master/app/src/main/java/net/micode/notes/data/NotesDatabaseHelper.java @@ -1,30 +1,31 @@ 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.content.ContentValues;//就是用于保存一些数据（string boolean byte double float int long short ...）信息，这些信息可以被数据库操作时使用。 +import android.content.Context;//加载和访问资源。（android中主要是这两个功能，但是这里具体不清楚） +import android.database.sqlite.SQLiteDatabase;//主要提供了对应于添加、删除、更新、查询的操作方法： insert()、delete()、update()和query()。配合content.values +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; +//数据库操作，用SQLOpenhelper,对一些note和文件进行数据库的操作，比如删除文件后，将文件里的note也相应删除 -// 数据库帮助类 public class NotesDatabaseHelper extends SQLiteOpenHelper { - private static final String DB_NAME = "note.db"; // 数据库名 - private static final int DB_VERSION = 4; // 数据库版本号 + private static final String DB_NAME = "note.db"; - // 数据表名称常量 - public interface TABLE { + private static final int DB_VERSION = 4; + + public interface TABLE { //接口，分成note和data，在后面的程序里分别使用过 public static final String NOTE = "note"; + public static final String DATA = "data"; } - private static final String TAG = "NotesDatabaseHelper"; // 日志tag - private static NotesDatabaseHelper mInstance; // 数据库帮助类实例 + private static final String TAG = "NotesDatabaseHelper"; + + private static NotesDatabaseHelper mInstance; - // 创建笔记数据表的SQL语句 private static final String CREATE_NOTE_TABLE_SQL = "CREATE TABLE " + TABLE.NOTE + "(" + NoteColumns.ID + " INTEGER PRIMARY KEY," + @@ -44,9 +45,8 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { NoteColumns.ORIGIN_PARENT_ID + " INTEGER NOT NULL DEFAULT 0," + NoteColumns.GTASK_ID + " TEXT NOT NULL DEFAULT ''," + NoteColumns.VERSION + " INTEGER NOT NULL DEFAULT 0" + - ")"; + ")";//数据库中需要存储的项目的名称，就相当于创建一个表格的表头的内容。 - // 创建笔记内容数据表的SQL语句 private static final String CREATE_DATA_TABLE_SQL = "CREATE TABLE " + TABLE.DATA + "(" + DataColumns.ID + " INTEGER PRIMARY KEY," + @@ -60,33 +60,28 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { DataColumns.DATA3 + " TEXT NOT NULL DEFAULT ''," + DataColumns.DATA4 + " TEXT NOT NULL DEFAULT ''," + DataColumns.DATA5 + " TEXT NOT NULL DEFAULT ''" + - ")"; - /** - *创建笔记在SQL中的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 + ");"; + TABLE.DATA + "(" + DataColumns.NOTE_ID + ");";//存储便签编号的一个数据表格 /** - * 将笔记移动到文件夹时增加文件夹的笔记计数 + * Increase folder's note count when move note to the folder */ private static final String NOTE_INCREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER = - //当在文件夹中插入新笔记时，该触发器会自动更新该文件夹中的笔记计数。 "CREATE TRIGGER increase_folder_count_on_update "+ " 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"; + " END";//在文件夹中移入一个Note之后需要更改的数据的表格。 /** - * 将笔记从文件夹移出时减少文件夹的笔记计数 + * Decrease folder's note count when move note from folder */ private static final String NOTE_DECREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER = - //：当笔记从一个文件夹中移出时，该触发器会自动更新该文件夹中的笔记计数。 "CREATE TRIGGER decrease_folder_count_on_update " + " AFTER UPDATE OF " + NoteColumns.PARENT_ID + " ON " + TABLE.NOTE + " BEGIN " + @@ -94,23 +89,22 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { " SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + "-1" + " WHERE " + NoteColumns.ID + "=old." + NoteColumns.PARENT_ID + " AND " + NoteColumns.NOTES_COUNT + ">0" + ";" + - " END"; + " END";//在文件夹中移出一个Note之后需要更改的数据的表格。 /** - * 在文件夹中插入新笔记时增加文件夹的笔记计数 + * Increase folder's note count when insert new note to the folder */ private static final String NOTE_INCREASE_FOLDER_COUNT_ON_INSERT_TRIGGER = - //当笔记被移动到一个文件夹时，该触发器会自动更新该文件夹中的笔记计数。 "CREATE TRIGGER increase_folder_count_on_insert " + " AFTER INSERT ON " + TABLE.NOTE + " BEGIN " + " UPDATE " + TABLE.NOTE + " SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + " + 1" + " WHERE " + NoteColumns.ID + "=new." + NoteColumns.PARENT_ID + ";" + - " END"; + " END";//在文件夹中插入一个Note之后需要更改的数据的表格。 /** - * 减少文件夹中的笔记数量（当从文件夹中删除笔记时） + * Decrease folder's note count when delete note from the folder */ private static final String NOTE_DECREASE_FOLDER_COUNT_ON_DELETE_TRIGGER = "CREATE TRIGGER decrease_folder_count_on_delete " + @@ -120,10 +114,10 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { " SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + "-1" + " WHERE " + NoteColumns.ID + "=old." + NoteColumns.PARENT_ID + " AND " + NoteColumns.NOTES_COUNT + ">0;" + - " END"; + " END";//在文件夹中删除一个Note之后需要更改的数据的表格。 /** - * 在插入类型为 {@link DataConstants#NOTE} 的数据时更新笔记的内容 + * Update note's content when insert data with type {@link DataConstants#NOTE} */ private static final String DATA_UPDATE_NOTE_CONTENT_ON_INSERT_TRIGGER = "CREATE TRIGGER update_note_content_on_insert " + @@ -133,10 +127,10 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { " UPDATE " + TABLE.NOTE + " SET " + NoteColumns.SNIPPET + "=new." + DataColumns.CONTENT + " WHERE " + NoteColumns.ID + "=new." + DataColumns.NOTE_ID + ";" + - " END"; + " END";//在文件夹中对一个Note导入新的数据之后需要更改的数据的表格。 /** - * 在类型为 {@link DataConstants#NOTE} 的数据更新时更新笔记的内容 + * Update note's content when data with {@link DataConstants#NOTE} type has changed */ private static final String DATA_UPDATE_NOTE_CONTENT_ON_UPDATE_TRIGGER = "CREATE TRIGGER update_note_content_on_update " + @@ -146,10 +140,10 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { " UPDATE " + TABLE.NOTE + " SET " + NoteColumns.SNIPPET + "=new." + DataColumns.CONTENT + " WHERE " + NoteColumns.ID + "=new." + DataColumns.NOTE_ID + ";" + - " END"; + " END";//Note数据被修改后需要更改的数据的表格。 /** - * 在类型为 {@link DataConstants#NOTE} 的数据删除时更新笔记的内容 + * Update note's content when data with {@link DataConstants#NOTE} type has deleted */ private static final String DATA_UPDATE_NOTE_CONTENT_ON_DELETE_TRIGGER = "CREATE TRIGGER update_note_content_on_delete " + @@ -159,9 +153,10 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { " UPDATE " + TABLE.NOTE + " SET " + NoteColumns.SNIPPET + "=''" + " WHERE " + NoteColumns.ID + "=old." + DataColumns.NOTE_ID + ";" + - " END"; + " END";//Note数据被删除后需要更改的数据的表格。 + /** - * 创建一个触发器，用于删除已删除笔记的数据 + * 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 " + @@ -169,10 +164,10 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { " BEGIN" + " DELETE FROM " + TABLE.DATA + " WHERE " + DataColumns.NOTE_ID + "=old." + NoteColumns.ID + ";" + - " END"; + " END";//删除已删除的便签的数据后需要更改的数据的表格。 /** - * 创建一个触发器，用于删除已删除文件夹的笔记 + * Delete notes belong to folder which has been deleted */ private static final String FOLDER_DELETE_NOTES_ON_DELETE_TRIGGER = "CREATE TRIGGER folder_delete_notes_on_delete " + @@ -180,10 +175,10 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { " BEGIN" + " DELETE FROM " + TABLE.NOTE + " WHERE " + NoteColumns.PARENT_ID + "=old." + NoteColumns.ID + ";" + - " END"; + " END";//删除已删除的文件夹的便签后需要更改的数据的表格。 /** - * 创建一个触发器，用于将被移动到垃圾箱文件夹中的笔记移动到垃圾箱中 + * Move notes belong to folder which has been moved to trash folder */ private static final String FOLDER_MOVE_NOTES_ON_TRASH_TRIGGER = "CREATE TRIGGER folder_move_notes_on_trash " + @@ -193,167 +188,144 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { " UPDATE " + TABLE.NOTE + " SET " + NoteColumns.PARENT_ID + "=" + Notes.ID_TRASH_FOLER + " WHERE " + NoteColumns.PARENT_ID + "=old." + NoteColumns.ID + ";" + - " END"; - //数据库帮助 + " END";//还原垃圾桶中便签后需要更改的数据的表格。 + public NotesDatabaseHelper(Context context) { super(context, DB_NAME, null, DB_VERSION); - } - //创建数据库实例 + }//构造函数，传入数据库的名称和版本 + public void createNoteTable(SQLiteDatabase db) { db.execSQL(CREATE_NOTE_TABLE_SQL); reCreateNoteTableTriggers(db); createSystemFolder(db); Log.d(TAG, "note table has been created"); - } - - /** + }//创建表格（用来存储标签属性） - 重新创建笔记表的触发器 - - @param db 数据库对象 - */ 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); - // 创建将笔记移动到垃圾桶时的触发器 - } + }//execSQL是数据库操作的API，主要是更改行为的SQL语句。 + //在这里主要是用来重新创建上述定义的表格用的，先删除原来有的数据库的触发器再重新创建新的数据库 - /** - - 创建系统文件夹 - - @param db 数据库对象 - */ private void createSystemFolder(SQLiteDatabase db) { ContentValues values = new ContentValues(); -/** - - 通话记录文件夹 - */ + /** + * call record foler for call notes + */ values.put(NoteColumns.ID, Notes.ID_CALL_RECORD_FOLDER); values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); db.insert(TABLE.NOTE, null, values); -/** - 根文件夹，即默认文件夹 - */ + /** + * 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); -/** - 临时文件夹，用于移动笔记 - */ + /** + * 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); -/** - 创建垃圾桶文件夹 - */ + /** + * 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); - } + }//创建几个系统文件夹 public void createDataTable(SQLiteDatabase db) { - db.execSQL(CREATE_DATA_TABLE_SQL); // 创建数据表 - reCreateDataTableTriggers(db); // 重建数据表触发器 - db.execSQL(CREATE_DATA_NOTE_ID_INDEX_SQL); // 在数据表上创建笔记 ID 索引 - Log.d(TAG, "data table has been created"); // 输出日志，表示数据表已创建 - } + db.execSQL(CREATE_DATA_TABLE_SQL); + reCreateDataTableTriggers(db); + db.execSQL(CREATE_DATA_NOTE_ID_INDEX_SQL); + Log.d(TAG, "data table has been created"); + }//创建表格（用来存储标签内容） private void reCreateDataTableTriggers(SQLiteDatabase db) { - db.execSQL("DROP TRIGGER IF EXISTS update_note_content_on_insert");// 如果存在，删除插入时更新笔记内容的触发器 - db.execSQL("DROP TRIGGER IF EXISTS update_note_content_on_update"); // 如果存在，删除更新时更新笔记内容的触发器 - db.execSQL("DROP TRIGGER IF EXISTS update_note_content_on_delete");// 如果存在，删除删除时更新笔记内容的触发器 + db.execSQL("DROP TRIGGER IF EXISTS update_note_content_on_insert"); + db.execSQL("DROP TRIGGER IF EXISTS update_note_content_on_update"); + db.execSQL("DROP TRIGGER IF EXISTS update_note_content_on_delete"); - db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_INSERT_TRIGGER); // 创建插入时更新笔记内容的触发器 - db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_UPDATE_TRIGGER); // 创建更新时更新笔记内容的触发器 - db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_DELETE_TRIGGER); // 创建删除时更新笔记内容的触发器 - } + 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); + }//同上面的execSQL static synchronized NotesDatabaseHelper getInstance(Context context) { if (mInstance == null) { - mInstance = new NotesDatabaseHelper(context); // 如果实例为空，创建新的实例 + mInstance = new NotesDatabaseHelper(context); } - return mInstance; // 返回实例 - } + return mInstance; + }//上网查是为解决同一时刻只能有一个线程执行. + //在写程序库代码时，有时有一个类需要被所有的其它类使用， + //但又要求这个类只能被实例化一次，是个服务类，定义一次，其它类使用同一个这个类的实例 @Override public void onCreate(SQLiteDatabase db) { - createNoteTable(db); // 创建笔记表 - createDataTable(db); // 创建数据表 - } + createNoteTable(db); + createDataTable(db); + }//实现两个表格（上面创建的两个表格） @Override public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) { - boolean reCreateTriggers = false; // 是否需要重新创建触发器 - boolean skipV2 = false; // 是否跳过版本 2 + boolean reCreateTriggers = false; + boolean skipV2 = false; if (oldVersion == 1) { - upgradeToV2(db); // 升级到版本 2 - skipV2 = true; // 标记跳过版本 2（因为版本 2 升级包含在版本 3 升级中） - oldVersion++; // 版本号加 1 + upgradeToV2(db); + skipV2 = true; // this upgrade including the upgrade from v2 to v3 + oldVersion++; } if (oldVersion == 2 && !skipV2) { - upgradeToV3(db); // 升级到版本 3 - reCreateTriggers = true; // 标记需要重新创建触发器 - oldVersion++; // 版本号加 1 + upgradeToV3(db); + reCreateTriggers = true; + oldVersion++; } if (oldVersion == 3) { - upgradeToV4(db); // 升级到版本 4 - oldVersion++; // 版本号加 1 + upgradeToV4(db); + oldVersion++; } if (reCreateTriggers) { - reCreateNoteTableTriggers(db); // 重新创建笔记表触发器 - reCreateDataTableTriggers(db); // 重新创建数据表触发器 + reCreateNoteTableTriggers(db); + reCreateDataTableTriggers(db); } if (oldVersion != newVersion) { throw new IllegalStateException("Upgrade notes database to version " + newVersion - + "fails"); // 如果版本升级失败，抛出异常 + + "fails"); } - } + }//数据库版本的更新（数据库内容的更改） + 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); - } + }//更新到V2版本 private void upgradeToV3(SQLiteDatabase db) { // drop unused triggers @@ -368,10 +340,10 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { values.put(NoteColumns.ID, Notes.ID_TRASH_FOLER); values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); db.insert(TABLE.NOTE, null, values); - } + }//更新到V3版本 private void upgradeToV4(SQLiteDatabase db) { db.execSQL("ALTER TABLE " + TABLE.NOTE + " ADD COLUMN " + NoteColumns.VERSION + " INTEGER NOT NULL DEFAULT 0"); - } -} + }//更新到V4版本,但是不知道V2、V3、V4是什么意思 +} \ No newline at end of file