يتضمّن WorkManager دعمًا مدمجًا للعمّال الذين ينفّذون مهام طويلة. في هذه الحالات، يمكن أن يرسل WorkManager إشارة إلى نظام التشغيل تفيد بضرورة إبقاء العملية نشطة قدر الإمكان أثناء تنفيذ هذا العمل. ويمكن تشغيل هذه الفئات من Workers لمدة تزيد عن 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
على التوالي.
لإضافة هذه الأنواع من الخدمات التي تعمل في المقدّمة، أكمِل الخطوات الموضّحة في الأقسام التالية.
الإعلان عن أنواع الخدمات التي تعمل في المقدّمة في ملف بيان التطبيق
يُرجى تعريف نوع الخدمة التي تعمل في المقدّمة ضمن ملف بيان تطبيقك. في المثال التالي، يحتاج مشغّل الخدمات إلى الوصول إلى الموقع الجغرافي والميكروفون:
AndroidManifest.xml
<service android:name="androidx.work.impl.foreground.SystemForegroundService" android:foregroundServiceType="location|microphone" tools:node="merge" />
تحديد أنواع الخدمات التي تعمل في المقدّمة أثناء التشغيل
عند طلب setForeground() أو setForegroundAsync()، تأكَّد من تحديد
نوع خدمة تعمل في المقدّمة.
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); }