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

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

Если вам необходимо выполнить передачу данных, которая может занять много времени, вы можете создать задание JobScheduler и обозначить его как задание передачи данных, инициируемое пользователем (UIDT) . Задания UIDT предназначены для длительной передачи данных, инициируемой пользователем устройства, например, для загрузки файла с удалённого сервера. Задания UIDT появились в Android 14 (API уровня 34).

Задания по передаче данных, инициированные пользователем, запускаются пользователем. Эти задания требуют уведомления, запускаются немедленно и могут выполняться в течение длительного времени, если позволяют системные условия. Вы можете запускать несколько заданий по передаче данных, инициированных пользователем, одновременно.

Задания, инициированные пользователем, должны планироваться, пока приложение видимо пользователю (или при соблюдении одного из допустимых условий ). После выполнения всех ограничений, инициированные пользователем задания могут быть выполнены ОС с учётом ограничений, связанных с состоянием системы. Система также может использовать предоставленный предполагаемый размер полезной нагрузки для определения длительности выполнения задания.

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

Чтобы запустить инициированное пользователем задание по передаче данных, выполните следующие действия:

Убедитесь, что ваше приложение объявило JobService и связанные с ним разрешения в своем манифесте:

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

Также определите конкретный подкласс JobService для передачи данных:

Котлин

class CustomTransferService : JobService() {
  ...
}

Ява

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() при создании задания.

Котлин

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

Ява

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

Ява

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

Ява

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.

По системе

В отличие от обычных заданий, на задания по передаче данных, инициированные пользователем, не влияют квоты резервных сегментов приложений . Однако система по-прежнему останавливает задание при возникновении любого из следующих условий:

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

Когда задание останавливается системой по причинам , отличным от нехватки памяти устройства, система вызывает onStopJob() и повторяет выполнение задания в момент, который система считает оптимальным. Убедитесь, что ваше приложение может сохранять состояние передачи данных, даже если onStopJob() не вызывается, и что ваше приложение может восстановить это состояние при повторном вызове onStartJob() .

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

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

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

如果作业安排在未满足必要条件的时间运行，则作业将失败并返回 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 передачи данных, инициируемому пользователем.

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

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

Котлин

Ява

Котлин

Ява

Котлин

Ява

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

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

Котлин

Ява

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

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

По системе

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

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

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

См. также

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

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