Google utilise la technologie IA pour traduire le contenu dans votre langue préférée. Les traductions générées par IA peuvent contenir des erreurs.

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 déclenchée par l'utilisateur, procédez comme suit :

Assurez-vous que votre application a déclaré le 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() {

    ....

}

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>

Appelez la méthode setUserInitiated() lors de la création d'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();

Pendant l'exécution de la tâche, appelez setNotification() sur l'objet JobService. L'appel de setNotification() informe 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
    }
}

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 tâches UIDT, procédez comme suit :

Définissez clairement les contraintes réseau et les contraintes d'exécution des tâches pour spécifier quand la tâche doit être exécutée.
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.
Pour éviter d'exécuter la tâche plus longtemps que nécessaire, appelez jobFinished() lorsque le transfert est terminé, qu'il réussisse ou échoue. Ainsi, la tâche ne s'exécute pas plus longtemps que nécessaire. Pour savoir pourquoi une tâche a été arrêtée, implémentez la onStopJob() méthode de rappel et appelez JobParameters.getStopReason().

Rétrocompatibilité.

目前还没有支持 UIDT 作业的 Jetpack 库。因此，我们建议您使用代码来限制更改，以验证您是否在 Android 14 或更高版本上运行。在较低的 Android 版本中，您可以将 WorkManager 的前台服务实现用作回退方法。

以下是检查相应系统版本的代码示例：

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

用户和系统都可以停止用户发起的传输作业。

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

用户可以停止显示在任务管理器中的用户发起的传输作业。

在用户按 Stop 时，系统会执行以下操作：

立即终止应用的进程，包括正在运行的所有其他作业或前台服务。
不针对任何正在运行的作业调用 onStopJob()。
阻止重新调度用户可见的作业。

因此，建议在发布的作业通知中提供控件，以便顺利停止和重新调度作业。

请注意，在特殊情况下，Stop 按钮不会显示在任务管理器中的作业旁边，或者该作业根本不会显示在任务管理器中。

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

下面列出了有关如何手动测试应用作业的一些步骤：

如需获取作业 ID，请获取在构建作业时定义的值。
如需立即运行作业或重试已停止的作业，请在终端窗口中运行以下命令：
```
adb shell cmd jobscheduler run -f APP_PACKAGE_NAME JOB_ID
```
如需模拟系统强行停止作业（由于系统运行状况或超出配额条件），请在终端窗口中运行以下命令：
```
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 :

Étude de cas sur l'intégration de l'UIDT : Google Maps a amélioré la fiabilité des téléchargements de 10 % grâce à l'API User Initiated Data Transfer

Transfert de données déclenché par l'utilisateur Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

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

Kotlin

Java

Kotlin

Java

Kotlin

Java

Recommandations

Rétrocompatibilité.

Kotlin

Java

Arrêter les tâches UIDT

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

Par le système

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

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

Tests

Voir aussi

Ressources supplémentaires

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