The Android 15 Beta is now available. Try it out today and let us know what you think!

Cette page a été traduite par l'API Cloud Translation.

Migrer les services de premier plan vers des tâches de transfert de données déclenchées par l'utilisateur

Android 14 applique des règles strictes lorsque les applications sont autorisées à utiliser les services de premier plan.

Dans Android 14, nous introduisons également une nouvelle API indiquant qu'une tâche doit être une tâche de transfert de données lancée par l'utilisateur. Cette API est utile pour les cas d'utilisation nécessitant un transfert de données plus long et lancé par l'utilisateur, tel que le téléchargement d'un fichier à partir d'un serveur distant. Ces types de tâches doivent utiliser une tâche de transfert de données lancée par l'utilisateur.

Les tâches de transfert de données déclenchées par l'utilisateur sont déclenchées par l'utilisateur. Ces tâches nécessitent une notification, démarrent immédiatement et peuvent s'exécuter pendant une période prolongée si les conditions du système le permettent. Vous pouvez exécuter simultanément plusieurs tâches de transfert de données déclenchées par l'utilisateur.

Les tâches déclenchées par l'utilisateur doivent être planifiées pendant que l'application est visible par l'utilisateur (ou dans l'une des conditions autorisées). Une fois toutes les contraintes remplies, les tâches déclenchées par l'utilisateur peuvent être exécutées par le système d'exploitation, sous réserve des restrictions de l'état du système. Le système peut également utiliser la taille de la charge utile fournie estimée pour déterminer la durée d'exécution de la tâche.

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

L'exécution des tâches de transfert de données déclenchées par l'utilisateur nécessite une nouvelle autorisation : RUN_USER_INITIATED_JOBS. Le système accorde automatiquement cette autorisation. Le système génère une exception SecurityException si vous ne déclarez pas l'autorisation dans le fichier manifeste de votre application.

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

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

Si vous déclarez une API pour la première fois avec JobScheduler, déclarez JobService et les autorisations associées dans votre fichier manifeste. Définissez également une sous-classe concrète de JobService pour votre transfert de données:
```
<service android:name="com.example.app.CustomTransferService"
        android:permission="android.permission.BIND_JOB_SERVICE"
        android:exported="false">
        ...
</service>
```
```
class CustomTransferService : JobService() {
  ...
}
```

Déclarez l'autorisation RUN_USER_INITIATED_JOBS dans votre fichier manifeste :

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

Appelez la nouvelle méthode setUserInitiated() lors de la création d'un objet JobInfo. Il est également recommandé de proposer une estimation de la taille de la charge utile en appelant setEstimatedNetworkBytes() lors de la création de la tâche:

val networkRequestBuilder = NetworkRequest.Builder()
        .addCapability(NET_CAPABILITY_INTERNET)
        .addCapability(NET_CAPABILITY_NOT_METERED)
        // Add or remove capabilities based on your requirements
        .build()

val jobInfo = JobInfo.Builder()
        // ...
        .setUserInitiated(true)
        .setRequiredNetwork(networkRequestBuilder.build())
        .setEstimatedNetworkBytes(1024 * 1024 * 1024)
        // ...
        .build()

Planifiez la tâche avant le début du transfert, lorsque l'application est visible ou dans la liste des conditions d'autorisation:

val jobScheduler: JobScheduler =
    context.getSystemService(Context.JOB_SCHEDULER_SERVICE) as JobScheduler
jobScheduler.schedule(jobInfo)

Lorsque vous exécutez la tâche, veillez à appeler setNotification() sur l'objet JobService. Cette valeur 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 :

class CustomTransferService : JobService() {
  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)
      // Do the job execution.
  }
}

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 qu'elle est connue.
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.

Les tâches de transfert de données déclenchées par l'utilisateur peuvent être arrêtées

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 (et non par le cas d'utilisation de la mémoire insuffisante), le système appelle onStopJob(), puis relance la tâche à un moment jugé optimal. Vérifiez 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. Pour déterminer quand une tâche de transfert de données déclenchée par l'utilisateur peut être planifiée, le système applique la même liste de conditions qui permet aux applications de lancer une activité en arrière-plan dans des cas particuliers. Cette liste de conditions n'est pas la même que l'ensemble d'exceptions pour les restrictions des services de premier plan lancées en arrière-plan.

Les exceptions à l'instruction précédente sont les suivantes :

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 autre moment non répertorié dans la liste des conditions autorisées, 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

Pour prendre en charge les tâches exécutées à des niveaux optimaux, Android offre la possibilité d'attribuer des contraintes à chaque type de tâche. Ces contraintes sont déjà disponibles à partir d'Android 13.

Remarque : Le tableau suivant ne compare que les contraintes qui varient entre chaque type de tâche. Consultez la page du développeur JobScheduler ou les contraintes de travail pour connaître toutes les contraintes.

Le tableau suivant présente les différents types de tâches compatibles avec une contrainte de tâche donnée, ainsi que l'ensemble des contraintes de tâche prises en charge par WorkManager. Utilisez la barre de recherche au-dessus du tableau pour le filtrer par nom de méthode de contrainte de tâche.

Voici les contraintes autorisées avec les tâches de transfert de données déclenchées par l'utilisateur :

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