如果您需要执行可能需要很长时间的数据传输,可以创建 JobScheduler 作业,并将其标识为由用户发起的数据传输 (UIDT) 作业。UIDT 作业适用于由设备用户发起的持续时间较长的数据传输,例如从远程服务器下载文件。UIDT 作业是在 Android 14(API 级别 34)中引入的。
由用户发起的数据传输作业由用户启动。这些作业需要一个通知,会立即启动,并且可能在系统条件允许的情况下长时间运行。您可以同时运行多个由用户发起的数据传输作业。
必须在应用对用户可见的情况下(或在某个允许的条件下)安排由用户发起的作业。满足所有限制条件后,操作系统可以执行由用户发起的作业,具体取决于系统运行状况限制。系统还可以根据提供的估算载荷大小来确定作业的执行时长。
جدولة مهام نقل البيانات التي يبدأها المستخدم
لتنفيذ مهمة نقل بيانات بدأها المستخدم، اتّبِع الخطوات التالية:
تأكَّد من أنّ تطبيقك قد أعلن عن
JobServiceوالأذونات المرتبطة به في ملف البيان:<service android:name="com.example.app.CustomTransferService" android:permission="android.permission.BIND_JOB_SERVICE" android:exported="false"> ... </service>حدِّد أيضًا فئة فرعية ملموسة من
JobServiceلنقل البيانات:Kotlin
class CustomTransferService : JobService() { ... }
Java
class CustomTransferService extends JobService() { .... }
أدرِج إذن
RUN_USER_INITIATED_JOBSفي ملف البيان على النحو التالي:<manifest ...> <uses-permission android:name="android.permission.RUN_USER_INITIATED_JOBS" /> <application ...> ... </application> </manifest>استدعِ الإجراء
setUserInitiated()عند إنشاء العنصرJobInfo. (تتوفّر هذه الطريقة بدءًا من نظام التشغيل Android 14). ننصحك أيضًا بتقديم تقدير لحجم الحمولة من خلال طلبsetEstimatedNetworkBytes()أثناء إنشاء مهمتك.Kotlin
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()
Java
NetworkRequest networkRequest = new 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(); JobInfo jobInfo = JobInfo.Builder(jobId, new ComponentName(mContext, CustomTransferService.class)) // ... .setUserInitiated(true) .setRequiredNetwork(networkRequest) // Provide your estimate of the network traffic here .setEstimatedNetworkBytes(1024 * 1024 * 1024, 1024 * 1024 * 1024) // ... .build();
أثناء تنفيذ المهمة، استدعِ الدالة
setNotification()على العنصرJobService. يؤدي استدعاءsetNotification()إلى إعلام المستخدم بأنّ المهمة قيد التنفيذ، وذلك في كل من "إدارة المهام" ومنطقة الإشعارات في شريط الحالة.عند اكتمال التنفيذ، استدعِ
jobFinished()لإعلام النظام بأنّ المهمة قد اكتملت أو يجب إعادة جدولتها.Kotlin
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.myicon) .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 } }
Java
class CustomTransferService extends JobService{ @RequiresApi(Build.VERSION_CODES.UPSIDE_DOWN_CAKE) @Override public boolean onStartJob(JobParameters params) { Notification notification = Notification.Builder(getBaseContext(), NOTIFICATION_CHANNEL_ID) .setContentTitle("My user-initiated data transfer job") .setSmallIcon(android.R.mipmap.myicon) .setContentText("Job is running") .build(); setNotification(params, notification.id, notification, JobService.JOB_END_NOTIFICATION_POLICY_DETACH) // Execute the work associated with this job asynchronously. new Thread(() -> doDownload(params)).start(); return true; } private void doDownload(JobParameters params) { // 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 public boolean onStopJob(JobParameters params) { // 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 كحلّ احتياطي.
في ما يلي مثال على رمز يتحقّق من إصدار النظام المناسب:
Kotlin
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) }
Java
public void beginTask() { if (Build.VERSION.SDK_INT < Build.VERSION_CODES.UPSIDE_DOWN_CAKE) { scheduleDownloadFGSWorker(context); } else { scheduleDownloadUIDTJob(context); } } private void scheduleDownloadUIDTJob(Context context) { // build jobInfo JobScheduler jobScheduler = (JobScheduler) context.getSystemService(Context.JOB_SCHEDULER_SERVICE); jobScheduler.schedule(jobInfo); } private void scheduleDownloadFGSWorker(Context context) { OneTimeWorkRequest myWorkRequest = OneTimeWorkRequest.from(DownloadWorker.class); WorkManager.getInstance(context).enqueue(myWorkRequest) }
إيقاف مهام UIDT
يمكن لكل من المستخدم والنظام إيقاف مهام النقل التي يبدأها المستخدم.
من قِبل المستخدم، من "إدارة المهام"
يمكن للمستخدم إيقاف مهمة نقل بيانات بدأها المستخدم وتظهر في إدارة المهام.
في اللحظة التي يضغط فيها المستخدم على إيقاف، ينفِّذ النظام ما يلي:
- يؤدي هذا الخيار إلى إنهاء عملية تطبيقك على الفور، بما في ذلك جميع المهام الأخرى أو الخدمات التي تعمل في المقدّمة.
- لا يتمّ استدعاء
onStopJob()لأيّ مهام قيد التنفيذ. - يمنع إعادة جدولة المهام المرئية للمستخدم.
لهذه الأسباب، ننصحك بتوفير عناصر تحكّم في الإشعار المُرسَل للعمل للسماح بإيقافه بنجاح وإعادة جدولته.
يُرجى العِلم أنّه في ظل ظروف خاصة، لا يظهر الزر إيقاف بجانب الوظيفة في "مدير المهام"، أو لا تظهر الوظيفة في "مدير المهام" على الإطلاق.
من خلال النظام
与常规作业不同,用户发起的数据传输作业不受应用待机模式存储分区配额的影响。但是,如果出现以下任一情况,系统仍会停止作业:
- 不再满足开发者定义的约束条件。
- 系统确定该作业的运行时间超出了完成数据传输任务所需的时间。
- 系统需要优先考虑系统运行状况,并因发热程度上升而停止作业。
- 应用进程因设备内存不足而被终止。
如果系统因设备内存不足以外的原因停止作业,系统会调用 onStopJob(),并在系统认为最佳的时间重试作业。确保您的应用可以保留数据传输状态(即使未调用 onStopJob()),并且您的应用可以在再次调用 onStartJob() 时恢复此状态。
الشروط المسموح بها لجدولة مهام نقل البيانات التي يبدأها المستخدم
لا يمكن للتطبيقات بدء مهمة نقل بيانات يبدأها المستخدم إلا إذا كان التطبيق في النافذة المرئية، أو في حال استيفاء شروط معيّنة:
- إذا كان بإمكان التطبيق تشغيل الأنشطة من الخلفية، يمكنه أيضًا تشغيل مهام نقل البيانات التي يبدأها المستخدم من الخلفية.
- إذا كان التطبيق يتضمّن نشاطًا في الحزمة الخلفية لمهمّة حالية على شاشة التطبيقات المستخدَمة مؤخرًا، لا يسمح ذلك وحده بتنفيذ مهمة نقل بيانات يُنفذها المستخدم.
إذا تم جدولة المهمة لتشغيلها في وقت لا يتم فيه استيفاء الشروط اللازمة، تتعذّر تنفيذ المهمة وتُعرِض رمز الخطأ RESULT_FAILURE.
القيود المسموح بها لمهام نقل البيانات التي يبدأها المستخدم
为了支持在最佳时间点运行的作业,Android 提供了为每种作业类型分配约束条件的功能。这些约束条件从 Android 13 开始就已经可用。
注意:下表仅比较了因作业类型而异的约束条件。如需了解所有约束条件,请参阅 JobScheduler 开发者页面或工作约束条件。
下表显示了支持给定作业约束条件的不同作业类型,以及 WorkManager 支持的作业约束条件集。您可以使用表格前的搜索栏按作业约束方法的名称过滤表格。
以下是用户发起的数据传输作业允许使用的约束条件:
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 باستخدام واجهة برمجة التطبيقات لنقل البيانات التي يبدأها المستخدم