تمت ترجمة هذه الصفحة بواسطة Cloud Translation API‏.

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

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

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

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

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

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

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

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

لا تتوفّر حاليًا أي مكتبة Jetpack تتوافق مع مهام UIDT. لهذا السبب، ننصحك بحصر التغيير على التعليمات البرمجية التي تتحقّق من أنّك تستخدم الإصدار 14 من نظام التشغيل Android أو الإصدارات الأحدث. في إصدارات 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

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

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

The user can stop a user-initiated data transfer job that appears in the Task Manager.

At the moment that the user presses Stop, the system does the following:

Terminates your app's process immediately, including all other jobs or foreground services running.
Doesn't call onStopJob() for any running jobs.
Prevents user-visible jobs from being rescheduled.

For these reasons, it's recommended to provide controls in the notification posted for the job to allow gracefully stopping and rescheduling the job.

Note that, under special circumstances, the Stop button doesn't appear next to the job in the Task Manager, or the job isn't shown in the Task Manager at all.

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

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.

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

لا يمكن للتطبيقات بدء مهمة نقل بيانات يبدأها المستخدم إلا إذا كان التطبيق في النافذة المرئية، أو في حال استيفاء شروط معيّنة:

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

إذا تم جدولة المهمة لتشغيلها في وقت لا يتم فيه استيفاء الشروط اللازمة، تتعذّر تنفيذ المهمة وتُعرِض رمز الخطأ RESULT_FAILURE.

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

To support jobs running at optimal points, Android offers the ability to assign constraints to each job type. These constraints are available as of Android 13.

Note: The following table only compares the constraints that vary between each job type. See JobScheduler developer page or work constraints for all constraints.

The following table shows the different job types that support a given job constraint, as well as the set of job constraints that WorkManager supports. Use the search bar before the table to filter the table by the name of a job constraint method.

These are the constraints allowed with user-initiated data transfer jobs:

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 باستخدام واجهة برمجة التطبيقات لنقل البيانات التي يبدأها المستخدم

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

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

Kotlin

Java

Kotlin

Java

Kotlin

Java

الاقتراحات

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

Kotlin

Java

إيقاف مهام UIDT

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

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

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

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

الاختبار

انظر أيضًا

مراجع إضافية

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