Dukungan untuk pekerja jangka panjang

WorkManager memiliki dukungan bawaan untuk pekerja jangka panjang. Dalam kasus ini, WorkManager dapat memberikan sinyal ke OS bahwa proses harus tetap aktif sebisa mungkin selama pekerjaan ini dijalankan. Pekerja ini dapat berjalan lebih dari 10 menit. Contoh kasus penggunaan untuk fitur baru ini mencakup upload atau download massal (yang tidak dapat dipisah), pemrosesan pada model ML secara lokal, atau tugas yang penting bagi pengguna aplikasi.

Di balik layar, WorkManager mengelola dan menjalankan layanan latar depan bagi Anda untuk menjalankan WorkRequest, sekaligus menampilkan notifikasi yang dapat dikonfigurasi.

ListenableWorker kini mendukung API setForegroundAsync(), dan CoroutineWorker mendukung API penangguhan setForeground(). API ini memungkinkan developer untuk menentukan bahwa WorkRequest ini bersifat penting (dari sudut pandang pengguna) atau diperlukan untuk jangka panjang.

Mulai dari 2.3.0-alpha03, WorkManager juga memungkinkan Anda membuat PendingIntent, yang dapat digunakan untuk membatalkan pekerja tanpa harus mendaftarkan komponen Android baru menggunakan API createCancelPendingIntent(). Pendekatan ini berguna terutama saat digunakan dengan API setForegroundAsync() atau setForeground(), yang dapat digunakan untuk menambahkan tindakan notifikasi guna membatalkan Worker.

Membuat dan mengelola pekerja jangka panjang

Anda perlu menggunakan pendekatan yang sedikit berbeda bergantung pada apakah Anda melakukan coding di Kotlin atau Java.

Kotlin

Developer Kotlin harus menggunakan CoroutineWorker. Sebagai ganti menggunakan setForegroundAsync(), Anda dapat menggunakan versi yang ditangguhkan dari metode tersebut, 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

Developer yang menggunakan ListenableWorker atau Worker dapat memanggil API setForegroundAsync(), yang menampilkan ListenableFuture<Void>. Anda juga dapat memanggil setForegroundAsync() untuk memperbarui Notification yang sedang aktif.

Berikut adalah contoh sederhana dari pekerja jangka panjang yang mendownload file. Pekerja ini terus melacak progres untuk memperbarui Notification yang sedang aktif yang menunjukkan progres download.

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

Menambahkan jenis layanan latar depan ke pekerja jangka panjang

Catatan: Bergantung pada level API yang ditargetkan aplikasi Anda dan jenis pekerjaan yang dilakukan layanan, Anda mungkin diwajibkan untuk menyatakan latar depan jenis layanan tertentu. Mendeklarasikan jenis layanan latar depan adalah praktik terbaik tidak peduli versi Android apa yang Anda targetkan. Detail selengkapnya, lihat dokumentasi layanan latar depan.

Jika aplikasi menargetkan Android 14 (API level 34) atau yang lebih baru, Anda harus menentukan jenis layanan latar depan untuk semua pekerja jangka panjang. Jika aplikasi Anda menargetkan Android 10 (API level 29) atau yang lebih baru dan berisi pekerja jangka panjang yang memerlukan akses ke lokasi, menunjukkan bahwa pekerja menggunakan jenis layanan latar depan location.

Jika aplikasi Anda menargetkan Android 11 (API level 30) atau yang lebih baru dan berisi pekerja jangka panjang yang memerlukan akses ke kamera atau mikrofon, menyatakan latar depan camera atau microphone jenis layanan.

Untuk menambahkan jenis layanan latar depan ini, selesaikan langkah-langkah yang dijelaskan di bagian berikut.

Mendeklarasikan jenis layanan latar depan dalam manifes aplikasi

Deklarasikan jenis layanan latar depan pekerja dalam manifes aplikasi Anda. Pada contoh berikut, pekerja memerlukan akses ke lokasi dan mikrofon:

AndroidManifest.xml

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

Catatan: Alat penggabung manifes menggabungkan elemen <service> dari cuplikan kode sebelumnya dan deklarasi bahwa SystemForegroundService WorkManager menentukan dalam manifesnya sendiri.

Menentukan jenis layanan latar depan saat runtime

Saat memanggil setForeground() atau setForegroundAsync(), pastikan Anda menentukan jenis layanan latar depan.

Catatan: Mulai dari Android 14 (level API 34), saat Anda memanggil setForeground() atau setForegroundAsync(), sistem akan memeriksa prasyarat tertentu berdasarkan jenis layanan tertentu. Untuk informasi selengkapnya, lihat Panduan Layanan Latar Depan.

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