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

Obecnie nie ma biblioteki Jetpack, która obsługuje zadania UIDT. Z tego powodu zalecamy ograniczenie zmiany za pomocą kodu, który sprawdza, czy używasz Androida 14 lub nowszego. W starszych wersjach 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ń

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,

W przeciwieństwie do zwykłych zadań na zadania przenoszenia danych inicjowane przez użytkownika nie mają wpływu limity zasobników gotowości aplikacji. System nadal jednak zatrzymuje zadanie, jeśli wystąpi którykolwiek z tych warunków:

  • Zdefiniowane przez dewelopera ograniczenie nie jest już spełnione.
  • System stwierdza, że zadanie trwało dłużej niż było to konieczne do ukończenia zadania przesyłania danych.
  • System musi traktować priorytetowo stan systemu i zatrzymywać zadania z powodu zwiększonego stanu termicznego.
  • Proces aplikacji zostaje zakończony z powodu małej ilości pamięci urządzenia.

Jeśli zadanie zostanie zatrzymane przez system z przyczyn innych niż mała ilość pamięci urządzenia, system wywoła funkcję onStopJob() i ponowi próbę wykonania zadania w optymalnym czasie. Upewnij się, że aplikacja może zachować stan przesyłania danych nawet wtedy, gdy funkcja onStopJob() nie jest wywoływana, oraz że może przywrócić ten stan, gdy funkcja onStartJob() zostanie ponownie wywołana.

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

Aplikacje mogą inicjować zadania przesyłania danych inicjowane przez użytkownika tylko wtedy, gdy są widoczne lub gdy są spełnione określone warunki:

  • Jeśli aplikacja może uruchamiać działania w tle, może też uruchamiać zadania przesyłania danych inicjowane przez użytkownika w tle.
  • Jeśli aplikacja ma aktywność w dolnej części stosu istniejącego zadania na ekranie Ostatnie, nie oznacza to, że zadanie przesyłania danych inicjowane przez użytkownika może zostać uruchomione.

Jeśli zadanie jest zaplanowane do wykonania w czasie, gdy nie są spełnione niezbędne warunki, zadanie się nie powiedzie i zwróci kod błędu 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

Na liście poniżej znajdziesz instrukcje ręcznego testowania zadań aplikacji:

  • Aby uzyskać identyfikator zadania, pobierz wartość zdefiniowaną przy tworzeniu zadania.

  • Aby od razu uruchomić zadanie lub ponownie uruchomić zatrzymane zadanie, uruchom następujące polecenie w oknie terminala:

    adb shell cmd jobscheduler run -f APP_PACKAGE_NAME JOB_ID

  • Aby symulować zatrzymanie zadania przez system (ze względu na stan systemu lub w warunkach braku limitu), uruchom to polecenie w oknie terminala:

    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: