Przenoszenie danych inicjowane przez użytkownika

如果您需要执行可能需要很长时间的数据传输，可以创建 JobScheduler 作业，并将其标识为由用户发起的数据传输 (UIDT) 作业。UIDT 作业适用于由设备用户发起的持续时间较长的数据传输，例如从远程服务器下载文件。UIDT 作业是在 Android 14（API 级别 34）中引入的。

由用户发起的数据传输作业由用户启动。这些作业需要一个通知，会立即启动，并且可能在系统条件允许的情况下长时间运行。您可以同时运行多个由用户发起的数据传输作业。

必须在应用对用户可见的情况下（或在某个允许的条件下）安排由用户发起的作业。满足所有限制条件后，操作系统可以执行由用户发起的作业，具体取决于系统运行状况限制。系统还可以根据提供的估算载荷大小来确定作业的执行时长。

Planowanie zadań przenoszenia danych inicjowanych przez użytkownika

Aby uruchomić zadanie przesyłania danych inicjowane przez użytkownika:

Upewnij się, że w pliku manifestu aplikacji zadeklarowano JobService i powiązane uprawnienia:

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

Określ też konkretną podklasę JobService dla transferu danych:

Kotlin

class CustomTransferService : JobService() {
  ...
}

Java

class CustomTransferService extends JobService() {

    ....

}

Zadeklaruj uprawnienie RUN_USER_INITIATED_JOBS w pliku manifestu:

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

Podczas tworzenia obiektu JobInfo wywołaj metodę setUserInitiated(). (Ta metoda jest dostępna od Androida 14). Zalecamy też podanie szacunkowego rozmiaru ładunku, wywołując funkcję setEstimatedNetworkBytes() podczas tworzenia zadania.

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

Podczas wykonywania zadania wywołaj funkcję setNotification() w obiekcie JobService. Wywołanie funkcji setNotification() informuje użytkownika o tym, że zadanie jest wykonywane, zarówno w Menedżerze zadań, jak i w obszarze powiadomień na pasku stanu.

Po zakończeniu wykonania wywołaj funkcję jobFinished(), aby poinformować system, że zadanie zostało wykonane lub należy je ponownie zaplanować.

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

Okresowo aktualizuj powiadomienie, aby informować użytkownika o stanie i postępach zadania. Jeśli nie możesz określić rozmiaru transferu przed zaplanowaniem zadania lub musisz zaktualizować szacowany rozmiar transferu, użyj nowego interfejsu API updateEstimatedNetworkBytes(), aby zaktualizować rozmiar transferu po jego ustaleniu.

Rekomendacje

Aby skutecznie uruchamiać zadania UIDT:

Jasno określ wymogi związane z siecią i ograniczenia wykonywania zadań, aby określić, kiedy zadanie powinno zostać wykonane.
Wykonaj zadanie asynchronicznie w onStartJob(). Możesz to zrobić na przykład za pomocą współprogramu. Jeśli nie uruchomisz zadania asynchronicznie, będzie ono wykonywane w wątku głównym i może go zablokować, co może spowodować błąd ANR.
Aby uniknąć niepotrzebnego przedłużania czasu trwania zadania, po zakończeniu transferu wywołaj funkcję jobFinished(), niezależnie od tego, czy transfer się powiódł, czy nie. Dzięki temu zadanie nie będzie uruchomione dłużej niż to konieczne. Aby dowiedzieć się, dlaczego zadanie zostało zatrzymane, zaimplementuj metodę wywołania zwrotnego onStopJob() i wywołaj JobParameters.getStopReason().

Zgodność wsteczna

Obecnie nie ma biblioteki Jetpack, która obsługuje zadania UIDT. Z tego powodu zalecamy ograniczenie zmiany za pomocą kodu, który sprawdza, czy aplikacja działa na Androidzie 14 lub nowszym. W przypadku starszych wersji Androida możesz użyć implementacji usługi na pierwszym planie w WorkManagerze jako metody rezerwowej.

Oto przykład kodu, który sprawdza odpowiednią wersję systemu:

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

Zatrzymywanie zadań UIDT

Zarówno użytkownik, jak i system mogą zatrzymać zadania transferu zainicjowane przez użytkownika.

Przez użytkownika w Menedżerze zadań

用户可以停止显示在任务管理器中的用户发起的传输作业。

在用户按 Stop 时，系统会执行以下操作：

立即终止应用的进程，包括正在运行的所有其他作业或前台服务。
不针对任何正在运行的作业调用 onStopJob()。
阻止重新调度用户可见的作业。

因此，建议在发布的作业通知中提供控件，以便顺利停止和重新调度作业。

请注意，在特殊情况下，Stop 按钮不会显示在任务管理器中的作业旁边，或者该作业根本不会显示在任务管理器中。

przez system,

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

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

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

Warunki, które muszą być spełnione, aby można było zaplanować zadania przesyłania danych inicjowane przez użytkownika

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

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

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

Ograniczenia dozwolone w przypadku zadań przesyłania danych inicjowanych przez użytkownika

Aby obsługiwać zadania uruchamiane w optymalnych momentach, Android umożliwia przypisywanie ograniczeń do każdego typu zadania. Te ograniczenia są dostępne od Androida 13.

Uwaga: w tej tabeli porównano tylko ograniczenia, które różnią się w zależności od typu zadania. Wszystkie ograniczenia znajdziesz na stronie dla deweloperów JobScheduler lub w sekcji ograniczenia zadań.

W tabeli poniżej znajdziesz różne typy zadań, które obsługują dane ograniczenie zadania, a także zestaw ograniczeń zadań obsługiwanych przez WorkManager. Użyj paska wyszukiwania przed tabelą, aby filtrować tabelę według nazwy metody ograniczenia zadania.

Oto ograniczenia dozwolone w przypadku zadań przesyłania danych inicjowanych przez użytkownika:

setBackoffCriteria(JobInfo.BACKOFF_POLICY_EXPONENTIAL)
setClipData()
setEstimatedNetworkBytes()
setMinimumNetworkChunkBytes()
setPersisted()
setNamespace()
setRequiredNetwork()
setRequiredNetworkType()
setRequiresBatteryNotLow()
setRequiresCharging()
setRequiresStorageNotLow()

Testowanie

下面列出了有关如何手动测试应用作业的一些步骤：

如需获取作业 ID，请获取在构建作业时定义的值。
如需立即运行作业或重试已停止的作业，请在终端窗口中运行以下命令：
```
adb shell cmd jobscheduler run -f APP_PACKAGE_NAME JOB_ID
```
如需模拟系统强行停止作业（由于系统运行状况或超出配额条件），请在终端窗口中运行以下命令：
```
adb shell cmd jobscheduler timeout TEST_APP_PACKAGE TEST_JOB_ID
```

Zobacz również

Dodatkowe materiały

Więcej informacji o zainicjowanych przez użytkownika transferach danych znajdziesz w tych dodatkowych materiałach:

Studium przypadku dotyczące integracji UIDT: dzięki interfejsowi User Initiated Data Transfer API Mapy Google zwiększyły niezawodność pobierania o 10%

Przenoszenie danych inicjowane przez użytkownika Zadbaj o dobrą organizację dzięki kolekcji Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.

Planowanie zadań przenoszenia danych inicjowanych przez użytkownika

Kotlin

Java

Kotlin

Java

Kotlin

Java

Rekomendacje

Zgodność wsteczna

Kotlin

Java

Zatrzymywanie zadań UIDT

Przez użytkownika w Menedżerze zadań

przez system,

Warunki, które muszą być spełnione, aby można było zaplanować zadania przesyłania danych inicjowane przez użytkownika

Ograniczenia dozwolone w przypadku zadań przesyłania danych inicjowanych przez użytkownika

Testowanie

Zobacz również

Dodatkowe materiały

Przenoszenie danych inicjowane przez użytkownika