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

אם אתם צריכים לבצע העברת נתונים שעשויה להימשך זמן רב, אתם יכולים ליצור משימה של JobScheduler ולזהות אותה כמשימה של העברת נתונים ביוזמת המשתמש (UIDT). משימות UIDT מיועדות להעברות נתונים לטווח ארוך שמופעלות על ידי משתמש המכשיר, כמו הורדת קובץ משרת מרוחק. משימות UIDT הוצגו ב-Android 14 (רמת API 34).

משימות של העברת נתונים שהפעילו משתמשים מתחילות על ידי המשתמש. המשימות האלה דורשות התראה, מתחילות באופן מיידי ויכולות לפעול למשך זמן ממושך אם תנאי המערכת מאפשרים זאת. אפשר להריץ כמה משימות של העברת נתונים שהמשתמש יזם בו-זמנית.

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

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

如需运行用户发起的数据传输作业，请执行以下操作：

  1. 确保您的应用已在其清单中声明 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() {

    ....

}

  2. 在清单中声明 RUN_USER_INITIATED_JOBS 权限：

    <manifest ...>
    <uses-permission android:name="android.permission.RUN_USER_INITIATED_JOBS" />
    <application ...>
        ...
    </application>
</manifest>

  3. 构建 JobInfo 对象时，调用 setUserInitiated() 方法。（此方法从 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)
        // ...
        .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();

  4. 在作业执行期间，对 JobService 对象调用 setNotification()。调用 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
    }
}

  5. 定期更新通知，让用户了解作业的状态和进度。如果在安排作业之前无法确定传输大小，或者需要更新估计的传输大小，请在知道传输大小之后使用新的 API updateEstimatedNetworkBytes() 更新传输大小。

建议

如需有效运行 UIDT 作业，请执行以下操作：

  1. 明确定义网络限制和作业执行限制，以指定作业的执行时间。

  2. 在 onStartJob() 中异步执行任务；例如，您可以使用协程来执行此操作。如果您不异步运行任务，工作将在主线程上运行，可能会阻塞主线程，从而导致 ANR。

  3. 为避免作业运行时间过长，请在转移完成后（无论成功还是失败）调用 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.

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

כדי לתמוך בהרצת משימות בנקודות אופטימליות, מערכת 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

למידע נוסף

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

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