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

如果您需要执行可能需要很长时间的数据传输，可以创建一个 JobScheduler 作业，并将其标识为由用户发起的数据传输 (UIDT) 作业。UIDT 作业适用于由设备用户发起的持续时间较长的数据传输，例如从远程服务器下载文件。UIDT 作业是在 Android 14（API 级别 34）中引入的。

由用户发起的数据传输作业由用户启动。这些作业需要一个通知，会立即启动，并且可能在系统条件允许的情况下长时间运行。您可以同时运行多个由用户发起的数据传输作业。

必须在应用对用户可见的情况下（或在某个允许的条件下）安排由用户发起的作业。满足所有限制条件后，操作系统可以执行由用户发起的作业，具体取决于系统运行状况限制。系统还可以根据提供的估算载荷大小来确定作业的执行时长。

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

Both the user and the system can stop user-initiated transfer jobs.

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

与常规作业不同，用户发起的数据传输作业不受应用待机模式存储分区配额的影响。但是，如果出现以下任一情况，系统仍会停止作业：

  • 不再满足开发者定义的约束条件。
  • 系统确定该作业的运行时间超出了完成数据传输任务所需的时间。
  • 系统需要优先考虑系统运行状况，并因发热程度上升而停止作业。
  • 应用进程因设备内存不足而被终止。

如果系统因设备内存不足以外的原因停止作业，系统会调用 onStopJob()，并在系统认为最佳的时间重试作业。确保您的应用可以保留数据传输状态（即使未调用 onStopJob()），并且您的应用可以在再次调用 onStartJob() 时恢复此状态。

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

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

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

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

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

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