WorkManager پشتیبانی داخلی برای کارگران طولانی مدت دارد. در چنین مواردی، WorkManager می تواند سیگنالی به سیستم عامل ارائه دهد که در صورت امکان، فرآیند باید در حین اجرای این کار زنده نگه داشته شود. این کارگران می توانند بیش از 10 دقیقه کار کنند. نمونههایی از موارد استفاده برای این ویژگی جدید شامل بارگذاری یا دانلود انبوه (که نمیتوان آنها را تکه تکه کرد)، خرد کردن یک مدل ML به صورت محلی، یا کاری که برای کاربر برنامه مهم است.
WorkManager در زیر سرپوش، یک سرویس پیش زمینه را از طرف شما برای اجرای WorkRequest
مدیریت و اجرا می کند، در حالی که یک اعلان قابل تنظیم را نیز نشان می دهد.
ListenableWorker
اکنون از API setForegroundAsync()
و CoroutineWorker
از API setForeground()
معلق پشتیبانی می کند. این APIها به توسعه دهندگان این امکان را می دهند تا مشخص کنند که این WorkRequest
مهم (از دیدگاه کاربر) یا طولانی مدت است.
با شروع با 2.3.0-alpha03
، WorkManager همچنین به شما اجازه می دهد تا یک PendingIntent
ایجاد کنید، که می تواند برای لغو کارگران بدون نیاز به ثبت یک جزء جدید Android با استفاده از createCancelPendingIntent()
API استفاده شود. این رویکرد مخصوصاً زمانی مفید است که با APIهای setForegroundAsync()
یا setForeground()
استفاده شود، که می تواند برای اضافه کردن یک اقدام اعلان برای لغو Worker
استفاده شود.
ایجاد و مدیریت کارگران طولانی مدت
بسته به اینکه در کاتلین یا جاوا کدنویسی می کنید، از رویکرد کمی متفاوت استفاده خواهید کرد.
کاتلین
توسعه دهندگان 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"
}
}
جاوا
توسعه دهندگانی که از ListenableWorker
یا Worker
استفاده می کنند می توانند API setForegroundAsync()
را فراخوانی کنند که یک ListenableFuture<Void>
برمی گرداند. همچنین می توانید برای به روز رسانی Notification
در حال انجام setForegroundAsync()
را فراخوانی کنید.
در اینجا یک مثال ساده از یک کارگر طولانی مدت است که یک فایل را دانلود می کند. این Worker پیشرفت را پیگیری می کند تا یک 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
}
}
یک نوع خدمات پیش زمینه را به یک کارگر طولانی مدت اضافه کنید
اگر برنامه شما 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" />
انواع خدمات پیش زمینه را در زمان اجرا مشخص کنید
وقتی setForeground()
یا setForegroundAsync()
را فرا می خوانید، مطمئن شوید که نوع سرویس پیش زمینه را مشخص کرده اید.
MyLocationAndMicrophoneWorker
کاتلین
private fun createForegroundInfo(progress: String): ForegroundInfo { // ... return ForegroundInfo(NOTIFICATION_ID, notification, FOREGROUND_SERVICE_TYPE_LOCATION or FOREGROUND_SERVICE_TYPE_MICROPHONE) }
جاوا
@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); }