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

إذا كنت بحاجة إلى تنفيذ عملية نقل بيانات قد تستغرق وقتًا طويلاً، يمكنك إنشاء مهمة 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. 构建 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();
  4. 执行作业时,对 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
        }
    }
  5. 定期更新通知,让用户了解作业的状态和进度。如果在安排作业之前无法确定传输大小,或者需要更新估算的传输大小,请在知道传输大小之后使用新的 API updateEstimatedNetworkBytes() 更新传输大小。

建议

如需有效地运行 UIDT 作业,请执行以下操作:

  1. 明确定义网络限制和作业执行限制,以指定应何时执行作业。

  2. onStartJob() 中异步执行任务;例如,您可以使用 协程 来执行此操作。如果您不异步运行任务,则工作会在主线程上运行,并且可能会阻塞主线程,从而导致 ANR。

  3. 为避免作业运行时间超出必要时长,请在传输完成时(无论成功还是失败)调用 jobFinished()。这样,作业就不会运行超出必要时长。如需了解作业停止的原因,请实现 onStopJob()回调方法并调用 JobParameters.getStopReason()

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

ما مِن مكتبة Jetpack حاليًا تتيح استخدام مهام UIDT. لهذا السبب، ننصحك بتحديد نطاق التغيير باستخدام رمز يتحقّق من أنّك تستخدم 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() 时恢复此状态。

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

只有当应用处于可见窗口中或满足特定条件时,应用才能启动用户发起的数据传输作业:

  • 如果应用可以从后台启动 activity,则也可以从后台启动用户发起的数据传输作业。
  • 如果应用在最近用过屏幕上现有任务的返回堆栈中有 activity,单靠这一点并不允许运行用户发起的数据传输作业。

如果作业安排在未满足必要条件的时间运行,则作业将失败并返回 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

انظر أيضًا

مراجع إضافية

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