Uzun süreli çalışanlar için destek

WorkManager, uzun süreli çalışanlar için yerleşik destek sunar. Bu gibi durumlarda WorkManager, bu çalışma yürütülürken mümkünse işlemin canlı tutulması gerektiği konusunda işletim sistemine bir sinyal sağlayabilir. Bu işçiler 10 dakikadan uzun süre çalışabilir. Bu yeni özelliğin kullanım alanlarına örnek olarak toplu yükleme veya indirme (parçalanamayan), makine öğrenimi modelini yerel olarak işleme ya da uygulamanın kullanıcısı için önemli olan bir görev verilebilir.

WorkManager, arka planda WorkRequest işlemini yürütmek için sizin adınıza bir ön plan hizmetini yönetir ve çalıştırır. Ayrıca, yapılandırılabilir bir bildirim de gösterir.

ListenableWorker artık setForegroundAsync() API'sini destekliyor ve CoroutineWorker, askıya alma setForeground() API'sini destekliyor. Bu API'ler, geliştiricilerin bu WorkRequest öğesinin önemli (kullanıcı açısından) veya uzun süreli olduğunu belirtmesine olanak tanır.

2.3.0-alpha03 sürümünden itibaren WorkManager, createCancelPendingIntent() API'si kullanılarak yeni bir Android bileşeni kaydetmeye gerek kalmadan çalışanları iptal etmek için kullanılabilecek bir PendingIntent oluşturmanıza da olanak tanır. Bu yaklaşım, özellikle setForegroundAsync() veya setForeground() API'leriyle birlikte kullanıldığında yararlıdır. Bu API'ler, Worker iptal etmek için bildirim işlemi eklemek üzere kullanılabilir.

Uzun süreli çalışanlar oluşturma ve yönetme

Kotlin veya Java'da kod yazmanıza bağlı olarak biraz farklı bir yaklaşım kullanırsınız.

Kotlin

Kotlin geliştiricileri CoroutineWorker kullanmalıdır. setForegroundAsync() yerine bu yöntemin askıya alma sürümünü, yani setForeground() kullanabilirsiniz.

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 veya Worker kullanan geliştiriciler, ListenableFuture<Void> döndüren setForegroundAsync() API'sini çağırabilir. Devam eden bir Notification güncellemek için setForegroundAsync() numaralı telefonu da arayabilirsiniz.

Aşağıda, uzun süredir çalışan ve dosya indiren bir işçiyle ilgili basit bir örnek verilmiştir. Bu Worker, indirme ilerleme durumunu gösteren devam eden bir Notification'yı güncellemek için ilerleme durumunu takip eder.

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

Uzun süreli çalışan bir işleme ön plan hizmeti türü ekleme

Uygulamanız Android 14'ü (API düzeyi 34) veya sonraki sürümleri hedefliyorsa uzun süreli çalışanların tümü için bir ön plan hizmeti türü belirtmeniz gerekir. Uygulamanız Android 10'u (API düzeyi 29) veya sonraki sürümleri hedefliyorsa ve konuma erişim gerektiren uzun süreli bir çalışan içeriyorsa çalışanın locationön plan hizmeti türünü kullandığını belirtin.

Uygulamanız Android 11'i (API düzeyi 30) veya sonraki sürümleri hedefliyorsa ve kamera ya da mikrofona erişim gerektiren uzun süreli bir çalışan içeriyorsa sırasıyla camera veya microphone ön plan hizmeti türlerini beyan edin.

Bu ön plan hizmeti türlerini eklemek için aşağıdaki bölümlerde açıklanan adımları tamamlayın.

Uygulama manifestinde ön plan hizmeti türlerini tanımlama

Çalışanın ön plan hizmeti türünü uygulamanızın manifest dosyasında tanımlayın. Aşağıdaki örnekte, çalışanın konum ve mikrofona erişmesi gerekiyor:

AndroidManifest.xml

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

Çalışma zamanında ön plan hizmeti türlerini belirtme

setForeground() veya setForegroundAsync() numaralı telefonu aradığınızda bir ön plan hizmeti türü belirttiğinizden emin olun.

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