Unterstützung für langlebige Worker

WorkManager unterstützt Mitarbeiter mit langer Ausführungszeit. In solchen Fällen WorkManager kann dem Betriebssystem signalisieren, dass der Prozess aktiv bleiben soll wenn möglich, während diese Arbeit ausgeführt wird. Diese Worker können länger als 10 Minuten. Beispiele für Anwendungsfälle für diese neue Funktion sind Bulk-Uploads oder Downloads (die nicht aufgeteilt werden können), das lokale Verarbeiten eines ML-Modells oder eine Aufgabe die für den Nutzer der App wichtig sind.

Im Hintergrund verwaltet und führt WorkManager für Sie einen Dienst im Vordergrund aus um den WorkRequest auszuführen und gleichzeitig eine konfigurierbare Version anzuzeigen. Benachrichtigung.

ListenableWorker unterstützt jetzt die setForegroundAsync() API und CoroutineWorker unterstützt eine sperrende setForeground() API. Diese Mit APIs können Entwickler angeben, dass diese WorkRequest wichtig ist (von einem Perspektive des Nutzers) oder mit langer Laufzeit verwendet werden.

Ab 2.3.0-alpha03 können Sie mit WorkManager auch ein PendingIntent, mit dem sich Worker kündigen lassen, ohne dass dies erforderlich ist eine neue Android-Komponente mit der createCancelPendingIntent() registrieren der API erstellen. Dieser Ansatz ist besonders nützlich, wenn er mit dem setForegroundAsync() oder setForeground() API, die zum Hinzufügen eines Benachrichtigungsaktion zum Abbrechen von Worker.

Lang andauernde Worker erstellen und verwalten

Je nachdem, ob Sie in Programmiersprachen programmieren, Kotlin oder Java

Kotlin

Kotlin-Entwickler sollten CoroutineWorker verwenden. Anstelle von setForegroundAsync(), können Sie die Sperrversion dieser Methode verwenden, 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

Entwickler, die ListenableWorker oder Worker verwenden, können die setForegroundAsync() API, die einen ListenableFuture<Void> zurückgibt. Ich können auch setForegroundAsync() aufrufen, um eine laufende Notification zu aktualisieren.

Hier ist ein einfaches Beispiel für einen lang andauernden Worker, der eine Datei herunterlädt. Dieses Worker verfolgt den Fortschritt, um eine laufende Notification zu aktualisieren, die Folgendes anzeigt: den Fortschritt des Downloads.

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
   }
}

Typ von Dienst im Vordergrund einem lang andauernden Worker hinzufügen

Hinweis :Je nachdem, auf welche API-Ebene Ihre App ausgerichtet ist und auf welche der Arbeit, die der Dienst ausführt, müssen Sie möglicherweise einen Vordergrund Diensttyp. Es empfiehlt sich, einen Typ von Diensten im Vordergrund anzugeben. unabhängig von der Android-Version. Weitere Informationen finden Sie unter Dokumentation zu Diensten im Vordergrund.

Wenn deine App auf Android 14 (API-Level 34) oder höher ausgerichtet ist, musst du eine Typ des Diensts im Vordergrund für alle Worker mit langer Laufzeit. Wenn deine App auf Android 10 (API-Level 29) oder höher ausgerichtet ist und eine lang andauernden Workers, der Zugriff auf den Standort benötigt, den Diensttyp location verwendet.

Wenn Ihre App auf Android 11 (API-Level 30) oder höher ausgerichtet ist und enthält einen lang andauernden Worker, der Zugriff auf die Kamera oder das Mikrofon benötigt, Vordergrund deklarieren camera oder microphone Diensttypen.

Wenn Sie diese Typen von Diensten im Vordergrund hinzufügen möchten, folgen Sie der Anleitung in den folgenden Abschnitten.

Typen von Diensten im Vordergrund im App-Manifest deklarieren

Deklarieren Sie im Manifest Ihrer App den Typ des Diensts im Vordergrund des Mitarbeiters. Im Im folgenden Beispiel benötigt der Worker Zugriff auf Standort und Mikrofon:

AndroidManifest.xml

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

Hinweis: Das Tool zum Zusammenführen von Manifesten kombiniert das Element <service> aus dem vorherigen Code-Snippet und der Deklaration, SystemForegroundService von WorkManager wird in einem eigenen Manifest definiert.

Typen von Diensten im Vordergrund zur Laufzeit angeben

Beim Aufrufen von setForeground() oder setForegroundAsync() muss ein Wert für Typ des Diensts im Vordergrund.

Hinweis : Ab Android 14 (API-Level 34) gilt: Wenn Sie setForeground() aufrufen, oder setForegroundAsync(), prüft das System bestimmte Voraussetzungen Diensttyp. Weitere Informationen finden Sie im Leitfaden zu Diensten im Vordergrund.

MeinStandortUndMikrofonarbeiter

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);
}