Chuyển dữ liệu do người dùng yêu cầu

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.

Lên lịch cho công việc chuyển dữ liệu do người dùng khởi tạo

To run a user initiated data-transfer job, do the following:

  1. Make sure your app has declared the JobService and associated permissions in its manifest:

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

    Also, define a concrete subclass of JobService for your data transfer:

    Kotlin

    class CustomTransferService : JobService() {
  ...
}

    Java

    class CustomTransferService extends JobService() {

    ....

}

  2. Declare the RUN_USER_INITIATED_JOBS permission in the manifest:

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

  3. Call the setUserInitiated() method when building a JobInfo object. (This method is available beginning with Android 14.) We also recommend that you offer a payload size estimate by calling setEstimatedNetworkBytes() while creating your job.

    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, CustomTransferService.class))
    // ...
    .setUserInitiated(true)
    .setRequiredNetwork(networkRequest)
    // Provide your estimate of the network traffic here
    .setEstimatedNetworkBytes(1024 * 1024 * 1024)
    // ...
    .build();

  4. While the job is being executed, call setNotification() on the JobService object. Calling setNotification() makes the user aware that the job is running, both in the Task Manager and in the status bar notification area.

    When execution is complete, call jobFinished() to signal to the system that the job is complete, or that the job should be rescheduled.

    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. Periodically update the notification to keep the user informed of the job's status and progress. If you cannot determine the transfer size ahead of scheduling the job, or need to update the estimated transfer size, use the new API, updateEstimatedNetworkBytes() to update the transfer size after it becomes known.

Recommendations

To run UIDT jobs effectively, do the following:

  1. Clearly define network constraints and job execution constraints to specify when the job should be executed.

  2. Execute the task asynchronously in onStartJob(); for example, you can do this by using a coroutine. If you don't run the task asynchronously, the work runs on the main thread and might block it, which can cause an ANR.

  3. To avoid running the job longer than necessary, call jobFinished() when the transfer finishes, whether it succeeds or fails. That way, the job doesn't run longer than necessary. To discover why a job was stopped, implement the onStopJob() callback method and call JobParameters.getStopReason().

Khả năng tương thích ngược

Hiện không có thư viện Jetpack nào hỗ trợ các tác vụ UIDT. Vì lý do này, bạn nên kiểm soát thay đổi bằng mã xác minh rằng bạn đang chạy trên Android 14 trở lên. Trên các phiên bản Android thấp hơn, bạn có thể sử dụng chế độ triển khai dịch vụ trên nền trước của WorkManager làm phương pháp dự phòng.

Dưới đây là ví dụ về mã kiểm tra phiên bản hệ thống thích hợp:

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

Dừng các công việc UIDT

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

Do người dùng đưa ra trên Trình quản lý tác vụ

Người dùng có thể dừng công việc chuyển dữ liệu do người dùng khởi xướng xuất hiện trong Task Manager (Trình quản lý tác vụ).

Tại thời điểm người dùng nhấn vào Stop (Dừng), hệ thống sẽ thực hiện những việc sau:

  • Ngay lập tức chấm dứt quá trình của ứng dụng (kể cả mọi công việc khác hoặc dịch vụ trên nền trước đang chạy).
  • Không gọi onStopJob() cho mọi công việc đang chạy.
  • Ngăn không cho các công việc mà người dùng có thể nhìn thấy được lên lịch lại.

Vì những lý do này, bạn nên cung cấp chế độ kiểm soát trong thông báo đã đăng cho công việc để cho phép ngừng và lên lịch lại công việc một cách linh hoạt.

Xin lưu ý rằng trong một số trường hợp đặc biệt, nút Stop (Dừng) sẽ không xuất hiện bên cạnh công việc trong Task Manager (Trình quản lý tác vụ), hoặc công việc đó sẽ không xuất hiện trong Task Manager (Trình quản lý tác vụ).

Do hệ thống

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.

Các điều kiện được cho phép để lên lịch công việc chuyển dữ liệu do người dùng khởi tạo

Các ứng dụng chỉ có thể bắt đầu công việc chuyển dữ liệu do người dùng khởi tạo nếu nằm trong cửa sổ hiển thị, hoặc nếu đáp ứng được một số điều kiện nhất định:

  • Nếu một ứng dụng có thể khởi chạy các hoạt động ở chế độ nền, thì các hoạt động đó cũng có thể chạy các công việc chuyển dữ liệu do người dùng khởi tạo ở chế độ nền.
  • Nếu một ứng dụng có hoạt động trong ngăn xếp lui của một tác vụ hiện có trên màn hình Gần đây, thì chỉ vậy là chưa đủ để cho phép chạy công việc chuyển dữ liệu do người dùng khởi tạo.

Nếu bạn lên lịch chạy công việc vào thời điểm không đáp ứng các điều kiện cần thiết, thì công việc đó sẽ không thành công và trả về mã lỗi RESULT_FAILURE.

Các hạn chế được cho phép đối với công việc chuyển dữ liệu do người dùng khởi tạo

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

Thử nghiệm

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

Xem thêm

Tài nguyên khác

Để biết thêm thông tin về hoạt động chuyển dữ liệu do người dùng bắt đầu, hãy xem các tài nguyên bổ sung sau: