Type: INTEGER (long)
+ */ public static final String ID = "_id"; + /** + * The parent's id for note or folder + *Type: INTEGER (long)
+ */ public static final String PARENT_ID = "parent_id"; + /** + * Created data for note or folder + *Type: INTEGER (long)
+ */ public static final String CREATED_DATE = "created_date"; + /** + * Latest modified date + *Type: INTEGER (long)
+ */ public static final String MODIFIED_DATE = "modified_date"; + + /** + * Alert date + *Type: INTEGER (long)
+ */ public static final String ALERTED_DATE = "alert_date"; + /** + * Folder's name or text content of note + *Type: TEXT
+ */ public static final String SNIPPET = "snippet"; + /** + * Note's widget id + *Type: INTEGER (long)
+ */ public static final String WIDGET_ID = "widget_id"; + /** + * Note's widget type + *Type: INTEGER (long)
+ */ public static final String WIDGET_TYPE = "widget_type"; + /** + * Note's background color's id + *Type: INTEGER (long)
+ */ public static final String BG_COLOR_ID = "bg_color_id"; + /** + * For text note, it doesn't has attachment, for multi-media + * note, it has at least one attachment + *Type: INTEGER
+ */ public static final String HAS_ATTACHMENT = "has_attachment"; + /** + * Folder's count of notes + *Type: INTEGER (long)
+ */ public static final String NOTES_COUNT = "notes_count"; + /** + * The file type: folder or note + *Type: INTEGER
+ */ public static final String TYPE = "type"; + /** + * The last sync id + *Type: INTEGER (long)
+ */ public static final String SYNC_ID = "sync_id"; + /** + * Sign to indicate local modified or not + *Type: INTEGER
+ */ public static final String LOCAL_MODIFIED = "local_modified"; + /** + * Original parent id before moving into temporary folder + *Type : INTEGER
+ */ public static final String ORIGIN_PARENT_ID = "origin_parent_id"; + /** + * The gtask id + *Type : TEXT
+ */ public static final String GTASK_ID = "gtask_id"; + /** + * The version code + *Type : INTEGER (long)
+ */ public static final String VERSION = "version"; - } - public interface DataColumns { + public static final String PASSWORD = "password"; + public static final String IMPORTANCE = "importance"; + }//便签的各种属性 + /* + * 便签数据在数据库中的表头 + */ + public interface DataColumns { + /** + * The unique ID for a row + *Type: INTEGER (long)
+ */ public static final String ID = "_id"; + /** + * The MIME type of the item represented by this row. + *Type: Text
+ */ public static final String MIME_TYPE = "mime_type"; + /** + * The reference id to note that this data belongs to + *Type: INTEGER (long)
+ */ public static final String NOTE_ID = "note_id"; + /** + * Created data for note or folder + *Type: INTEGER (long)
+ */ public static final String CREATED_DATE = "created_date"; + /** + * Latest modified date + *Type: INTEGER (long)
+ */ public static final String MODIFIED_DATE = "modified_date"; + /** + * Data's content + *Type: TEXT
+ */ public static final String CONTENT = "content"; + + /** + * 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 #MIMETYPE} specific, used for + * integer data type + *Type: INTEGER
+ */ public static final String DATA2 = "data2"; + /** + * 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 #MIMETYPE} specific, used for + * TEXT data type + *Type: TEXT
+ */ public static final String DATA4 = "data4"; + /** + * Generic data column, the meaning is {@link #MIMETYPE} specific, used for + * TEXT data type + *Type: TEXT
+ */ public static final String DATA5 = "data5"; - } + }//一个便签内部各种数据类型 public static final class TextNote implements DataColumns { - + /** + * Mode to indicate the text in check list mode or not + *Type: Integer 1:check list mode 0: normal mode
+ */ public static final String MODE = DATA1; public static final int MODE_CHECK_LIST = 1; @@ -142,12 +266,19 @@ public class Notes { 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"); - } + }//一种是文本textnote public static final class CallNote implements DataColumns { - + /** + * Call date for this record + *Type: INTEGER (long)
+ */ public static final String CALL_DATE = DATA1; + /** + * Phone number for this record + *Type: TEXT
+ */ public static final String PHONE_NUMBER = DATA3; public static final String CONTENT_TYPE = "vnd.android.cursor.dir/call_note"; @@ -155,5 +286,5 @@ public class Notes { public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/call_note"; public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/call_note"); - } + }//另一种是通话类型的callnote } diff --git a/src/main/java/net/micode/notes/data/NotesDatabaseHelper.java b/src/main/java/net/micode/notes/data/NotesDatabaseHelper.java index 1f05bbf..bedbf65 100644 --- a/src/main/java/net/micode/notes/data/NotesDatabaseHelper.java +++ b/src/main/java/net/micode/notes/data/NotesDatabaseHelper.java @@ -16,31 +16,22 @@ package net.micode.notes.data; -import android.content.ContentValues;//就是用于保存一些数据（string boolean ...）信息，这些信息可以被数据库操作时使用。 +import android.content.ContentValues; import android.content.Context; -import android.database.sqlite.SQLiteDatabase;//主要提供了对应于添加、删除、更新、查询的操作方法： insert()、delete()、update()和query()。配合content.values -import android.database.sqlite.SQLiteOpenHelper;//用来管理数据的创建和版本更新 +import android.database.sqlite.SQLiteDatabase; +import android.database.sqlite.SQLiteOpenHelper; import android.util.Log; - +//引用了同一个包中的另一个子包Notes中一些接口 import net.micode.notes.data.Notes.DataColumns; import net.micode.notes.data.Notes.DataConstants; import net.micode.notes.data.Notes.NoteColumns; -/** - * @Package: net.micode.notes.data - * @ClassName: NotesDatabaseHelper - * @Description: 便签数据库操作底层实现 - * @Author: WuShuxian - * @CreateDate: 2023/12/21 19:46 - * @Version: 1.0 - */ +//数据库操作 public class NotesDatabaseHelper extends SQLiteOpenHelper { private static final String DB_NAME = "note.db"; private static final int DB_VERSION = 4; - /** - * 接口，创建数据库表头 - */ + //接口两部分一个Note一个DATA public interface TABLE { public static final String NOTE = "note"; @@ -50,9 +41,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { private static final String TAG = "NotesDatabaseHelper"; private static NotesDatabaseHelper mInstance; - /** - * 便签的属性数据库 - */ + //基于NoteColumn创建一个NOTE_TABLE表格，并附上初始数据 private static final String CREATE_NOTE_TABLE_SQL = "CREATE TABLE " + TABLE.NOTE + "(" + NoteColumns.ID + " INTEGER PRIMARY KEY," + @@ -73,9 +62,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { NoteColumns.GTASK_ID + " TEXT NOT NULL DEFAULT ''," + NoteColumns.VERSION + " INTEGER NOT NULL DEFAULT 0" + ")"; - /** - * 便签的内容数据库 - */ + //主要基于datacolumn来创建DATA_TABLE private static final String CREATE_DATA_TABLE_SQL = "CREATE TABLE " + TABLE.DATA + "(" + DataColumns.ID + " INTEGER PRIMARY KEY," + @@ -90,13 +77,13 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { DataColumns.DATA4 + " TEXT NOT NULL DEFAULT ''," + DataColumns.DATA5 + " TEXT NOT NULL DEFAULT ''" + ")"; - + //这个数据是关于INDEX编号的 private static final String CREATE_DATA_NOTE_ID_INDEX_SQL = "CREATE INDEX IF NOT EXISTS note_id_index ON " + TABLE.DATA + "(" + DataColumns.NOTE_ID + ");"; /** - * 文件夹内移进便签时需要修改的数据 + * Increase folder's note count when move note to the folder */ private static final String NOTE_INCREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER = "CREATE TRIGGER increase_folder_count_on_update "+ @@ -106,9 +93,9 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { " SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + " + 1" + " WHERE " + NoteColumns.ID + "=new." + NoteColumns.PARENT_ID + ";" + " 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 " + @@ -119,9 +106,9 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { " WHERE " + NoteColumns.ID + "=old." + NoteColumns.PARENT_ID + " AND " + NoteColumns.NOTES_COUNT + ">0" + ";" + " 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 " + @@ -131,9 +118,9 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { " SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + " + 1" + " WHERE " + NoteColumns.ID + "=new." + NoteColumns.PARENT_ID + ";" + " 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 " + @@ -144,7 +131,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { " WHERE " + NoteColumns.ID + "=old." + NoteColumns.PARENT_ID + " AND " + NoteColumns.NOTES_COUNT + ">0;" + " END"; - + //删除note /** * Update note's content when insert data with type {@link DataConstants#NOTE} */ @@ -157,7 +144,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { " SET " + NoteColumns.SNIPPET + "=new." + DataColumns.CONTENT + " WHERE " + NoteColumns.ID + "=new." + DataColumns.NOTE_ID + ";" + " END"; - + //当给note插入新数据时触发 /** * Update note's content when data with {@link DataConstants#NOTE} type has changed */ @@ -169,7 +156,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { " UPDATE " + TABLE.NOTE + " SET " + NoteColumns.SNIPPET + "=new." + DataColumns.CONTENT + " WHERE " + NoteColumns.ID + "=new." + DataColumns.NOTE_ID + ";" + - " END"; + " END";//note数据被修改update /** * Update note's content when data with {@link DataConstants#NOTE} type has deleted @@ -182,7 +169,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { " UPDATE " + TABLE.NOTE + " SET " + NoteColumns.SNIPPET + "=''" + " WHERE " + NoteColumns.ID + "=old." + DataColumns.NOTE_ID + ";" + - " END"; + " END";//更新已经删除的便签的数据 /** * Delete datas belong to note which has been deleted @@ -193,7 +180,7 @@ 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 @@ -204,7 +191,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { " BEGIN" + " DELETE FROM " + TABLE.NOTE + " WHERE " + NoteColumns.PARENT_ID + "=old." + NoteColumns.ID + ";" + - " END"; + " END";//删除 已删除folder文件夹 中的便签要修改的数据 /** * Move notes belong to folder which has been moved to trash folder @@ -217,12 +204,12 @@ 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";//移动trash_folder中的便签 public NotesDatabaseHelper(Context context) { super(context, DB_NAME, null, DB_VERSION); } - + //构造函数 public void createNoteTable(SQLiteDatabase db) { db.execSQL(CREATE_NOTE_TABLE_SQL); reCreateNoteTableTriggers(db); @@ -246,48 +233,49 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { 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); - } - /** - * @method createSystemFolder - * @description: 创建系统缺省文件夹：通话记录、缺省根目录、临时文件夹、回收文件夹 - * @date: 2023/12/21 20:19 - * @author: WuShuxian - * @param: db - * @return: void - */ + }//数据库操作的API，重新创建 + 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); Log.d(TAG, "data table has been created"); - } + }//创建数据表格 private void reCreateDataTableTriggers(SQLiteDatabase db) { db.execSQL("DROP TRIGGER IF EXISTS update_note_content_on_insert"); @@ -297,45 +285,38 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { 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); - } + }//类似于recreatenotetable，重新创建触发器 static synchronized NotesDatabaseHelper getInstance(Context context) { if (mInstance == null) { mInstance = new NotesDatabaseHelper(context); } return mInstance; - } + }//sync同步，同一时刻只有一个线程执行 @Override public void onCreate(SQLiteDatabase db) { - createNoteTable(db);//属性数据库 - createDataTable(db);//内容数据库 - } - /** - * @method onUpgrade - * @description: 便签版本更新？没有使用者判断不了 - * @date: 2023/12/21 20:42 - * @author: WuShuxian - * @param: - * @return: - */ + createNoteTable(db); + createDataTable(db); + }//创建Note Data两个表格 + @Override public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) { boolean reCreateTriggers = false; boolean skipV2 = false; - //V1->V2 + if (oldVersion == 1) { upgradeToV2(db); skipV2 = true; // this upgrade including the upgrade from v2 to v3 oldVersion++; } - //V2->V3 + if (oldVersion == 2 && !skipV2) { upgradeToV3(db); reCreateTriggers = true; oldVersion++; } - //V3->V4 + if (oldVersion == 3) { upgradeToV4(db); oldVersion++; @@ -350,19 +331,15 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { throw new IllegalStateException("Upgrade notes database to version " + newVersion + "fails"); } - } - /** - * 升级到V2，修改相应数据库 - */ + }//数据库版本更新 + private void upgradeToV2(SQLiteDatabase db) { db.execSQL("DROP TABLE IF EXISTS " + TABLE.NOTE); db.execSQL("DROP TABLE IF EXISTS " + TABLE.DATA); createNoteTable(db); createDataTable(db); - } - /** - * 升级到V3，修改相应数据库 - */ + }//更新到V2 + private void upgradeToV3(SQLiteDatabase db) { // drop unused triggers db.execSQL("DROP TRIGGER IF EXISTS update_note_modified_date_on_insert"); @@ -376,12 +353,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); - } - /** - * 升级到V4，修改相应数据库 - */ + }//更新到V3 + private void upgradeToV4(SQLiteDatabase db) { db.execSQL("ALTER TABLE " + TABLE.NOTE + " ADD COLUMN " + NoteColumns.VERSION + " INTEGER NOT NULL DEFAULT 0"); - } + }//更新到V4 } diff --git a/src/main/java/net/micode/notes/data/NotesProvider.java b/src/main/java/net/micode/notes/data/NotesProvider.java index ddb2282..6897999 100644 --- a/src/main/java/net/micode/notes/data/NotesProvider.java +++ b/src/main/java/net/micode/notes/data/NotesProvider.java @@ -1,22 +1,5 @@ -/* - * 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; @@ -33,19 +16,15 @@ 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; - -/** - * @Package: net.micode.notes.data - * @ClassName: NotesProvider - * @Description: 为存储和获取数据提供接口。可以在不同的应用程序之间共享数据 - * @Author: WuShuxian - * @CreateDate: 2023/12/21 20:50 - * @Version: 1.0 - */ +//为存储和获取数据提供接口。可以在不同的应用程序之间共享数据 +//ContentProvider提供的方法 +//query：查询 +//insert：插入 +//update：更新 +//delete：删除 +//getType：得到数据类型 public class NotesProvider extends ContentProvider { - /** - * UriMatcher用于匹配Uri - */ + // UriMatcher用于匹配Uri private static final UriMatcher mMatcher; private NotesDatabaseHelper mHelper; @@ -61,7 +40,9 @@ public class NotesProvider extends ContentProvider { private static final int URI_SEARCH_SUGGEST = 6; static { + // 创建UriMatcher时，调用UriMatcher(UriMatcher.NO_MATCH)表示不匹配任何路径的返回码 mMatcher = new UriMatcher(UriMatcher.NO_MATCH); + // 把需要匹配Uri路径全部给注册上 mMatcher.addURI(Notes.AUTHORITY, "note", URI_NOTE); mMatcher.addURI(Notes.AUTHORITY, "note/#", URI_NOTE_ITEM); mMatcher.addURI(Notes.AUTHORITY, "data", URI_DATA); @@ -72,44 +53,43 @@ 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. */ + // 声明 NOTES_SEARCH_PROJECTION private static final String NOTES_SEARCH_PROJECTION = NoteColumns.ID + "," - + NoteColumns.ID + " AS " + SearchManager.SUGGEST_COLUMN_INTENT_EXTRA_DATA + "," - + "TRIM(REPLACE(" + NoteColumns.SNIPPET + ", x'0A','')) AS " + SearchManager.SUGGEST_COLUMN_TEXT_1 + "," - + "TRIM(REPLACE(" + NoteColumns.SNIPPET + ", x'0A','')) AS " + SearchManager.SUGGEST_COLUMN_TEXT_2 + "," - + R.drawable.search_result + " AS " + SearchManager.SUGGEST_COLUMN_ICON_1 + "," - + "'" + Intent.ACTION_VIEW + "' AS " + SearchManager.SUGGEST_COLUMN_INTENT_ACTION + "," - + "'" + Notes.TextNote.CONTENT_TYPE + "' AS " + SearchManager.SUGGEST_COLUMN_INTENT_DATA; - + + NoteColumns.ID + " AS " + SearchManager.SUGGEST_COLUMN_INTENT_EXTRA_DATA + "," + + "TRIM(REPLACE(" + NoteColumns.SNIPPET + ", x'0A','')) AS " + SearchManager.SUGGEST_COLUMN_TEXT_1 + "," + + "TRIM(REPLACE(" + NoteColumns.SNIPPET + ", x'0A','')) AS " + SearchManager.SUGGEST_COLUMN_TEXT_2 + "," + + R.drawable.search_result + " AS " + SearchManager.SUGGEST_COLUMN_ICON_1 + "," + + "'" + Intent.ACTION_VIEW + "' AS " + SearchManager.SUGGEST_COLUMN_INTENT_ACTION + "," + + "'" + Notes.TextNote.CONTENT_TYPE + "' AS " + SearchManager.SUGGEST_COLUMN_INTENT_DATA; + // 声明NOTES_SNIPPET_SEARCH_QUERY private static String NOTES_SNIPPET_SEARCH_QUERY = "SELECT " + NOTES_SEARCH_PROJECTION - + " FROM " + TABLE.NOTE - + " WHERE " + NoteColumns.SNIPPET + " LIKE ?" - + " AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER - + " AND " + NoteColumns.TYPE + "=" + Notes.TYPE_NOTE; + + " FROM " + TABLE.NOTE + + " WHERE " + NoteColumns.SNIPPET + " LIKE ?" + + " AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER + + " AND " + NoteColumns.TYPE + "=" + Notes.TYPE_NOTE; @Override + // Context只有在onCreate()中才被初始化 + // 对mHelper进行实例化 public boolean onCreate() { mHelper = NotesDatabaseHelper.getInstance(getContext()); return true; } - /** - * @Package: net.micode.notes.data - * @ClassName: NotesProvider - * @Description: 查询Uri在数据库中的位置 - * @Author: WuShuxian - * @CreateDate: 2023/12/21 21:06 - * @Version: 1.0 - */ + @Override + // 查询uri在数据库中对应的位置 public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, - String sortOrder) { + String sortOrder) { Cursor c = null; - SQLiteDatabase db = mHelper.getReadableDatabase();//读数据库 + // 获取可读数据库 + SQLiteDatabase db = mHelper.getReadableDatabase(); String id = null; + // 匹配查找uri switch (mMatcher.match(uri)) { + // 对于不同的匹配值，在数据库中查找相应的条目 case URI_NOTE: c = db.query(TABLE.NOTE, projection, selection, selectionArgs, null, null, sortOrder); @@ -131,6 +111,7 @@ public class NotesProvider extends ContentProvider { case URI_SEARCH: case URI_SEARCH_SUGGEST: if (sortOrder != null || projection != null) { + // 不合法的参数异常 throw new IllegalArgumentException( "do not specify sortOrder, selection, selectionArgs, or projection" + "with this query"); } @@ -138,6 +119,8 @@ public class NotesProvider extends ContentProvider { String searchString = null; if (mMatcher.match(uri) == URI_SEARCH_SUGGEST) { if (uri.getPathSegments().size() > 1) { + // getPathSegments()方法得到一个String的List， + // 在uri.getPathSegments().get(1)为第2个元素 searchString = uri.getPathSegments().get(1); } } else { @@ -149,7 +132,7 @@ public class NotesProvider extends ContentProvider { } try { - searchString = String.format("%%%s%%", searchString);//在新建便签并输入内容保存后会跳到这里，暂时不知道为什么 + searchString = String.format("%%%s%%", searchString); c = db.rawQuery(NOTES_SNIPPET_SEARCH_QUERY, new String[] { searchString }); } catch (IllegalStateException ex) { @@ -157,6 +140,7 @@ public class NotesProvider extends ContentProvider { } break; default: + // 抛出异常 throw new IllegalArgumentException("Unknown URI " + uri); } if (c != null) { @@ -165,22 +149,18 @@ public class NotesProvider extends ContentProvider { return c; } - /** - * @method insert - * @description: 插入一个Uri，只有新建便签并保存后才会触发，修改内容不会触发 - * @date: 2023/12/21 21:16 - * @author: WuShuxian - * @param: - * @return: - */ @Override + // 插入一个uri public Uri insert(Uri uri, ContentValues values) { + // 获得可写的数据库 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; + // 如果存在，查找NOTE_ID case URI_DATA: if (values.containsKey(DataColumns.NOTE_ID)) { noteId = values.getAsLong(DataColumns.NOTE_ID); @@ -193,6 +173,7 @@ public class NotesProvider extends ContentProvider { throw new IllegalArgumentException("Unknown URI " + uri); } // Notify the note uri + // notifyChange获得一个ContextResolver对象并且更新里面的内容 if (noteId > 0) { getContext().getContentResolver().notifyChange( ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), null); @@ -204,20 +185,17 @@ public class NotesProvider extends ContentProvider { ContentUris.withAppendedId(Notes.CONTENT_DATA_URI, dataId), null); } + // 返回插入的uri的路径 return ContentUris.withAppendedId(uri, insertedId); } - /** - * @method delete - * @description: 删除一个Uri，删除便签时会触发 - * @date: 2023/12/21 21:17 - * @author: WuShuxian - * @param: - * @return: - */ + @Override + // 删除一个uri public int delete(Uri uri, String selection, String[] selectionArgs) { + //Uri代表要操作的数据，Android上可用的每种资源 -包括 图像、视频片段、音频资源等都可以用Uri来表示。 int count = 0; String id = null; + // 获得可写的数据库 SQLiteDatabase db = mHelper.getWritableDatabase(); boolean deleteData = false; switch (mMatcher.match(uri)) { @@ -226,7 +204,7 @@ public class NotesProvider extends ContentProvider { count = db.delete(TABLE.NOTE, selection, selectionArgs); break; case URI_NOTE_ITEM: - id = uri.getPathSegments().get(1);//修改便签内容时会触发，原因不明 + id = uri.getPathSegments().get(1); /** * ID that smaller than 0 is system folder which is not allowed to * trash @@ -259,15 +237,9 @@ public class NotesProvider extends ContentProvider { } return count; } - /** - * @method update - * @description: 更新Uri，修改便签时会触发。期间会跳到delete中执行，原因不明 - * @date: 2023/12/21 21:19 - * @author: WuShuxian - * @param: - * @return: - */ + @Override + // 更新一个uri public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs) { int count = 0; String id = null; @@ -307,10 +279,12 @@ public class NotesProvider extends ContentProvider { return count; } + // 将字符串解析成规定格式 private String parseSelection(String selection) { return (!TextUtils.isEmpty(selection) ? " AND (" + selection + ')' : ""); } + //增加一个noteVersion private void increaseNoteVersion(long id, String selection, String[] selectionArgs) { StringBuilder sql = new StringBuilder(120); sql.append("UPDATE "); @@ -333,6 +307,7 @@ public class NotesProvider extends ContentProvider { sql.append(selectString); } + // execSQL()方法可以执行insert、delete、update和CREATE TABLE之类有更改行为的SQL语句 mHelper.getWritableDatabase().execSQL(sql.toString()); } @@ -342,4 +317,4 @@ public class NotesProvider extends ContentProvider { return null; } -} +} \ No newline at end of file diff --git a/src/main/java/net/micode/notes/gtask/data/MetaData.java b/src/main/java/net/micode/notes/gtask/data/MetaData.java index 9b96094..3a2050b 100644 --- a/src/main/java/net/micode/notes/gtask/data/MetaData.java +++ b/src/main/java/net/micode/notes/gtask/data/MetaData.java @@ -24,26 +24,12 @@ import net.micode.notes.tool.GTaskStringUtils; import org.json.JSONException; import org.json.JSONObject; -/** - * @Package: net.micode.notes.gtask.data - * @ClassName: MetaData - * @Description: 一些元数据的操作 - * @Author: WuShuxian - * @CreateDate: 2023/12/22 21:45 - * @Version: 1.0 - */ + public class MetaData extends Task { private final static String TAG = MetaData.class.getSimpleName(); private String mRelatedGid = null; - /** - * @method setMeta - * @description: 生成元数据库 - * @date: 2023/12/24 20:07 - * @author: WuShuxian - * @param: - * @return: - */ + public void setMeta(String gid, JSONObject metaInfo) { try { metaInfo.put(GTaskStringUtils.META_HEAD_GTASK_ID, gid); @@ -62,14 +48,7 @@ public class MetaData extends Task { public boolean isWorthSaving() { return getNotes() != null; } - /** - * @method setContentByRemoteJSON - * @description: 从远程Json对象设置元数据库内容 - * @date: 2023/12/24 20:11 - * @author: WuShuxian - * @param: - * @return: - */ + @Override public void setContentByRemoteJSON(JSONObject js) { super.setContentByRemoteJSON(js); @@ -83,14 +62,7 @@ public class MetaData extends Task { } } } - /** - * @method setContentByLocalJSON - * @description: 根据本地Json对象设置元数据库内容 - * @date: 2023/12/24 20:12 - * @author: WuShuxian - * @param: - * @return: - */ + @Override public void setContentByLocalJSON(JSONObject js) { // this function should not be called diff --git a/src/main/java/net/micode/notes/gtask/data/Node.java b/src/main/java/net/micode/notes/gtask/data/Node.java index c3ebd5a..63950e0 100644 --- a/src/main/java/net/micode/notes/gtask/data/Node.java +++ b/src/main/java/net/micode/notes/gtask/data/Node.java @@ -19,50 +19,24 @@ package net.micode.notes.gtask.data; import android.database.Cursor; import org.json.JSONObject; -/** - * @Package: net.micode.notes.gtask.data - * @ClassName: Node - * @Description: 定义了同步节点：多个关于同步的常量，实现类似于Git的版本控制 - * @Author: WuShuxian - * @CreateDate: 2023/12/21 21:30 - * @Version: 1.0 - */ + public abstract class Node { - /** - * 本地与云端一致 - */ public static final int SYNC_ACTION_NONE = 0; - /** - * 需要云端添加内容 - */ + public static final int SYNC_ACTION_ADD_REMOTE = 1; - /** - * 需要本地添加内容 - */ + public static final int SYNC_ACTION_ADD_LOCAL = 2; - /** - * 需要删除云端的内容 - */ + public static final int SYNC_ACTION_DEL_REMOTE = 3; - /** - * 需要删除本地的内容 - */ + public static final int SYNC_ACTION_DEL_LOCAL = 4; - /** - * 本地同步到云端 - */ + public static final int SYNC_ACTION_UPDATE_REMOTE = 5; - /** - * 云端同步到本地 - */ + public static final int SYNC_ACTION_UPDATE_LOCAL = 6; - /** - * 同步出现冲突 - */ + public static final int SYNC_ACTION_UPDATE_CONFLICT = 7; - /** - * 同步错误 - */ + public static final int SYNC_ACTION_ERROR = 8; private String mGid; diff --git a/src/main/java/net/micode/notes/gtask/data/SqlData.java b/src/main/java/net/micode/notes/gtask/data/SqlData.java index 76ffb9f..d3ec3be 100644 --- a/src/main/java/net/micode/notes/gtask/data/SqlData.java +++ b/src/main/java/net/micode/notes/gtask/data/SqlData.java @@ -34,15 +34,7 @@ import net.micode.notes.gtask.exception.ActionFailureException; import org.json.JSONException; import org.json.JSONObject; -/** - * @Package: net.micode.notes.gtask.data - * @ClassName: SqlData - * @Description: 用于支持小米便签最底层的数据库相关操作，和sqlnote的关系上是子集关系，即data是note的子集（节点） - * SqlData其实就是也就是所谓数据中的数据 - * @Author: WuShuxian - * @CreateDate: 2023/12/24 20:13 - * @Version: 1.0 - */ + public class SqlData { private static final String TAG = SqlData.class.getSimpleName(); @@ -52,9 +44,7 @@ public class SqlData { DataColumns.ID, DataColumns.MIME_TYPE, DataColumns.CONTENT, DataColumns.DATA1, DataColumns.DATA3 }; - /** - * 以下五个变量作为sql表中5列的编号 - */ + public static final int DATA_ID_COLUMN = 0; public static final int DATA_MIME_TYPE_COLUMN = 1; @@ -80,14 +70,7 @@ public class SqlData { private String mDataContentData3; private ContentValues mDiffDataValues; - /** - * @method SqlData - * @description: 构造函数，用于初始化数据 - * @date: 2023/12/24 20:17 - * @author: WuShuxian - * @param: - * @return: - */ + public SqlData(Context context) { mContentResolver = context.getContentResolver(); mIsCreate = true; @@ -98,28 +81,14 @@ public class SqlData { mDataContentData3 = ""; mDiffDataValues = new ContentValues(); } - /** - * @method SqlData - * @description: 构造函数，根据已有数据初始化一个新的数据对象 - * @date: 2023/12/24 20:17 - * @author: WuShuxian - * @param: - * @return: - */ + public SqlData(Context context, Cursor c) { mContentResolver = context.getContentResolver(); mIsCreate = false; loadFromCursor(c); mDiffDataValues = new ContentValues(); } - /** - * @method loadFromCursor - * @description: 从光标处加载数据 - * @date: 2023/12/24 20:18 - * @author: WuShuxian - * @param: c:光标的位置 - * @return: void - */ + private void loadFromCursor(Cursor c) { mDataId = c.getLong(DATA_ID_COLUMN); mDataMimeType = c.getString(DATA_MIME_TYPE_COLUMN); @@ -127,14 +96,7 @@ public class SqlData { mDataContentData1 = c.getLong(DATA_CONTENT_DATA_1_COLUMN); mDataContentData3 = c.getString(DATA_CONTENT_DATA_3_COLUMN); } - /** - * @method setContent - * @description: 设置用于共享的数据，并提供异常抛出与处理机制 - * @date: 2023/12/24 20:19 - * @author: WuShuxian - * @param: js: Json对象 - * @return: void - */ + public void setContent(JSONObject js) throws JSONException { long dataId = js.has(DataColumns.ID) ? js.getLong(DataColumns.ID) : INVALID_ID; if (mIsCreate || mDataId != dataId) { @@ -181,16 +143,7 @@ public class SqlData { js.put(DataColumns.DATA3, mDataContentData3); return js; } - /** - * @method commit - * @description: commit函数用于把当前造作所做的修改保存到数据库 - * @date: 2023/12/24 20:21 - * @author: WuShuxian - * @param: noteId：要保存的便签ID - * validateVersion：判断此次修改是否合法 - * version：版本号 - * @return: void - */ + public void commit(long noteId, boolean validateVersion, long version) { if (mIsCreate) { diff --git a/src/main/java/net/micode/notes/gtask/data/SqlNote.java b/src/main/java/net/micode/notes/gtask/data/SqlNote.java index ae97d68..79a4095 100644 --- a/src/main/java/net/micode/notes/gtask/data/SqlNote.java +++ b/src/main/java/net/micode/notes/gtask/data/SqlNote.java @@ -37,14 +37,7 @@ import org.json.JSONObject; import java.util.ArrayList; -/** - * @Package: net.micode.notes.gtask.data - * @ClassName: SqlNote - * @Description: 用于支持小米便签最底层的数据库相关操作，和sqldata的关系上是父集关系，即note是data的子父集 - * @Author: WuShuxian - * @CreateDate: 2023/12/24 20:23 - * @Version: 1.0 - */ + public class SqlNote { private static final String TAG = SqlNote.class.getSimpleName(); @@ -128,24 +121,17 @@ public class SqlNote { private ContentValues mDiffNoteValues; private ArrayList