תמיכה לעובדים ותיקים

ל-WorkManager יש תמיכה מובנית בעובדים שפועלים לאורך זמן. במקרים כאלה, WorkManager יכול לספק אות למערכת ההפעלה שהתהליך צריך להמשיך לפעול אם אפשר, בזמן שהעבודה הזו מתבצעת. ה-Workers האלה יכולים לפעול יותר מ-10 דקות. דוגמאות לתרחישי שימוש בתכונה החדשה הזו כוללות העלאות או הורדות בכמות גדולה (שאי אפשר לחלק לחלקים), עיבוד של מודל ML באופן מקומי או משימה שחשובה למשתמש באפליקציה.

מתחת לפני השטח, WorkManager מנהל ומריץ שירות בחזית בשמכם כדי להפעיל את WorkRequest, וגם מציג התראה שאפשר להגדיר.

ListenableWorker תומך עכשיו ב-API‏ setForegroundAsync(), ו-CoroutineWorker תומך ב-API‏ setForeground() להשעיה. ממשקי ה-API האלה מאפשרים למפתחים לציין ש-WorkRequest הוא חשוב (מנקודת המבט של המשתמש) או פועל לאורך זמן.

החל מגרסה 2.3.0-alpha03, אפשר גם ליצור PendingIntent באמצעות WorkManager. אפשר להשתמש ב-PendingIntent כדי לבטל עובדים בלי לרשום רכיב Android חדש באמצעות createCancelPendingIntent() API. הגישה הזו שימושית במיוחד כשמשתמשים בממשקי ה-API‏ setForegroundAsync() או setForeground(), שאפשר להשתמש בהם כדי להוסיף פעולת התראה לביטול Worker.

יצירה וניהול של תהליכי עבודה ארוכים

הגישה תהיה שונה מעט בהתאם לשפת התכנות שבה אתם משתמשים: Kotlin או Java.

Kotlin

מפתחי Kotlin צריכים להשתמש ב-CoroutineWorker. במקום להשתמש ב-setForegroundAsync(), אפשר להשתמש בגרסת ההשהיה של השיטה הזו, setForeground().

class DownloadWorker(context: Context, parameters: WorkerParameters) :
   CoroutineWorker(context, parameters) {

   private val notificationManager =
       context.getSystemService(Context.NOTIFICATION_SERVICE) as
               NotificationManager

   override suspend fun doWork(): Result {
       val inputUrl = inputData.getString(KEY_INPUT_URL)
                      ?: return Result.failure()
       val outputFile = inputData.getString(KEY_OUTPUT_FILE_NAME)
                      ?: return Result.failure()
       // Mark the Worker as important
       val progress = "Starting Download"
       setForeground(createForegroundInfo(progress))
       download(inputUrl, outputFile)
       return Result.success()
   }

   private fun download(inputUrl: String, outputFile: String) {
       // Downloads a file and updates bytes read
       // Calls setForeground() periodically when it needs to update
       // the ongoing Notification
   }
   // Creates an instance of ForegroundInfo which can be used to update the
   // ongoing notification.
   private fun createForegroundInfo(progress: String): ForegroundInfo {
       val id = applicationContext.getString(R.string.notification_channel_id)
       val title = applicationContext.getString(R.string.notification_title)
       val cancel = applicationContext.getString(R.string.cancel_download)
       // This PendingIntent can be used to cancel the worker
       val intent = WorkManager.getInstance(applicationContext)
               .createCancelPendingIntent(getId())

       // Create a Notification channel if necessary
       if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
           createChannel()
       }

       val notification = NotificationCompat.Builder(applicationContext, id)
           .setContentTitle(title)
           .setTicker(title)
           .setContentText(progress)
           .setSmallIcon(R.drawable.ic_work_notification)
           .setOngoing(true)
           // Add the cancel action to the notification which can
           // be used to cancel the worker
           .addAction(android.R.drawable.ic_delete, cancel, intent)
           .build()

       return ForegroundInfo(notificationId, notification)
   }

   @RequiresApi(Build.VERSION_CODES.O)
   private fun createChannel() {
       // Create a Notification channel
   }

   companion object {
       const val KEY_INPUT_URL = "KEY_INPUT_URL"
       const val KEY_OUTPUT_FILE_NAME = "KEY_OUTPUT_FILE_NAME"
   }
}

Java

מפתחים שמשתמשים ב-ListenableWorker או ב-Worker יכולים לשלוח קריאה ל-API‏ setForegroundAsync(), שמחזיר ListenableFuture<Void>. אפשר גם להתקשר אל setForegroundAsync() כדי לעדכן Notification פעיל.

זוהי דוגמה פשוטה ל-worker שפועל לאורך זמן ומוריד קובץ. ה-Worker הזה עוקב אחרי ההתקדמות כדי לעדכן את Notification שמתבצעת, שבה מוצגת התקדמות ההורדה.

public class DownloadWorker extends Worker {
   private static final String KEY_INPUT_URL = "KEY_INPUT_URL";
   private static final String KEY_OUTPUT_FILE_NAME = "KEY_OUTPUT_FILE_NAME";

   private NotificationManager notificationManager;

   public DownloadWorker(
       @NonNull Context context,
       @NonNull WorkerParameters parameters) {
           super(context, parameters);
           notificationManager = (NotificationManager)
               context.getSystemService(NOTIFICATION_SERVICE);
   }

   @NonNull
   @Override
   public Result doWork() {
       Data inputData = getInputData();
       String inputUrl = inputData.getString(KEY_INPUT_URL);
       String outputFile = inputData.getString(KEY_OUTPUT_FILE_NAME);
       // Mark the Worker as important
       String progress = "Starting Download";
       setForegroundAsync(createForegroundInfo(progress));
       download(inputUrl, outputFile);
       return Result.success();
   }

   private void download(String inputUrl, String outputFile) {
       // Downloads a file and updates bytes read
       // Calls setForegroundAsync(createForegroundInfo(myProgress))
       // periodically when it needs to update the ongoing Notification.
   }

   @NonNull
   private ForegroundInfo createForegroundInfo(@NonNull String progress) {
       // Build a notification using bytesRead and contentLength

       Context context = getApplicationContext();
       String id = context.getString(R.string.notification_channel_id);
       String title = context.getString(R.string.notification_title);
       String cancel = context.getString(R.string.cancel_download);
       // This PendingIntent can be used to cancel the worker
       PendingIntent intent = WorkManager.getInstance(context)
               .createCancelPendingIntent(getId());

       if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
           createChannel();
       }

       Notification notification = new NotificationCompat.Builder(context, id)
               .setContentTitle(title)
               .setTicker(title)
               .setSmallIcon(R.drawable.ic_work_notification)
               .setOngoing(true)
               // Add the cancel action to the notification which can
               // be used to cancel the worker
               .addAction(android.R.drawable.ic_delete, cancel, intent)
               .build();

       return new ForegroundInfo(notificationId, notification);
   }

   @RequiresApi(Build.VERSION_CODES.O)
   private void createChannel() {
       // Create a Notification channel
   }
}

הוספת סוג של שירות שפועל בחזית לעובד שפועל לזמן רב

אם האפליקציה מטרגטת ל-Android 14 (רמת API‏ 34) ואילך, צריך לציין סוג של שירות שפועל בחזית לכל העובדים שפועלים לאורך זמן. אם האפליקציה מטרגטת ל-Android 10 (רמת API ‏29) ואילך ומכילה תהליך worker שפועל לאורך זמן ודורש גישה למיקום, צריך לציין שתהליך ה-worker משתמש בסוג שירות שפועל בחזית location.

אם האפליקציה מטרגטת ל-Android 11 (רמת API‏ 30) ומעלה ומכילה תהליך עובד שפועל לאורך זמן ודורש גישה למצלמה או למיקרופון, צריך להצהיר על סוגי שירותים של camera או microphone בהתאמה.

כדי להוסיף את סוגי השירותים האלה בחזית, צריך לבצע את השלבים שמתוארים בקטעים הבאים.

הצהרה על סוגי שירותים שפועלים בחזית במניפסט של האפליקציה

מצהירים על סוג השירות שפועל בחזית של ה-Worker במניפסט של האפליקציה. בדוגמה הבאה, העובד צריך גישה למיקום ולמיקרופון:

AndroidManifest.xml

<service
   android:name="androidx.work.impl.foreground.SystemForegroundService"
   android:foregroundServiceType="location|microphone"
   tools:node="merge" />

ציון סוגים של שירותים שפועלים בחזית בזמן ריצה

כשקוראים ל-setForeground() או ל-setForegroundAsync(), צריך לציין סוג של שירות שפועל בחזית.

MyLocationAndMicrophoneWorker

Kotlin

private fun createForegroundInfo(progress: String): ForegroundInfo {
   // ...
   return ForegroundInfo(NOTIFICATION_ID, notification,
           FOREGROUND_SERVICE_TYPE_LOCATION or
FOREGROUND_SERVICE_TYPE_MICROPHONE) }

Java

@NonNull
private ForegroundInfo createForegroundInfo(@NonNull String progress) {
   // Build a notification...
   Notification notification = ...;
   return new ForegroundInfo(NOTIFICATION_ID, notification,
           FOREGROUND_SERVICE_TYPE_LOCATION | FOREGROUND_SERVICE_TYPE_MICROPHONE);
}