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

Si vous devez effectuer un transfert de données qui peut prendre beaucoup de temps, vous pouvez créer une tâche JobScheduler et l'identifier comme une tâche de transfert de données initié par l'utilisateur (UIDT). Les tâches UIDT sont destinées aux transferts de données de longue durée initiés par l'utilisateur de l'appareil, comme le téléchargement d'un fichier à partir d'un serveur distant. Les jobs UIDT ont été introduits avec Android 14 (niveau d'API 34).

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.

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é l'autorisation 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 votre job.

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

    Java

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

  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

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.
  • Prevents 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.

Par le système

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.

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

只有当应用处于可见窗口中或满足特定条件时，应用才能启动用户发起的数据传输作业：

  • 如果应用可以从后台启动 activity，则也可以从后台启动用户发起的数据传输作业。
  • 如果应用在最近用过屏幕上现有任务的返回堆栈中有 activity，单靠这一点并不允许运行用户发起的数据传输作业。

如果作业安排在未满足必要条件的时间运行，则作业将失败并返回 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 :