Эта страница переведена с помощью Cloud Translation API.

Передача данных по инициативе пользователя

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 для передачи данных:

Котлин

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>

При создании объекта JobInfo вызовите метод setUserInitiated() . (Этот метод доступен начиная с Android 14.) Также рекомендуется указывать приблизительный размер полезной нагрузки, вызвав setEstimatedNetworkBytes() при создании задания.

Котлин

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() чтобы сообщить системе о завершении задания или о необходимости его перепланирования.

Котлин

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

Периодически обновляйте уведомление, чтобы держать пользователя в курсе статуса и хода выполнения задания. Если вы не можете определить размер передаваемых данных до планирования задания или вам необходимо обновить предполагаемый размер передаваемых данных, используйте новый API-интерфейс updateEstimatedNetworkBytes() для обновления размера передаваемых данных после того, как он станет известен.

Обратная совместимость

В настоящее время в Jetpack нет библиотеки, поддерживающей задания UIDT. Поэтому мы рекомендуем проверять внесение изменений с помощью кода, подтверждающего работу на Android 14 или выше. На более ранних версиях Android в качестве запасного варианта можно использовать реализацию службы переднего плана WorkManager .

Вот пример кода, который проверяет соответствие версии системы:

Котлин

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() для любых запущенных заданий.
Предотвращает перепланирование видимых пользователю заданий.

По этим причинам рекомендуется предоставить элементы управления в уведомлении, публикуемом для задания, чтобы можно было корректно останавливать и перепланировать задание.

Обратите внимание, что в особых случаях кнопка «Стоп» не отображается рядом с заданием в диспетчере задач или задание вообще не отображается в диспетчере задач.

По системе

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 .

Ограничения, разрешенные для заданий передачи данных, инициируемых пользователем

Для обеспечения оптимального выполнения задач 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 % благодаря API передачи данных, инициируемому пользователем.

Передача данных по инициативе пользователя Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.

Планирование заданий по передаче данных, инициируемых пользователем

Котлин

Java

Котлин

Java

Котлин

Java

Рекомендации

Обратная совместимость

Котлин

Java

Остановить задания UIDT

Пользователь, из диспетчера задач

По системе

Условия, разрешенные для планирования заданий по передаче данных, инициируемых пользователем

Ограничения, разрешенные для заданий передачи данных, инициируемых пользователем

Тестирование

См. также

Дополнительные ресурсы

Передача данных по инициативе пользователя