نقل البيانات الذي يبدأه المستخدم

إذا كنت بحاجة إلى تنفيذ عملية نقل بيانات قد تستغرق وقتًا طويلاً، يمكنك إنشاء مهمة JobScheduler وتحديدها على أنّها مهمة نقل بيانات يبدأها المستخدم (UIDT). تم تصميم مهام UIDT لعمليات نقل البيانات التي تستغرق وقتًا أطول والتي يبدأها مستخدم الجهاز، مثل تنزيل ملف من خادم بعيد. تم طرح مهام UIDT مع نظام التشغيل Android 14 (المستوى 34 لواجهة برمجة التطبيقات).

يبدأ المستخدم مهام نقل البيانات التي يبدأها المستخدم. تتطلّب هذه المهام إرسال إشعار، وتبدأ على الفور، وقد تستغرق وقتًا طويلاً حسب ما تسمح به ظروف النظام. يمكنك تشغيل عدّة مهام لنقل البيانات بدأها المستخدمون في الوقت نفسه.

يجب جدولة المهام التي يبدأها المستخدم أثناء ظهور التطبيق للمستخدم (أو في إحدى الحالات المسموح بها). بعد استيفاء جميع القيود، يمكن لنظام التشغيل تنفيذ المهام التي يبدأها المستخدم، مع مراعاة القيود المتعلقة بسلامة النظام. قد يستخدم النظام أيضًا حجم الحمولة المقدَّر المقدَّم لتحديد مدة تنفيذ المهمة.

جدولة مهام نقل البيانات التي يبدأها المستخدم

لتشغيل مهمة نقل بيانات يبدأها المستخدم، اتّبِع الخطوات التالية:

  1. تأكَّد من أنّ تطبيقك قد أعلن عن 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() {
    
        ....
    
    }
  2. أعلن عن إذن RUN_USER_INITIATED_JOBS في بيان التطبيق:

    <manifest ...>
        <uses-permission android:name="android.permission.RUN_USER_INITIATED_JOBS" />
        <application ...>
            ...
        </application>
    </manifest>
    
  3. استدعِ طريقة 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();
  4. أثناء تنفيذ المهمة، استدعِ 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
        }
    }
  5. عدِّل الإشعار بشكل دوري لإبقاء المستخدم على اطّلاع على حالة المهمة ومراحلها. إذا لم تتمكّن من تحديد حجم النقل قبل جدولة المهمة، أو إذا كنت بحاجة إلى تعديل حجم النقل المقدَّر، استخدِم واجهة برمجة التطبيقات الجديدة updateEstimatedNetworkBytes() لتعديل حجم النقل بعد أن يصبح معروفًا.

الاقتراحات

لتشغيل مهام نقل البيانات التي يبدأها المستخدم بفعالية، اتّبِع الخطوات التالية:

  1. حدِّد بوضوح قيود الشبكة وقيود تنفيذ المهام لتحديد وقت تنفيذ المهمة.

  2. نفِّذ المهمة بشكل غير متزامن في onStartJob()، على سبيل المثال، يمكنك إجراء ذلك باستخدام روتين فرعي. إذا لم تنفِّذ المهمة بشكل غير متزامن، سيتم تنفيذها على سلسلة التعليمات الرئيسية وقد تحظرها، ما قد يؤدي إلى حدوث خطأ ANR.

  3. لتجنُّب تشغيل المهمة لفترة أطول من اللازم، استدعِ jobFinished() عند انتهاء النقل، سواء نجح أو فشل. بهذه الطريقة، لن يتم تشغيل المهمة لفترة أطول من اللازم. لاكتشاف سبب إيقاف مهمة، نفِّذ طريقة رد الاتصال onStopJob() واستدعِ JobParameters.getStopReason().

التوافق مع الإصدارات السابقة

目前还没有支持 UIDT 作业的 Jetpack 库。因此,我们建议您使用代码来限制更改,以验证您是否在 Android 14 或更高版本上运行。在较低的 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

يمكن لكل من المستخدم والنظام إيقاف مهام النقل التي يبدأها المستخدم.

من قِبل المستخدم، من "إدارة المهام"

用户可以停止显示在任务管理器中的用户发起的传输作业。

在用户按 Stop 时,系统会执行以下操作:

  • 立即终止应用的进程,包括正在运行的所有其他作业或前台服务。
  • 不针对任何正在运行的作业调用 onStopJob()
  • 阻止重新调度用户可见的作业。

因此,建议在发布的作业通知中提供控件,以便顺利停止和重新调度作业。

请注意,在特殊情况下,Stop 按钮不会显示在任务管理器中的作业旁边,或者该作业根本不会显示在任务管理器中。

من خلال النظام

与常规作业不同,用户发起的数据传输作业不受应用待机模式存储分区配额的影响。但是,如果出现以下任一情况,系统仍会停止作业:

  • 不再满足开发者定义的约束条件。
  • 系统确定该作业的运行时间超出了完成数据传输任务所需的时间。
  • 系统需要优先考虑系统运行状况,并因发热程度上升而停止作业。
  • 应用进程因设备内存不足而被终止。

如果系统因设备内存不足以外的原因停止作业,系统会调用 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

انظر أيضًا

مراجع إضافية

لمزيد من المعلومات حول عمليات نقل البيانات التي يبدأها المستخدم، يُرجى الاطّلاع على المراجع الإضافية التالية: