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

Nếu cần thực hiện một lệnh 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ột máy chủ từ xa. Các tác vụ UIDT được ra mắt cùng với Android 14 (API cấp 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 (payload) ướ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

如需运行用户发起的数据传输作业,请执行以下操作:

  1. 确保您的应用已在其清单中声明 JobService 和关联的权限:

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

    此外,还要为数据转移定义 JobService 的具体子类:

    Kotlin

    class CustomTransferService : JobService() {
      ...
    }

    Java

    class CustomTransferService extends JobService() {
    
        ....
    
    }
  2. 在清单中声明 RUN_USER_INITIATED_JOBS 权限:

    <manifest ...>
        <uses-permission android:name="android.permission.RUN_USER_INITIATED_JOBS" />
        <application ...>
            ...
        </application>
    </manifest>
    
  3. 构建 JobInfo 对象时,调用 setUserInitiated() 方法。(此方法从 Android 14 开始提供。)我们还建议您在创建作业时通过调用 setEstimatedNetworkBytes() 提供载荷大小估算值。

    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, DownloadTransferService.class))
        // ...
        .setUserInitiated(true)
        .setRequiredNetwork(networkRequest)
        // Provide your estimate of the network traffic here
        .setEstimatedNetworkBytes(1024 * 1024 * 1024)
        // ...
        .build();
  4. 在作业执行期间,对 JobService 对象调用 setNotification()。调用 setNotification() 会在任务管理器和状态栏通知区域中告知用户作业正在运行。

    执行完成后,调用 jobFinished() 以向系统表明作业已完成,或者应重新调度作业。

    Kotlin

    class DownloadTransferService: 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 DownloadTransferService 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. 定期更新通知,让用户了解作业的状态和进度。如果在安排作业之前无法确定传输大小,或者需要更新估计的传输大小,请在知道传输大小之后使用新的 API updateEstimatedNetworkBytes() 更新传输大小。

建议

如需有效运行 UIDT 作业,请执行以下操作:

  1. 明确定义网络限制和作业执行限制,以指定作业的执行时间。

  2. onStartJob() 中异步执行任务;例如,您可以使用协程来执行此操作。如果您不异步运行任务,工作将在主线程上运行,可能会阻塞主线程,从而导致 ANR。

  3. 为避免作业运行时间过长,请在转移完成后(无论成功还是失败)调用 jobFinished()。这样,作业就不会运行过长时间。如需了解作业停止的原因,请实现 onStopJob() 回调方法并调用 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

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ụ

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

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

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

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

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: