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

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

אם אתם צריכים לבצע העברת נתונים שעשויה להימשך זמן רב, אתם יכולים ליצור משימה של 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>

מפעילים את השיטה 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, DownloadTransferService.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 DownloadTransferService: 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 DownloadTransferService 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

Both the user and the system can stop user-initiated transfer jobs.

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

המשתמש יכול להפסיק משימה להעברת נתונים שהמשתמש יזם, שמופיעה במנהל המשימות.

ברגע שהמשתמש לוחץ על Stop, המערכת מבצעת את הפעולות הבאות:

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

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

חשוב לדעת שבנסיבות מיוחדות, הלחצן Stop לא מופיע לצד המשימה במנהל המשימות, או שהמשימה לא מוצגת בכלל במנהל המשימות.

על ידי המערכת

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

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

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

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

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

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

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

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

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()

בדיקה

The following list shows some steps on how to test your app's jobs manually:

To get the job ID, get the value that is defined upon the job being built.
To run a job immediately, or to retry a stopped job, run the following command in a terminal window:
```
adb shell cmd jobscheduler run -f APP_PACKAGE_NAME JOB_ID
```
To simulate the system force-stopping a job (due to system health or out-of-quota conditions), run the following command in a terminal window:
```
adb shell cmd jobscheduler timeout TEST_APP_PACKAGE TEST_JOB_ID
```

למידע נוסף

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

למידע נוסף על העברות נתונים שיזם המשתמש, אפשר לעיין במקורות המידע הנוספים הבאים:

מחקר מקרה על שילוב של UIDT: ‏ שיפור של 10% במהימנות ההורדה במפות Google באמצעות API להעברת נתונים שהופעלה על ידי המשתמש

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

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

Kotlin

Java

Kotlin

Java

Kotlin

Java

המלצות

תאימות לאחור

Kotlin

Java

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

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

על ידי המערכת

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

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

בדיקה

למידע נוסף

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

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