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

Para ejecutar una tarea de transferencia de datos que inicia el usuario, haz lo siguiente:

  1. Asegúrate de que tu app haya declarado los permisos JobService y los permisos asociados en su manifiesto:

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

    Además, define una subclase concreta de JobService para tu transferencia de datos:

    Kotlin

    class CustomTransferService : JobService() {
  ...
}

    Java

    class CustomTransferService extends JobService() {

    ....

}

  2. Declara el permiso RUN_USER_INITIATED_JOBS en el manifiesto:

    <manifest ...>
    <uses-permission android:name="android.permission.RUN_USER_INITIATED_JOBS" />
    <application ...>
        ...
    </application>
</manifest>

  3. Llama al método setUserInitiated() cuando compiles un objeto JobInfo. (Este método está disponible a partir de Android 14). También te recomendamos que ofrezcas una estimación del tamaño de la carga útil llamando a setEstimatedNetworkBytes() durante la creación de la tarea.

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

  4. Mientras se ejecuta el trabajo, llama a setNotification() en el objeto JobService. La llamada a setNotification() le informa al usuario que el trabajo está en ejecución, tanto en el Administrador de tareas como en el área de notificaciones de la barra de estado.

    Cuando finalice la ejecución, llama a jobFinished() para indicarle al sistema que se completó la tarea o que se debe reprogramar.

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

  5. Actualiza la notificación de forma periódica para mantener informado al usuario sobre el estado y el progreso de la tarea. Si no puedes determinar el tamaño de transferencia antes de programar la tarea o necesitas actualizar el tamaño de transferencia estimado, usa la nueva API, updateEstimatedNetworkBytes(), para actualizar el tamaño de transferencia después de que se haga conocido.

Recomendaciones

Para ejecutar trabajos de UIDT de manera eficaz, haz lo siguiente:

  1. Define claramente las restricciones de red y las restricciones de ejecución del trabajo para especificar cuándo se debe ejecutar el trabajo.

  2. Ejecuta la tarea de forma asíncrona en onStartJob(); por ejemplo, puedes hacerlo con una corrutina. Si no ejecutas la tarea de forma asíncrona, el trabajo se ejecutará en el subproceso principal y podría bloquearlo, lo que puede provocar un error de ANR.

  3. Para evitar que el trabajo se ejecute más tiempo del necesario, llama a jobFinished() cuando finalice la transferencia, ya sea que se realice correctamente o no. De esta manera, el trabajo no se ejecutará más tiempo del necesario. Para descubrir por qué se detuvo un trabajo, implementa el método de devolución de llamada onStopJob() y llama a JobParameters.getStopReason().

Retrocompatibilidad

Actualmente, no hay ninguna biblioteca de Jetpack que admita trabajos de UIDT. Por este motivo, te recomendamos que limites el cambio con código que verifique que estás ejecutando Android 14 o versiones posteriores. En versiones anteriores de Android, puedes usar la implementación del servicio en primer plano de WorkManager como un enfoque alternativo.

Este es un ejemplo de código que verifica la versión del sistema adecuada:

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

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.

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

Para admitir las tareas que se ejecutan en puntos óptimos, Android ofrece la capacidad de asignar restricciones a cada tipo de tarea. Estas restricciones están disponibles a partir de Android 13.

Nota: En la siguiente tabla, solo se comparan las restricciones que varían entre cada tipo de tarea. Consulta la página del desarrollador de JobScheduler o las restricciones de tareas para conocer todas las restricciones.

En la siguiente tabla, se muestran los diferentes tipos de tareas que admiten una restricción de tarea determinada, así como el conjunto de restricciones de tareas que admite WorkManager. Usa la barra de búsqueda antes de la tabla para filtrarla por el nombre de un método de restricción de tarea.

Estas son las restricciones permitidas para las tareas de transferencia de datos que inicia el usuario:

  • 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: