דף זה תורגם על ידי 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>

מבצעים קריאה ל-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().

תאימות לאחור

בשלב הזה, אין ספריית 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.

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

The user can stop a user-initiated data transfer job that appears in the Task Manager.

At the moment that the user presses Stop, the system does the following:

Terminates your app's process immediately, including all other jobs or foreground services running.
Doesn't call onStopJob() for any running jobs.
Prevents user-visible jobs from being rescheduled.

For these reasons, it's recommended to provide controls in the notification posted for the job to allow gracefully stopping and rescheduling the job.

Note that, under special circumstances, the Stop button doesn't appear next to the job in the Task Manager, or the job isn't shown in the Task Manager at all.

על ידי המערכת

Unlike regular jobs, user-initiated data transfer jobs are unaffected by App Standby Buckets quotas. However, the system still stops the job if any of the following conditions occur:

A developer-defined constraint is no longer met.
The system determines that the job has run for longer than necessary to complete the data transfer task.
The system needs to prioritize system health and stop jobs due to increased thermal state.
The app process is killed due to low device memory.

When the job is stopped by the system for reasons other than low device memory, the system calls onStopJob(), and the system retries the job at a time that the system deems to be optimal. Make sure that your app can persist the data transfer state even if onStopJob() isn't called, and that your app can restore this state when onStartJob() is called again.

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

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

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

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

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

על ידי המערכת

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

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

בדיקה

למידע נוסף

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

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