src/Notes-master3/app/build/intermediates/incremental/packageDebug/tmp/debug/dex-renamer-state.txt

@@ -1,4 +1,4 @@
-#Fri Apr 14 15:45:42 CST 2023
+#Fri Apr 14 15:51:23 CST 2023
 base.0=C\:\\Users\\13293\\Desktop\\Git\\gitProject\\src\\Notes-master3\\app\\build\\intermediates\\dex\\debug\\mergeDexDebug\\classes.dex
 renamed.0=classes.dex
 path.0=classes.dex

src/Notes-master3/app/src/main/java/net/micode/notes/gtask/remote/GTaskManager.java

@@ -50,70 +50,72 @@ import java.util.Map;
 
 public class GTaskManager {
     private static final String TAG = GTaskManager.class.getSimpleName();
-
     public static final int STATE_SUCCESS = 0;
-
     public static final int STATE_NETWORK_ERROR = 1;
-
     public static final int STATE_INTERNAL_ERROR = 2;
-
     public static final int STATE_SYNC_IN_PROGRESS = 3;
-
     public static final int STATE_SYNC_CANCELLED = 4;
-
     private static GTaskManager mInstance = null;
 
     private Activity mActivity;
-
     private Context mContext;
-
     private ContentResolver mContentResolver;
-
     private boolean mSyncing;
-
     private boolean mCancelled;
-
     private HashMap<String, TaskList> mGTaskListHashMap;
-
     private HashMap<String, Node> mGTaskHashMap;
-
     private HashMap<String, MetaData> mMetaHashMap;
-
     private TaskList mMetaList;
-
     private HashSet<Long> mLocalDeleteIdMap;
-
     private HashMap<String, Long> mGidToNid;
-
     private HashMap<Long, String> mNidToGid;
 
-    private GTaskManager() {
+    private GTaskManager() {                                   //对象初始化函数
-        mSyncing = false;
+        mSyncing = false;                                      //正在同步,flase代表未执行
-        mCancelled = false;
+        mCancelled = false;                                    //全局标识，flase代表可以执行
-        mGTaskListHashMap = new HashMap<String, TaskList>();
+        mGTaskListHashMap = new HashMap<String, TaskList>();   //<>代表Java的泛型,就是创建一个用类型作为参数的类。
         mGTaskHashMap = new HashMap<String, Node>();
         mMetaHashMap = new HashMap<String, MetaData>();
         mMetaList = null;
         mLocalDeleteIdMap = new HashSet<Long>();
-        mGidToNid = new HashMap<String, Long>();
+        mGidToNid = new HashMap<String, Long>();    //GoogleID to NodeID??
-        mNidToGid = new HashMap<Long, String>();
+        mNidToGid = new HashMap<Long, String>();    //NodeID to GoogleID???通过hashmap散列表建立映射
     }
 
-    public static synchronized GTaskManager getInstance() {
+    /**
+     * 包含关键字synchronized，语言级同步，指明该函数可能运行在多线程的环境下。
+     * 功能：类初始化函数
+     * @author TTS
+     * @return GtaskManger
+     */
+    public static synchronized GTaskManager getInstance() {    //可能运行在多线程环境下，使用语言级同步--synchronized
         if (mInstance == null) {
             mInstance = new GTaskManager();
         }
         return mInstance;
     }
 
+    /**
+     * 包含关键字synchronized，语言级同步，指明该函数可能运行在多线程的环境下。
+     * @author TTS
+     * @param activity
+     */
     public synchronized void setActivityContext(Activity activity) {
-        // used for getting authtoken
+        // used for getting auth token
         mActivity = activity;
     }
 
-    public int sync(Context context, GTaskASyncTask asyncTask) {
+    /**
+     * 核心函数
+     * 功能：实现了本地同步操作和远端同步操作
+     * @author TTS
+     * @param context-----获取上下文
+     * @param asyncTask-------用于同步的异步操作类
+     * @return int
+     */
+    public int sync(Context context, GTaskASyncTask asyncTask) {           //核心函数
         if (mSyncing) {
-            Log.d(TAG, "Sync is in progress");
+            Log.d(TAG, "Sync is in progress");                       //创建日志文件（调试信息），debug
             return STATE_SYNC_IN_PROGRESS;
         }
         mContext = context;
@@ -128,8 +130,8 @@ public class GTaskManager {
         mNidToGid.clear();
 
         try {
-            GTaskClient client = GTaskClient.getInstance();
+            GTaskClient client = GTaskClient.getInstance();    //getInstance即为创建一个实例,client--客户机
-            client.resetUpdateArray();
+            client.resetUpdateArray();     //JSONArray类型，reset即置为NULL
 
             // login google task
             if (!mCancelled) {
@@ -140,15 +142,15 @@ public class GTaskManager {
 
             // get the task list from google
             asyncTask.publishProgess(mContext.getString(R.string.sync_progress_init_list));
-            initGTaskList();
+            initGTaskList();                                 //获取Google上的JSONtasklist转为本地TaskList
 
             // do content sync work
             asyncTask.publishProgess(mContext.getString(R.string.sync_progress_syncing));
             syncContent();
-        } catch (NetworkFailureException e) {
+        } catch (NetworkFailureException e) {                       //分为两种异常，此类异常为网络异常
-            Log.e(TAG, e.toString());
+            Log.e(TAG, e.toString());                             //创建日志文件（调试信息），error
             return STATE_NETWORK_ERROR;
-        } catch (ActionFailureException e) {
+        } catch (ActionFailureException e) {                        //此类异常为操作异常
             Log.e(TAG, e.toString());
             return STATE_INTERNAL_ERROR;
         } catch (Exception e) {
@@ -168,32 +170,41 @@ public class GTaskManager {
         return mCancelled ? STATE_SYNC_CANCELLED : STATE_SUCCESS;
     }
 
+    /**
+     *功能：初始化GtaskList，获取Google上的JSONtasklist转为本地TaskList。
+     *获得的数据存储在mMetaList，mGTaskListHashMap，mGTaskHashMap
+     *@author TTS
+     *@exception NetworkFailureException
+     *@return void
+     */
     private void initGTaskList() throws NetworkFailureException {
         if (mCancelled)
             return;
-        GTaskClient client = GTaskClient.getInstance();
+        GTaskClient client = GTaskClient.getInstance();    //getInstance即为创建一个实例，client应指远端客户机
         try {
-            JSONArray jsTaskLists = client.getTaskLists();
+            //Json对象是Name Value对(即子元素)的无序集合，相当于一个Map对象。JsonObject类是bantouyan-json库对Json对象的抽象，提供操纵Json对象的各种方法。
+            //其格式为{"key1":value1,"key2",value2....};key 必须是字符串。
+            //因为ajax请求不刷新页面，但配合js可以实现局部刷新，因此json常常被用来作为异步请求的返回对象使用。
+            JSONArray jsTaskLists = client.getTaskLists();     //原注释为get task list------lists？？？
 
             // init meta list first
-            mMetaList = null;
+            mMetaList = null;                                       //TaskList类型
             for (int i = 0; i < jsTaskLists.length(); i++) {
-                JSONObject object = jsTaskLists.getJSONObject(i);
+                JSONObject object = jsTaskLists.getJSONObject(i);  //JSONObject与JSONArray一个为对象，一个为数组。此处取出单个JASONObject
                 String gid = object.getString(GTaskStringUtils.GTASK_JSON_ID);
                 String name = object.getString(GTaskStringUtils.GTASK_JSON_NAME);
 
-                if (name
+                if (name.equals(GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_META)) {
-                        .equals(GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_META)) {
+                    mMetaList = new TaskList();                    //MetaList意为元表,Tasklist类型，此处为初始化
-                    mMetaList = new TaskList();
+                    mMetaList.setContentByRemoteJSON(object);      //将JSON中部分数据复制到自己定义的对象中相对应的数据：name->mname...
-                    mMetaList.setContentByRemoteJSON(object);
 
                     // load meta data
-                    JSONArray jsMetas = client.getTaskList(gid);
+                    JSONArray jsMetas = client.getTaskList(gid);   //原注释为get action_list------list？？？
                     for (int j = 0; j < jsMetas.length(); j++) {
                         object = (JSONObject) jsMetas.getJSONObject(j);
-                        MetaData metaData = new MetaData();
+                        MetaData metaData = new MetaData();            //继承自Node
                         metaData.setContentByRemoteJSON(object);
-                        if (metaData.isWorthSaving()) {
+                        if (metaData.isWorthSaving()) {                             //if not worth to save，metadata将不加入mMetaList
                             mMetaList.addChildTask(metaData);
                             if (metaData.getGid() != null) {
                                 mMetaHashMap.put(metaData.getRelatedGid(), metaData);
@@ -214,16 +225,16 @@ public class GTaskManager {
             // init task list
             for (int i = 0; i < jsTaskLists.length(); i++) {
                 JSONObject object = jsTaskLists.getJSONObject(i);
-                String gid = object.getString(GTaskStringUtils.GTASK_JSON_ID);
+                String gid = object.getString(GTaskStringUtils.GTASK_JSON_ID);  //通过getString函数传入本地某个标志数据的名称，获取其在远端的名称。
                 String name = object.getString(GTaskStringUtils.GTASK_JSON_NAME);
 
                 if (name.startsWith(GTaskStringUtils.MIUI_FOLDER_PREFFIX)
                         && !name.equals(GTaskStringUtils.MIUI_FOLDER_PREFFIX
                         + GTaskStringUtils.FOLDER_META)) {
-                    TaskList tasklist = new TaskList();
+                    TaskList tasklist = new TaskList();     //继承自Node
                     tasklist.setContentByRemoteJSON(object);
                     mGTaskListHashMap.put(gid, tasklist);
-                    mGTaskHashMap.put(gid, tasklist);
+                    mGTaskHashMap.put(gid, tasklist);          //为什么加两遍？？？
 
                     // load tasks
                     JSONArray jsTasks = client.getTaskList(gid);
@@ -247,13 +258,18 @@ public class GTaskManager {
         }
     }
 
-    private void syncContent() throws NetworkFailureException {
+    /**
+     * 功能：本地内容同步操作
+     * @throws NetworkFailureException
+     * @return 无返回值
+     */
+    private void syncContent() throws NetworkFailureException {    //本地内容同步操作
         int syncType;
-        Cursor c = null;
+        Cursor c = null;                                           //数据库指针
-        String gid;
+        String gid;                                                //GoogleID??
-        Node node;
+        Node node;                                                 //Node包含Sync_Action的不同类型
 
-        mLocalDeleteIdMap.clear();
+        mLocalDeleteIdMap.clear();                                 //HashSet<Long>类型
 
         if (mCancelled) {
             return;
@@ -301,8 +317,8 @@ public class GTaskManager {
                     node = mGTaskHashMap.get(gid);
                     if (node != null) {
                         mGTaskHashMap.remove(gid);
-                        mGidToNid.put(gid, c.getLong(SqlNote.ID_COLUMN));
+                        mGidToNid.put(gid, c.getLong(SqlNote.ID_COLUMN));   //通过hashmap建立联系
-                        mNidToGid.put(c.getLong(SqlNote.ID_COLUMN), gid);
+                        mNidToGid.put(c.getLong(SqlNote.ID_COLUMN), gid);   //通过hashmap建立联系
                         syncType = node.getSyncAction(c);
                     } else {
                         if (c.getString(SqlNote.GTASK_ID_COLUMN).trim().length() == 0) {
@@ -327,14 +343,14 @@ public class GTaskManager {
         }
 
         // go through remaining items
-        Iterator<Map.Entry<String, Node>> iter = mGTaskHashMap.entrySet().iterator();
+        Iterator<Map.Entry<String, Node>> iter = mGTaskHashMap.entrySet().iterator();   //Iterator迭代器
         while (iter.hasNext()) {
             Map.Entry<String, Node> entry = iter.next();
             node = entry.getValue();
             doContentSync(Node.SYNC_ACTION_ADD_LOCAL, node, null);
         }
 
-        // mCancelled can be set by another thread, so we neet to check one by
+        // mCancelled can be set by another thread, so we neet to check one by    //thread----线程
         // one
         // clear local delete table
         if (!mCancelled) {
@@ -351,6 +367,11 @@ public class GTaskManager {
 
     }
 
+    /**
+     * 功能：
+     * @author TTS
+     * @throws NetworkFailureException
+     */
     private void syncFolder() throws NetworkFailureException {
         Cursor c = null;
         String gid;
@@ -476,6 +497,14 @@ public class GTaskManager {
             GTaskClient.getInstance().commitUpdate();
     }
 
+    /**
+     * 功能：syncType分类，addLocalNode，addRemoteNode，deleteNode，updateLocalNode，updateRemoteNode
+     * @author TTS
+     * @param syncType
+     * @param node
+     * @param c
+     * @throws NetworkFailureException
+     */
     private void doContentSync(int syncType, Node node, Cursor c) throws NetworkFailureException {
         if (mCancelled) {
             return;
@@ -522,6 +551,12 @@ public class GTaskManager {
         }
     }
 
+    /**
+     * 功能：本地增加Node
+     * @author TTS
+     * @param node
+     * @throws NetworkFailureException
+     */
     private void addLocalNode(Node node) throws NetworkFailureException {
         if (mCancelled) {
             return;
@@ -596,6 +631,15 @@ public class GTaskManager {
         updateRemoteMeta(node.getGid(), sqlNote);
     }
 
+    /**
+     * 功能：update本地node
+     * @author TTS
+     * @param node
+     * ----同步操作的基础数据类型
+     * @param c
+     * ----Cursor
+     * @throws NetworkFailureException
+     */
     private void updateLocalNode(Node node, Cursor c) throws NetworkFailureException {
         if (mCancelled) {
             return;
@@ -619,12 +663,22 @@ public class GTaskManager {
         updateRemoteMeta(node.getGid(), sqlNote);
     }
 
+    /**
+     * 功能：远程增加Node
+     * 需要updateRemoteMeta
+     * @author TTS
+     * @param node
+     * ----同步操作的基础数据类型
+     * @param c
+     * --Cursor
+     * @throws NetworkFailureException
+     */
     private void addRemoteNode(Node node, Cursor c) throws NetworkFailureException {
         if (mCancelled) {
             return;
         }
 
-        SqlNote sqlNote = new SqlNote(mContext, c);
+        SqlNote sqlNote = new SqlNote(mContext, c);     //从本地mContext中获取内容
         Node n;
 
         // update remotely
@@ -634,11 +688,12 @@ public class GTaskManager {
 
             String parentGid = mNidToGid.get(sqlNote.getParentId());
             if (parentGid == null) {
-                Log.e(TAG, "cannot find task's parent tasklist");
+                Log.e(TAG, "cannot find task's parent tasklist");           //调试信息
                 throw new ActionFailureException("cannot add remote task");
             }
-            mGTaskListHashMap.get(parentGid).addChildTask(task);
+            mGTaskListHashMap.get(parentGid).addChildTask(task);            //在本地生成的GTaskList中增加子结点
 
+            //登录远程服务器，创建Task
             GTaskClient.getInstance().createTask(task);
             n = (Node) task;
 
@@ -656,6 +711,7 @@ public class GTaskManager {
             else
                 folderName += sqlNote.getSnippet();
 
+            //iterator迭代器，通过统一的接口迭代所有的map元素
             Iterator<Map.Entry<String, TaskList>> iter = mGTaskListHashMap.entrySet().iterator();
             while (iter.hasNext()) {
                 Map.Entry<String, TaskList> entry = iter.next();
@@ -687,11 +743,20 @@ public class GTaskManager {
         sqlNote.resetLocalModified();
         sqlNote.commit(true);
 
-        // gid-id mapping
+        // gid-id mapping                                             //创建id间的映射
         mGidToNid.put(n.getGid(), sqlNote.getId());
         mNidToGid.put(sqlNote.getId(), n.getGid());
     }
 
+    /**
+     * 功能：更新远端的Node，包含meta更新(updateRemoteMeta)
+     * @author TTS
+     * @param node
+     * ----同步操作的基础数据类型
+     * @param c
+     *  --Cursor
+     * @throws NetworkFailureException
+     */
     private void updateRemoteNode(Node node, Cursor c) throws NetworkFailureException {
         if (mCancelled) {
             return;
@@ -701,7 +766,7 @@ public class GTaskManager {
 
         // update remotely
         node.setContentByLocalJSON(sqlNote.getContent());
-        GTaskClient.getInstance().addUpdateNode(node);
+        GTaskClient.getInstance().addUpdateNode(node);                                //GTaskClient用途为从本地登陆远端服务器
 
         // update meta
         updateRemoteMeta(node.getGid(), sqlNote);
@@ -710,15 +775,19 @@ public class GTaskManager {
         if (sqlNote.isNoteType()) {
             Task task = (Task) node;
             TaskList preParentList = task.getParent();
+            //preParentList为通过node获取的父节点列表
 
             String curParentGid = mNidToGid.get(sqlNote.getParentId());
+            //curParentGid为通过光标在数据库中找到sqlNote的mParentId，再通过mNidToGid由long类型转为String类型的Gid
+
             if (curParentGid == null) {
                 Log.e(TAG, "cannot find task's parent tasklist");
                 throw new ActionFailureException("cannot update remote task");
             }
             TaskList curParentList = mGTaskListHashMap.get(curParentGid);
+            //通过HashMap找到对应Gid的TaskList
 
-            if (preParentList != curParentList) {
+            if (preParentList != curParentList) {                                          //?????????????
                 preParentList.removeChildTask(task);
                 curParentList.addChildTask(task);
                 GTaskClient.getInstance().moveTask(task, preParentList, curParentList);
@@ -727,9 +796,19 @@ public class GTaskManager {
 
         // clear local modified flag
         sqlNote.resetLocalModified();
+        //commit到本地数据库
         sqlNote.commit(true);
     }
 
+    /**
+     * 功能：升级远程meta。  meta---元数据----计算机文件系统管理数据---管理数据的数据。
+     * @author TTS
+     * @param gid
+     * ---GoogleID为String类型
+     * @param sqlNote
+     * ---同步前的数据库操作，故使用类SqlNote
+     * @throws NetworkFailureException
+     */
     private void updateRemoteMeta(String gid, SqlNote sqlNote) throws NetworkFailureException {
         if (sqlNote != null && sqlNote.isNoteType()) {
             MetaData metaData = mMetaHashMap.get(gid);
@@ -746,12 +825,18 @@ public class GTaskManager {
         }
     }
 
+    /**
+     * 功能：刷新本地，给sync的ID对应上最后更改过的对象
+     * @author TTS
+     * @return void
+     * @throws NetworkFailureException
+     */
     private void refreshLocalSyncId() throws NetworkFailureException {
         if (mCancelled) {
             return;
         }
 
-        // get the latest gtask list
+        // get the latest gtask list                                               //获取最近的（最晚的）gtask list
         mGTaskHashMap.clear();
         mGTaskListHashMap.clear();
         mMetaHashMap.clear();
@@ -762,16 +847,16 @@ public class GTaskManager {
             c = mContentResolver.query(Notes.CONTENT_NOTE_URI, SqlNote.PROJECTION_NOTE,
                     "(type<>? AND parent_id<>?)", new String[] {
                             String.valueOf(Notes.TYPE_SYSTEM), String.valueOf(Notes.ID_TRASH_FOLER)
-                    }, NoteColumns.TYPE + " DESC");
+                    }, NoteColumns.TYPE + " DESC");                                                 //query语句：五个参数，NoteColumns.TYPE + " DESC"-----为按类型递减顺序返回查询结果。new String[] {String.valueOf(Notes.TYPE_SYSTEM), String.valueOf(Notes.ID_TRASH_FOLER)}------为选择参数。"(type<>? AND parent_id<>?)"-------指明返回行过滤器。SqlNote.PROJECTION_NOTE--------应返回的数据列的名字。Notes.CONTENT_NOTE_URI--------contentProvider包含所有数据集所对应的uri
             if (c != null) {
                 while (c.moveToNext()) {
                     String gid = c.getString(SqlNote.GTASK_ID_COLUMN);
                     Node node = mGTaskHashMap.get(gid);
                     if (node != null) {
                         mGTaskHashMap.remove(gid);
-                        ContentValues values = new ContentValues();
+                        ContentValues values = new ContentValues();                     //在ContentValues中创建键值对。准备通过contentResolver写入数据
                         values.put(NoteColumns.SYNC_ID, node.getLastModified());
-                        mContentResolver.update(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI,
+                        mContentResolver.update(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI,   //进行批量更改，选择参数为NULL，应该可以用insert替换，参数分别为表名和需要更新的value对象。
                                 c.getLong(SqlNote.ID_COLUMN)), values, null, null);
                     } else {
                         Log.e(TAG, "something is missed");
@@ -790,10 +875,19 @@ public class GTaskManager {
         }
     }
 
+    /**
+     * 功能：获取同步账号,mAccount.name
+     * @author TTS
+     * @return String
+     */
     public String getSyncAccount() {
         return GTaskClient.getInstance().getSyncAccount().name;
     }
 
+    /**
+     * 功能：取消同步，置mCancelled为true
+     * @author TTS
+     */
     public void cancelSync() {
         mCancelled = true;
     }