WorkManager, uzun süredir çalışan çalışanlar için yerleşik desteğe sahiptir. Bu tür durumlarda WorkManager, işletim sistemine işlem yürütülürken mümkünse sürecin devam ettirilmesi gerektiğine dair bir sinyal sağlayabilir. Bu Çalışanlar 10 dakikadan daha uzun süre koşabilir. Bu yeni özelliğin kullanım alanları arasında toplu yüklemeler veya indirmeler (parçalara ayrılamayan), bir ML modeli üzerinde yerel olarak çalışma ya da uygulamanın kullanıcısı için önemli bir görev yer alır.
Temel olarak WorkManager, WorkRequest'i yürütmek için sizin adınıza bir ön plan hizmetini yönetir ve çalıştırır, aynı zamanda yapılandırılabilir bir bildirim gösterir.
ListenableWorker artık setForegroundAsync() API'yi, CoroutineWorker ise 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 belirtmelerine olanak tanır.
WorkManager, 2.3.0-alpha03 tarihinden itibaren createCancelPendingIntent() API'sini kullanarak yeni bir Android bileşeni kaydetmenize gerek kalmadan çalışanları iptal etmek için kullanabileceğiniz bir PendingIntent oluşturmanıza da olanak tanır. Bu yaklaşım, özellikle Worker API'lerini iptal etmek için bir bildirim işlemi eklemek üzere kullanılabilen setForegroundAsync() veya setForeground() API'leriyle kullanıldığında kullanışlıdır.
Uzun süreli çalışanlar oluşturma ve yönetme
Kotlin veya Java ile kodlama olmanı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ü (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, setForegroundAsync() API'sini çağırabilir. Bu API, ListenableFuture<Void> döndürür. Devam eden bir Notification hesabını güncellemek için setForegroundAsync() numaralı telefonu da arayabilirsiniz.
Aşağıda, uzun süre çalışan ve dosya indiren bir çalışana basit bir örnek verilmiştir. Bu çalışan, indirme işleminin ilerleme durumunu gösteren bir Notification güncellemesinde 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üredir çalışan bir çalışana ön plan hizmet türü ekleme
Uygulamanız Android 14 (API düzeyi 34) veya sonraki sürümleri hedefliyorsa uzun süredir çalışan tüm çalışanlar için bir ön plan hizmet türü belirtmeniz gerekir.
Uygulamanız Android 10 (API düzeyi 29) veya sonraki bir sürümü hedefliyorsa ve konuma erişim gerektiren uzun süreli bir çalışan içeriyorsa, çalışanın ön plan hizmet türünü location kullandığını belirtin.
Uygulamanız Android 11 (API düzeyi 30) veya sonraki sürümleri hedefliyorsa ve kamera veya mikrofona erişmesi gereken uzun süreli bir çalışan içeriyorsa sırasıyla camera veya microphone ön plan hizmeti türlerini belirtin.
Bu ön plan hizmet türlerini eklemek için aşağıdaki bölümlerde açıklanan adımları tamamlayın.
Uygulama manifest dosyasında ön plan hizmeti türlerini tanımlama
Uygulamanızın manifest dosyasında çalışanın ön plan hizmet türünü tanımlayın. Aşağıdaki örnekte, çalışanın konum ve mikrofona erişmesi gerekir:
AndroidManifest.xml
<service android:name="androidx.work.impl.foreground.SystemForegroundService" android:foregroundServiceType="location|microphone" tools:node="merge" />
Çalışma zamanında ön plan hizmet türlerini belirtin
setForeground() veya setForegroundAsync() çağrılarını yaptığınızda bir ön plan hizmet türü belirttiğinizden emin olun.
Konumum veMikrofonÇalışan
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);
}