Transfer data yang dimulai pengguna

Jika perlu melakukan transfer data yang mungkin memerlukan waktu lama, Anda dapat membuat tugas JobScheduler dan mengidentifikasinya sebagai tugas transfer data yang dimulai oleh pengguna (UIDT). Tugas UIDT ditujukan untuk transfer data berdurasi lebih lama yang dimulai oleh pengguna perangkat, seperti mendownload file dari server jarak jauh. Pekerjaan UIDT diperkenalkan dengan Android 14 (level API 34).

Tugas transfer data yang dimulai pengguna dimulai oleh pengguna. Tugas ini memerlukan notifikasi, segera dimulai, dan mungkin dapat berjalan untuk jangka waktu lama sesuai kondisi sistem. Anda dapat menjalankan beberapa tugas transfer data yang dimulai oleh pengguna secara serentak.

Tugas yang dimulai oleh pengguna harus dijadwalkan saat aplikasi terlihat oleh pengguna (atau dalam salah satu kondisi yang diizinkan). Setelah semua batasan terpenuhi, tugas yang dimulai pengguna dapat dijalankan oleh OS, tunduk pada batasan kesehatan sistem. Sistem juga dapat menggunakan estimasi ukuran payload yang diberikan untuk menentukan berapa lama tugas dijalankan.

Menjadwalkan tugas transfer data yang dimulai pengguna

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

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

Kompatibilitas mundur

目前还没有支持 UIDT 作业的 Jetpack 库。因此，我们建议您使用代码来限制更改，以验证您是否在 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)
}

Menghentikan tugas UIDT

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

Oleh pengguna, dari Pengelola Tugas

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.

Oleh sistem

Tidak seperti tugas reguler, tugas transfer data yang dimulai pengguna tidak terpengaruh oleh kuota Bucket Aplikasi Standby. Namun, sistem tetap menghentikan tugas jika salah satu kondisi berikut terjadi:

  • Batasan yang ditentukan developer tidak lagi terpenuhi.
  • Sistem menentukan bahwa tugas telah berjalan lebih lama dari yang diperlukan untuk menyelesaikan tugas transfer data.
  • Sistem perlu memprioritaskan kesehatan sistem dan menghentikan tugas karena peningkatan status termal.
  • Proses aplikasi dihentikan karena memori perangkat rendah.

Jika tugas dihentikan oleh sistem karena alasan selain memori perangkat rendah, sistem akan memanggil onStopJob(), dan sistem akan mencoba kembali tugas pada waktu yang dianggap optimal oleh sistem. Pastikan aplikasi Anda dapat mempertahankan status transfer data meskipun onStopJob() tidak dipanggil, dan aplikasi Anda dapat memulihkan status ini saat onStartJob() dipanggil lagi.

Kondisi yang diizinkan untuk menjadwalkan tugas transfer data yang dimulai pengguna

只有当应用处于可见窗口中或满足特定条件时，应用才能启动用户发起的数据传输作业：

  • 如果应用可以从后台启动 activity，则也可以从后台启动用户发起的数据传输作业。
  • 如果应用在最近用过屏幕上现有任务的返回堆栈中有 activity，单靠这一点并不允许运行用户发起的数据传输作业。

如果作业安排在未满足必要条件的时间运行，则作业将失败并返回 RESULT_FAILURE 错误代码。

Batasan yang diizinkan untuk tugas transfer data yang dimulai pengguna

Untuk mendukung tugas agar berjalan pada titik yang optimal, Android menawarkan kemampuan untuk menetapkan batasan bagi setiap jenis tugas. Batasan ini tersedia mulai Android 13.

Catatan: Tabel berikut hanya membandingkan batasan yang bervariasi antara setiap jenis tugas. Lihat halaman developer JobScheduler atau batasan kerja untuk semua batasan.

Tabel berikut menunjukkan berbagai jenis tugas yang mendukung batasan tugas tertentu, serta kumpulan batasan tugas yang didukung WorkManager. Gunakan kotak penelusuran sebelum tabel untuk memfilter tabel berdasarkan nama metode batasan tugas.

Berikut ini batasan yang diizinkan dengan tugas transfer data yang dimulai pengguna:

  • setBackoffCriteria(JobInfo.BACKOFF_POLICY_EXPONENTIAL)
  • setClipData()
  • setEstimatedNetworkBytes()
  • setMinimumNetworkChunkBytes()
  • setPersisted()
  • setNamespace()
  • setRequiredNetwork()
  • setRequiredNetworkType()
  • setRequiresBatteryNotLow()
  • setRequiresCharging()
  • setRequiresStorageNotLow()

Pengujian

下面列出了有关如何手动测试应用作业的一些步骤：

  • 如需获取作业 ID，请获取在构建作业时定义的值。

  • 如需立即运行作业或重试已停止的作业，请在终端窗口中运行以下命令：

    adb shell cmd jobscheduler run -f APP_PACKAGE_NAME JOB_ID

  • 如需模拟系统强行停止作业（由于系统运行状况或超出配额条件），请在终端窗口中运行以下命令：

    adb shell cmd jobscheduler timeout TEST_APP_PACKAGE TEST_JOB_ID

Lihat juga

Referensi lainnya

Untuk mengetahui informasi selengkapnya tentang transfer data yang dimulai pengguna, lihat referensi tambahan berikut: