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

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

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

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

החל מ-2.3.0-alpha03, Work Manager מאפשר גם ליצור PendingIntent, שבאמצעותו אפשר לבטל עובדים בלי לרשום רכיב Android חדש באמצעות createCancelPendingIntent() API. הגישה הזאת שימושית במיוחד כשמשתמשים בה בשילוב עם setForegroundAsync() או setForeground() API, שבהם אפשר להשתמש כדי להוסיף פעולת התראה לביטול 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 יכולים לקרוא ל setForegroundAsync() API, שמחזיר ListenableFuture<Void>. שלך יכול גם להתקשר אל setForegroundAsync() כדי לעדכן Notification מתמשך.

הנה דוגמה פשוטה לעובד ותיק שמוריד קובץ. הזה העובד עוקב אחר ההתקדמות כדי לעדכן 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
   }
}

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

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

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

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

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

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

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

AndroidManifest.xml

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

הערה: הכלי למיזוג מניפסט משלב את הרכיב <service> מקטע הקוד הקודם וההצהרה SystemForegroundService של WorkManager מוגדר במניפסט משלו.

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

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

הערה: החל מ-Android 14 (רמת API 34), כשקוראים לפונקציה 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);
}