Эта страница переведена с помощью 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() {
  ...
}

Ява

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)
        // ...
        .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, DownloadTransferService.class))
    // ...
    .setUserInitiated(true)
    .setRequiredNetwork(networkRequest)
    // Provide your estimate of the network traffic here
    .setEstimatedNetworkBytes(1024 * 1024 * 1024)
    // ...
    .build();

Пока задание выполняется, вызовите setNotification() для объекта JobService . Вызов setNotification() сообщает пользователю о том, что задание выполняется, как в диспетчере задач, так и в области уведомлений строки состояния.

Когда выполнение завершится, вызовите jobFinished() , чтобы сообщить системе, что задание завершено или что задание следует перенести.

Котлин

class DownloadTransferService: 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 DownloadTransferService 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() чтобы обновить размер передачи после того, как он станет известен.

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

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) {
        scheduleDownloadUIDTJob(context)
    } else {
        scheduleDownloadFGSWorker(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) {
        scheduleDownloadUIDTJob(context);
    } else {
        scheduleDownloadFGSWorker(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.

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

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.
Prevets 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.

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

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

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

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

Котлин

Ява

Котлин

Ява

Котлин

Ява

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

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

Kotlin

Java

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

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

По системе

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

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

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