如果您需要执行可能需要很长时间的数据传输,可以创建 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>构建
JobInfo对象时,调用setUserInitiated()方法。(此方法从 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();
在作业执行期间,对
JobService对象调用setNotification()。调用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 } }
定期更新通知,让用户了解作业的状态和进度。如果在安排作业之前无法确定传输大小,或者需要更新估计的传输大小,请在知道传输大小之后使用新的 API
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 باستخدام واجهة برمجة التطبيقات لنقل البيانات التي يبدأها المستخدم