pgytbhcw9
/
xiaominote_code_analysis
1
0
Fork 0
Code Issues Pull Requests 1 Packages Projects Releases Wiki Activity

liuyuxia

Browse Source
main
liuyuxia 7 months ago
parent 58f1351787
commit 03322225e8
4 changed files with 895 additions and 727 deletions
Show Stats Download Patch File Download Diff File

117
src/java/net/micode/notes/model/Note.java
Unescape View File

@ -15,6 +15,7 @@
*/
package net.micode.notes.model;
import android.content.ContentProviderOperation;
import android.content.ContentProviderResult;
import android.content.ContentUris;
@ -33,16 +34,23 @@ import net.micode.notes.data.Notes.TextNote;
import java.util.ArrayList;
/**
* Note 类用于表示一个便签。
* 它封装了便签的各种属性和操作方法，包括创建新便签、同步便签数据等。
*/
public class Note {
private ContentValues mNoteDiffValues;
private NoteData mNoteData;
private static final String TAG = "Note";
private ContentValues mNoteDiffValues; // 便签差异值
private NoteData mNoteData; // 便签数据
private static final String TAG = "Note"; // 日志标签
/**
* Create a new note id for adding a new note to databases
* 创建一个新的便签ID。
* @param context 上下文
* @param folderId 文件夹ID
* @return 新便签ID
*/
public static synchronized long getNewNoteId(Context context, long folderId) {
// Create a new note in the database
// 创建一个新的便签
ContentValues values = new ContentValues();
long createdTime = System.currentTimeMillis();
values.put(NoteColumns.CREATED_DATE, createdTime);
@ -70,40 +78,82 @@ public class Note {
mNoteData = new NoteData();
}
/**
* 设置便签的置顶状态。
* @param key 键
* @param value 值
*/
public void setTopState(String key, int value) {
mNoteDiffValues.put(key, value);
}
/**
* 设置便签的值。
* @param key 键
* @param value 值
*/
public void setNoteValue(String key, String value) {
mNoteDiffValues.put(key, value);
mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1);
mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis());
}
/**
* 设置文本数据。
* @param key 键
* @param value 值
*/
public void setTextData(String key, String value) {
mNoteData.setTextData(key, value);
}
/**
* 设置文本数据ID。
* @param id ID
*/
public void setTextDataId(long id) {
mNoteData.setTextDataId(id);
}
/**
* 获取文本数据ID。
* @return 文本数据ID
*/
public long getTextDataId() {
return mNoteData.mTextDataId;
}
/**
* 设置通话数据ID。
* @param id ID
*/
public void setCallDataId(long id) {
mNoteData.setCallDataId(id);
}
/**
* 设置通话数据。
* @param key 键
* @param value 值
*/
public void setCallData(String key, String value) {
mNoteData.setCallData(key, value);
}
/**
* 判断便签是否本地修改过。
* @return 修改过返回true，否则返回false
*/
public boolean isLocalModified() {
return mNoteDiffValues.size() > 0 || mNoteData.isLocalModified();
}
/**
* 同步便签数据。
* @param context 上下文
* @param noteId 便签ID
* @return 同步成功返回true，否则返回false
*/
public boolean syncNote(Context context, long noteId) {
if (noteId <= 0) {
throw new IllegalArgumentException("Wrong note id:" + noteId);
@ -113,16 +163,10 @@ public class Note {
return true;
}
/**
* In theory, once data changed, the note should be updated on {@link NoteColumns#LOCAL_MODIFIED} and
* {@link NoteColumns#MODIFIED_DATE}. For data safety, though update note fails, we also update the
* note data info
*/
if (context.getContentResolver().update(
ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), mNoteDiffValues, null,
null) == 0) {
Log.e(TAG, "Update note error, should not happen");
// Do not return, fall through
}
mNoteDiffValues.clear();
@ -134,16 +178,15 @@ public class Note {
return true;
}
/**
* NoteData 类用于表示便签的数据。
*/
private class NoteData {
private long mTextDataId;
private ContentValues mTextDataValues;
private long mCallDataId;
private ContentValues mCallDataValues;
private static final String TAG = "NoteData";
private long mTextDataId; // 文本数据ID
private ContentValues mTextDataValues; // 文本数据值
private long mCallDataId; // 通话数据ID
private ContentValues mCallDataValues; // 通话数据值
private static final String TAG = "NoteData"; // 日志标签
public NoteData() {
mTextDataValues = new ContentValues();
@ -152,10 +195,18 @@ public class Note {
mCallDataId = 0;
}
/**
* 判断便签数据是否本地修改过。
* @return 修改过返回true，否则返回false
*/
boolean isLocalModified() {
return mTextDataValues.size() > 0 || mCallDataValues.size() > 0;
}
/**
* 设置文本数据ID。
* @param id ID
*/
void setTextDataId(long id) {
if(id <= 0) {
throw new IllegalArgumentException("Text data id should larger than 0");
@ -163,6 +214,10 @@ public class Note {
mTextDataId = id;
}
/**
* 设置通话数据ID。
* @param id ID
*/
void setCallDataId(long id) {
if (id <= 0) {
throw new IllegalArgumentException("Call data id should larger than 0");
@ -170,22 +225,35 @@ public class Note {
mCallDataId = id;
}
/**
* 设置通话数据。
* @param key 键
* @param value 值
*/
void setCallData(String key, String value) {
mCallDataValues.put(key, value);
mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1);
mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis());
}
/**
* 设置文本数据。
* @param key 键
* @param value 值
*/
void setTextData(String key, String value) {
mTextDataValues.put(key, value);
mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1);
mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis());
}
Uri pushIntoContentResolver(Context context, long noteId) {
/**
* Check for safety
* 将便签数据推送到ContentResolver。
* @param context 上下文
* @param noteId 便签ID
* @return 推送成功返回URI，否则返回null
*/
Uri pushIntoContentResolver(Context context, long noteId) {
if (noteId <= 0) {
throw new IllegalArgumentException("Wrong note id:" + noteId);
}
@ -207,8 +275,7 @@ public class Note {
return null;
}
} else {
builder = ContentProviderOperation.newUpdate(ContentUris.withAppendedId(
Notes.CONTENT_DATA_URI, mTextDataId));
builder = ContentProviderOperation.newUpdate(ContentUris .withAppendedId(Notes.CONTENT_DATA_URI, mTextDataId));
builder.withValues(mTextDataValues);
operationList.add(builder.build());
}

292
src/java/net/micode/notes/model/WorkingNote.java
Unescape View File

@ -31,82 +31,74 @@ import net.micode.notes.data.Notes.NoteColumns;
import net.micode.notes.data.Notes.TextNote;
import net.micode.notes.tool.ResourceParser.NoteBgResources;
/**
* WorkingNote 类用于表示正在编辑的便签。
* 它封装了便签的各种属性和操作方法。
*/
public class WorkingNote {
// Note for the working note
// 当前正在编辑的便签对象
private Note mNote;
// Note Id
// 便签ID
private long mNoteId;
// Note content
// 便签内容
private String mContent;
// Note mode
// 便签模式
private int mMode;
private long mAlertDate;
private long mModifiedDate;
private int mBgColorId;
private int mWidgetId;
private long mAlertDate; // 提醒日期
private long mModifiedDate; // 修改日期
private int mBgColorId; // 背景颜色ID
private int mWidgetId; // 小部件ID
private int mWidgetType; // 小部件类型
private int mTop; // 置顶状态
private long mFolderId; // 文件夹ID
private Context mContext; // 上下文
private int mWidgetType;
private static final String TAG = "WorkingNote"; // 日志标签
private int mTop;
private long mFolderId;
private Context mContext;
private static final String TAG = "WorkingNote";
private boolean mIsDeleted;
private NoteSettingChangedListener mNoteSettingStatusListener;
private boolean mIsDeleted; // 是否已删除
private NoteSettingChangedListener mNoteSettingStatusListener; // 设置变化监听器
// 数据查询投影
public static final String[] DATA_PROJECTION = new String[] {
DataColumns.ID,
DataColumns.CONTENT,
DataColumns.MIME_TYPE,
DataColumns.DATA1,
DataColumns.DATA2,
DataColumns.DATA3,
DataColumns.DATA4,
DataColumns.ID, // 数据ID
DataColumns.CONTENT, // 数据内容
DataColumns.MIME_TYPE, // 数据类型
DataColumns.DATA1, // 数据1
DataColumns.DATA2, // 数据2
DataColumns.DATA3, // 数据3
DataColumns.DATA4 // 数据4
};
// 便签查询投影
public static final String[] NOTE_PROJECTION = new String[] {
NoteColumns.PARENT_ID,
NoteColumns.ALERTED_DATE,
NoteColumns.BG_COLOR_ID,
NoteColumns.WIDGET_ID,
NoteColumns.WIDGET_TYPE,
NoteColumns.MODIFIED_DATE,
NoteColumns.TOP
NoteColumns.PARENT_ID, // 父ID
NoteColumns.ALERTED_DATE, // 提醒日期
NoteColumns.BG_COLOR_ID, // 背景颜色ID
NoteColumns.WIDGET_ID, // 小部件ID
NoteColumns.WIDGET_TYPE, // 小部件类型
NoteColumns.MODIFIED_DATE, // 修改日期
NoteColumns.TOP // 置顶状态
};
// 列索引
private static final int DATA_ID_COLUMN = 0;
private static final int DATA_CONTENT_COLUMN = 1;
private static final int DATA_MIME_TYPE_COLUMN = 2;
private static final int DATA_MODE_COLUMN = 3;
private static final int NOTE_PARENT_ID_COLUMN = 0;
private static final int NOTE_ALERTED_DATE_COLUMN = 1;
private static final int NOTE_BG_COLOR_ID_COLUMN = 2;
private static final int NOTE_WIDGET_ID_COLUMN = 3;
private static final int NOTE_WIDGET_TYPE_COLUMN = 4;
private static final int NOTE_MODIFIED_DATE_COLUMN = 5;
private static final int NOTE_TOP_STATE_COLUMN = 6;
// New note construct
/**
* 创建一个新的工作便签。
* @param context 上下文
* @param folderId 文件夹ID
*/
private WorkingNote(Context context, long folderId) {
mContext = context;
mAlertDate = 0;
@ -120,7 +112,12 @@ public class WorkingNote {
mWidgetType = Notes.TYPE_WIDGET_INVALIDE;
}
// Existing note construct
/**
* 加载一个已存在的工作便签。
* @param context 上下文
* @param noteId 便签ID
* @param folderId 文件夹ID
*/
private WorkingNote(Context context, long noteId, long folderId) {
mContext = context;
mNoteId = noteId;
@ -130,7 +127,11 @@ public class WorkingNote {
loadNote();
}
/**
* 加载便签数据。
*/
private void loadNote() {
// 查询便签信息
Cursor cursor = mContext.getContentResolver().query(
ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, mNoteId), NOTE_PROJECTION, null,
null, null);
@ -153,7 +154,11 @@ public class WorkingNote {
loadNoteData();
}
/**
* 加载便签数据内容。
*/
private void loadNoteData() {
// 查询便签数据
Cursor cursor = mContext.getContentResolver().query(Notes.CONTENT_DATA_URI, DATA_PROJECTION,
DataColumns.NOTE_ID + "=?", new String[] {
String.valueOf(mNoteId)
@ -181,16 +186,17 @@ public class WorkingNote {
}
}
public static WorkingNote createEmptyNote(Context context, long folderId, int widgetId,
int widgetType, int defaultBgColorId) {
/**
* @method: createEmptyNote
* @description: 创建一个空的工作便签，根据传入参数，设置好工作便签的背景色、挂件号、挂件类型
* @date: 2023/12/20 23:55
* @author: zhoukexing
* @param: [context, folderId, widgetId, widgetType, defaultBgColorId]
* @return: net.micode.notes.model.WorkingNote 返回一个WorkingNote实例
* 创建一个空的工作便签。
* @param context 上下文
* @param folderId 文件夹ID
* @param widgetId 小部件ID
* @param widgetType 小部件类型
* @param defaultBgColorId 默认背景颜色ID
* @return 返回一个WorkingNote实例
*/
public static WorkingNote createEmptyNote(Context context, long folderId, int widgetId,
int widgetType, int defaultBgColorId) {
WorkingNote note = new WorkingNote(context, folderId);
note.setBgColorId(defaultBgColorId);
note.setWidgetId(widgetId);
@ -198,47 +204,20 @@ public class WorkingNote {
return note;
}
public static WorkingNote load(Context context, long id) {
return new WorkingNote(context, id, 0);
}
public synchronized boolean saveNote() {// TODO: 2023/12/19 要仔细溯源看看
/**
* @method: saveNote
* @description: 保存工作便签，当保存成功时，返回true，保存失败（）
* @date: 2023/12/19 23:44
* @author: zhoukexing
* @param: []
* @return: boolean
* 加载一个已存在的工作便签。
* @param context 上下文
* @param id 便签ID
* @return 返回一个WorkingNote实例
*/
if (isWorthSaving()) { // 判断是否有新内容-->是否值得注释 @zhoukexing 2023/12/19 23:45
if (!existInDatabase()) { // 判断是否在数据库里存在==是新便签还是已有便签 @zhoukexing 2023/12/19 23:45
if ((mNoteId = Note.getNewNoteId(mContext, mFolderId)) == 0) {
Log.e(TAG, "Create new note fail with id:" + mNoteId);
return false;
}
public static WorkingNote load(Context context, long id) {
return new WorkingNote(context, id, 0);
}
mNote.syncNote(mContext, mNoteId); // 和远程同步 @zhoukexing 2023/12/19 23:46
/**
* Update widget content if there exist any widget of this note
* 判断便签是否有值得保存的内容。
* @return 有值得保存的内容返回true，否则返回false
*/
if (mWidgetId != AppWidgetManager.INVALID_APPWIDGET_ID
&& mWidgetType != Notes.TYPE_WIDGET_INVALIDE
&& mNoteSettingStatusListener != null) {
mNoteSettingStatusListener.onWidgetChanged();
}
return true;
} else {
return false; // 没有需要保存的，就返回false @zhoukexing 2023/12/19 23:46
}
}
public boolean existInDatabase() {
return mNoteId > 0;
}
private boolean isWorthSaving() {
if (mIsDeleted || (!existInDatabase() && TextUtils.isEmpty(mContent))
|| (existInDatabase() && !mNote.isLocalModified())) {
@ -249,54 +228,47 @@ public class WorkingNote {
}
/**
* @method: setOnSettingStatusChangedListener
* @description: 将工作目录里的NoteEditActivity项设置为NoteSettingChangedListener
* @date: 2023/12/21 0:10
* @author: zhoukexing
* @param: [l] NoteEditActivity
* @return: void
* 设置设置变化监听器。
* @param l 监听器实例
*/
public void setOnSettingStatusChangedListener(NoteSettingChangedListener l) {
//Q: 这里的l是怎么获取的。l是NoteEditActivity @zkx 2023/12/21
mNoteSettingStatusListener = l;
}
/**
* 反转便签的置顶状态。
*/
public void reverseTopState() {
mTop ^= 1;
mNote.setTopState(NoteColumns.TOP, mTop);
}
/**
* 获取便签的置顶状态。
* @return 置顶状态
*/
public int getmTop() {
return mTop;
}
/**
* @Method setAlertDate
* @Date 2023/12/13 11:43
* 设置便签的提醒日期。
* @param date 提醒日期
* @param set 动作（关闭或开启）
* @Author lenovo
* @Return void
* @Description 设置一个提醒时间
* @param set 是否设置提醒
*/
public void setAlertDate(long date, boolean set) {
// 更新便签项中的提醒日期
if (date != mAlertDate) {
mAlertDate = date;
mNote.setNoteValue(NoteColumns.ALERTED_DATE, String.valueOf(mAlertDate));
}
// 设置提醒的监听事件
if (mNoteSettingStatusListener != null) {
mNoteSettingStatusListener.onClockAlertChanged(date, set);
}
}
/**
* @method: markDeleted
* @description: 描述一下方法的作用
* @date: 2023/12/21 0:50
* @author: zhoukexing
* @param: [mark]
* @return: void
* 标记便签为已删除或未删除。
* @param mark 是否标记为已删除
*/
public void markDeleted(boolean mark) {
mIsDeleted = mark;
@ -306,6 +278,10 @@ public class WorkingNote {
}
}
/**
* 设置便签的背景颜色ID。
* @param id 背景颜色ID
*/
public void setBgColorId(int id) {
if (id != mBgColorId) {
mBgColorId = id;
@ -316,6 +292,10 @@ public class WorkingNote {
}
}
/**
* 设置便签的检查列表模式。
* @param mode 模式
*/
public void setCheckListMode(int mode) {
if (mMode != mode) {
if (mNoteSettingStatusListener != null) {
@ -326,6 +306,10 @@ public class WorkingNote {
}
}
/**
* 设置便签的小部件类型。
* @param type 小部件类型
*/
public void setWidgetType(int type) {
if (type != mWidgetType) {
mWidgetType = type;
@ -333,6 +317,10 @@ public class WorkingNote {
}
}
/**
* 设置便签的小部件ID。
* @param id 小部件ID
*/
public void setWidgetId(int id) {
if (id != mWidgetId) {
mWidgetId = id;
@ -340,6 +328,10 @@ public class WorkingNote {
}
}
/**
* 设置便签的文本内容。
* @param text 文本内容
*/
public void setWorkingText(String text) {
if (!TextUtils.equals(mContent, text)) {
mContent = text;
@ -347,80 +339,138 @@ public class WorkingNote {
}
}
/**
* 将便签转换为通话记录便签。
* @param phoneNumber 电话号码
* @param callDate 通话日期
*/
public void convertToCallNote(String phoneNumber, long callDate) {
mNote.setCallData(CallNote.CALL_DATE, String.valueOf(callDate));
mNote.setCallData(CallNote.PHONE_NUMBER, phoneNumber);
mNote.setNoteValue(NoteColumns.PARENT_ID, String.valueOf(Notes.ID_CALL_RECORD_FOLDER));
}
/**
* 判断便签是否有提醒。
* @return 有提醒返回true，否则返回false
*/
public boolean hasClockAlert() {
return (mAlertDate > 0 ? true : false);
return (mAlertDate > 0);
}
/**
* 获取便签的内容。
* @return 便签内容
*/
public String getContent() {
return mContent;
}
/**
* 获取便签的提醒日期。
* @return 提醒日期
*/
public long getAlertDate() {
return mAlertDate;
}
/**
* 获取便签的修改日期。
* @return 修改日期
*/
public long getModifiedDate() {
return mModifiedDate;
}
/**
* 获取便签的背景颜色资源ID。
* @return 背景颜色资源ID
*/
public int getBgColorResId() {
return NoteBgResources.getNoteBgResource(mBgColorId);
}
/**
* 获取便签的背景颜色ID。
* @return 背景颜色ID
*/
public int getBgColorId() {
return mBgColorId;
}
/**
* 获取便签的标题背景资源ID。
* @return 标题背景资源ID
*/
public int getTitleBgResId() {
return NoteBgResources.getNoteTitleBgResource(mBgColorId);
}
/**
* 获取便签的检查列表模式。
* @return 检查列表模式
*/
public int getCheckListMode() {
return mMode;
}
/**
* 获取便签的ID。
* @return 便签ID
*/
public long getNoteId() {
return mNoteId;
}
/**
* 获取便签的文件夹ID。
* @return 文件夹ID
*/
public long getFolderId() {
return mFolderId;
}
/**
* 获取便签的小部件ID。
* @return 小部件ID
*/
public int getWidgetId() {
return mWidgetId;
}
/**
* 获取便签的小部件类型。
* @return 小部件类型
*/
public int getWidgetType() {
return mWidgetType;
}
/**
* 便签设置变化监听器接口。
*/
public interface NoteSettingChangedListener {
/**
* Called when the background color of current note has just changed
* 当便签的背景颜色发生变化时调用。
*/
void onBackgroundColorChanged();
/**
* Called when user set clock
* 当用户设置提醒时调用。
* @param date 提醒日期
* @param set 是否设置提醒
*/
void onClockAlertChanged(long date, boolean set);
/**
* Call when user create note from widget
* 当用户从小部件创建便签时调用。
*/
void onWidgetChanged();
/**
* Call when switch between check list mode and normal mode
* @param oldMode is previous mode before change
* @param newMode is new mode
* 当用户在检查列表模式和普通模式之间切换时调用。
* @param oldMode 之前的模式
* @param newMode 新的模式
*/
void onCheckListModeChanged(int oldMode, int newMode);
}

156
src/java/net/micode/notes/tool/BackupUtils.java
Unescape View File

@ -16,36 +16,56 @@
package net.micode.notes.tool;
import android.content.Context;
import android.database.Cursor;
import android.net.Uri;
import android.os.Environment;
import android.text.format.DateFormat;
import android.util.Log;
import net.micode.notes.data.Notes;
import net.micode.notes.data.Notes.DataColumns;
import net.micode.notes.data.Notes.NoteColumns;
import net.micode.notes.tool.ResourceParser;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.PrintStream;
import java.text.SimpleDateFormat;
/**
* BackupUtils 类用于实现便签数据的备份功能。
* 它提供了一个单例模式的实例，并且可以将便签数据导出为文本文件。
*/
public class BackupUtils {
private static final String TAG = "BackupUtils";
// Singleton stuff
private static BackupUtils sInstance; //类里面为什么可以定义自身类的对象？
// 单例模式
private static BackupUtils sInstance; // 类里面可以定义自身类的对象，用于实现单例模式
/**
* 获取BackupUtils的单例实例。
* @param context 上下文
* @return BackupUtils实例
*/
public static synchronized BackupUtils getInstance(Context context) {
//ynchronized 关键字，代表这个方法加锁,相当于不管哪一个线程（例如线程A）
//运行到这个方法时,都要检查有没有其它线程B（或者C、 D等）正在用这个方法(或者该类的其他同步方法)，有的话要等正在使用synchronized方法的线程B（或者C 、D）运行完这个方法后再运行此线程A,没有的话,锁定调用者,然后直接运行。
//它包括两种用法：synchronized 方法和 synchronized 块。
// synchronized 关键字，确保多线程环境下线程安全
if (sInstance == null) {
//如果当前备份不存在，则新声明一个
// 如果当前实例不存在，则创建一个新的实例
sInstance = new BackupUtils(context);
}
return sInstance;
}
/**
* Following states are signs to represents backup or restore
* status
* 备份或恢复状态常量
*/
// Currently, the sdcard is not mounted SD卡没有被装入手机
public static final int STATE_SD_CARD_UNMOUONTED = 0;
// The backup file not exist 备份文件夹不存在
public static final int STATE_BACKUP_FILE_NOT_EXIST = 1;
// The data is not well formated, may be changed by other programs 数据已被破坏，可能被修改
public static final int STATE_DATA_DESTROIED = 2;
// Some run-time exception which causes restore or backup fails 超时异常
public static final int STATE_SYSTEM_ERROR = 3;
// Backup or restore success 成功存储
public static final int STATE_SUCCESS = 4;
public static final int STATE_SD_CARD_UNMOUONTED = 0; // SD卡未挂载
public static final int STATE_BACKUP_FILE_NOT_EXIST = 1; // 备份文件不存在
public static final int STATE_DATA_DESTROIED = 2; // 数据被破坏
public static final int STATE_SYSTEM_ERROR = 3; // 系统错误
public static final int STATE_SUCCESS = 4; // 成功
private TextExport mTextExport;
@ -53,22 +73,41 @@
mTextExport = new TextExport(context);
}
private static boolean externalStorageAvailable() { //外部存储功能是否可用
/**
* 检查外部存储是否可用。
* @return 可用返回true，否则返回false
*/
private static boolean externalStorageAvailable() {
return Environment.MEDIA_MOUNTED.equals(Environment.getExternalStorageState());
}
/**
* 将便签数据导出为文本。
* @return 导出结果状态
*/
public int exportToText() {
return mTextExport.exportToText();
}
/**
* 获取导出的文本文件名。
* @return 文件名
*/
public String getExportedTextFileName() {
return mTextExport.mFileName;
}
/**
* 获取导出的文本文件目录。
* @return 文件目录
*/
public String getExportedTextFileDir() {
return mTextExport.mFileDirectory;
}
/**
* TextExport 类用于将便签数据导出为文本。
*/
private static class TextExport {
private static final String[] NOTE_PROJECTION = {
NoteColumns.ID,
@ -78,9 +117,7 @@
};
private static final int NOTE_COLUMN_ID = 0;
private static final int NOTE_COLUMN_MODIFIED_DATE = 1;
private static final int NOTE_COLUMN_SNIPPET = 2;
private static final String[] DATA_PROJECTION = {
@ -93,11 +130,8 @@
};
private static final int DATA_COLUMN_CONTENT = 0;
private static final int DATA_COLUMN_MIME_TYPE = 1;
private static final int DATA_COLUMN_CALL_DATE = 2;
private static final int DATA_COLUMN_PHONE_NUMBER = 4;
private final String [] TEXT_FORMAT;
@ -112,19 +146,26 @@
public TextExport(Context context) {
TEXT_FORMAT = context.getResources().getStringArray(R.array.format_for_exported_note);
mContext = context;
mFileName = ""; //为什么为空?
mFileName = ""; // 初始化为空
mFileDirectory = "";
}
private String getFormat(int id) { //获取文本的组成部分
/**
* 获取文本格式字符串。
* @param id 格式ID
* @return 格式字符串
*/
private String getFormat(int id) {
return TEXT_FORMAT[id];
}
/**
* Export the folder identified by folder id to text
* 将指定文件夹的便签导出为文本。
* @param folderId 文件夹ID
* @param ps 输出流
*/
private void exportFolderToText(String folderId, PrintStream ps) {
// Query notes belong to this folder 通过查询parent id是文件夹id的note来选出制定ID文件夹下的Note
// 查询属于该文件夹的便签
Cursor notesCursor = mContext.getContentResolver().query(Notes.CONTENT_NOTE_URI,
NOTE_PROJECTION, NoteColumns.PARENT_ID + "=?", new String[] {
folderId
@ -133,13 +174,13 @@
if (notesCursor != null) {
if (notesCursor.moveToFirst()) {
do {
// Print note's last modified date ps里面保存有这份note的日期
// 打印便签的最后修改日期
ps.println(String.format(getFormat(FORMAT_NOTE_DATE), DateFormat.format(
mContext.getString(R.string.format_datetime_mdhm),
notesCursor.getLong(NOTE_COLUMN_MODIFIED_DATE))));
// Query data belong to this note
// 查询属于该便签的数据
String noteId = notesCursor.getString(NOTE_COLUMN_ID);
exportNoteToText(noteId, ps); //将文件导出到text
exportNoteToText(noteId, ps); // 将便签导出为文本
} while (notesCursor.moveToNext());
}
notesCursor.close();
@ -147,7 +188,9 @@
}
/**
* Export note identified by id to a print stream
* 将指定便签导出为文本。
* @param noteId 便签ID
* @param ps 输出流
*/
private void exportNoteToText(String noteId, PrintStream ps) {
Cursor dataCursor = mContext.getContentResolver().query(Notes.CONTENT_DATA_URI,
@ -155,25 +198,25 @@
noteId
}, null);
if (dataCursor != null) { //利用光标来扫描内容，区别为callnote和note两种，靠ps.printline输出
if (dataCursor != null) {
if (dataCursor.moveToFirst()) {
do {
String mimeType = dataCursor.getString(DATA_COLUMN_MIME_TYPE);
if (DataConstants.CALL_NOTE.equals(mimeType)) {
// Print phone number
// 打印电话号码
String phoneNumber = dataCursor.getString(DATA_COLUMN_PHONE_NUMBER);
long callDate = dataCursor.getLong(DATA_COLUMN_CALL_DATE);
String location = dataCursor.getString(DATA_COLUMN_CONTENT);
if (!TextUtils.isEmpty(phoneNumber)) { //判断是否为空字符
if (!TextUtils.isEmpty(phoneNumber)) {
ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT),
phoneNumber));
}
// Print call date
// 打印通话日期
ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT), DateFormat
.format(mContext.getString(R.string.format_datetime_mdhm),
callDate)));
// Print call attachment location
// 打印通话附件位置
if (!TextUtils.isEmpty(location)) {
ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT),
location));
@ -189,7 +232,7 @@
}
dataCursor.close();
}
// print a line separator between note
// 打印便签之间的分隔符
try {
ps.write(new byte[] {
Character.LINE_SEPARATOR, Character.LETTER_NUMBER
@ -200,9 +243,10 @@
}
/**
* Note will be exported as text which is user readable
* 将便签数据导出为文本。
* @return 导出结果状态
*/
public int exportToText() { //总函数，调用上面的exportFolder和exportNote
public int exportToText() {
if (!externalStorageAvailable()) {
Log.d(TAG, "Media was not mounted");
return STATE_SD_CARD_UNMOUONTED;
@ -213,18 +257,18 @@
Log.e(TAG, "get print stream error");
return STATE_SYSTEM_ERROR;
}
// First export folder and its notes 导出文件夹，就是导出里面包含的便签
// 首先导出文件夹及其便签
Cursor folderCursor = mContext.getContentResolver().query(
Notes.CONTENT_NOTE_URI,
NOTE_PROJECTION,
"(" + NoteColumns.TYPE + "=" + Notes.TYPE_FOLDER + " AND "
+ NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER + ") OR "
+ NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLDER + ") OR "
+ NoteColumns.ID + "=" + Notes.ID_CALL_RECORD_FOLDER, null, null);
if (folderCursor != null) {
if (folderCursor.moveToFirst()) {
if (folderCursor.moveToFirst( ) {
do {
// Print folder's name
// 打印文件夹名称
String folderName = "";
if(folderCursor.getLong(NOTE_COLUMN_ID) == Notes.ID_CALL_RECORD_FOLDER) {
folderName = mContext.getString(R.string.call_record_folder_name);
@ -241,11 +285,11 @@
folderCursor.close();
}
// Export notes in root's folder 将根目录里的便签导出（由于不属于任何文件夹，因此无法通过文件夹导出来实现这一部分便签的导出）
// 导出根目录下的便签
Cursor noteCursor = mContext.getContentResolver().query(
Notes.CONTENT_NOTE_URI,
NOTE_PROJECTION,
NoteColumns.TYPE + "=" + +Notes.TYPE_NOTE + " AND " + NoteColumns.PARENT_ID
NoteColumns.TYPE + "=" + Notes.TYPE_NOTE + " AND " + NoteColumns.PARENT_ID
+ "=0", null, null);
if (noteCursor != null) {
@ -254,7 +298,7 @@
ps.println(String.format(getFormat(FORMAT_NOTE_DATE), DateFormat.format(
mContext.getString(R.string.format_datetime_mdhm),
noteCursor.getLong(NOTE_COLUMN_MODIFIED_DATE))));
// Query data belong to this note
// 查询属于该便签的数据
String noteId = noteCursor.getString(NOTE_COLUMN_ID);
exportNoteToText(noteId, ps);
} while (noteCursor.moveToNext());
@ -267,7 +311,8 @@
}
/**
* Get a print stream pointed to the file {@generateExportedTextFile}
* 获取指向导出文本文件的输出流。
* @return 输出流
*/
private PrintStream getExportToTextPrintStream() {
File file = generateFileMountedOnSDcard(mContext, R.string.file_path,
@ -281,7 +326,7 @@
PrintStream ps = null;
try {
FileOutputStream fos = new FileOutputStream(file);
ps = new PrintStream(fos); //将ps输出流输出到特定的文件，目的就是导出到文件，而不是直接输出
ps = new PrintStream(fos);
} catch (FileNotFoundException e) {
e.printStackTrace();
return null;
@ -294,13 +339,17 @@
}
/**
* Generate the text file to store imported data
* 在SD卡上生成用于存储导出数据的文本文件。
* @param context 上下文
* @param filePathResId 文件路径资源ID
* @param fileNameFormatResId 文件名格式资源ID
* @return 文件对象
*/
private static File generateFileMountedOnSDcard(Context context, int filePathResId, int fileNameFormatResId) {
StringBuilder sb = new StringBuilder();
sb.append(Environment.getExternalStorageDirectory()); // 外部（SD卡）的存储路径
sb.append(context.getString(filePathResId)); // 文件的存储路径
File filedir = new File(sb.toString()); //filedir应该就是用来存储路径信息
File filedir = new File(sb.toString()); // filedir用于存储路径信息
sb.append(context.getString(
fileNameFormatResId,
DateFormat.format(context.getString(R.string.format_date_ymd),
@ -320,10 +369,7 @@
} catch (IOException e) {
e.printStackTrace();
}
// try catch 异常处理
// 异常处理
return null;
}
}

81
src/java/net/micode/notes/tool/DataUtils.java
Unescape View File

@ -13,9 +13,8 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*该类定义在 net.micode.notes.tool 包下，并导入了Android和Java的一些核心类。这些导入的类提供了对内容提供者操作、日志记录、游标以及存储值的支持。 */
package net.micode.notes.tool;
/*定义了一个公共类 DataUtils，并创建了一个常量 TAG 用于日志记录。 */
import android.content.ContentProviderOperation;
import android.content.ContentProviderResult;
import android.content.ContentResolver;
@ -34,11 +33,19 @@ import net.micode.notes.ui.NotesListAdapter.AppWidgetAttribute;
import java.util.ArrayList;
import java.util.HashSet;
/*这个方法实现了根据一组ID批量删除笔记的功能。
它首先检查ID集合是否为空，并创建一个操作列表。
通过 ContentResolver 执行删除操作，成功后返回 true，失败则返回 false。 */
/**
* DataUtils 类提供了一系列用于操作便签数据的工具方法。
* 包括批量删除便签、移动便签、查询便签等。
*/
public class DataUtils {
public static final String TAG = "DataUtils";
/**
* 批量删除便签。
* @param resolver ContentResolver对象
* @param ids 需要删除的便签ID集合
* @return 删除成功返回true，否则返回false
*/
public static boolean batchDeleteNotes(ContentResolver resolver, HashSet<Long> ids) {
if (ids == null) {
Log.d(TAG, "the ids is null");
@ -73,9 +80,14 @@ public class DataUtils {
}
return false;
}
/*此方法将指定的笔记移动到目标文件夹。
更新笔记的父文件夹ID并标记为本地修改。 */
/*查询非系统文件夹的数量。异常处理用于确保在查询失败时释放游标资源。 */
/**
* 将便签移动到指定文件夹。
* @param resolver ContentResolver对象
* @param id 便签ID
* @param srcFolderId 源文件夹ID
* @param desFolderId 目标文件夹ID
*/
public static void moveNoteToFoler(ContentResolver resolver, long id, long srcFolderId, long desFolderId) {
ContentValues values = new ContentValues();
values.put(NoteColumns.PARENT_ID, desFolderId);
@ -85,20 +97,11 @@ public class DataUtils {
}
/**
* @method: batchMoveToFolder
* @description: 将ids里标注的文件移至folderId指定的文件夹
* @date: 2024/12/26 3:32
* @author: zhoukexing
* @param: [resolver, ids, folderId]
* @return: boolean
*/
/*检查数据库中是否存在特定类型的可见笔记。 */
/**
* 批量将便签移动到指定文件夹
* 批量将便签移动到指定文件夹。
* @param resolver ContentResolver对象
* @param ids 需要移动的便签ID集合
* @param folderId 目标文件夹ID
* @return 是否移动成功
* @return 移动成功返回true，否则返回false
*/
public static boolean batchMoveToFolder(ContentResolver resolver, HashSet<Long> ids, long folderId) {
if (ids == null) {
@ -118,7 +121,7 @@ public static boolean batchMoveToFolder(ContentResolver resolver, HashSet<Long>
try {
ContentProviderResult[] results = resolver.applyBatch(Notes.AUTHORITY, operationList);
if (results == null || results.length == 0 || results[0] == null) {
Log.d(TAG, "delete notes failed, ids:" + ids.toString());
Log.d(TAG, "move notes failed, ids:" + ids.toString());
return false;
}
return true;
@ -131,7 +134,7 @@ public static boolean batchMoveToFolder(ContentResolver resolver, HashSet<Long>
}
/**
* 获取用户文件夹的数量（不包括系统文件夹）
* 获取用户文件夹的数量（不包括系统文件夹）。
* @param resolver ContentResolver对象
* @return 用户文件夹的数量
*/
@ -139,7 +142,7 @@ public static int getUserFolderCount(ContentResolver resolver) {
Cursor cursor = resolver.query(Notes.CONTENT_NOTE_URI,
new String[] { "COUNT(*)" },
NoteColumns.TYPE + "=? AND " + NoteColumns.PARENT_ID + "<>?",
new String[] { String.valueOf(Notes.TYPE_FOLDER), String.valueOf(Notes.ID_TRASH_FOLER)},
new String[] { String.valueOf(Notes.TYPE_FOLDER), String.valueOf(Notes.ID_TRASH_FOLDER)},
null);
int count = 0;
@ -158,16 +161,16 @@ public static int getUserFolderCount(ContentResolver resolver) {
}
/**
* 检查数据库中是否存在指定ID和类型的便签
* 检查数据库中是否存在指定ID和类型的便签。
* @param resolver ContentResolver对象
* @param noteId 便签ID
* @param type 便签类型
* @return 是否存在
* @return 存在返回true，否则返回false
*/
public static boolean visibleInNoteDatabase(ContentResolver resolver, long noteId, int type) {
Cursor cursor = resolver.query(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId),
null,
NoteColumns.TYPE + "=? AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER,
NoteColumns.TYPE + "=? AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLDER,
new String [] {String.valueOf(type)},
null);
@ -182,10 +185,10 @@ public static boolean visibleInNoteDatabase(ContentResolver resolver, long noteI
}
/**
* 检查数据库中是否存在指定ID的便签
* 检查数据库中是否存在指定ID的便签。
* @param resolver ContentResolver对象
* @param noteId 便签ID
* @return 是否存在
* @return 存在返回true，否则返回false
*/
public static boolean existInNoteDatabase(ContentResolver resolver, long noteId) {
Cursor cursor = resolver.query(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId),
@ -202,10 +205,10 @@ public static boolean existInNoteDatabase(ContentResolver resolver, long noteId)
}
/**
* 检查数据库中是否存在指定ID的数据
* 检查数据库中是否存在指定ID的数据。
* @param resolver ContentResolver对象
* @param dataId 数据ID
* @return 是否存在
* @return 存在返回true，否则返回false
*/
public static boolean existInDataDatabase(ContentResolver resolver, long dataId) {
Cursor cursor = resolver.query(ContentUris.withAppendedId(Notes.CONTENT_DATA_URI, dataId),
@ -222,20 +225,21 @@ public static boolean existInDataDatabase(ContentResolver resolver, long dataId)
}
/**
* 检查数据库中是否存在指定名称的可见文件夹
* 检查数据库中是否存在指定名称的可见文件夹。
* @param resolver ContentResolver对象
* @param name 文件夹名称
* @return 是否存在
* @return 存在返回true，否则返回false
*/
public static boolean checkVisibleFolderName(ContentResolver resolver, String name) {
Cursor cursor = resolver.query(Notes.CONTENT_NOTE_URI, null,
NoteColumns.TYPE + "=" + Notes.TYPE_FOLDER +
" AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER +
" AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLDER +
" AND " + NoteColumns.SNIPPET + "=?",
new String[] { name }, null);
boolean exist = false;
if(cursor != null) {
if(cursor.getCount() > 0) {
exist = true;
}
cursor.close();
@ -244,7 +248,7 @@ public static boolean checkVisibleFolderName(ContentResolver resolver, String na
}
/**
* 获取指定文件夹中的小部件属性集合
* 获取指定文件夹中的小部件属性集合。
* @param resolver ContentResolver对象
* @param folderId 文件夹ID
* @return 小部件属性集合
@ -277,7 +281,7 @@ public static HashSet<AppWidgetAttribute> getFolderNoteWidget(ContentResolver re
}
/**
* 根据便签ID获取电话号码
* 根据便签ID获取电话号码。
* @param resolver ContentResolver对象
* @param noteId 便签ID
* @return 电话号码
@ -302,7 +306,7 @@ public static String getCallNumberByNoteId(ContentResolver resolver, long noteId
}
/**
* 根据电话号码和通话日期获取便签ID
* 根据电话号码和通话日期获取便签ID。
* @param resolver ContentResolver对象
* @param phoneNumber 电话号码
* @param callDate 通话日期
@ -330,7 +334,7 @@ public static long getNoteIdByPhoneNumberAndCallDate(ContentResolver resolver, S
}
/**
* 根据便签ID获取便签摘要
* 根据便签ID获取便签摘要。
* @param resolver ContentResolver对象
* @param noteId 便签ID
* @return 便签摘要
@ -354,7 +358,7 @@ public static String getSnippetById(ContentResolver resolver, long noteId) {
}
/**
* 格式化便签摘要
* 格式化便签摘要。
* @param snippet 便签摘要
* @return 格式化后的便签摘要
*/
@ -370,7 +374,7 @@ public static String getFormattedSnippet(String snippet) {
}
/**
* 在数据库中搜索包含指定查询内容的便签
* 在数据库中搜索包含指定查询内容的便签。
* @param resolver ContentResolver对象
* @param query 查询内容
* @return 包含查询结果的Cursor对象
@ -383,3 +387,4 @@ public static Cursor searchInNoteDatabase(ContentResolver resolver, String query
null);
return cursor;
}
}
Write Preview
Loading…
Cancel
Save