如果您需要执行可能需要很长时间的数据传输,可以创建一个 JobScheduler 作业,并将其标识为由用户发起的数据传输 (UIDT) 作业。UIDT 作业适用于由设备用户发起的持续时间较长的数据传输,例如从远程服务器下载文件。UIDT 作业是在 Android 14(API 级别 34)中引入的。
由用户发起的数据传输作业由用户启动。这些作业需要一个通知,会立即启动,并且可能在系统条件允许的情况下长时间运行。您可以同时运行多个由用户发起的数据传输作业。
必须在应用对用户可见的情况下(或在某个允许的条件下)安排由用户发起的作业。满足所有限制条件后,操作系统可以执行由用户发起的作业,具体取决于系统运行状况限制。系统还可以根据提供的估算载荷大小来确定作业的执行时长。
کارهای انتقال داده توسط کاربر را برنامه ریزی کنید
如需运行用户发起的数据传输作业,请执行以下操作:
确保您的应用已在其清单中声明
JobService
和关联的权限:<service android:name="com.example.app.CustomTransferService" android:permission="android.permission.BIND_JOB_SERVICE" android:exported="false"> ... </service>
此外,还要为数据转移定义
JobService
的具体子类:Kotlin
class CustomTransferService : JobService() { ... }
Java
class CustomTransferService extends JobService() { .... }
在清单中声明
RUN_USER_INITIATED_JOBS
权限:<manifest ...> <uses-permission android:name="android.permission.RUN_USER_INITIATED_JOBS" /> <application ...> ... </application> </manifest>
构建
JobInfo
对象时,调用setUserInitiated()
方法。(此方法从 Android 14 开始提供。)我们还建议您在创建作业时通过调用setEstimatedNetworkBytes()
提供载荷大小估算值。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();
在作业执行期间,对
JobService
对象调用setNotification()
。调用setNotification()
会在任务管理器和状态栏通知区域中告知用户作业正在运行。执行完成后,调用
jobFinished()
以向系统表明作业已完成,或者应重新调度作业。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 } }
定期更新通知,让用户了解作业的状态和进度。如果在安排作业之前无法确定传输大小,或者需要更新估计的传输大小,请在知道传输大小之后使用新的 API
updateEstimatedNetworkBytes()
更新传输大小。
建议
如需有效运行 UIDT 作业,请执行以下操作:
明确定义网络限制和作业执行限制,以指定作业的执行时间。
在
onStartJob()
中异步执行任务;例如,您可以使用协程来执行此操作。如果您不异步运行任务,工作将在主线程上运行,可能会阻塞主线程,从而导致 ANR。为避免作业运行时间过长,请在转移完成后(无论成功还是失败)调用
jobFinished()
。这样,作业就不会运行过长时间。如需了解作业停止的原因,请实现onStopJob()
回调方法并调用JobParameters.getStopReason()
。
سازگاری به عقب
目前还没有支持 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) }
کارهای UIDT را متوقف کنید
用户和系统都可以停止用户发起的传输作业。
توسط کاربر، از Task Manager
用户可以停止显示在任务管理器中的用户发起的传输作业。
在用户按 Stop 时,系统会执行以下操作:
- 立即终止应用的进程,包括正在运行的所有其他作业或前台服务。
- 不针对任何正在运行的作业调用
onStopJob()
。 - 阻止重新调度用户可见的作业。
因此,建议在发布的作业通知中提供控件,以便顺利停止和重新调度作业。
请注意,在特殊情况下,Stop 按钮不会显示在任务管理器中的作业旁边,或者该作业根本不会显示在任务管理器中。
توسط سیستم
برخلاف مشاغل معمولی، کارهای انتقال داده توسط کاربر تحت تاثیر سهمیه App Standby Buckets قرار نمی گیرند. با این حال، در صورت بروز هر یک از شرایط زیر، سیستم همچنان کار را متوقف می کند:
- یک محدودیت تعریف شده توسط توسعه دهنده دیگر برآورده نمی شود.
- سیستم تعیین می کند که کار برای تکمیل کار انتقال داده بیش از زمان لازم اجرا شده است.
- این سیستم باید سلامت سیستم را در اولویت قرار دهد و به دلیل افزایش حالت حرارتی، کار را متوقف کند.
- فرآیند برنامه به دلیل حافظه کم دستگاه از بین می رود.
هنگامی که کار به دلایلی غیر از حافظه کم دستگاه توسط سیستم متوقف می شود، سیستم onStopJob()
را فراخوانی می کند و سیستم در زمانی که سیستم بهینه بداند کار را دوباره امتحان می کند. مطمئن شوید که برنامه شما میتواند وضعیت انتقال داده را حفظ کند، حتی اگر onStopJob()
فراخوانی نشود، و برنامه شما میتواند این حالت را با فراخوانی مجدد onStartJob()
بازیابی کند.
شرایط مجاز برای زمانبندی کارهای انتقال داده توسط کاربر
برنامهها تنها در صورتی میتوانند یک کار انتقال داده توسط کاربر را شروع کنند که برنامه در پنجره قابل مشاهده باشد یا شرایط خاصی وجود داشته باشد:
- اگر برنامهای بتواند فعالیتها را از پسزمینه راهاندازی کند ، میتواند کارهای انتقال داده توسط کاربر را نیز از پسزمینه راهاندازی کند.
- اگر یک برنامه فعالیتی در پشته پشته یک کار موجود در صفحه نمایش اخیر داشته باشد، این به تنهایی اجازه نمی دهد کار انتقال داده توسط کاربر اجرا شود.
اگر قرار باشد کار در زمانی اجرا شود که شرایط لازم برآورده نشده باشد، کار از کار می افتد و کد خطای RESULT_FAILURE
را برمی گرداند.
محدودیت هایی که برای کارهای انتقال داده توسط کاربر مجاز است
为了支持在最佳时间点运行的作业,Android 提供了为每种作业类型分配约束条件的功能。这些约束条件从 Android 13 开始就已经可用。
注意:下表仅比较了因作业类型而异的约束条件。如需了解所有约束条件,请参阅 JobScheduler 开发者页面或工作约束条件。
下表显示了支持给定作业约束条件的不同作业类型,以及 WorkManager 支持的作业约束条件集。您可以使用表格前的搜索栏按作业约束方法的名称过滤表格。
以下是用户发起的数据传输作业允许使用的约束条件:
setBackoffCriteria(JobInfo.BACKOFF_POLICY_EXPONENTIAL)
setClipData()
setEstimatedNetworkBytes()
setMinimumNetworkChunkBytes()
setPersisted()
setNamespace()
setRequiredNetwork()
setRequiredNetworkType()
setRequiresBatteryNotLow()
setRequiresCharging()
setRequiresStorageNotLow()
تست کردن
下面列出了有关如何手动测试应用作业的一些步骤:
- 如需获取作业 ID,请获取在构建作业时定义的值。
如需立即运行作业或重试已停止的作业,请在终端窗口中运行以下命令:
adb shell cmd jobscheduler run -f APP_PACKAGE_NAME JOB_ID
如需模拟系统强行停止作业(由于系统运行状况或超出配额条件),请在终端窗口中运行以下命令:
adb shell cmd jobscheduler timeout TEST_APP_PACKAGE TEST_JOB_ID
همچنین ببینید
منابع اضافی
برای اطلاعات بیشتر در مورد انتقال داده توسط کاربر، به منابع اضافی زیر مراجعه کنید:
- مطالعه موردی در مورد ادغام UIDT: Google Maps با استفاده از API انتقال داده آغاز شده توسط کاربر، قابلیت اطمینان دانلود را 10 درصد بهبود بخشید.