Se usó la API de Cloud Translation para traducir esta página.

Transferencia de datos que inicia el usuario

Si necesitas realizar una transferencia de datos que puede tardar mucho tiempo, puedes crear un trabajo de JobScheduler y, luego, identificarlo como un trabajo de transferencia de datos iniciada por el usuario (UIDT). Los trabajos de UIDT están diseñados para transferencias de datos de mayor duración que inicia el usuario del dispositivo, como descargar un archivo desde un servidor remoto. Los trabajos de UIDT se introdujeron con Android 14 (nivel de API 34).

Estas tareas de transferencia de datos son iniciadas por el usuario. Estas tareas requieren una notificación, comienzan de inmediato y pueden ejecutarse durante un período prolongado si las condiciones del sistema lo permiten. Se pueden ejecutar varias tareas de transferencia de datos iniciadas por el usuario al mismo tiempo.

Se deben programar las tareas iniciadas por el usuario mientras la aplicación sea visible para él (o en una de las condiciones permitidas). Después de que se cumplen todas las restricciones, el SO puede ejecutar las tareas iniciadas por el usuario, sujeto a las limitaciones del estado del sistema. Es posible que el sistema también utilice el tamaño indicado de la carga útil estimada para determinar la duración de la tarea.

Cómo programar tareas de transferencia de datos que inicia el usuario

如需运行用户发起的数据传输作业，请执行以下操作：

确保您的应用已在其清单中声明 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>

构建 JobInfo 对象时，调用 setUserInitiated() 方法。（此方法从 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)
        // ...
        .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)
    // ...
    .build();

在作业执行期间，对 JobService 对象调用 setNotification()。调用 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
    }
}

定期更新通知，让用户了解作业的状态和进度。如果在安排作业之前无法确定传输大小，或者需要更新估计的传输大小，请在知道传输大小之后使用新的 API updateEstimatedNetworkBytes() 更新传输大小。

建议

如需有效运行 UIDT 作业，请执行以下操作：

明确定义网络限制和作业执行限制，以指定作业的执行时间。
在 onStartJob() 中异步执行任务；例如，您可以使用协程来执行此操作。如果您不异步运行任务，工作将在主线程上运行，可能会阻塞主线程，从而导致 ANR。
为避免作业运行时间过长，请在转移完成后（无论成功还是失败）调用 jobFinished()。这样，作业就不会运行过长时间。如需了解作业停止的原因，请实现 onStopJob() 回调方法并调用 JobParameters.getStopReason()。

Retrocompatibilidad

目前还没有支持 UIDT 作业的 Jetpack 库。因此，我们建议您使用代码来限制更改，以验证您是否在 Android 14 或更高版本上运行。在较低的 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)
}

Detén los trabajos de UIDT

El usuario y el sistema pueden detener tareas de transferencia que inicia el usuario.

Por el usuario, desde el Administrador de tareas

El usuario puede detener una tarea de transferencia de datos que inicia él mismo y que aparece en el Administrador de tareas.

En el momento en que el usuario presiona Detener, el sistema hace lo siguiente:

Finaliza el proceso de tu app de inmediato, incluidos todas las demás tareas o servicios en primer plano que se ejecutan.
No llama a onStopJob() para ninguna tarea en ejecución.
Evita la reprogramación de las tareas visibles para el usuario.

Por estos motivos, te recomendamos que proporciones controles en la notificación publicada para la tarea para permitir que se detenga y se reprograme la tarea con facilidad.

Ten en cuenta que, en circunstancias especiales, el botón Detener no aparece junto a la tarea en el Administrador de tareas, o la tarea no se muestra en el Administrador en absoluto.

Por el sistema

A diferencia de las tareas normales, las de transferencia de datos que inicia el usuario no se ven afectadas por las cuotas de los buckets de App Standby. Sin embargo, el sistema detiene la tarea si se produce alguna de las siguientes condiciones:

Ya no se cumple una restricción que define el desarrollador.
El sistema determina que la tarea se ejecutó más tiempo del necesario para completar la tarea de transferencia de datos.
El sistema debe priorizar el estado del sistema y detener las tareas debido al aumento del estado térmico.
El proceso de la app finaliza debido a la poca memoria del dispositivo.

Cuando el sistema detiene el trabajo por motivos distintos a la poca memoria del dispositivo, el sistema llama a onStopJob() y vuelve a intentar el trabajo en un momento que considera óptimo. Asegúrate de que tu app pueda conservar el estado de transferencia de datos, incluso si no se llama a onStopJob(), y que tu app pueda restablecer este estado cuando se vuelva a llamar a onStartJob().

Condiciones permitidas para programar tareas de transferencia de datos que inicia el usuario

Las apps solo pueden iniciar una tarea de transferencia de datos que inicie el usuario si estas están en la ventana visible o si se cumplen ciertas condiciones:

Si una app puede iniciar actividades en segundo plano, también puede iniciar tareas de transferencia de datos que inicie el usuario en segundo plano.
Si una app tiene una actividad en la pila de actividades de una tarea existente en la pantalla Recientes, eso solo no permite que se ejecute una tarea de transferencia de datos que inicia el usuario.

Si la tarea está programada para ejecutarse en un momento en el que no se cumplen las condiciones necesarias, la tarea falla y muestra un código de error RESULT_FAILURE.

Restricciones permitidas para las tareas de transferencia de datos que inicia el usuario

为了支持在最佳时间点运行的作业，Android 提供了为每种作业类型分配约束条件的功能。这些约束条件从 Android 13 开始就已经可用。

注意：下表仅比较了因作业类型而异的约束条件。如需了解所有约束条件，请参阅 JobScheduler 开发者页面或工作约束条件。

下表显示了支持给定作业约束条件的不同作业类型，以及 WorkManager 支持的作业约束条件集。您可以使用表格前的搜索栏按作业约束方法的名称过滤表格。

以下是用户发起的数据传输作业允许使用的约束条件：

setBackoffCriteria(JobInfo.BACKOFF_POLICY_EXPONENTIAL)
setClipData()
setEstimatedNetworkBytes()
setMinimumNetworkChunkBytes()
setPersisted()
setNamespace()
setRequiredNetwork()
setRequiredNetworkType()
setRequiresBatteryNotLow()
setRequiresCharging()
setRequiresStorageNotLow()

Prueba

En la siguiente lista, se muestran algunos pasos para probar las tareas de tu app de forma manual:

Para obtener el ID de tarea, consigue el valor que se define en la tarea que se está compilando.
Para ejecutar una tarea de inmediato o volver a intentar una tarea detenida, ejecuta el siguiente comando en una ventana de terminal:
```
adb shell cmd jobscheduler run -f APP_PACKAGE_NAME JOB_ID
```
Para simular que el sistema detiene, de manera forzosa, una tarea (debido al estado de este o a las condiciones de falta de cuota), ejecuta el siguiente comando en una ventana de terminal:
```
adb shell cmd jobscheduler timeout TEST_APP_PACKAGE TEST_JOB_ID
```

Consulta también

Recursos adicionales

Para obtener más información sobre las transferencias de datos iniciadas por el usuario, consulta los siguientes recursos adicionales:

Caso de éxito sobre la integración de la UIDT: Google Maps mejoró la confiabilidad de las descargas en un 10% con la API de transferencia de datos iniciada por el usuario

Transferencia de datos que inicia el usuario Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

Cómo programar tareas de transferencia de datos que inicia el usuario

Kotlin

Java

Kotlin

Java

Kotlin

Java

建议

Retrocompatibilidad

Kotlin

Java

Detén los trabajos de UIDT

Por el usuario, desde el Administrador de tareas

Por el sistema

Condiciones permitidas para programar tareas de transferencia de datos que inicia el usuario

Restricciones permitidas para las tareas de transferencia de datos que inicia el usuario

Prueba

Consulta también

Recursos adicionales

Transferencia de datos que inicia el usuario