Esegui la migrazione dei servizi in primo piano a job di trasferimento di dati avviati dall'utente

Android 14 applica regole rigide relative ai casi in cui alle app è consentito usare i servizi in primo piano.

Sempre in Android 14 stiamo introducendo una nuova API per specificare che un job deve essere un job di trasferimento di dati avviato dall'utente. Questa API è utile per i casi d'uso che richiedono il trasferimento di dati avviato dall'utente e di maggiore durata, come il download di un file da un server remoto. Questi tipi di attività dovrebbero utilizzare un job di trasferimento di dati avviato dall'utente.

I processi di trasferimento di dati avviati dall'utente vengono avviati dall'utente. Questi job richiedono una notifica, vengono avviati immediatamente e potrebbero essere eseguiti per un periodo di tempo prolungato, secondo quanto consentito dalle condizioni del sistema. Puoi eseguire contemporaneamente diversi job di trasferimento dati avviati dall'utente.

I job avviati dall'utente devono essere pianificati quando 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, in base alle restrizioni di integrità del sistema. Inoltre, il sistema può utilizzare la dimensione stimata del payload fornita per determinare per quanto tempo viene eseguito il job.

Autorizzazione per i job di trasferimento di dati avviati dall'utente

I job di trasferimento di dati avviati dall'utente richiedono una nuova autorizzazione per essere eseguiti: RUN_USER_INITIATED_JOBS. Il sistema concede automaticamente questa autorizzazione. Il sistema genera un SecurityException se non dichiari l'autorizzazione nel file manifest dell'app.

Processo per la pianificazione di job di trasferimento di dati avviati dall'utente

Per eseguire un job avviato dall'utente:

  1. Se è la prima volta che dichiari un'API con JobScheduler, dichiara JobService e le autorizzazioni associate nel manifest. Inoltre, definisci una sottoclasse concreta di JobService per il trasferimento di dati:

    <service android:name="com.example.app.CustomTransferService"
            android:permission="android.permission.BIND_JOB_SERVICE"
            android:exported="false">
            ...
    </service>
    
    class CustomTransferService : JobService() {
      ...
    }
    
  2. Dichiara l'autorizzazione RUN_USER_INITIATED_JOBS nel tuo file manifest:

    <manifest ...>
        <uses-permission android:name="android.permission.RUN_USER_INITIATED_JOBS" />
        <application ...>
            ...
        </application>
    </manifest>
    
  3. Chiama il nuovo metodo setUserInitiated() durante la creazione di un oggetto JobInfo. Ti consigliamo inoltre di offrire una stima delle dimensioni del payload chiamando setEstimatedNetworkBytes() durante la creazione del job:

    val networkRequestBuilder = NetworkRequest.Builder()
            .addCapability(NET_CAPABILITY_INTERNET)
            .addCapability(NET_CAPABILITY_NOT_METERED)
            // Add or remove capabilities based on your requirements
            .build()
    
    val jobInfo = JobInfo.Builder()
            // ...
            .setUserInitiated(true)
            .setRequiredNetwork(networkRequestBuilder.build())
            .setEstimatedNetworkBytes(1024 * 1024 * 1024)
            // ...
            .build()
    
  4. Pianifica il job prima dell'inizio del trasferimento, quando l'applicazione è visibile o nell'elenco delle condizioni consentite:

    val jobScheduler: JobScheduler =
        context.getSystemService(Context.JOB_SCHEDULER_SERVICE) as JobScheduler
    jobScheduler.schedule(jobInfo)
    
  5. Durante l'esecuzione del job, assicurati di chiamare setNotification() sull'oggetto JobService. Questo valore viene utilizzato per informare l'utente che il job è in esecuzione, sia in Task Manager sia nell'area di notifica della barra di stato:

    class CustomTransferService : JobService() {
      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)
          // Do the job execution.
      }
    }
    
  6. Aggiorna periodicamente la notifica per tenere l'utente informato sullo stato e sull'avanzamento del job. Se non riesci a determinare le dimensioni di trasferimento prima della pianificazione del job o devi aggiornare la dimensione di trasferimento stimata, utilizza la nuova API updateEstimatedNetworkBytes() per aggiornare le dimensioni di trasferimento quando diventano note.

  7. Al termine dell'esecuzione, chiama jobFinished() per segnalare al sistema che il job è stato completato o che deve essere ripianificato.

I processi di trasferimento di dati avviati dall'utente possono essere interrotti

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 di dati avviato dall'utente che viene visualizzato in Task Manager.

Nel momento in cui l'utente preme Interrompi, il sistema procede nel seguente modo:

  • Termina immediatamente il processo dell'app, inclusi tutti gli altri job o servizi in primo piano in esecuzione.
  • Non chiama onStopJob() per alcun job in esecuzione.
  • Prevede la ripianificazione dei lavori visibili all'utente.

Per questi motivi, ti consigliamo di fornire i controlli nella notifica pubblicata per il job per consentire di arrestare e ripianificare agevolmente il job.

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

Dal sistema

A differenza dei job normali, quelli di trasferimento di 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 è più soddisfatto.
  • Il sistema determina che il job è stato eseguito per un periodo superiore a quello necessario per completare l'attività di trasferimento dei dati.
  • Il sistema deve dare la priorità all'integrità del sistema e arrestare i job a causa dell'aumento dello stato termico.
  • Il processo dell'app viene interrotto a causa della memoria del dispositivo insufficiente.

Quando il job viene arrestato dal sistema (non a causa di un caso con memoria insufficiente), il sistema chiama onStopJob() e il sistema riprova a eseguire il job nell'ora che il sistema ritiene ottimale. Verifica che l'app possa mantenere lo stato di trasferimento dei dati, anche se non viene richiamata la chiamata onStopJob(), e che l'app possa ripristinarla quando onStartJob() viene richiamato.

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

Le app possono avviare un job di trasferimento di dati avviato dall'utente solo se si trovano nella finestra visibile o se sono soddisfatte determinate condizioni. Per determinare quando è possibile pianificare un job di trasferimento di dati avviato dall'utente, il sistema applica lo stesso elenco di condizioni che consentono alle app di avviare un'attività in background in casi speciali. In particolare, questo elenco di condizioni non corrisponde all'insieme di esenzioni per le limitazioni per i servizi in primo piano avviate in background.

Le eccezioni alla precedente dichiarazione sono le seguenti:

  • Se un'app può avviare attività in background, può anche avviare job di trasferimento di dati avviati dall'utente in background.
  • Se un'app ha un'attività nello stack precedente di un'attività esistente nella schermata Recenti, ciò non consente l'esecuzione di un job di trasferimento di dati avviato dall'utente.

Se il job viene pianificato in un altro momento non elencato nell'elenco delle condizioni consentite, non riesce e restituisce un codice di errore RESULT_FAILURE.

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

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

Nota: la tabella seguente confronta solo i vincoli che variano in base al tipo di job. Consulta la pagina per gli 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 dei 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.

Di seguito sono riportati i vincoli consentiti per i job 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 sono riportati alcuni passaggi per verificare manualmente i job dell'app:

  • Per ottenere l'ID job, ottieni il valore definito dal job in fase di creazione.
  • Per eseguire un job immediatamente 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 l'arresto forzato di un job da parte del sistema (a causa dell'integrità del sistema o di condizioni di fuori quota), esegui questo comando in una finestra del terminale:

    adb shell cmd jobscheduler timeout TEST_APP_PACKAGE TEST_JOB_ID