Questa pagina è stata tradotta dall'API Cloud Translation.

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 processi di trasferimento di dati avviati dall'utente vengono avviati dall'utente. Questi job richiedono una notifica, vengono avviati 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 può anche utilizzare la dimensione stimata del payload fornita per determinare la durata di esecuzione del job.

Pianificare i job di trasferimento di dati avviati dall'utente

Per eseguire un processo di trasferimento di dati avviato dall'utente:

Assicurati che la tua app abbia dichiarato JobService e le autorizzazioni associate nel manifest:

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

Inoltre, definisci una sottoclasse concreta di JobService per il trasferimento dei dati:

Kotlin

class CustomTransferService : JobService() {
  ...
}

Java

class CustomTransferService extends JobService() {

    ....

}

Dichiara l'autorizzazione RUN_USER_INITIATED_JOBS nel manifest:

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

Chiama il metodo setUserInitiated() durante la creazione di un oggetto JobInfo. (Questo metodo è disponibile a partire da Android 14.) Ti consigliamo inoltre di offrire una stima delle dimensioni del payload chiamando il numero setEstimatedNetworkBytes() durante la creazione del lavoro.

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();

Mentre il job è in esecuzione, chiama setNotification() sull'oggetto JobService. Chiamata setNotification() informa l'utente che il job è in esecuzione, sia in Task Manager sia nell'area di notifica della barra di stato.

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

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

Aggiorna periodicamente la notifica per tenere l'utente informato sullo stato e sull'avanzamento del lavoro. Se non riesci a determinare le dimensioni del trasferimento prima di pianificare il job o devi aggiornare le dimensioni del trasferimento stimate, utilizza la nuova API updateEstimatedNetworkBytes() per aggiornare le dimensioni del trasferimento una volta che sono note.

Consigli

Per eseguire in modo efficace i job UIDT:

Definisci chiaramente i vincoli di rete e di esecuzione del job per specificare quando deve essere eseguito.
Esegui l'attività in modo asincrono in onStartJob(); ad esempio, puoi farlo utilizzando una coroutine. Se non esegui l'attività in modo asincrono, il lavoro viene eseguito sul thread principale e potrebbe bloccarlo, causando un errore ANR.
Per evitare di eseguire il job più a lungo del necessario, chiama jobFinished() al termine del trasferimento, indipendentemente dal fatto che vada a buon fine o meno. In questo modo, il job non viene eseguito più a lungo del necessario. Per scoprire perché un job è stato interrotto, implementa il metodo di callback onStopJob() e chiama JobParameters.getStopReason().

Compatibilità con le versioni precedenti

目前还没有支持 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)
}

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.

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

To support jobs running at optimal points, Android offers the ability to assign constraints to each job type. These constraints are available as of Android 13.

Note: The following table only compares the constraints that vary between each job type. See JobScheduler developer page or work constraints for all constraints.

The following table shows the different job types that support a given job constraint, as well as the set of job constraints that WorkManager supports. Use the search bar before the table to filter the table by the name of a job constraint method.

These are the constraints allowed with user-initiated data transfer jobs:

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

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

Trasferimento di dati avviato dall'utente Mantieni tutto organizzato con le raccolte Salva e classifica i contenuti in base alle tue preferenze.

Pianificare i job di trasferimento di dati avviati dall'utente

Kotlin

Java

Kotlin

Java

Kotlin

Java

Consigli

Compatibilità con le versioni precedenti

Kotlin

Java

Arresta i job UIDT

Dall'utente, da Task Manager

Dal sistema

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

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

Test

Vedi anche

Risorse aggiuntive

Trasferimento di dati avviato dall'utente