diff --git a/doc/~$便签开源代码的泛读报告.docx b/doc/~$便签开源代码的泛读报告.docx new file mode 100644 index 0000000..3aded6b Binary files /dev/null and b/doc/~$便签开源代码的泛读报告.docx differ diff --git a/doc/小米便签开源代码的泛读报告.docx b/doc/小米便签开源代码的泛读报告.docx index eda7156..6e1623f 100644 Binary files a/doc/小米便签开源代码的泛读报告.docx and b/doc/小米便签开源代码的泛读报告.docx differ diff --git a/src/Notes-master/.idea/sonarlint/issuestore/index.pb b/src/Notes-master/.idea/sonarlint/issuestore/index.pb new file mode 100644 index 0000000..e69de29 diff --git a/src/Notes-master/.idea/sonarlint/securityhotspotstore/index.pb b/src/Notes-master/.idea/sonarlint/securityhotspotstore/index.pb new file mode 100644 index 0000000..e69de29 diff --git a/src/Notes-master/app/src/main/java/net/micode/notes/model/Note.java b/src/Notes-master/app/src/main/java/net/micode/notes/model/Note.java index 7f95be2..704054c 100644 --- a/src/Notes-master/app/src/main/java/net/micode/notes/model/Note.java +++ b/src/Notes-master/app/src/main/java/net/micode/notes/model/Note.java @@ -56,60 +56,62 @@ public class Note { values.put(NoteColumns.LOCAL_MODIFIED, 1);//把LOCAL_MODIFIED 本地修改 的值赋为1 values.put(NoteColumns.PARENT_ID, folderId);//把文件夹id赋给PARENT_ID 父类id Uri uri = context.getContentResolver().insert(Notes.CONTENT_NOTE_URI, values); + //getContentResolver()函数是实现外部应用对于ContentProvider中的数据进行增删查改的操作 - long noteId = 0; + long noteId = 0;//用于标记错误信息 try { noteId = Long.valueOf(uri.getPathSegments().get(1)); } catch (NumberFormatException e) { Log.e(TAG, "Get note id error :" + e.toString()); noteId = 0; - } + }//异常处理 + if (noteId == -1) { throw new IllegalStateException("Wrong note id:" + noteId); - } + } // 如果发生错误，输出错误ID return noteId; } public Note() { - mNoteDiffValues = new ContentValues(); - mNoteData = new NoteData(); + mNoteDiffValues = new ContentValues(); //定义一个新变量，存储便签属性 + mNoteData = new NoteData();//定义一个新变量，存出便签内容 } public void setNoteValue(String key, String value) { - mNoteDiffValues.put(key, value); - mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1); - mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis()); + mNoteDiffValues.put(key, value); //设置便签属性传入ket和value + mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1); //设置新创建的便签更改次数为1 + mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis()); //设置新创建的更改日期为系统当前时间 } public void setTextData(String key, String value) { - mNoteData.setTextData(key, value); + mNoteData.setTextData(key, value); //设置便签的内容和数据 } public void setTextDataId(long id) { - mNoteData.setTextDataId(id); + mNoteData.setTextDataId(id); //设置便签数据的ID } public long getTextDataId() { - return mNoteData.mTextDataId; + return mNoteData.mTextDataId; //获取便签数据的ID } public void setCallDataId(long id) { - mNoteData.setCallDataId(id); + mNoteData.setCallDataId(id); //设置电话的数据的ID } public void setCallData(String key, String value) { - mNoteData.setCallData(key, value); + mNoteData.setCallData(key, value); //设置电话的内容和数据 } public boolean isLocalModified() { - return mNoteDiffValues.size() > 0 || mNoteData.isLocalModified(); - } + return mNoteDiffValues.size() > 0 || mNoteData.isLocalModified(); // + }//判断是否为本地产生的修改 public boolean syncNote(Context context, long noteId) { if (noteId <= 0) { throw new IllegalArgumentException("Wrong note id:" + noteId); - } + } //报告错误信息 if (!isLocalModified()) { return true; @@ -120,6 +122,13 @@ public class Note { * {@link NoteColumns#MODIFIED_DATE}. For data safety, though update note fails, we also update the * note data info */ + + /* + 理论上，一旦数据发生变化，应在{@link NoteColumns#LOCAL_MODIFIED}和 + {@link NotesColumns#MODIFIED_DATE}上更新注释。为了数据安全， + 虽然更新笔记失败，但我们也会更新笔记数据信息 + */ + if (context.getContentResolver().update( ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), mNoteDiffValues, null, null) == 0) { @@ -134,16 +143,16 @@ public class Note { } return true; - } + }//用于判断便签是否正确同步 private class NoteData { - private long mTextDataId; + private long mTextDataId; //定义便签数据的文件数据ID - private ContentValues mTextDataValues; + private ContentValues mTextDataValues; //定义文件数据 - private long mCallDataId; + private long mCallDataId;//定义便签电话ID - private ContentValues mCallDataValues; + private ContentValues mCallDataValues;//定义便签电话数据 private static final String TAG = "NoteData"; @@ -152,57 +161,62 @@ public class Note { mCallDataValues = new ContentValues(); mTextDataId = 0; mCallDataId = 0; - } + } //构造函数，定义文件数据ID和电话数据ID为0，创建便签电话数据和文件数据类 boolean isLocalModified() { return mTextDataValues.size() > 0 || mCallDataValues.size() > 0; - } + }//判断是否被本地修改，返回是否修改文本数据或者电话数据 void setTextDataId(long id) { if (id <= 0) { throw new IllegalArgumentException("Text data id should larger than 0"); - } - mTextDataId = id; + } //为文本数据ID的定义提供错误判断 + mTextDataId = id; //设置文本数据ID } void setCallDataId(long id) { if (id <= 0) { throw new IllegalArgumentException("Call data id should larger than 0"); - } - mCallDataId = id; + }//为电话数据ID的定义提供错误判断 + mCallDataId = id;//设置电话数据ID } void setCallData(String key, String value) { - mCallDataValues.put(key, value); - mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1); - mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis()); + mCallDataValues.put(key, value); //设置电话数据的数据和内容 + mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1); //设置电话数据的本地修改为1 + mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis()); //设置修改时间为本地时间 } void setTextData(String key, String value) { - mTextDataValues.put(key, value); - mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1); - mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis()); + mTextDataValues.put(key, value); //设置文本数据 + mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1);//设置文本数据的本地修改为1 + mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis());//设置修改时间为本地时间 } Uri pushIntoContentResolver(Context context, long noteId) { + + /* + *下面函数的作用是将新的数据通过Uri的操作存储到数据库 + */ + /** * Check for safety */ if (noteId <= 0) { throw new IllegalArgumentException("Wrong note id:" + noteId); - } + }//显示错误代码 - ArrayList operationList = new ArrayList(); - ContentProviderOperation.Builder builder = null; + ArrayList operationList = new ArrayList(); //定义一个新的可变数组 + ContentProviderOperation.Builder builder = null; //数据库的操作列表设置为空 - if (mTextDataValues.size() > 0) { - mTextDataValues.put(DataColumns.NOTE_ID, noteId); + if (mTextDataValues.size() > 0) { //如果文本数据的值不为0 + mTextDataValues.put(DataColumns.NOTE_ID, noteId); //存入note数据ID if (mTextDataId == 0) { mTextDataValues.put(DataColumns.MIME_TYPE, TextNote.CONTENT_ITEM_TYPE); Uri uri = context.getContentResolver().insert(Notes.CONTENT_DATA_URI, mTextDataValues); try { - setTextDataId(Long.valueOf(uri.getPathSegments().get(1))); + setTextDataId(Long.valueOf(uri.getPathSegments().get(1))); } catch (NumberFormatException e) { Log.e(TAG, "Insert new text data fail with noteId" + noteId); @@ -217,7 +231,7 @@ public class Note { operationList.add(builder.build()); } mTextDataValues.clear(); - } + }//把文本数据存入到DataColumns if (mCallDataValues.size() > 0) { mCallDataValues.put(DataColumns.NOTE_ID, noteId); @@ -241,7 +255,7 @@ public class Note { operationList.add(builder.build()); } mCallDataValues.clear(); - } + }//把电话数据存入到DataColumns if (operationList.size() > 0) { try { @@ -260,6 +274,6 @@ public class Note { } } return null; - } + }//存储过程中对于异常情况的处理 } }