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

如果您需要执行可能需要很长时间的数据传输,可以创建一个 JobScheduler 作业,并将其标识为由用户发起的数据传输 (UIDT) 作业。UIDT 作业适用于由设备用户发起的持续时间较长的数据传输,例如从远程服务器下载文件。UIDT 作业是在 Android 14(API 级别 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() لتعديل حجم عملية النقل بعد معرفته.

الاقتراحات

لتشغيل مهام UIDT بفعالية، اتّبِع الخطوات التالية:

  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

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

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

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

في اللحظة التي يضغط فيها المستخدم على إيقاف، ينفِّذ النظام ما يلي:

  • يؤدي هذا الخيار إلى إنهاء عملية تطبيقك على الفور، بما في ذلك جميع المهام الأخرى أو الخدمات التي تعمل في المقدّمة.
  • لا يتمّ استدعاء onStopJob() لأيّ مهام قيد التنفيذ.
  • يمنع إعادة جدولة المهام المرئية للمستخدم.

لهذه الأسباب، ننصحك بتوفير عناصر تحكّم في الإشعار المُرسَل للعمل للسماح بإيقافه بنجاح وإعادة جدولته.

يُرجى العِلم أنّه في ظل ظروف خاصة، لا يظهر الزر إيقاف بجانب الوظيفة في "مدير المهام"، أو لا تظهر الوظيفة في "مدير المهام" على الإطلاق.

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

على عكس المهام العادية، لا تتأثر مهام نقل البيانات التي يبدأها المستخدم بحصص "حاويات وضع الاستعداد للتطبيق". ومع ذلك، سيظل النظام يوقف المهمة في حال حدوث أيّ من الشروط التالية:

  • لم يعُد يتم استيفاء قيد يحدده المطوّر.
  • يحدّد النظام أنّ المهمة استغرقت وقتًا أطول من اللازم لإكمال مهمة نقل البيانات.
  • يحتاج النظام إلى تحديد أولويات سلامة النظام وإيقاف المهام بسبب ارتفاع درجة الحرارة.
  • تم إيقاف عملية التطبيق بسبب انخفاض ذاكرة الجهاز.

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

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

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

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

如果作业安排在未满足必要条件的时间运行,则作业将失败并返回 RESULT_FAILURE 错误代码。

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

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

ملاحظة: يقارن الجدول التالي فقط القيود التي تختلف بين كل نوع مهمة. يمكنك الاطّلاع على صفحة مطوّري 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

انظر أيضًا

مراجع إضافية

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