diff --git a/src/Notes-master/src/net/micode/notes/gtask/remote/GTaskSyncService.java b/src/Notes-master/src/net/micode/notes/gtask/remote/GTaskSyncService.java index cca36f7..9939522 100644 --- a/src/Notes-master/src/net/micode/notes/gtask/remote/GTaskSyncService.java +++ b/src/Notes-master/src/net/micode/notes/gtask/remote/GTaskSyncService.java @@ -23,54 +23,97 @@ import android.content.Intent; import android.os.Bundle; import android.os.IBinder; +/** + * GTaskSyncService 是一个用于处理 Google 任务同步操作的服务类。 + * 该服务提供了启动同步、取消同步等功能,并通过广播机制通知同步状态和进度。 + */ public class GTaskSyncService extends Service { + // 用于在 Intent 中传递同步操作类型的键名 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(); } }); + // 发送广播通知同步开始 sendBroadcast(""); + // 执行异步同步任务 mSyncTask.execute(); } } + /** + * 取消同步任务的方法。 + * 如果当前有正在进行的同步任务,则调用其取消同步的方法。 + */ private void cancelSync() { if (mSyncTask != null) { mSyncTask.cancelSync(); } } + /** + * 服务创建时调用的方法。 + * 初始化同步任务对象为 null。 + */ @Override public void onCreate() { mSyncTask = null; } + /** + * 服务启动时调用的方法。 + * 根据 Intent 中传递的同步操作类型,执行相应的操作。 + * + * @param intent 启动服务的 Intent 对象 + * @param flags 启动标志 + * @param startId 启动 ID + * @return 服务的启动模式 + */ @Override public int onStartCommand(Intent intent, int flags, int startId) { + // 获取 Intent 中的额外数据 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(); @@ -86,6 +129,10 @@ public class GTaskSyncService extends Service { return super.onStartCommand(intent, flags, startId); } + /** + * 系统内存不足时调用的方法。 + * 如果当前有正在进行的同步任务,则取消该任务。 + */ @Override public void onLowMemory() { if (mSyncTask != null) { @@ -93,36 +140,79 @@ public class GTaskSyncService extends Service { } } + /** + * 绑定服务时调用的方法。 + * 该服务不支持绑定,返回 null。 + * + * @param intent 绑定服务的 Intent 对象 + * @return 绑定的 IBinder 对象,这里返回 null + */ public IBinder onBind(Intent intent) { return null; } + /** + * 发送广播通知同步状态和进度的方法。 + * + * @param msg 同步进度消息 + */ public void sendBroadcast(String msg) { mSyncProgress = msg; + // 创建一个广播 Intent 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); } + /** + * 静态方法,用于从 Activity 启动同步服务。 + * + * @param activity 调用该方法的 Activity 对象 + */ public static void startSync(Activity activity) { + // 设置 GTaskManager 的 Activity 上下文 GTaskManager.getInstance().setActivityContext(activity); + // 创建一个启动服务的 Intent Intent intent = new Intent(activity, GTaskSyncService.class); + // 添加启动同步操作的类型 intent.putExtra(GTaskSyncService.ACTION_STRING_NAME, GTaskSyncService.ACTION_START_SYNC); + // 启动服务 activity.startService(intent); } + /** + * 静态方法,用于从 Context 取消同步服务。 + * + * @param context 调用该方法的 Context 对象 + */ public static void cancelSync(Context context) { + // 创建一个启动服务的 Intent Intent intent = new Intent(context, GTaskSyncService.class); + // 添加取消同步操作的类型 intent.putExtra(GTaskSyncService.ACTION_STRING_NAME, GTaskSyncService.ACTION_CANCEL_SYNC); + // 启动服务 context.startService(intent); } + /** + * 静态方法,用于检查当前是否正在进行同步操作。 + * + * @return 如果正在同步返回 true,否则返回 false + */ public static boolean isSyncing() { return mSyncTask != null; } + /** + * 静态方法,用于获取当前的同步进度消息。 + * + * @return 当前的同步进度消息 + */ public static String getProgressString() { return mSyncProgress; } -} +} \ No newline at end of file