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

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

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

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

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

To run a user initiated data-transfer job, do the following:

1. Make sure your app has declared the JobService and associated permissions in its manifest:

   <service android:name="com.example.app.CustomTransferService"
           android:permission="android.permission.BIND_JOB_SERVICE"
           android:exported="false">
           ...
   </service>
   

   Also, define a concrete subclass of JobService for your data transfer:

   Kotlin

   class CustomTransferService : JobService() {
     ...
   }

   Java

   class CustomTransferService extends JobService() {
   
       ....
   
   }

2. Declare the RUN_USER_INITIATED_JOBS permission in the manifest:

   <manifest ...>
       <uses-permission android:name="android.permission.RUN_USER_INITIATED_JOBS" />
       <application ...>
           ...
       </application>
   </manifest>
   

3. Call the setUserInitiated() method when building a JobInfo object. (This method is available beginning with Android 14.) We also recommend that you offer a payload size estimate by calling setEstimatedNetworkBytes() while creating your job.

   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)
           // ...
           .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)
       // ...
       .build();

4. While the job is being executed, call setNotification() on the JobService object. Calling setNotification() makes the user aware that the job is running, both in the Task Manager and in the status bar notification area.

   When execution is complete, call jobFinished() to signal to the system that the job is complete, or that the job should be rescheduled.

   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. Periodically update the notification to keep the user informed of the job's status and progress. If you cannot determine the transfer size ahead of scheduling the job, or need to update the estimated transfer size, use the new API, updateEstimatedNetworkBytes() to update the transfer size after it becomes known.

Recommendations

To run UIDT jobs effectively, do the following:

1. Clearly define network constraints and job execution constraints to specify when the job should be executed.

2. Execute the task asynchronously in onStartJob(); for example, you can do this by using a coroutine. If you don't run the task asynchronously, the work runs on the main thread and might block it, which can cause an ANR.

3. To avoid running the job longer than necessary, call jobFinished() when the transfer finishes, whether it succeeds or fails. That way, the job doesn't run longer than necessary. To discover why a job was stopped, implement the onStopJob() callback method and call JobParameters.getStopReason().

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

There is currently no Jetpack library that supports UIDT jobs. For this reason, we recommend that you gate your change with code that verifies that you're running on Android 14 or higher. On lower Android versions, you can use WorkManager's foreground service implementation as a fallback approach.

Here's an example of code that checks for the appropriate system version:

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)
}

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

Both the user and the system can stop user-initiated transfer jobs.

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

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

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

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

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

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

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

Unlike regular jobs, user-initiated data transfer jobs are unaffected by App Standby Buckets quotas. However, the system still stops the job if any of the following conditions occur:

• A developer-defined constraint is no longer met.
• The system determines that the job has run for longer than necessary to complete the data transfer task.
• The system needs to prioritize system health and stop jobs due to increased thermal state.
• The app process is killed due to low device memory.

When the job is stopped by the system for reasons other than low device memory, the system calls onStopJob(), and the system retries the job at a time that the system deems to be optimal. Make sure that your app can persist the data transfer state even if onStopJob() isn't called, and that your app can restore this state when onStartJob() is called again.

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

Apps can only start a user-initiated data transfer job if the app is in the visible window, or if certain conditions are met:

• If an app can launch activities from the background, it can also launch user-initiated data transfer jobs from the background.
• If an app has an activity in the back stack of an existing task on the Recents screen, that alone doesn't allow a user-initiated data transfer job to run.

If the job is scheduled to run at a time when the necessary conditions are not met, the job fails and returns a RESULT_FAILURE error code.

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

ولإتاحة تنفيذ المهام في أفضل الأوقات، يوفّر نظام التشغيل 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 باستخدام واجهة برمجة التطبيقات لنقل البيانات التي يبدأها المستخدم