Trasferimento di dati avviato dall'utente

Se devi eseguire un trasferimento di dati che potrebbe richiedere molto tempo, puoi creare un job JobScheduler e identificarlo come job di trasferimento di dati avviato dall'utente (UIDT). I processi UIDT sono destinati a trasferimenti di dati di durata più lunga avviati dall'utente del dispositivo, ad esempio il download di un file da un server remoto. I job UIDT sono stati introdotti con Android 14 (livello API 34).

I job di trasferimento di dati avviati dall'utente vengono avviati dall'utente. Questi job richiedono una notifica, iniziano immediatamente e possono essere eseguiti per un periodo di tempo prolungato, a seconda delle condizioni del sistema. Puoi eseguire più job di trasferimento dei dati avviati dall'utente contemporaneamente.

I job avviati dall'utente devono essere pianificati mentre l'applicazione è visibile all'utente (o in una delle condizioni consentite). Una volta soddisfatti tutti i vincoli, i job avviati dall'utente possono essere eseguiti dal sistema operativo, nel rispetto delle limitazioni relative all'integrità del sistema. Il sistema potrebbe anche utilizzare la dimensione stimata del payload fornita per determinare la durata di esecuzione del job.

Nota :se attualmente utilizzi WorkManager per i casi d'uso di trasferimento di dati di rete di breve durata e interrompibili, ti consigliamo di continuare a utilizzare WorkManager anziché passare ai job di trasferimento di dati avviati dall'utente. Per capire meglio se devi utilizzare UIDT, consulta la documentazione relativa alle opzioni dell'attività in background di Data Transfer.

Pianificare i job di trasferimento di dati avviati dall'utente

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

1. 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() {
   
       ....
   
   }

2. Declare the RUN_USER_INITIATED_JOBS permission in the manifest:

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

3. 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)
           // ...
           .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)
       // ...
       .build();

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

5. 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:

1. Clearly define network constraints and job execution constraints to specify when the job should be executed.

2. 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.

3. 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().

Compatibilità con le versioni precedenti

Al momento non esiste una libreria Jetpack che supporti i job UIDT. Per questo motivo, ti consigliamo di proteggere la modifica con codice che verifichi che stai utilizzando Android 14 o versioni successive. Nelle versioni precedenti di Android, puoi utilizzare l'implementazione del servizio in primo piano di WorkManager come approccio di riserva.

Ecco un esempio di codice che verifica la versione di sistema appropriata:

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

Arresta i job UIDT

Sia l'utente che il sistema possono interrompere i job di trasferimento avviati dall'utente.

Dall'utente, da Task Manager

L'utente può interrompere un job di trasferimento dati avviato dall'utente visualizzato in Task Manager.

Nel momento in cui l'utente preme Stop, il sistema esegue le seguenti operazioni:

• Interrompe immediatamente il processo dell'app, inclusi tutti gli altri job o servizi in primo piano in esecuzione.
• Non chiama onStopJob() per i job in esecuzione.
• Impedisce la riprogrammazione dei job visibili all'utente.

Per questi motivi, è consigliabile fornire controlli nella notifica pubblicata per il job per consentire l'arresto e la riprogrammazione in modo corretto.

Tieni presente che, in circostanze speciali, il pulsante Interrompi non viene visualizzato accanto al job in Task Manager o il job non viene visualizzato affatto in Task Manager.

Dal sistema

A differenza dei normali job, i job di trasferimento dei dati avviati dall'utente non sono interessati dalle quote dei bucket di standby delle app. Tuttavia, il sistema interrompe comunque il job se si verifica una delle seguenti condizioni:

• Un vincolo definito dallo sviluppatore non viene più soddisfatto.
• Il sistema determina che il job è stato eseguito per un periodo di tempo superiore a quello necessario per completare l'attività di trasferimento dei dati.
• Il sistema deve dare la priorità all'integrità del sistema e interrompere i job a causa dell'aumento dello stato termico.
• Il processo dell'app viene interrotto a causa della memoria del dispositivo in esaurimento.

Quando il job viene interrotto dal sistema per motivi diversi dalla memoria del dispositivo insufficiente, il sistema chiama onStopJob() e riprova a eseguire il job in un momento che ritiene ottimale. Assicurati che la tua app possa mantenere lo stato di trasferimento dei dati anche se onStopJob() non viene chiamato e che possa ripristinare questo stato quando onStartJob() viene chiamato di nuovo.

Condizioni consentite per la pianificazione dei job di trasferimento di dati avviati dall'utente

Le app possono avviare un job di trasferimento dati avviato dall'utente solo se l'app è nella finestra visibile o se sono soddisfatte determinate condizioni:

• Se un'app può avviare attività in background, può anche avviare job di trasferimento dati avviati dall'utente in background.
• Se un'app ha un'attività nella pila posteriore di un'attività esistente nella schermata Recenti, questo da solo non consente l'esecuzione di un job di trasferimento dati avviato dall'utente.

Nota: le condizioni per avviare un job UIDT in background non sono le stesse delle esenzioni che consentono a un'app di avviare servizi in primo piano dal background.

Se il job è pianificato per l'esecuzione in un momento in cui le condizioni necessarie non sono soddisfatte, il job non riesce e restituisce un codice di errore RESULT_FAILURE.

Vincoli consentiti per i processi di trasferimento di dati avviati dall'utente

Per supportare i job eseguiti in punti ottimali, Android offre la possibilità di assegnare vincoli a ogni tipo di job. Questi vincoli sono disponibili a partire da Android 13.

Nota: la seguente tabella confronta solo i vincoli che variano in base a ciascun tipo di job. Consulta la pagina per sviluppatori di JobScheduler o i vincoli di lavoro per tutti i vincoli.

La seguente tabella mostra i diversi tipi di job che supportano un determinato vincolo del job, nonché l'insieme di vincoli del job supportati da WorkManager. Utilizza la barra di ricerca prima della tabella per filtrare la tabella in base al nome di un metodo di vincolo del job.

Questi sono i vincoli consentiti con i processi di trasferimento di dati avviati dall'utente:

• setBackoffCriteria(JobInfo.BACKOFF_POLICY_EXPONENTIAL)
• setClipData()
• setEstimatedNetworkBytes()
• setMinimumNetworkChunkBytes()
• setPersisted()
• setNamespace()
• setRequiredNetwork()
• setRequiredNetworkType()
• setRequiresBatteryNotLow()
• setRequiresCharging()
• setRequiresStorageNotLow()

Test

Nell'elenco che segue vengono mostrati alcuni passaggi per testare manualmente i job dell'app:

• Per ottenere l'ID job, recupera il valore definito al momento della creazione del job.

• Per eseguire immediatamente un job o per riprovare un job interrotto, esegui questo comando: in una finestra del terminale:

  adb shell cmd jobscheduler run -f APP_PACKAGE_NAME JOB_ID

• Per simulare il sistema che forza l'arresto di un job (a causa dell'integrità del sistema o condizioni fuori quota), esegui questo comando in una finestra del terminale:

  adb shell cmd jobscheduler timeout TEST_APP_PACKAGE TEST_JOB_ID

Vedi anche

• Panoramica delle attività in background
• Opzioni per l'attività in background di trasferimento dei dati

Risorse aggiuntive

Per ulteriori informazioni sui trasferimenti di dati avviati dall'utente, consulta le seguenti risorse aggiuntive:

• Case study sull'integrazione di UIDT: Google Maps ha migliorato l'affidabilità dei download del 10% utilizzando l'API Data Transfer avviata dall'utente