Transfert de données déclenché par l'utilisateur

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.

Planifier des tâches de transfert de données déclenchées par l'utilisateur

Pour exécuter une tâche de transfert de données lancée par l'utilisateur, procédez comme suit :

  1. Assurez-vous que votre application a déclaré JobService et les autorisations associées dans son fichier manifeste :

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

    Définissez également une sous-classe concrète de JobService pour votre transfert de données :

    Kotlin

    class CustomTransferService : JobService() {
  ...
}

    Java

    class CustomTransferService extends JobService() {

    ....

}

  2. Déclarez l'autorisation RUN_USER_INITIATED_JOBS dans le fichier manifeste :

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

  3. Appelez la méthode setUserInitiated() lorsque vous créez un objet JobInfo. (Cette méthode est disponible à partir d'Android 14.) Nous vous recommandons également de proposer une estimation de la taille de la charge utile en appelant setEstimatedNetworkBytes() lors de la création de la tâche.

    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. Pendant l'exécution du job, appelez setNotification() sur l'objet JobService. L'appel de setNotification() permet d'informer l'utilisateur que la tâche est en cours d'exécution, à la fois dans le gestionnaire de tâches et dans la zone de notification de la barre d'état.

    Une fois l'exécution terminée, appelez jobFinished() pour signaler au système que la tâche est terminée ou qu'elle doit être reprogrammée.

    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. Mettez régulièrement à jour la notification pour tenir l'utilisateur informé de l'état et de la progression de la tâche. Si vous ne pouvez pas déterminer la taille de transfert avant de planifier la tâche ou si vous devez mettre à jour la taille de transfert estimée, utilisez la nouvelle API updateEstimatedNetworkBytes() pour mettre à jour la taille de transfert une fois que celle-ci est connue.

Recommandations

Pour exécuter efficacement les jobs UIDT, procédez comme suit :

  1. Définissez clairement les contraintes réseau et d'exécution des jobs pour spécifier quand le job doit être exécuté.

  2. Exécutez la tâche de manière asynchrone dans onStartJob(). Par exemple, vous pouvez le faire à l'aide d'une coroutine. Si vous n'exécutez pas la tâche de manière asynchrone, le travail s'exécute sur le thread principal et peut le bloquer, ce qui peut entraîner une erreur ANR.

  3. Pour éviter d'exécuter le job plus longtemps que nécessaire, appelez jobFinished() lorsque le transfert est terminé, qu'il ait réussi ou échoué. Ainsi, le job ne s'exécute pas plus longtemps que nécessaire. Pour découvrir pourquoi un job a été arrêté, implémentez la méthode de rappel onStopJob() et appelez JobParameters.getStopReason().

Rétrocompatibilité.

Il n'existe actuellement aucune bibliothèque Jetpack compatible avec les tâches UIDT. Pour cette raison, nous vous recommandons de limiter votre modification avec du code qui vérifie que vous exécutez Android 14 ou version ultérieure. Sur les versions antérieures d'Android, vous pouvez utiliser l'implémentation du service de premier plan de WorkManager comme approche de secours.

Voici un exemple de code qui vérifie la version du système appropriée :

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

Arrêter les tâches UIDT

L'utilisateur et le système peuvent arrêter les tâches de transfert déclenchées par l'utilisateur.

Par l'utilisateur, depuis le gestionnaire de tâches

L'utilisateur peut arrêter une tâche de transfert de données déclenchée par l'utilisateur qui s'affiche dans le gestionnaire de tâches.

Lorsque l'utilisateur appuie sur Stop (Arrêter), le système procède comme suit :

  • Arrête immédiatement du processus de votre application, y compris toutes les autres tâches ou tous les services de premier plan en cours d'exécution.
  • N'appelle pas onStopJob() pour les tâches en cours d'exécution.
  • Empêche les tâches visibles par l'utilisateur d'être reprogrammées.

Pour ces raisons, il est recommandé de fournir des commandes dans la notification publiée pour la tâche afin de permettre son arrêt et sa replanification en douceur.

Notez que, dans certaines circonstances spéciales, le bouton Stop (Arrêter) n'apparaît pas à côté de la tâche dans le gestionnaire de tâches ou n'est pas du tout affiché.

Par le système

Contrairement aux tâches standards, les tâches de transfert de données déclenchées par l'utilisateur ne sont pas concernées par les quotas des buckets App Standby. Toutefois, le système arrête toujours la tâche si l'une des conditions suivantes se produit :

  • Une contrainte définie par le développeur n'est plus respectée.
  • Le système détermine que la tâche a été exécutée plus longtemps que nécessaire pour effectuer la tâche de transfert de données.
  • Le système doit prioriser l'état du système et arrêter les tâches en raison de l'augmentation de l'état thermique.
  • Le processus de l'application est arrêté, car la mémoire de l'appareil est insuffisante.

Lorsque la tâche est arrêtée par le système pour des raisons autres que la mémoire insuffisante de l'appareil, le système appelle onStopJob(), puis relance la tâche à un moment jugé optimal. Assurez-vous que votre application peut conserver l'état de transfert de données même si onStopJob() n'est pas appelé, et que votre application peut restaurer cet état lorsqu'onStartJob() est à nouveau appelé.

Conditions permettant de planifier des tâches de transfert de données déclenchées par l'utilisateur

Une application ne peut lancer une tâche de transfert de données déclenchée par l'utilisateur que si elle est dans la fenêtre visible ou que certaines conditions sont remplies:

  • Si une application peut lancer des activités en arrière-plan, elle peut également lancer des tâches de transfert de données déclenchées par l'utilisateur en arrière-plan.
  • Si une application présente une activité dans la pile "Retour" d'une tâche existante sur l'écran Récents, cela ne permet pas d'exécuter une tâche de transfert de données déclenchée par l'utilisateur.

Si la tâche est planifiée à un moment où les conditions requises ne sont pas remplies, elle échoue et renvoie un code d'erreur RESULT_FAILURE.

Contraintes autorisées pour les tâches de transfert de données déclenchées par l'utilisateur

To support jobs running at optimal points, Android offers the ability to assign constraints to each job type. These constraints are available as of Android 13.

Note: The following table only compares the constraints that vary between each job type. See JobScheduler developer page or work constraints for all constraints.

The following table shows the different job types that support a given job constraint, as well as the set of job constraints that WorkManager supports. Use the search bar before the table to filter the table by the name of a job constraint method.

These are the constraints allowed with user-initiated data transfer jobs:

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

Tests

La liste suivante montre comment tester manuellement les tâches de votre application :

  • Pour obtenir l'ID de la tâche, obtenez la valeur définie lors de la création de la tâche.

  • Pour exécuter une tâche immédiatement ou pour relancer une tâche arrêtée, exécutez la commande suivante dans une fenêtre de terminal :

    adb shell cmd jobscheduler run -f APP_PACKAGE_NAME JOB_ID

  • Pour simuler l'arrêt forcé du système (en raison de l'état du système ou de conditions hors quota), exécutez la commande suivante dans une fenêtre de terminal :

    adb shell cmd jobscheduler timeout TEST_APP_PACKAGE TEST_JOB_ID

Voir aussi

Ressources supplémentaires

Pour en savoir plus sur les transferts de données initiés par l'utilisateur, consultez les ressources supplémentaires suivantes :