يتضمن WorkManager دعمًا مضمَّنًا للعاملين الذين يعملون لفترات طويلة. وفي مثل هذه الحالات، يمكن أن يقدّم WorkManager إشارة إلى نظام التشغيل بأنّه يجب الاحتفاظ بالعملية إن أمكن أثناء تنفيذ هذا العمل. يمكن لهؤلاء العمال الجري لأكثر من 10 دقائق. وتشمل الأمثلة على حالات استخدام هذه الميزة الجديدة عمليات التحميل المجمّعة أو عمليات التنزيل (التي لا يمكن تقسيمها)، أو مراجعة نموذج تعلُّم الآلة محليًا، أو مهمة مهمّة لمستخدم التطبيق.
بحلّة أخرى، يدير WorkManager خدمة تعمل في المقدّمة ويشغّلها بالنيابة عنك لتنفيذ WorkRequest
، مع عرض أيضًا إشعارًا قابلاً للضبط.
يتوافق ListenableWorker
الآن مع واجهة برمجة تطبيقات setForegroundAsync()
، ويوفّر CoroutineWorker
واجهة برمجة تطبيقات للتعليق setForeground()
. تتيح
واجهات برمجة التطبيقات هذه للمطوّرين تحديد أنّ عنصر WorkRequest
هذا مهم (من منظور المستخدم) أو طويل الأمد.
بدءًا من 2.3.0-alpha03
، يسمح لك WorkManager أيضًا بإنشاء
PendingIntent
، والتي يمكن استخدامها لإلغاء العاملين بدون الحاجة إلى
تسجيل مكوّن Android جديد باستخدام واجهة برمجة التطبيقات createCancelPendingIntent()
. ويمكن الاستفادة من هذه الطريقة على وجه الخصوص عند استخدامها مع واجهات برمجة التطبيقات setForegroundAsync()
أو setForeground()
التي يمكن استخدامها لإضافة إجراء إشعار لإلغاء Worker
.
إنشاء وإدارة العاملين لفترة طويلة
ستستخدم نهجًا مختلفًا قليلاً اعتمادًا على ما إذا كنت تبرمج في Kotlin أو Java.
Kotlin
على مطوّري لغة 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"
}
}
Java
يمكن للمطوّرين الذين يستخدمون ListenableWorker
أو Worker
استدعاء واجهة برمجة التطبيقات
setForegroundAsync()
، التي تعرض الخطأ ListenableFuture<Void>
. يمكنك
أيضًا الاتصال بـ setForegroundAsync()
لتعديل Notification
جارية.
في ما يلي مثال بسيط لعامل يعمل لفترة طويلة وينزّل ملفًا. يتتبّع
هذا العامل مستوى التقدّم لتحديث 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
}
}
إضافة نوع خدمة تعمل في المقدّمة إلى عامل يعمل منذ فترة طويلة
إذا كان تطبيقك يستهدف الإصدار 14 من نظام التشغيل Android (المستوى 34 لواجهة برمجة التطبيقات) أو الإصدارات الأحدث، يجب تحديد
نوع خدمة تعمل في المقدّمة لجميع العاملين لفترة طويلة.
إذا كان تطبيقك يستهدف الإصدار 10 من نظام التشغيل Android (المستوى 29 من واجهة برمجة التطبيقات) أو إصدارًا أحدث ويحتوي على عامل
عمل لفترة طويلة يتطلّب الوصول إلى الموقع الجغرافي، يُرجى الإشارة إلى أنّ العامل
يستخدم نوع خدمة تعمل في المقدّمة من "location
".
إذا كان تطبيقك يستهدف الإصدار 11 من نظام التشغيل Android (المستوى 30 لواجهة برمجة التطبيقات) أو إصدارًا أحدث
وكان يتضمّن موظفًا يعمل منذ فترة طويلة يتطلّب الوصول إلى الكاميرا أو الميكروفون،
يُرجى تحديد نوعَي الخدمة التي تعمل في المقدّمة في المقدّمة من النوع camera
أو microphone
، على التوالي.
لإضافة أنواع الخدمات التي تعمل في المقدّمة هذه، أكمِل الخطوات الموضّحة في الأقسام التالية.
تحديد أنواع الخدمات التي تعمل في المقدّمة في بيان التطبيق
يُرجى تحديد نوع الخدمة التي تعمل في المقدّمة للعامل في ملف البيان لتطبيقك. في المثال التالي، يطلب العامل الوصول إلى الموقع الجغرافي والميكروفون:
<service android:name="androidx.work.impl.foreground.SystemForegroundService" android:foregroundServiceType="location|microphone" tools:node="merge" />
تحديد أنواع الخدمات التي تعمل في المقدّمة في وقت التشغيل
عند الاتصال بـ setForeground()
أو setForegroundAsync()
، تأكَّد من تحديد
نوع خدمة تعمل في المقدّمة.
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); }