使用者啟動的資料移轉

如要執行可能需要長時間的資料移轉作業，可以建立 JobScheduler 工作，並將其識別為使用者啟動的資料移轉 (UIDT) 工作。UIDT 工作適用於裝置使用者啟動的長時間資料轉移作業，例如從遠端伺服器下載檔案。Android 14 (API 級別 34) 導入了 UIDT 工作。

顧名思義，使用者啟動的資料移轉工作是由使用者所發起的。這類工作會要求傳送通知並且要立即開始執行，如果系統條件允許，還可能會長時間執行。您可以同時執行多項使用者啟動的資料移轉工作。

當使用者具備應用程式的瀏覽權限時 (或符合任一許可條件)，則必須為使用者啟動的工作進行排程。滿足所有限制後，作業系統就能執行使用者啟動的工作，具體情況取決於系統健康狀態限制。此外，系統也能根據所提供的預估酬載大小，判斷執行工作的時間長度。

排定使用者啟動的資料移轉作業

如要執行使用者啟動的資料移轉作業，請按照下列步驟操作：

請確認應用程式已在資訊清單中宣告 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() {

    ....

}

在資訊清單中宣告 RUN_USER_INITIATED_JOBS 權限：

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

建構 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, 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();

執行工作時，請在 JobService 物件上呼叫 setNotification()。呼叫 setNotification() 會告知使用者工作正在工作管理員和狀態列通知區域執行中。

執行作業完成後，請呼叫 jobFinished() 以告知系統工作已經完成，或應重新為工作排程。

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

定期更新通知，讓使用者掌握工作狀態與進度。如果您無法在工作排程前確定轉移大小，或需要更新預估轉移大小，請使用新的 API updateEstimatedNetworkBytes() 更新已知的轉移大小。

建議

如要有效執行 UIDT 作業，請採取下列做法：

明確定義網路限制和工作執行限制，指定工作執行時間。
在 onStartJob() 中以非同步方式執行工作；舉例來說，您可以使用協同程式執行這項操作。如果沒有非同步執行工作，工作就會在主執行緒上執行，並可能封鎖主執行緒，進而導致 ANR。
為避免工作執行時間過長，請在移轉完成時呼叫 jobFinished()，無論移轉成功或失敗都一樣。這樣一來，工作就不會執行過久。如要瞭解工作停止的原因，請實作 onStopJob() 回呼方法，並呼叫 JobParameters.getStopReason()。

回溯相容性

目前沒有支援 UIDT 作業的 Jetpack 程式庫。因此，建議您使用程式碼控管變更，確認您是在 Android 14 以上版本上執行作業。在較舊的 Android 版本中，您可以使用 WorkManager 的前景服務實作做為備用方法。

以下是檢查適當系統版本的程式碼範例：

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

停止 UIDT 工作

用户和系统都可以停止用户发起的传输作业。

由工作管理員的使用者執行

使用者可以停止在工作管理員中顯示的使用者啟動資料移轉作業。

當使用者按下「停止」時，系統會執行以下操作：

立即終止應用程式的處理程序，包括所有其他執行中的工作或前景服務。
不會針對任何執行中的工作呼叫 onStopJob()。
防止使用者開放瀏覽權限的工作重新排程。

基於上述理由，建議您針對工作發布的通知中提供控制項，以便有條理地停止工作並重新排程。

請注意，在特殊情況下，工作管理員中所列的工作旁不會顯示「停止」按鈕，抑或工作完全沒有顯示在工作管理員中。

由系統執行

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

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

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

可對使用者啟動的資料移轉作業進行排程的情況

只有当应用处于可见窗口中或满足特定条件时，应用才能启动用户发起的数据传输作业：

如果应用可以从后台启动 activity，则也可以从后台启动用户发起的数据传输作业。
如果应用在最近用过屏幕上现有任务的返回堆栈中有 activity，单靠这一点并不允许运行用户发起的数据传输作业。

如果作业安排在未满足必要条件的时间运行，则作业将失败并返回 RESULT_FAILURE 错误代码。