Trang này được dịch bởi Cloud Translation API.

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

Để 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:

Đảm bảo rằng ứng dụng của bạn đã khai báo JobService và các quyền liên quan 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 để chuyển dữ liệu:

Kotlin

class CustomTransferService : JobService() {
  ...
}

Java

class CustomTransferService extends JobService() {

    ....

}

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>

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

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

Đị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 sẽ chuyển, 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:

Xác định rõ các quy tắc ràng buộc đối với mạng và quy tắc ràng buộc đối với việc thực thi công việc để chỉ định thời điểm cần thực thi công việc.
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.
Để 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ù 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

Cả người dùng và hệ thống đều có thể ngừng các công việc chuyển dữ liệu do người dùng khởi tạo.

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

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

Để hỗ trợ các công việc (job) chạy ở điểm tối ưu, Android cho phép chỉ định các quy tắc ràng buộc cho từng loại công việc. Các quy tắc ràng buộc này có sẵn kể từ Android 13.

Lưu ý: Bảng sau đây chỉ so sánh những quy tắc ràng buộc có sự khác biệt giữa từng kiểu công việc. Hãy xem trang dành cho nhà phát triển JobScheduler hoặc các quy tắc ràng buộc đối với công việc để tìm hiểu tất cả quy tắc ràng buộc.

Bảng sau đây trình bày các kiểu công việc hỗ trợ một quy tắc ràng buộc nhất định đối với công việc, cũng như tập hợp các quy tắc ràng buộc công việc mà WorkManager hỗ trợ. Hãy sử dụng thanh tìm kiếm phía trước bảng để lọc bảng theo tên phương thức ràng buộc công việc.

Sau đây là những quy tắc ràng buộc được phép đối với các công việc chuyển dữ liệu do người dùng khởi xướng:

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:

Nghiên cứu điển hình về việc tích hợp UIDT: Google Maps cải thiện độ tin cậy khi tải xuống thêm 10% bằng cách sử dụng API chuyển dữ liệu do người dùng yêu cầu

Chuyển dữ liệu do người dùng yêu cầu Sử dụng bộ sưu tập để sắp xếp ngăn nắp các trang Lưu và phân loại nội dung dựa trên lựa chọn ưu tiên của bạn.

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

Kotlin

Java

Kotlin

Java

Kotlin

Java

Đề xuất

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

Kotlin

Java

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

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

Do hệ thống

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

Thử nghiệm

Xem thêm

Tài nguyên khác

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