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 job UIDT sono destinati a trasferimenti di dati di lunga durata 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, vengono avviati immediatamente e possono essere eseguiti per un periodo di tempo prolungato, se le condizioni del sistema lo consentono. Puoi eseguire contemporaneamente diversi job di trasferimento di dati avviati dall'utente.
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, fatte salve le limitazioni relative all'integrità del sistema. Il sistema potrebbe anche utilizzare le dimensioni del payload stimate fornite per determinare la durata dell'esecuzione del job.
Pianificare i job di trasferimento di dati avviati dall'utente
Per eseguire un job di trasferimento di dati avviato dall'utente, segui questi passaggi:
Assicurati che la tua app abbia dichiarato
JobServicee le autorizzazioni associate nel suo 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 di 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 chiamandosetEstimatedNetworkBytes()durante la creazione del 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();
Mentre viene eseguito il job, chiama
setNotification()sull'oggettoJobService. La chiamata asetNotification()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 è stato completato o che deve essere ripianificato.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 job. Se non riesci a determinare le dimensioni del trasferimento prima di pianificare il job o se 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 i job UIDT in modo efficace, segui questi passaggi:
Definisci chiaramente i vincoli di rete e di esecuzione dei job per specificare quando deve essere eseguito il job.
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, il che può causare un errore ANR.Per evitare di eseguire il job più a lungo del necessario, chiama
jobFinished()al termine del trasferimento, indipendentemente dal fatto che l'esito sia positivo o negativo. 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
Al momento non esiste una libreria Jetpack che supporti i job UIDT. Per questo motivo, ti consigliamo di limitare la modifica con un codice che verifichi che l'app sia in esecuzione su 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 del 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
用户可以停止显示在任务管理器中的用户发起的传输作业。
在用户按 Stop 时,系统会执行以下操作:
- 立即终止应用的进程,包括正在运行的所有其他作业或前台服务。
- 不针对任何正在运行的作业调用
onStopJob()。 - 阻止重新调度用户可见的作业。
因此,建议在发布的作业通知中提供控件,以便顺利停止和重新调度作业。
请注意,在特殊情况下,Stop 按钮不会显示在任务管理器中的作业旁边,或者该作业根本不会显示在任务管理器中。
Dal sistema
与常规作业不同,用户发起的数据传输作业不受应用待机模式存储分区配额的影响。但是,如果出现以下任一情况,系统仍会停止作业:
- 不再满足开发者定义的约束条件。
- 系统确定该作业的运行时间超出了完成数据传输任务所需的时间。
- 系统需要优先考虑系统运行状况,并因发热程度上升而停止作业。
- 应用进程因设备内存不足而被终止。
如果系统因设备内存不足以外的原因停止作业,系统会调用 onStopJob(),并在系统认为最佳的时间重试作业。确保您的应用可以保留数据传输状态(即使未调用 onStopJob()),并且您的应用可以在再次调用 onStartJob() 时恢复此状态。
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
为了支持在最佳时间点运行的作业,Android 提供了为每种作业类型分配约束条件的功能。这些约束条件从 Android 13 开始可用。
注意:下表仅比较了因作业类型而异的约束条件。如需了解所有约束条件,请参阅 JobScheduler 开发者页面或工作约束条件。
下表显示了支持给定作业约束条件的不同作业类型,以及 WorkManager 支持的作业约束条件集。您可以使用表格前的搜索栏按作业约束方法的名称过滤表格。
以下是用户发起的数据传输作业允许使用的约束条件:
setBackoffCriteria(JobInfo.BACKOFF_POLICY_EXPONENTIAL)setClipData()setEstimatedNetworkBytes()setMinimumNetworkChunkBytes()setPersisted()setNamespace()setRequiredNetwork()setRequiredNetworkType()setRequiresBatteryNotLow()setRequiresCharging()setRequiresStorageNotLow()
Test
下面列出了有关如何手动测试应用作业的一些步骤:
- 如需获取作业 ID,请获取在构建作业时定义的值。
如需立即运行作业或重试已停止的作业,请在终端窗口中运行以下命令:
adb shell cmd jobscheduler run -f APP_PACKAGE_NAME JOB_ID
如需模拟系统强行停止作业(由于系统运行状况或超出配额条件),请在终端窗口中运行以下命令:
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