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

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>

מבצעים קריאה ל-method‏ setUserInitiated() כשיוצרים אובייקט JobInfo. (השיטה הזו זמינה החל מ-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, 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. הפונקציה 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().

תאימות לאחור

There is currently no Jetpack library that supports UIDT jobs. For this reason, we recommend that you gate your change with code that verifies that you're running on Android 14 or higher. On lower Android versions, you can use WorkManager's foreground service implementation as a fallback approach.

Here's an example of code that checks for the appropriate system version:

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() שוב.

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

Apps can only start a user-initiated data transfer job if the app is in the visible window, or if certain conditions are met:

If an app can launch activities from the background, it can also launch user-initiated data transfer jobs from the background.
If an app has an activity in the back stack of an existing task on the Recents screen, that alone doesn't allow a user-initiated data transfer job to run.

If the job is scheduled to run at a time when the necessary conditions are not met, the job fails and returns a RESULT_FAILURE error code.

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

To support jobs running at optimal points, Android offers the ability to assign constraints to each job type. These constraints are available as of Android 13.

Note: The following table only compares the constraints that vary between each job type. See JobScheduler developer page or work constraints for all constraints.

The following table shows the different job types that support a given job constraint, as well as the set of job constraints that WorkManager supports. Use the search bar before the table to filter the table by the name of a job constraint method.

These are the constraints allowed with user-initiated data transfer jobs:

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

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

על ידי המערכת

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

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

בדיקה

למידע נוסף

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

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