gtask/remote/GTaskSyncService.java注释

app/src/main/java/net/micode/notes/gtask/remote/GTaskSyncService.java

@@ -23,54 +23,72 @@ import android.content.Intent;
 import android.os.Bundle;
 import android.os.IBinder;
 
+// GTask同步服务，在后台执行GTask同步操作
 public class GTaskSyncService extends Service {
+    // 同步动作类型的Extra键名
     public final static String ACTION_STRING_NAME = "sync_action_type";
 
+    // 开始同步的动作代码
     public final static int ACTION_START_SYNC = 0;
 
+    // 取消同步的动作代码
     public final static int ACTION_CANCEL_SYNC = 1;
 
+    // 无效动作的代码
     public final static int ACTION_INVALID = 2;
 
+    // 广播名称，用于发送同步状态
     public final static String GTASK_SERVICE_BROADCAST_NAME = "net.micode.notes.gtask.remote.gtask_sync_service";
 
+    // 广播中表示是否正在同步的键名
     public final static String GTASK_SERVICE_BROADCAST_IS_SYNCING = "isSyncing";
 
+    // 广播中表示同步进度消息的键名
     public final static String GTASK_SERVICE_BROADCAST_PROGRESS_MSG = "progressMsg";
 
+    // 静态的异步任务实例，用于执行同步操作
     private static GTaskASyncTask mSyncTask = null;
 
+    // 静态的同步进度消息
     private static String mSyncProgress = "";
 
+    // 开始同步操作
     private void startSync() {
+        // 检查是否已有同步任务在运行
         if (mSyncTask == null) {
+            // 创建新的同步任务
             mSyncTask = new GTaskASyncTask(this, new GTaskASyncTask.OnCompleteListener() {
+                // 同步完成时的回调
                 public void onComplete() {
                     mSyncTask = null;
                     sendBroadcast("");
-                    stopSelf();
+                    stopSelf(); // 同步完成后停止服务
                 }
             });
-            sendBroadcast("");
-            mSyncTask.execute();
+            sendBroadcast(""); // 发送广播通知开始同步
+            mSyncTask.execute(); // 执行异步任务
         }
     }
 
+    // 取消同步操作
     private void cancelSync() {
         if (mSyncTask != null) {
-            mSyncTask.cancelSync();
+            mSyncTask.cancelSync(); // 调用异步任务的取消方法
         }
     }
 
+    // 服务创建时调用
     @Override
     public void onCreate() {
-        mSyncTask = null;
+        mSyncTask = null; // 确保初始状态下没有同步任务
     }
 
+    // 服务启动命令处理
     @Override
     public int onStartCommand(Intent intent, int flags, int startId) {
         Bundle bundle = intent.getExtras();
         if (bundle != null && bundle.containsKey(ACTION_STRING_NAME)) {
+            // 根据传递的动作类型执行相应操作
             switch (bundle.getInt(ACTION_STRING_NAME, ACTION_INVALID)) {
                 case ACTION_START_SYNC:
                     startSync();
@@ -81,48 +99,55 @@ public class GTaskSyncService extends Service {
                 default:
                     break;
             }
-            return START_STICKY;
+            return START_STICKY; // 服务被终止后会自动重启
         }
         return super.onStartCommand(intent, flags, startId);
     }
 
+    // 系统内存不足时调用
     @Override
     public void onLowMemory() {
         if (mSyncTask != null) {
-            mSyncTask.cancelSync();
+            mSyncTask.cancelSync(); // 内存不足时取消同步任务
         }
     }
 
+    // 绑定服务时调用（此服务不支持绑定）
     public IBinder onBind(Intent intent) {
         return null;
     }
 
+    // 发送同步状态广播
     public void sendBroadcast(String msg) {
         mSyncProgress = msg;
         Intent intent = new Intent(GTASK_SERVICE_BROADCAST_NAME);
         intent.putExtra(GTASK_SERVICE_BROADCAST_IS_SYNCING, mSyncTask != null);
         intent.putExtra(GTASK_SERVICE_BROADCAST_PROGRESS_MSG, msg);
-        sendBroadcast(intent);
+        sendBroadcast(intent); // 发送包含同步状态的广播
     }
 
+    // 静态方法：启动同步服务
     public static void startSync(Activity activity) {
         GTaskManager.getInstance().setActivityContext(activity);
         Intent intent = new Intent(activity, GTaskSyncService.class);
         intent.putExtra(GTaskSyncService.ACTION_STRING_NAME, GTaskSyncService.ACTION_START_SYNC);
-        activity.startService(intent);
+        activity.startService(intent); // 启动服务并传递开始同步的动作
     }
 
+    // 静态方法：取消同步服务
     public static void cancelSync(Context context) {
         Intent intent = new Intent(context, GTaskSyncService.class);
         intent.putExtra(GTaskSyncService.ACTION_STRING_NAME, GTaskSyncService.ACTION_CANCEL_SYNC);
-        context.startService(intent);
+        context.startService(intent); // 启动服务并传递取消同步的动作
     }
 
+    // 静态方法：检查是否正在同步
     public static boolean isSyncing() {
         return mSyncTask != null;
     }
 
+    // 静态方法：获取当前同步进度消息
     public static String getProgressString() {
         return mSyncProgress;
     }
-}
+}