Przenoszenie danych inicjowane przez użytkownika

Jeśli musisz przeprowadzić transfer danych, który może potrwać długo, możesz utworzyć zadanie JobScheduler i oznaczyć je jako zadanie przesyłania danych inicjowane przez użytkownika (UIDT). Zadania UIDT są przeznaczone do dłuższych transferów danych inicjowanych przez użytkownika urządzenia, np. pobierania pliku z serwera zdalnego. Zadania UIDT zostały wprowadzone w Androidzie 14 (poziom 34 interfejsu API).

Zadania przesyłania danych inicjowane przez użytkownika są uruchamiane przez użytkownika. Te zadania wymagają powiadomienia, rozpoczynają się natychmiast i mogą być wykonywane przez dłuższy czas, o ile pozwalają na to warunki systemowe. Możesz uruchomić kilka zadań przesyłania danych inicjowanych przez użytkownika jednocześnie.

Zadania inicjowane przez użytkownika muszą być zaplanowane, gdy aplikacja jest widoczna dla użytkownika (lub w jednym z dozwolonych warunków). Po spełnieniu wszystkich ograniczeń zadania inicjowane przez użytkownika mogą być wykonywane przez system operacyjny z zastrzeżeniem ograniczeń dotyczących kondycji systemu. System może też użyć podanego szacowanego rozmiaru ładunku, aby określić, jak długo będzie wykonywane zadanie.

Planowanie zadań przenoszenia danych inicjowanych przez użytkownika

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

  1. Sprawdź, czy aplikacja zadeklarowała JobService i powiązane uprawnienia w pliku manifestu:

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

    Zdefiniuj też konkretną podklasę JobService na potrzeby przesyłania danych:

    Kotlin

    class CustomTransferService : JobService() {
      ...
    }

    Java

    class CustomTransferService extends JobService() {
    
        ....
    
    }
  2. Zadeklaruj uprawnienie RUN_USER_INITIATED_JOBS w pliku manifestu:

    <manifest ...>
        <uses-permission android:name="android.permission.RUN_USER_INITIATED_JOBS" />
        <application ...>
            ...
        </application>
    </manifest>
    
  3. Podczas tworzenia obiektu JobInfo wywołaj metodę setUserInitiated(). (Ta metoda jest dostępna od Androida 14). Zalecamy też, aby podczas tworzenia zadania podać szacunkowy rozmiar ładunku , wywołując metodę 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();
  4. Podczas wykonywania zadania wywołaj setNotification() w obiekcie JobService. Wywołanie metody 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 wykonywania wywołaj metodę jobFinished(), aby poinformować system, że zadanie zostało ukończone lub że 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
        }
    }
  5. Okresowo aktualizuj powiadomienie, aby informować użytkownika o stanie i postępie 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:

  1. Jasno określ ograniczenia sieciowe i ograniczenia wykonywania zadań, aby określić, kiedy zadanie ma zostać wykonane.

  2. Wykonaj zadanie asynchronicznie w onStartJob(). Możesz to zrobić na przykład za pomocą współprogramu. Jeśli nie wykonasz zadania asynchronicznie, będzie ono działać w wątku głównym i może go zablokować, co może spowodować błąd ANR.

  3. Aby uniknąć wykonywania zadania dłużej niż to konieczne, wywołaj jobFinished() po zakończeniu transferu, niezależnie od tego, czy się on powiódł, czy nie. Dzięki temu zadanie nie będzie wykonywane dłużej niż to konieczne. Aby dowiedzieć się, dlaczego zadanie zostało zatrzymane, zaimplementuj onStopJob() metodę wywołania zwrotnego i wywołaj JobParameters.getStopReason().

Zgodność wsteczna

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

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ń

Użytkownik może zatrzymać zadanie przesyłania danych inicjowane przez użytkownika, które pojawia się w Menedżerze zadań.

Gdy użytkownik naciśnie Zatrzymaj, system wykona te czynności:

  • natychmiast zakończyć proces aplikacji, w tym wszystkie inne zadania lub usługi działające w tle;
  • Nie wywołuje funkcji onStopJob() w przypadku żadnych uruchomionych zadań.
  • Uniemożliwia przeplanowanie zadań widocznych dla użytkowników.

Z tego powodu zalecamy udostępnienie w powiadomieniu o zadaniu ustawień umożliwiających płynne zatrzymanie i przeplanowanie zadania.

Pamiętaj, że w szczególnych okolicznościach przycisk Zatrzymaj nie będzie widoczny obok zadania w Menedżerze zadań lub zadanie w ogóle nie będzie widoczne w Menedżerze zadań.

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ć zlecenia działające w optymalnych punktach, Android umożliwia przypisywanie ograniczeń do każdego typu zlecenia. Te ograniczenia są dostępne od Androida 13.

Uwaga: w tabeli poniżej 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 pracy.

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

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

Zobacz również

Dodatkowe materiały

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