魏欣阳 8 months ago
parent 746fb55204
commit 9204014f20

@ -1,3 +1,4 @@
// 该文件的版权信息,表明代码的版权属于 The MiCode Open Source Community使用 Apache License 2.0 协议
/*
* Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net)
*
@ -8,15 +9,17 @@
* 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,
* 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;
// 导入所需的 Android 类和接口
import android.app.SearchManager;
import android.content.ContentProvider;
import android.content.ContentUris;
@ -29,273 +32,403 @@ 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;
// 定义一个名为 NotesProvider 的类,继承自 ContentProvider 类,用于提供数据存储和访问服务
public class NotesProvider extends ContentProvider {
// 声明一个静态的 UriMatcher 对象,用于匹配不同的 URI
private static final UriMatcher mMatcher;
// 声明一个 NotesDatabaseHelper 对象,用于操作数据库
private NotesDatabaseHelper mHelper;
// 定义一个日志标签,用于在 Logcat 中输出日志信息
private static final String TAG = "NotesProvider";
// 定义不同 URI 匹配结果的常量,分别代表不同的操作
private static final int URI_NOTE = 1;
private static final int URI_NOTE_ITEM = 2;
private static final int URI_DATA = 3;
private static final int URI_DATA_ITEM = 4;
private static final int URI_SEARCH = 5;
private static final int URI_SEARCH_SUGGEST = 6;
// 静态代码块,在类加载时执行,用于初始化 UriMatcher 对象
static {
// 创建一个新的 UriMatcher 对象,初始匹配结果为 NO_MATCH
mMatcher = new UriMatcher(UriMatcher.NO_MATCH);
// 为 mMatcher 添加一个 URI 匹配规则,当 URI 为 "content://[Notes.AUTHORITY]/note" 时,匹配结果为 URI_NOTE
mMatcher.addURI(Notes.AUTHORITY, "note", URI_NOTE);
// 为 mMatcher 添加一个 URI 匹配规则,当 URI 为 "content://[Notes.AUTHORITY]/note/#" 时,匹配结果为 URI_NOTE_ITEM
mMatcher.addURI(Notes.AUTHORITY, "note/#", URI_NOTE_ITEM);
// 为 mMatcher 添加一个 URI 匹配规则,当 URI 为 "content://[Notes.AUTHORITY]/data" 时,匹配结果为 URI_DATA
mMatcher.addURI(Notes.AUTHORITY, "data", URI_DATA);
// 为 mMatcher 添加一个 URI 匹配规则,当 URI 为 "content://[Notes.AUTHORITY]/data/#" 时,匹配结果为 URI_DATA_ITEM
mMatcher.addURI(Notes.AUTHORITY, "data/#", URI_DATA_ITEM);
// 为 mMatcher 添加一个 URI 匹配规则,当 URI 为 "content://[Notes.AUTHORITY]/search" 时,匹配结果为 URI_SEARCH
mMatcher.addURI(Notes.AUTHORITY, "search", URI_SEARCH);
// 为 mMatcher 添加一个 URI 匹配规则,当 URI 为 "content://[Notes.AUTHORITY]/search/suggest_query" 时,匹配结果为 URI_SEARCH_SUGGEST
mMatcher.addURI(Notes.AUTHORITY, SearchManager.SUGGEST_URI_PATH_QUERY, URI_SEARCH_SUGGEST);
// 为 mMatcher 添加一个 URI 匹配规则,当 URI 为 "content://[Notes.AUTHORITY]/search/suggest_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.
* x'0A' SQLite '\n'
* '\n'
*/
// 定义一个 SQL 投影字符串,用于搜索结果的查询,包含笔记的各种信息
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 查询语句,用于根据笔记片段进行搜索
private static String NOTES_SNIPPET_SEARCH_QUERY = "SELECT " + NOTES_SEARCH_PROJECTION
// 从笔记表中查询
+ " FROM " + TABLE.NOTE
+ " WHERE " + NoteColumns.SNIPPET + " LIKE ?"
// 筛选出包含搜索关键字的笔记片段,且不在回收站中的笔记
+ " WHERE " + NoteColumns.SNIPPET + " LIKE?"
+ " AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER
+ " AND " + NoteColumns.TYPE + "=" + Notes.TYPE_NOTE;
// 重写 ContentProvider 的 onCreate 方法,在创建时调用
@Override
public boolean onCreate() {
// 获取数据库帮助类的实例,用于后续的数据库操作
mHelper = NotesDatabaseHelper.getInstance(getContext());
// 返回 true 表示创建成功
return true;
}
// 重写 ContentProvider 的 query 方法,用于执行查询操作
@Override
public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs,
String sortOrder) {
// 声明一个 Cursor 对象,用于存储查询结果
Cursor c = null;
// 获取一个可读的 SQLite 数据库对象
SQLiteDatabase db = mHelper.getReadableDatabase();
// 声明一个字符串,用于存储 URI 中的 ID
String id = null;
// 使用 mMatcher 匹配 URI根据匹配结果执行不同的查询操作
switch (mMatcher.match(uri)) {
// 当 URI 匹配为 URI_NOTE 时,查询笔记表
case URI_NOTE:
// 执行查询操作,返回一个 Cursor 对象
c = db.query(TABLE.NOTE, projection, selection, selectionArgs, null, null,
sortOrder);
break;
// 当 URI 匹配为 URI_NOTE_ITEM 时,查询笔记表中的特定项
case URI_NOTE_ITEM:
// 获取 URI 中的 ID 部分
id = uri.getPathSegments().get(1);
// 根据 ID 执行查询操作,将选择条件与原始选择条件拼接
c = db.query(TABLE.NOTE, projection, NoteColumns.ID + "=" + id
+ parseSelection(selection), selectionArgs, null, null, sortOrder);
break;
// 当 URI 匹配为 URI_DATA 时,查询数据表格
case URI_DATA:
// 执行查询操作,返回一个 Cursor 对象
c = db.query(TABLE.DATA, projection, selection, selectionArgs, null, null,
sortOrder);
break;
// 当 URI 匹配为 URI_DATA_ITEM 时,查询数据表格中的特定项
case URI_DATA_ITEM:
// 获取 URI 中的 ID 部分
id = uri.getPathSegments().get(1);
// 根据 ID 执行查询操作,将选择条件与原始选择条件拼接
c = db.query(TABLE.DATA, projection, DataColumns.ID + "=" + id
+ parseSelection(selection), selectionArgs, null, null, sortOrder);
break;
// 当 URI 匹配为 URI_SEARCH 或 URI_SEARCH_SUGGEST 时,执行搜索操作
case URI_SEARCH:
case URI_SEARCH_SUGGEST:
if (sortOrder != null || projection != null) {
// 如果指定了排序顺序、选择条件、选择参数或投影,则抛出异常
if (sortOrder!= null || projection!= null) {
throw new IllegalArgumentException(
"do not specify sortOrder, selection, selectionArgs, or projection" + "with this query");
}
// 声明一个字符串,用于存储搜索关键字
String searchString = null;
// 如果 URI 匹配为 URI_SEARCH_SUGGEST 且路径段数量大于 1则获取搜索关键字
if (mMatcher.match(uri) == URI_SEARCH_SUGGEST) {
if (uri.getPathSegments().size() > 1) {
searchString = uri.getPathSegments().get(1);
}
} else {
// 从 URI 的查询参数中获取搜索关键字
searchString = uri.getQueryParameter("pattern");
}
// 如果搜索关键字为空,返回 null
if (TextUtils.isEmpty(searchString)) {
return null;
}
try {
// 格式化搜索关键字,添加通配符,以便进行模糊搜索
searchString = String.format("%%%s%%", searchString);
// 执行原始查询操作,使用 NOTES_SNIPPET_SEARCH_QUERY 进行搜索
c = db.rawQuery(NOTES_SNIPPET_SEARCH_QUERY,
new String[] { searchString });
} catch (IllegalStateException ex) {
// 捕获异常并输出日志
Log.e(TAG, "got exception: " + ex.toString());
}
break;
// 如果 URI 不匹配任何已知的 URI抛出异常
default:
throw new IllegalArgumentException("Unknown URI " + uri);
}
if (c != null) {
// 如果查询结果不为空,设置通知 URI以便在数据发生变化时通知监听者
if (c!= null) {
c.setNotificationUri(getContext().getContentResolver(), uri);
}
// 返回查询结果
return c;
}
// 重写 ContentProvider 的 insert 方法,用于执行插入操作
@Override
public Uri insert(Uri uri, ContentValues values) {
// 获取一个可写的 SQLite 数据库对象
SQLiteDatabase db = mHelper.getWritableDatabase();
// 声明三个变量,用于存储插入操作的结果 ID
long dataId = 0, noteId = 0, insertedId = 0;
// 使用 mMatcher 匹配 URI根据匹配结果执行不同的插入操作
switch (mMatcher.match(uri)) {
// 当 URI 匹配为 URI_NOTE 时,插入一条笔记
case URI_NOTE:
// 插入笔记,并存储插入结果的 ID
insertedId = noteId = db.insert(TABLE.NOTE, null, values);
break;
// 当 URI 匹配为 URI_DATA 时,插入一条数据
case URI_DATA:
// 如果插入的数据包含笔记 ID则获取该笔记 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());
}
// 插入数据,并存储插入结果的 ID
insertedId = dataId = db.insert(TABLE.DATA, null, values);
break;
// 如果 URI 不匹配任何已知的 URI抛出异常
default:
throw new IllegalArgumentException("Unknown URI " + uri);
}
// Notify the note uri
// 如果插入的是笔记,通知笔记 URI 的数据发生了变化
if (noteId > 0) {
getContext().getContentResolver().notifyChange(
ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), null);
}
// Notify the data uri
// 如果插入的是数据,通知数据 URI 的数据发生了变化
if (dataId > 0) {
getContext().getContentResolver().notifyChange(
ContentUris.withAppendedId(Notes.CONTENT_DATA_URI, dataId), null);
}
// 返回插入结果的 URI
return ContentUris.withAppendedId(uri, insertedId);
}
// 重写 ContentProvider 的 delete 方法,用于执行删除操作
@Override
public int delete(Uri uri, String selection, String[] selectionArgs) {
// 声明一个变量,用于存储删除操作影响的行数
int count = 0;
// 声明一个字符串,用于存储 URI 中的 ID
String id = null;
// 获取一个可写的 SQLite 数据库对象
SQLiteDatabase db = mHelper.getWritableDatabase();
// 声明一个布尔变量,用于标记是否删除数据
boolean deleteData = false;
// 使用 mMatcher 匹配 URI根据匹配结果执行不同的删除操作
switch (mMatcher.match(uri)) {
// 当 URI 匹配为 URI_NOTE 时,删除笔记
case URI_NOTE:
// 添加额外的选择条件,只删除 ID 大于 0 的笔记
selection = "(" + selection + ") AND " + NoteColumns.ID + ">0 ";
// 执行删除操作,返回删除的行数
count = db.delete(TABLE.NOTE, selection, selectionArgs);
break;
// 当 URI 匹配为 URI_NOTE_ITEM 时,删除笔记中的特定项
case URI_NOTE_ITEM:
// 获取 URI 中的 ID 部分
id = uri.getPathSegments().get(1);
/**
* ID that smaller than 0 is system folder which is not allowed to
* trash
* ID 0
*/
// 将 ID 转换为长整型
long noteId = Long.valueOf(id);
// 如果 ID 小于等于 0则不执行删除操作
if (noteId <= 0) {
break;
}
// 执行删除操作,将选择条件与原始选择条件拼接
count = db.delete(TABLE.NOTE,
NoteColumns.ID + "=" + id + parseSelection(selection), selectionArgs);
break;
// 当 URI 匹配为 URI_DATA 时,删除数据
case URI_DATA:
// 执行删除操作,返回删除的行数
count = db.delete(TABLE.DATA, selection, selectionArgs);
// 标记删除了数据
deleteData = true;
break;
// 当 URI 匹配为 URI_DATA_ITEM 时,删除数据中的特定项
case URI_DATA_ITEM:
// 获取 URI 中的 ID 部分
id = uri.getPathSegments().get(1);
// 执行删除操作,将选择条件与原始选择条件拼接
count = db.delete(TABLE.DATA,
DataColumns.ID + "=" + id + parseSelection(selection), selectionArgs);
// 标记删除了数据
deleteData = true;
break;
// 如果 URI 不匹配任何已知的 URI抛出异常
default:
throw new IllegalArgumentException("Unknown URI " + uri);
}
// 如果删除操作影响的行数大于 0
if (count > 0) {
// 如果删除了数据,通知笔记 URI 的数据发生了变化
if (deleteData) {
getContext().getContentResolver().notifyChange(Notes.CONTENT_NOTE_URI, null);
}
// 通知 URI 的数据发生了变化
getContext().getContentResolver().notifyChange(uri, null);
}
// 返回删除操作影响的行数
return count;
}
// 重写 ContentProvider 的 update 方法,用于执行更新操作
@Override
public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs) {
// 声明一个变量,用于存储更新操作影响的行数
int count = 0;
// 声明一个字符串,用于存储 URI 中的 ID
String id = null;
// 获取一个可写的 SQLite 数据库对象
SQLiteDatabase db = mHelper.getWritableDatabase();
// 声明一个布尔变量,用于标记是否更新数据
boolean updateData = false;
// 使用 mMatcher 匹配 URI根据匹配结果执行不同的更新操作
switch (mMatcher.match(uri)) {
// 当 URI 匹配为 URI_NOTE 时,更新笔记
case URI_NOTE:
// 调用 increaseNoteVersion 方法增加笔记的版本号
increaseNoteVersion(-1, selection, selectionArgs);
// 执行更新操作,返回更新的行数
count = db.update(TABLE.NOTE, values, selection, selectionArgs);
break;
// 当 URI 匹配为 URI_NOTE_ITEM 时,更新笔记中的特定项
case URI_NOTE_ITEM:
// 获取 URI 中的 ID 部分
id = uri.getPathSegments().get(1);
// 调用 increaseNoteVersion 方法增加笔记的版本号
increaseNoteVersion(Long.valueOf(id), selection, selectionArgs);
// 执行更新操作,将选择条件与原始选择条件拼接
count = db.update(TABLE.NOTE, values, NoteColumns.ID + "=" + id
+ parseSelection(selection), selectionArgs);
break;
// 当 URI 匹配为 URI_DATA 时,更新数据
case URI_DATA:
// 执行更新操作,返回更新的行数
count = db.update(TABLE.DATA, values, selection, selectionArgs);
// 标记更新了数据
updateData = true;
break;
// 当 URI 匹配为 URI_DATA_ITEM 时,更新数据中的特定项
case URI_DATA_ITEM:
// 获取 URI 中的 ID 部分
id = uri.getPathSegments().get(1);
// 执行更新操作,将选择条件与原始选择条件拼接
count = db.update(TABLE.DATA, values, DataColumns.ID + "=" + id
+ parseSelection(selection), selectionArgs);
// 标记更新了数据
updateData = true;
break;
// 如果 URI 不匹配任何已知的 URI抛出异常
default:
throw new IllegalArgumentException("Unknown URI " + uri);
}
// 如果更新操作影响的行数大于 0
if (count > 0) {
// 如果更新了数据,通知笔记 URI 的数据发生了变化
if (updateData) {
getContext().getContentResolver().notifyChange(Notes.CONTENT_NOTE_URI, null);
}
// 通知 URI 的数据发生了变化
getContext().getContentResolver().notifyChange(uri, null);
}
// 返回更新操作影响的行数
return count;
}
// 辅助方法,用于解析选择条件,添加额外的逻辑
private String parseSelection(String selection) {
return (!TextUtils.isEmpty(selection) ? " AND (" + selection + ')' : "");
// 如果选择条件不为空,添加 AND 逻辑运算符和括号
return (!TextUtils.isEmpty(selection)? " AND (" + selection + ')' : "");
}
// 辅助方法,用于增加笔记的版本号
private void increaseNoteVersion(long id, String selection, String[] selectionArgs) {
// 创建一个 StringBuilder 对象,用于构建 SQL 语句
StringBuilder sql = new StringBuilder(120);
// 开始构建 SQL 语句,更新笔记表
sql.append("UPDATE ");
sql.append(TABLE.NOTE);
sql.append(" SET ");
// 将笔记的版本号加 1
sql.append(NoteColumns.VERSION);
sql.append("=" + NoteColumns.VERSION + "+1 ");
if (id > 0 || !TextUtils.isEmpty(selection)) {
// 如果有 ID 或选择条件不为空,添加 WHERE 子句
if (id > 0 ||!TextUtils.isEmpty(selection)) {
sql.append(" WHERE ");
}
// 如果有 ID添加 ID 条件
if (id > 0) {
sql.append(NoteColumns.ID + "=" + String.valueOf(id));
}
// 如果选择条件不为空
if (!TextUtils.isEmpty(selection)) {
String selectString = id > 0 ? parseSelection(selection) : selection;
// 根据是否有 ID 选择不同的方式处理选择条件
String selectString = id > 0? parseSelection(selection) : selection;
// 将选择参数替换到选择条件中
for (String args : selectionArgs) {
selectString = selectString.replaceFirst("\\?", args);
}
// 添加选择条件
sql.append(selectString);
}
// 执行 SQL 语句
mHelper.getWritableDatabase().execSQL(sql.toString());
}
// 重写 ContentProvider 的 getType 方法,用于获取 URI 的 MIME 类型,未实现
@Override
public String getType(Uri uri) {
// TODO Auto-generated method stub

Loading…
Cancel
Save