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

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

  1. 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() {

    ....

}

  2. Deklarasikan izin RUN_USER_INITIATED_JOBS dalam manifes:

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

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

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

  5. 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:

  1. Tentukan batasan jaringan dan batasan eksekusi tugas dengan jelas untuk menentukan kapan tugas harus dieksekusi.

  2. 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.

  3. 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

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

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.

Kondisi yang diizinkan untuk menjadwalkan tugas transfer data yang dimulai pengguna

Apps can only start a user-initiated data transfer job if the app is in the visible window, or if certain conditions are met:

  • If an app can launch activities from the background, it can also launch user-initiated data transfer jobs from the background.
  • If an app has an activity in the back stack of an existing task on the Recents screen, that alone doesn't allow a user-initiated data transfer job to run.

If the job is scheduled to run at a time when the necessary conditions are not met, the job fails and returns a RESULT_FAILURE error code.

Batasan yang diizinkan untuk tugas transfer data yang dimulai pengguna

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

Pengujian

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

Lihat juga

Referensi lainnya

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