אם אתם צריכים לבצע העברת נתונים שעשויה להימשך זמן רב, אתם יכולים ליצור משימה ב-JobScheduler ולזהות אותה כמשימה של העברת נתונים ביוזמת המשתמש (UIDT). משימות UIDT מיועדות להעברות נתונים לטווח ארוך שמופעלות על ידי המשתמש במכשיר, כמו הורדת קובץ משרת מרוחק. התכונה 'משימות UIDT' הושקה ב-Android 14 (רמת API 34).
משימות של העברת נתונים ביוזמת המשתמשים מופעלות על ידי המשתמשים. המשימות האלה דורשות התראה, מתחילות מיד ויכולות לפעול למשך תקופה ממושכת, בהתאם לתנאי המערכת. אפשר להריץ כמה משימות של העברת נתונים ביוזמת המשתמשים בו-זמנית.
צריך לתזמן משימות שהמשתמש מפעיל בזמן שהאפליקציה גלויה למשתמש (או באחד מהתנאים המותרים). אחרי שכל האילוצים מתקיימים, מערכת ההפעלה יכולה להריץ משימות שהמשתמש יזום, בכפוף למגבלות של תקינות המערכת. יכול להיות שהמערכת תשתמש גם בגודל המטען הייעודי (payload) המשוער שסיפקתם כדי לקבוע כמה זמן העבודה תפעל.
תזמון משימות של העברת נתונים שהפעילו משתמשים
כדי להריץ משימה של העברת נתונים ביוזמת המשתמשים:
מוודאים שהאפליקציה הצהירה על
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()
בדיקה
下面列出了有关如何手动测试应用作业的一些步骤:
- 如需获取作业 ID,请获取在构建作业时定义的值。
如需立即运行作业或重试已停止的作业,请在终端窗口中运行以下命令:
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 להעברת נתונים שהופעלה על ידי המשתמש