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

If you need to perform a data transfer that may take a long time, you can create a JobScheduler job and identify it as a user-initiated data transfer (UIDT) job. UIDT jobs are intended for longer-duration data transfers that are initiated by the device user, such as downloading a file from a remote server. UIDT jobs were introduced with Android 14 (API level 34).

User-initiated data transfer jobs are started by the user. These jobs require a notification, start immediately, and may be able to run for an extended period of time as system conditions allow. You can run several user-initiated data transfer jobs concurrently.

User initiated jobs must be scheduled while the application is visible to the user (or in one of the allowed conditions). After all constraints are met, user initiated jobs can be executed by the OS, subject to system health restrictions. The system may also use the provided estimated payload size to determine how long the job executes.

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

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

تأكَّد من أنّ تطبيقك قد أعلن عن 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>

استدعِ الإجراء 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();

أثناء تنفيذ المهمة، استدعِ الدالة 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
    }
}

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

الاقتراحات

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

حدِّد بوضوح قيود الشبكة وقيود تنفيذ المهمة لتحديد وقت تنفيذ المهمة.
نفِّذ المهمة بشكل غير متزامن في onStartJob()، على سبيل المثال، يمكنك إجراء ذلك باستخدام روتين فرعي. إذا لم تنفّذ المهمة بشكل غير متزامن، سيتم تنفيذها على سلسلة التعليمات الرئيسية وقد تحظرها، ما قد يؤدي إلى حدوث خطأ ANR.
لتجنُّب تشغيل المهمة لمدة أطول من اللازم، استدعِ الدالة jobFinished() عند انتهاء عملية النقل، سواء نجحت أم لا. بهذه الطريقة، لن يستغرق تنفيذ المهمة وقتًا أطول من اللازم. لمعرفة سبب توقّف مهمة، عليك تنفيذ طريقة معاودة الاتصال onStopJob() واستدعاء 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:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

الاختبار

The following list shows some steps on how to test your app's jobs manually:

To get the job ID, get the value that is defined upon the job being built.
To run a job immediately, or to retry a stopped job, run the following command in a terminal window:
```
adb shell cmd jobscheduler run -f APP_PACKAGE_NAME JOB_ID
```
To simulate the system force-stopping a job (due to system health or out-of-quota conditions), run the following command in a terminal window:
```
adb shell cmd jobscheduler timeout TEST_APP_PACKAGE TEST_JOB_ID
```

انظر أيضًا

مراجع إضافية

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

دراسة حالة حول دمج UIDT: حسّنت "خرائط Google" موثوقية التنزيل بنسبة% 10 باستخدام واجهة برمجة التطبيقات لنقل البيانات التي يبدأها المستخدم

نقل البيانات الذي يبدأه المستخدم تنظيم صفحاتك في مجموعات يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.

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

Kotlin

Java

Kotlin

Java

Kotlin

Java

الاقتراحات

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

Kotlin

Java

إيقاف مهام UIDT

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

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

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

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

الاختبار

انظر أيضًا

مراجع إضافية

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