דף זה תורגם על ידי Cloud Translation API.

העברת נתונים ביוזמת המשתמש

If you need to perform a data transfer that may take a long time, you can create a JobScheduler job and identify it as a user-initiated data transfer (UIDT) job. UIDT jobs are intended for longer-duration data transfers that are initiated by the device user, such as downloading a file from a remote server. UIDT jobs were introduced with Android 14 (API level 34).

User-initiated data transfer jobs are started by the user. These jobs require a notification, start immediately, and may be able to run for an extended period of time as system conditions allow. You can run several user-initiated data transfer jobs concurrently.

User initiated jobs must be scheduled while the application is visible to the user (or in one of the allowed conditions). After all constraints are met, user initiated jobs can be executed by the OS, subject to system health restrictions. The system may also use the provided estimated payload size to determine how long the job executes.

תזמון משימות של העברת נתונים שהפעילו משתמשים

כדי להפעיל העברת נתונים שיזם משתמש:

מוודאים שהאפליקציה הצהירה על 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>

מפעילים את השיטה 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)
        // ...
        .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();

בזמן שהעבודה מתבצעת, מפעילים את הפונקציה call setNotification() באובייקט JobService. הפונקציה Calling 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() כשההעברה מסתיימת, בין אם היא מצליחה ובין אם היא נכשלת. כך העבודה לא תפעל יותר מהזמן הנדרש. כדי לגלות למה משימה הופסקה, מטמיעים את שיטת הקריאה החוזרת (callback) 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() שוב.

תנאים שמאפשרים לתזמן משימות של העברת נתונים שהמשתמשים יזמו

אפליקציות יכולות להתחיל משימת העברת נתונים ביוזמת משתמש רק אם האפליקציה נמצאת בחלון הגלוי, או אם מתקיימים תנאים מסוימים:

אם אפליקציה יכולה להפעיל פעילויות מהרקע, היא יכולה גם להפעיל מהרקע משימות העברת נתונים שהמשתמשים יזמו.
אם לאפליקציה יש פעילות בסטאק העורפי של משימה קיימת במסך מהזמן האחרון, זה לא מאפשר להפעיל משימה להעברת נתונים ביוזמת המשתמש.

אם המשימה מתוזמנת לפעול בזמן שבו התנאים הנדרשים לא מתקיימים, היא תיכשל ותוחזר לה קוד השגיאה 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 להעברת נתונים שהופעלה על ידי המשתמש

העברת נתונים ביוזמת המשתמש קל לארגן דפים בעזרת אוספים אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.

תזמון משימות של העברת נתונים שהפעילו משתמשים

Kotlin

Java

Kotlin

Java

Kotlin

Java

המלצות

תאימות לאחור

Kotlin

Java

הפסקת עבודות UIDT

על ידי המשתמש, דרך מנהל המשימות

על ידי המערכת

תנאים שמאפשרים לתזמן משימות של העברת נתונים שהמשתמשים יזמו

מגבלות שמותרות לעבודות של העברת נתונים שהמשתמשים יזמו

בדיקה

למידע נוסף

מקורות מידע נוספים

העברת נתונים ביוזמת המשתמש