إذا كنت بحاجة إلى إجراء عملية نقل بيانات قد تستغرق وقتًا طويلاً، يمكنك إنشاء مَهمة JobScheduler وتحديدها على أنّها مَهمة نقل بيانات يبدأها المستخدم (UIDT). تم تصميم مهام UIDT لعمليات نقل البيانات التي تستغرق وقتًا أطول والتي يبدأها مستخدم الجهاز، مثل تنزيل ملف من خادم عن بُعد. تم طرح وظائف UIDT في الإصدار 14 من نظام التشغيل Android (المستوى 34 لواجهة برمجة التطبيقات).
يبدأ المستخدم مهام نقل البيانات التي يبدأها المستخدم. تتطلّب هذه المهام إرسال إشعار، وتبدأ على الفور، وقد يتم تشغيلها لفترة طويلة حسبما تسمح به ظروف النظام. يمكنك تشغيل عدة مهام نقل بيانات يبدأها المستخدم في الوقت نفسه.
يجب جدولة المهام التي يبدأها المستخدم عندما يكون التطبيق مرئيًا له (أو في إحدى الحالات المسموح بها). بعد استيفاء جميع القيود، يمكن لنظام التشغيل تنفيذ المهام التي بدأها المستخدم، وذلك وفقًا لقيود حالة النظام. قد يستخدم النظام أيضًا حجم الحمولة المقدَّر المقدَّم لتحديد مدة تنفيذ المهمة.
جدولة مهام نقل البيانات التي يبدأها المستخدم
لتشغيل مهمة نقل بيانات يبدأها المستخدم، اتّبِع الخطوات التالية:
تأكَّد من أنّ تطبيقك قد أعلن عن
JobServiceوالأذونات المرتبطة به في ملف البيان:<service android:name="com.example.app.CustomTransferService" android:permission="android.permission.BIND_JOB_SERVICE" android:exported="false"> ... </service>يجب أيضًا تحديد فئة فرعية ملموسة من
JobServiceلنقل البيانات:class CustomTransferService : JobService() { // ... }
أضِف إذن
RUN_USER_INITIATED_JOBSفي ملف البيان:<manifest ...> <uses-permission android:name="android.permission.RUN_USER_INITIATED_JOBS" /> <application ...> ... </application> </manifest>استدعِ الإجراء
setUserInitiated()عند إنشاء عنصرJobInfo. (تتوفّر هذه الطريقة بدءًا من الإصدار 14 من نظام التشغيل Android). ننصحك أيضًا بتقديم تقدير لحجم الحمولة من خلال استدعاءsetEstimatedNetworkBytes()أثناء إنشاء مهمتك.val networkRequestBuilder = NetworkRequest.Builder() // Add or remove capabilities based on your requirements. // For example, this code specifies that the job won't run // unless there's a connection to the internet (not just a local // network), and the connection doesn't charge per-byte. .addCapability(NET_CAPABILITY_INTERNET) .addCapability(NET_CAPABILITY_NOT_METERED) .build() val jobInfo = JobInfo.Builder( jobId, ComponentName(mContext, CustomTransferService::class.java) ) // ... .setUserInitiated(true) .setRequiredNetwork(networkRequestBuilder) // Provide your estimate of the network traffic here. .setEstimatedNetworkBytes(1024 * 1024 * 1024, 1024 * 1024 * 1024) // ... .build()
أثناء تنفيذ المهمة، يمكنك استدعاء
setNotification()على العنصرJobService. يؤدي استدعاءsetNotification()إلى إعلام المستخدم بأنّ المهمة قيد التشغيل، سواء في "إدارة المهام" أو في منطقة الإشعارات في شريط الحالة.عند اكتمال التنفيذ، يمكنك استدعاء
jobFinished()لإرسال إشارة إلى النظام بأنّ المهمة قد اكتملت أو أنّه يجب إعادة جدولة المهمة.class CustomTransferService : JobService() { private val scope = CoroutineScope(Dispatchers.IO) @RequiresApi(Build.VERSION_CODES.UPSIDE_DOWN_CAKE) override fun onStartJob(params: JobParameters): Boolean { val notification = Notification.Builder( applicationContext, NOTIFICATION_CHANNEL_ID ) .setContentTitle("My user-initiated data transfer job") .setSmallIcon(android.R.mipmap.sym_def_app_icon) .setContentText("Job is running") .build() setNotification( params, NOTIFICATION_ID, notification, JobService.JOB_END_NOTIFICATION_POLICY_DETACH ) // Execute the work associated with this job asynchronously. scope.launch { doDownload(params) } return true } private suspend fun doDownload(params: JobParameters) { // Run the relevant async download task, then call // jobFinished once the task is completed. jobFinished(params, false) } // Called when the system stops the job. override fun onStopJob(params: JobParameters?): Boolean { // Asynchronously record job-related data, such as the // stop reason. return true // or return false if job should end entirely. } }
يجب تعديل الإشعار بشكل دوري لإبقاء المستخدم على عِلم بحالة المهمة ومستوى تقدّمها. إذا لم تتمكّن من تحديد حجم عملية النقل قبل جدولة المهمة، أو إذا كنت بحاجة إلى تعديل حجم عملية النقل المقدَّر، استخدِم واجهة برمجة التطبيقات الجديدة
updateEstimatedNetworkBytes()لتعديل حجم عملية النقل بعد معرفته.
الاقتراحات
لتشغيل مهام UIDT بفعالية، اتّبِع الخطوات التالية:
حدِّد بوضوح قيود الشبكة وقيود تنفيذ المهام لتحديد وقت تنفيذ المهمة.
نفِّذ المهمة بشكل غير متزامن في
onStartJob()، على سبيل المثال، يمكنك إجراء ذلك باستخدام روتين مشترك. إذا لم يتم تشغيل المهمة بشكل غير متزامن، سيتم تشغيلها على سلسلة التعليمات الرئيسية وقد يتم حظرها، ما قد يؤدي إلى حدوث خطأ ANR.لتجنُّب تشغيل المهمة لفترة أطول من اللازم، يمكنك استدعاء
jobFinished()عند انتهاء عملية النقل، سواء نجحت أو فشلت. بهذه الطريقة، لا يتم تشغيل المهمة لفترة أطول من اللازم. لمعرفة سبب إيقاف مهمة، يمكنك تنفيذ طريقة رد الاتصالonStopJob()واستدعاءJobParameters.getStopReason().
التوافق مع الإصدارات السابقة
لا تتوفّر حاليًا مكتبة Jetpack تتيح استخدام وظائف UIDT. لهذا السبب، ننصحك بحظر التغيير باستخدام رمز برمجي يتحقّق من أنّك تستخدم الإصدار 14 من نظام التشغيل Android أو إصدارًا أحدث. في إصدارات Android الأقدم، يمكنك استخدام تنفيذ الخدمة التي تعمل في المقدّمة من WorkManager كنهج احتياطي.
في ما يلي مثال على رمز برمجي يتحقّق من إصدار النظام المناسب:
fun beginTask() { if (Build.VERSION.SDK_INT < Build.VERSION_CODES.UPSIDE_DOWN_CAKE) { scheduleDownloadFGSWorker(context) } else { scheduleDownloadUIDTJob(context) } } private fun scheduleDownloadUIDTJob(context: Context) { // build jobInfo. val jobScheduler: JobScheduler = context.getSystemService(Context.JOB_SCHEDULER_SERVICE) as JobScheduler jobScheduler.schedule(jobInfo) } private fun scheduleDownloadFGSWorker(context: Context) { val myWorkRequest = OneTimeWorkRequest.from(DownloadWorker::class.java) WorkManager.getInstance(context).enqueue(myWorkRequest) }
إيقاف مهام UIDT
Both the user and the system can stop user-initiated transfer jobs.
من قِبل المستخدم، من "إدارة المهام"
يمكن للمستخدم إيقاف مهمة نقل بيانات بدأها المستخدم وتظهر في إدارة المهام.
في اللحظة التي يضغط فيها المستخدم على إيقاف، ينفِّذ النظام ما يلي:
- يؤدي هذا الخيار إلى إنهاء عملية تطبيقك على الفور، بما في ذلك جميع المهام الأخرى أو الخدمات التي تعمل في المقدّمة.
- لا يتمّ استدعاء
onStopJob()لأيّ مهام قيد التنفيذ. - يمنع إعادة جدولة المهام المرئية للمستخدم.
لهذه الأسباب، ننصحك بتوفير عناصر تحكّم في الإشعار المُرسَل للعمل للسماح بإيقافه بنجاح وإعادة جدولته.
يُرجى العِلم أنّه في ظل ظروف خاصة، لا يظهر الزر إيقاف بجانب الوظيفة في "مدير المهام"، أو لا تظهر الوظيفة في "مدير المهام" على الإطلاق.
من خلال النظام
Unlike regular jobs, user-initiated data transfer jobs are unaffected by App Standby Buckets quotas. However, the system still stops the job if any of the following conditions occur:
- A developer-defined constraint is no longer met.
- The system determines that the job has run for longer than necessary to complete the data transfer task.
- The system needs to prioritize system health and stop jobs due to increased thermal state.
- The app process is killed due to low device memory.
When the job is stopped by the system for reasons other than low device
memory, the system calls onStopJob(), and the system retries the job at a time
that the system deems to be optimal. Make sure that your app can persist the
data transfer state even if onStopJob() isn't called, and that your app can
restore this state when onStartJob() is called again.
الشروط المسموح بها لجدولة مهام نقل البيانات التي يبدأها المستخدم
لا يمكن للتطبيقات بدء مهمة نقل بيانات يبدأها المستخدم إلا إذا كان التطبيق في النافذة المرئية، أو في حال استيفاء شروط معيّنة:
- إذا كان بإمكان التطبيق تشغيل الأنشطة من الخلفية، يمكنه أيضًا تشغيل مهام نقل البيانات التي يبدأها المستخدم من الخلفية.
- إذا كان التطبيق يتضمّن نشاطًا في الحزمة الخلفية لمهمّة حالية على شاشة التطبيقات المستخدَمة مؤخرًا، لا يسمح ذلك وحده بتنفيذ مهمة نقل بيانات يُنفذها المستخدم.
إذا تم جدولة المهمة لتشغيلها في وقت لا يتم فيه استيفاء الشروط اللازمة، تتعذّر تنفيذ المهمة وتُعرِض رمز الخطأ RESULT_FAILURE.
القيود المسموح بها لمهام نقل البيانات التي يبدأها المستخدم
To support jobs running at optimal points, Android offers the ability to assign constraints to each job type. These constraints are available as of Android 13.
Note: The following table only compares the constraints that vary between each job type. See JobScheduler developer page or work constraints for all constraints.
The following table shows the different job types that support a given job constraint, as well as the set of job constraints that WorkManager supports. Use the search bar before the table to filter the table by the name of a job constraint method.
These are the constraints allowed with user-initiated data transfer jobs:
setBackoffCriteria(JobInfo.BACKOFF_POLICY_EXPONENTIAL)setClipData()setEstimatedNetworkBytes()setMinimumNetworkChunkBytes()setPersisted()setNamespace()setRequiredNetwork()setRequiredNetworkType()setRequiresBatteryNotLow()setRequiresCharging()setRequiresStorageNotLow()
الاختبار
توضِّح القائمة التالية بعض الخطوات حول كيفية اختبار مهام تطبيقك يدويًا:
- للحصول على معرّف الوظيفة، احصل على القيمة التي تم تحديدها بناءً على المهمة التي يتم إنشاؤها.
لتشغيل مهمة على الفور أو إعادة محاولة مهمة متوقفة، نفِّذ ما يلي: في نافذة طرفية:
adb shell cmd jobscheduler run -f APP_PACKAGE_NAME JOB_ID
لمحاكاة النظام الذي يوقف إحدى المهام (بسبب سلامة النظام أو خارج الحصة)، شغِّل الأمر التالي في نافذة طرفية:
adb shell cmd jobscheduler timeout TEST_APP_PACKAGE TEST_JOB_ID
انظر أيضًا
مراجع إضافية
لمزيد من المعلومات حول عمليات نقل البيانات التي يبدأها المستخدم، يُرجى الاطّلاع على المراجع الإضافية التالية:
- دراسة حالة حول دمج UIDT: حسّنت "خرائط Google" موثوقية التنزيل بنسبة% 10 باستخدام واجهة برمجة التطبيقات لنقل البيانات التي يبدأها المستخدم