Transfer data yang dimulai pengguna

如果您需要执行可能需要很长时间的数据传输，可以创建 JobScheduler 作业，并将其标识为由用户发起的数据传输 (UIDT) 作业。UIDT 作业适用于由设备用户发起的持续时间较长的数据传输，例如从远程服务器下载文件。UIDT 作业是在 Android 14（API 级别 34）中引入的。

由用户发起的数据传输作业由用户启动。这些作业需要一个通知，会立即启动，并且可能在系统条件允许的情况下长时间运行。您可以同时运行多个由用户发起的数据传输作业。

必须在应用对用户可见的情况下（或在某个允许的条件下）安排由用户发起的作业。满足所有限制条件后，操作系统可以执行由用户发起的作业，具体取决于系统运行状况限制。系统还可以根据提供的估算载荷大小来确定作业的执行时长。

Menjadwalkan tugas transfer data yang dimulai pengguna

Untuk menjalankan tugas transfer data yang dimulai pengguna, lakukan hal berikut:

Pastikan aplikasi Anda telah mendeklarasikan JobService dan izin terkait dalam manifesnya:

<service android:name="com.example.app.CustomTransferService"
        android:permission="android.permission.BIND_JOB_SERVICE"
        android:exported="false">
        ...
</service>

Selain itu, tentukan subclass konkret JobService untuk transfer data Anda:

Kotlin

class CustomTransferService : JobService() {
  ...
}

Java

class CustomTransferService extends JobService() {

    ....

}

Deklarasikan izin RUN_USER_INITIATED_JOBS dalam manifes:

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

Panggil metode setUserInitiated() saat membuat objek JobInfo. (Metode ini tersedia mulai dari Android 14.) Sebaiknya Anda juga menawarkan estimasi ukuran payload dengan memanggil setEstimatedNetworkBytes() saat membuat tugas.

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

Saat tugas sedang dieksekusi, panggil setNotification() pada objek JobService. Memanggil setNotification() membuat pengguna menyadari bahwa tugas sedang berjalan, baik di Pengelola Tugas maupun di area notifikasi status bar.

Setelah eksekusi selesai, panggil jobFinished() untuk memberi tahu sistem bahwa tugas telah selesai, atau tugas tersebut harus dijadwalkan ulang.

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
    }
}

Perbarui notifikasi secara berkala untuk terus memberikan informasi kepada pengguna tentang status dan progres tugas. Jika Anda tidak dapat menentukan ukuran transfer sebelum menjadwalkan tugas, atau perlu memperbarui perkiraan ukuran transfer, gunakan API baru, updateEstimatedNetworkBytes(), untuk memperbarui ukuran transfer setelah diketahui.

Rekomendasi

Untuk menjalankan tugas UIDT secara efektif, lakukan hal berikut:

Tentukan batasan jaringan dan batasan eksekusi tugas dengan jelas untuk menentukan kapan tugas harus dieksekusi.
Jalankan tugas secara asinkron di onStartJob(); misalnya, Anda dapat melakukannya dengan menggunakan coroutine. Jika Anda tidak menjalankan tugas secara asinkron, pekerjaan akan berjalan di thread utama dan mungkin memblokirnya, yang dapat menyebabkan ANR.
Untuk menghindari menjalankan tugas lebih lama dari yang diperlukan, panggil jobFinished() saat transfer selesai, baik berhasil maupun gagal. Dengan begitu, tugas tidak berjalan lebih lama dari yang diperlukan. Untuk mengetahui alasan tugas dihentikan, terapkan metode callback onStopJob() dan panggil JobParameters.getStopReason().

Kompatibilitas mundur

Saat ini, tidak ada library Jetpack yang mendukung tugas UIDT. Oleh karena itu, sebaiknya batasi perubahan Anda dengan kode yang memverifikasi bahwa Anda menjalankan tugas di Android 14 atau yang lebih tinggi. Di versi Android yang lebih rendah, Anda dapat menggunakan penerapan layanan latar depan WorkManager sebagai strategi fallback.

Berikut contoh kode yang memeriksa versi sistem yang sesuai:

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

Pengguna dan sistem dapat menghentikan tugas transfer yang dimulai pengguna.

Oleh pengguna, dari Pengelola Tugas

Pengguna dapat menghentikan tugas transfer data yang dimulai pengguna dan muncul di Pengelola Tugas.

Saat pengguna menekan Stop, sistem akan melakukan hal berikut:

Menghentikan proses aplikasi Anda dengan segera, termasuk semua tugas lain atau layanan latar depan yang sedang berjalan.
Tidak memanggil onStopJob() untuk tugas yang sedang berjalan.
Mencegah tugas yang terlihat oleh pengguna agar tidak dijadwalkan ulang.

Oleh karena itu, sebaiknya berikan kontrol dalam notifikasi yang diposting untuk tugas itu guna memungkinkan penghentian dan penjadwalan ulang tugas dengan baik.

Perlu diperhatikan bahwa, dalam keadaan khusus, tombol Stop tidak akan muncul di samping tugas di Pengelola Tugas, atau tugas tidak ditampilkan sama sekali di Pengelola Tugas.

Oleh sistem

与常规作业不同，用户发起的数据传输作业不受应用待机模式存储分区配额的影响。但是，如果出现以下任一情况，系统仍会停止作业：

不再满足开发者定义的约束条件。
系统确定该作业的运行时间超出了完成数据传输任务所需的时间。
系统需要优先考虑系统运行状况，并因发热程度上升而停止作业。
应用进程因设备内存不足而被终止。

如果系统因设备内存不足以外的原因停止作业，系统会调用 onStopJob()，并在系统认为最佳的时间重试作业。确保您的应用可以保留数据传输状态（即使未调用 onStopJob()），并且您的应用可以在再次调用 onStartJob() 时恢复此状态。

Kondisi yang diizinkan untuk menjadwalkan tugas transfer data yang dimulai pengguna

Aplikasi hanya dapat memulai tugas transfer data yang dimulai pengguna jika aplikasi berada di jendela yang terlihat, atau jika kondisi tertentu terpenuhi:

Jika dapat meluncurkan aktivitas dari latar belakang, aplikasi juga dapat meluncurkan tugas transfer data yang dimulai pengguna dari latar belakang.
Jika aplikasi memiliki aktivitas di data sebelumnya dari tugas yang ada di layar Terbaru, hal tersebut tidak memungkinkan tugas transfer data yang dimulai pengguna dijalankan.

Jika tugas dijadwalkan untuk dijalankan pada saat kondisi yang diperlukan tidak terpenuhi, tugas akan gagal dan menampilkan kode error 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

Daftar berikut menunjukkan beberapa langkah untuk menguji tugas aplikasi secara manual:

Untuk mendapatkan ID tugas, dapatkan nilai yang ditentukan saat tugas di-build.
Untuk langsung menjalankan tugas, atau untuk mencoba kembali tugas yang dihentikan, jalankan perintah berikut di jendela terminal:
```
adb shell cmd jobscheduler run -f APP_PACKAGE_NAME JOB_ID
```
Untuk menyimulasikan penghentian paksa sebuah tugas oleh sistem (karena kondisi sistem atau kondisi kehabisan kuota), jalankan perintah berikut di jendela terminal:
```
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:

Studi kasus tentang integrasi UIDT: Google Maps meningkatkan keandalan download sebesar 10% menggunakan API transfer data yang dimulai oleh pengguna

Transfer data yang dimulai pengguna Tetap teratur dengan koleksi Simpan dan kategorikan konten berdasarkan preferensi Anda.

Menjadwalkan tugas transfer data yang dimulai pengguna

Kotlin

Java

Kotlin

Java

Kotlin

Java

Rekomendasi

Kompatibilitas mundur

Kotlin

Java

Menghentikan tugas UIDT

Oleh pengguna, dari Pengelola Tugas

Oleh sistem

Kondisi yang diizinkan untuk menjadwalkan tugas transfer data yang dimulai pengguna

Batasan yang diizinkan untuk tugas transfer data yang dimulai pengguna

Pengujian

Lihat juga

Referensi lainnya

Transfer data yang dimulai pengguna