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

Nếu cần thực hiện một hoạt động chuyển dữ liệu có thể mất nhiều thời gian, bạn có thể tạo một lệnh JobScheduler và xác định lệnh đó là lệnh chuyển dữ liệu do người dùng yêu cầu (UIDT). Các lệnh UIDT được thiết kế để chuyển dữ liệu trong thời gian dài do người dùng thiết bị yêu cầu, chẳng hạn như tải tệp xuống từ máy chủ từ xa. Các tác vụ UIDT được ra mắt cùng với Android 14 (cấp độ API 34).

Công việc chuyển dữ liệu do người dùng khởi tạo là công việc do người dùng đưa ra yêu cầu. Các công việc này đòi hỏi phải có thông báo, bắt đầu ngay lập tức và có thể chạy trong một khoảng thời gian dài nếu điều kiện của hệ thống cho phép. Bạn có thể chạy đồng thời một vài công việc chuyển dữ liệu do người dùng khởi tạo.

Các công việc do người dùng khởi tạo phải được lên lịch trong khi ứng dụng đang hiển thị cho người dùng (hoặc trong một trong các điều kiện được cho phép). Sau khi bạn đáp ứng tất cả các điều kiện ràng buộc, các hoạt động do người dùng yêu cầu có thể được hệ điều hành thực thi, tuân theo các hạn chế về tình trạng của hệ thống. Hệ thống cũng có thể sử dụng kích thước tải trọng ước tính được cung cấp để xác định thời gian thực hiện công việc này.

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

Để chạy một công việc chuyển dữ liệu do người dùng khởi tạo, hãy làm như sau:

  1. Đảm bảo rằng ứng dụng của bạn đã khai báo JobService và các quyền liên kết trong tệp kê khai:

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

    Ngoài ra, hãy xác định một lớp con cụ thể của JobService để truyền dữ liệu:

    Kotlin

    class CustomTransferService : JobService() {
  ...
}

    Java

    class CustomTransferService extends JobService() {

    ....

}

  2. Khai báo quyền RUN_USER_INITIATED_JOBS trong tệp kê khai:

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

  3. Gọi phương thức setUserInitiated() khi tạo một đối tượng JobInfo. (Phương thức này có từ Android 14.) Bạn cũng nên ước tính kích thước tải trọng bằng cách gọi setEstimatedNetworkBytes() trong khi tạo công việc.

    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. Khi công việc đang được thực thi, hãy gọi setNotification() trên đối tượng JobService. Việc gọi setNotification() giúp người dùng biết rằng công việc đang chạy, cả trong Trình quản lý tác vụ và trong vùng thông báo của thanh trạng thái.

    Khi thực thi xong, hãy gọi jobFinished() để báo cho hệ thống biết rằng công việc này đã hoàn tất hoặc cần lên lịch lại cho công việc đó.

    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. Định kỳ cập nhật thông báo để cho người dùng biết về trạng thái và tiến trình của công việc. Nếu bạn không xác định được kích thước tải trọng sẽ chuyển trước khi lên lịch hoặc cần cập nhật kích thước tải trọng ước tính, hãy sử dụng API mới (updateEstimatedNetworkBytes()) để cập nhật kích thước tải trọng sẽ chuyển sau khi xác định được.

Đề xuất

Để chạy các công việc UIDT một cách hiệu quả, hãy làm như sau:

  1. Xác định rõ các quy tắc ràng buộc về mạng và quy tắc ràng buộc về việc thực thi công việc để chỉ định thời điểm cần thực thi công việc.

  2. Thực thi tác vụ không đồng bộ trong onStartJob(); ví dụ: bạn có thể thực hiện việc này bằng cách sử dụng một coroutine. Nếu bạn không chạy tác vụ không đồng bộ, thì tác vụ sẽ chạy trên luồng chính và có thể chặn luồng này, dẫn đến lỗi ANR.

  3. Để tránh chạy công việc lâu hơn mức cần thiết, hãy gọi jobFinished() khi quá trình chuyển hoàn tất, cho dù quá trình đó thành công hay không. Bằng cách đó, công việc sẽ không chạy lâu hơn mức cần thiết. Để biết lý do một công việc bị dừng, hãy triển khai phương thức gọi lại onStopJob() và gọi JobParameters.getStopReason().

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

There is currently no Jetpack library that supports UIDT jobs. For this reason, we recommend that you gate your change with code that verifies that you're running on Android 14 or higher. On lower Android versions, you can use WorkManager's foreground service implementation as a fallback approach.

Here's an example of code that checks for the appropriate system version:

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ụ

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.

Do hệ thống

Khác với các công việc thông thường, công việc chuyển dữ liệu do người dùng khởi tạo sẽ không bị ảnh hưởng bởi hạn mức Bộ chứa chế độ chờ ứng dụng (App Standby Buckets). Tuy nhiên, hệ thống vẫn sẽ dừng công việc đó trong điều kiện bất kỳ sau đây:

  • Không còn đáp ứng quy tắc ràng buộc do nhà phát triển xác định nữa.
  • Hệ thống xác định rằng công việc đã chạy lâu hơn mức cần thiết để hoàn tất tác vụ chuyển dữ liệu.
  • Tình trạng của hệ thống là vấn đề cần ưu tiên, đồng dừng công việc do nhiệt độ tăng.
  • Dừng quá trình của ứng dụng do còn ít bộ nhớ trên thiết bị.

Khi hệ thống dừng công việc vì những lý do khác với việc thiết bị còn ít bộ nhớ, hệ thống sẽ gọi onStopJob() và thử lại công việc đó vào thời điểm hệ thống cho là tối ưu. Đảm bảo rằng ứng dụng của bạn có thể duy trì trạng thái chuyển dữ liệu ngay cả khi onStopJob() không được gọi, cũng như có thể khôi phục trạng thái này khi onStartJob() được gọi lại.

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

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.

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

Danh sách sau đây trình bày một số bước kiểm thử công việc của ứng dụng theo cách thủ công:

  • Để có mã công việc, hãy lấy giá trị được xác định cho công việc đang được tạo.

  • Để chạy một công việc ngay lập tức hoặc để thử lại một công việc đã dừng, hãy chạy lệnh sau trong cửa sổ dòng lệnh:

    adb shell cmd jobscheduler run -f APP_PACKAGE_NAME JOB_ID

  • Để mô phỏng việc hệ thống buộc dừng công việc (do tình trạng hệ thống hoặc hết thời hạn), hãy chạy lệnh sau trong cửa sổ dòng lệnh:

    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: