Google uses AI technology to translate content into your preferred language. AI translations can contain errors.

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

To run a user initiated data-transfer job, do the following:

Make sure your app has declared the JobService and associated permissions in its manifest:

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

Also, define a concrete subclass of JobService for your data transfer:

Kotlin

class CustomTransferService : JobService() {
  ...
}

Java

class CustomTransferService extends JobService() {

    ....

}

Declare the RUN_USER_INITIATED_JOBS permission in the manifest:

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

Call the setUserInitiated() method when building a JobInfo object. (This method is available beginning with Android 14.) We also recommend that you offer a payload size estimate by calling setEstimatedNetworkBytes() while creating your 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, 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();

While the job is being executed, call setNotification() on the JobService object. Calling setNotification() makes the user aware that the job is running, both in the Task Manager and in the status bar notification area.

When execution is complete, call jobFinished() to signal to the system that the job is complete, or that the job should be rescheduled.

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

Periodically update the notification to keep the user informed of the job's status and progress. If you cannot determine the transfer size ahead of scheduling the job, or need to update the estimated transfer size, use the new API, updateEstimatedNetworkBytes() to update the transfer size after it becomes known.

Recommendations

To run UIDT jobs effectively, do the following:

Clearly define network constraints and job execution constraints to specify when the job should be executed.
Execute the task asynchronously in onStartJob(); for example, you can do this by using a coroutine. If you don't run the task asynchronously, the work runs on the main thread and might block it, which can cause an ANR.
To avoid running the job longer than necessary, call jobFinished() when the transfer finishes, whether it succeeds or fails. That way, the job doesn't run longer than necessary. To discover why a job was stopped, implement the onStopJob() callback method and call 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

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

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

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

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

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

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

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 disponibles à partir d'Android 13.

Remarque : Le tableau suivant ne compare que les contraintes qui varient entre chaque type de mission. 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
```

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

Recommendations

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