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, iniziano immediatamente e potrebbero 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.
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
JobServicee 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
JobServiceper il trasferimento dei dati:Kotlin
class CustomTransferService : JobService() { ... }
Java
class CustomTransferService extends JobService() { .... }
Dichiara l'autorizzazione
RUN_USER_INITIATED_JOBSnel manifest:<manifest ...> <uses-permission android:name="android.permission.RUN_USER_INITIATED_JOBS" /> <application ...> ... </application> </manifest>Chiama il metodo
setUserInitiated()durante la creazione di un oggettoJobInfo. (Questo metodo è disponibile a partire da Android 14.) Ti consigliamo inoltre di offrire una stima delle dimensioni del payload chiamando il numerosetEstimatedNetworkBytes()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'oggettoJobService. ChiamatasetNotification()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 dopo che sono state determinate.
Consigli
Per eseguire i job UIDT in modo efficace:
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 callbackonStopJob()e chiamaJobParameters.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
Both the user and the system can stop user-initiated transfer jobs.
Dall'utente, da Task Manager
用户可以停止显示在任务管理器中的用户发起的传输作业。
在用户按 Stop 时,系统会执行以下操作:
- 立即终止应用的进程,包括正在运行的所有其他作业或前台服务。
- 不针对任何正在运行的作业调用
onStopJob()。 - 阻止重新调度用户可见的作业。
因此,建议在发布的作业通知中提供控件,以便顺利停止和重新调度作业。
请注意,在特殊情况下,Stop 按钮不会显示在任务管理器中的作业旁边,或者该作业根本不会显示在任务管理器中。
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
只有当应用处于可见窗口中或满足特定条件时,应用才能启动用户发起的数据传输作业:
- 如果应用可以从后台启动 activity,则也可以从后台启动用户发起的数据传输作业。
- 如果应用在最近用过屏幕上现有任务的返回堆栈中有 activity,单靠这一点并不允许运行用户发起的数据传输作业。
如果作业安排在未满足必要条件的时间运行,则作业将失败并返回 RESULT_FAILURE 错误代码。
Vincoli consentiti per i processi di trasferimento di dati avviati dall'utente
Per supportare i job eseguiti nei punti ottimali, Android offre la possibilità di assegnare vincoli a ogni tipo di prestazione. Questi vincoli sono disponibili a partire da Android 13.
Nota: la seguente tabella confronta solo i vincoli che variano tra i tipi di prestazione. Per tutti i vincoli, consulta la pagina per gli sviluppatori di JobScheduler o i vincoli di lavoro.
La seguente tabella mostra i diversi tipi di job che supportano un determinato vincolo di job, nonché l'insieme di vincoli di 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 di job.
Di seguito sono riportati i vincoli consentiti con i job di trasferimento dati avviati dall'utente:
setBackoffCriteria(JobInfo.BACKOFF_POLICY_EXPONENTIAL)setClipData()setEstimatedNetworkBytes()setMinimumNetworkChunkBytes()setPersisted()setNamespace()setRequiredNetwork()setRequiredNetworkType()setRequiresBatteryNotLow()setRequiresCharging()setRequiresStorageNotLow()
Test
The following list shows some steps on how to test your app's jobs manually:
- To get the job ID, get the value that is defined upon the job being built.
To run a job immediately, or to retry a stopped job, run the following command in a terminal window:
adb shell cmd jobscheduler run -f APP_PACKAGE_NAME JOB_ID
To simulate the system force-stopping a job (due to system health or out-of-quota conditions), run the following command in a terminal window:
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