如果您需要执行可能需要很长时间的数据传输,可以创建 一个 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>מבצעים קריאה ל-method
setUserInitiated()כשיוצרים אובייקטJobInfo. (השיטה הזו זמינה החל מ-Android 14). מומלץ גם להעריך את גודל המטען הייעודי (payload) באמצעות קריאה ל-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, 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();
בזמן שהעבודה מתבצעת, מפעילים את הפונקציה call
setNotification()באובייקטJobService. התקשרות אל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(). לדוגמה, אפשר לעשות את זה באמצעות קורוטינה. אם לא מריצים את המשימה באופן אסינכרוני, העבודה מתבצעת ב-thread הראשי והיא עלולה לחסום אותו, מה שיכול לגרום ל-ANR.כדי למנוע הפעלה של העבודה למשך זמן ארוך מהנדרש, צריך להפעיל את
jobFinished()כשההעברה מסתיימת, בין אם היא מצליחה ובין אם היא נכשלת. כך העבודה לא תפעל יותר מהזמן שנדרש. כדי לגלות למה משימה הופסקה, צריך להטמיע את שיטת הקריאה החוזרתonStopJob()ולקרוא ל-JobParameters.getStopReason().
תאימות לאחור
אין כרגע ספריית Jetpack שתומכת במשימות UIDT. לכן, מומלץ להגביל את השינוי באמצעות קוד שמאמת שאתם מריצים את המערכת ב-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
גם המשתמש וגם המערכת יכולים לעצור העברות שהמשתמש יזם.
על ידי המשתמש, דרך מנהל המשימות
用户可以停止显示在任务管理器中的用户发起的传输作业。
在用户按 Stop 时,系统会执行以下操作:
- 立即终止应用的进程,包括正在运行的所有其他作业或前台服务。
- 不针对任何正在运行的作业调用
onStopJob()。 - 阻止重新调度用户可见的作业。
因此,建议在发布的作业通知中提供控件,以便顺利停止和重新调度作业。
请注意,在特殊情况下,Stop 按钮不会显示在任务管理器中的作业旁边,或者该作业根本不会显示在任务管理器中。
על ידי המערכת
与常规作业不同,用户发起的数据传输作业不受应用待机模式存储分区配额的影响。但是,如果出现以下任一情况,系统仍会停止作业:
- 不再满足开发者定义的约束条件。
- 系统确定该作业的运行时间超出了完成数据传输任务所需的时间。
- 系统需要优先考虑系统运行状况,并因发热程度上升而停止作业。
- 应用进程因设备内存不足而被终止。
如果系统因设备内存不足以外的原因停止作业,系统会调用 onStopJob(),并在系统认为最佳的时间重试作业。确保您的应用可以保留数据传输状态(即使未调用 onStopJob()),并且您的应用可以在再次调用 onStartJob() 时恢复此状态。
תנאים שמאפשרים לתזמן משימות של העברת נתונים שהמשתמשים יזמו
只有当应用处于可见窗口中或满足特定条件时,应用才能启动用户发起的数据传输作业:
- 如果应用可以从后台启动 activity,则也可以从后台启动用户发起的数据传输作业。
- 如果应用在最近用过屏幕上现有任务的返回堆栈中有 activity,单靠这一点并不允许运行用户发起的数据传输作业。
如果作业安排在未满足必要条件的时间运行,则作业将失败并返回 RESULT_FAILURE 错误代码。
מגבלות שמותרות לעבודות של העברת נתונים שהמשתמשים יזמו
为了支持在最佳时间点运行的作业,Android 提供了为每种作业类型分配约束条件的功能。这些约束条件从 Android 13 开始就已经可用。
注意:下表仅比较了因作业类型而异的约束条件。如需了解所有约束条件,请参阅 JobScheduler 开发者页面或工作约束条件。
下表显示了支持给定作业约束条件的不同作业类型,以及 WorkManager 支持的作业约束条件集。您可以使用表格前的搜索栏按作业约束方法的名称过滤表格。
以下是用户发起的数据传输作业允许使用的约束条件:
setBackoffCriteria(JobInfo.BACKOFF_POLICY_EXPONENTIAL)setClipData()setEstimatedNetworkBytes()setMinimumNetworkChunkBytes()setPersisted()setNamespace()setRequiredNetwork()setRequiredNetworkType()setRequiresBatteryNotLow()setRequiresCharging()setRequiresStorageNotLow()
בדיקה
ברשימה הבאה מוצגים כמה שלבים לבדיקה ידנית של המשימות באפליקציה:
- כדי למצוא את מזהה המשימה, צריך להזין את הערך שהוגדר במשימה שנוצרת.
כדי להריץ משימה באופן מיידי או כדי לנסות שוב משימה מסוימת, מריצים את הפקודה הבאה: הפקודה בחלון הטרמינל:
adb shell cmd jobscheduler run -f APP_PACKAGE_NAME JOB_ID
כדי לדמות את עצירת המשימה בכוח המערכת (עקב תקינות המערכת או בתנאים שלא נכללים במכסה), מריצים את הפקודה הבאה בחלון הטרמינל:
adb shell cmd jobscheduler timeout TEST_APP_PACKAGE TEST_JOB_ID
למידע נוסף
מקורות מידע נוספים
למידע נוסף על העברות נתונים שיזם המשתמש, אפשר לעיין במקורות המידע הנוספים הבאים:
- מחקר מקרה על שילוב של UIDT: שיפור של 10% במהימנות ההורדה במפות Google באמצעות API להעברת נתונים שהופעלה על ידי המשתמש