Google verwendet KI-Technologie, um Inhalte in Ihre bevorzugte Sprache zu übersetzen. KI-Übersetzungen können Fehler enthalten.

Vom Nutzer initiierte Datenübertragung

Wenn Sie eine Datenübertragung durchführen müssen, die lange dauern kann, können Sie einen JobScheduler-Job erstellen und ihn als vom Nutzer initiierte Datenübertragung (UIDT) kennzeichnen. UIDT-Jobs sind für länger dauernde Datenübertragungen vorgesehen, die vom Gerätenutzer initiiert werden, z. B. das Herunterladen einer Datei von einem Remote-Server. UIDT-Jobs wurden mit Android 14 (API‑Level 34) eingeführt.

Vom Nutzer initiierte Datenübertragungsvorgänge werden vom Nutzer gestartet. Für diese Jobs ist eine Benachrichtigung erforderlich. Sie werden sofort gestartet und können unter Umständen über einen längeren Zeitraum ausgeführt werden, sofern die Systembedingungen dies zulassen. Sie können mehrere vom Nutzer initiierte Datenübermittlungsvorgänge gleichzeitig ausführen.

Von Nutzern initiierte Jobs müssen geplant werden, während die Anwendung für den Nutzer sichtbar ist oder unter einer der zulässigen Bedingungen. Wenn alle Einschränkungen erfüllt sind, können vom Nutzer initiierte Jobs vom Betriebssystem ausgeführt werden, sofern keine Einschränkungen aufgrund des Systemzustands vorliegen. Das System kann die angegebene geschätzte Nutzlastgröße auch verwenden, um die Ausführungsdauer des Jobs zu bestimmen.

Vom Nutzer initiierte Datenübertragungsvorgänge planen

So führen Sie einen vom Nutzer initiierten Datenübertragungsjob aus:

Ihre App muss die JobService und die zugehörigen Berechtigungen in ihrem Manifest deklariert haben:

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

Definieren Sie außerdem eine konkrete Unterklasse von JobService für die Datenübertragung:

Kotlin

class CustomTransferService : JobService() {
  ...
}

Java

class CustomTransferService extends JobService() {

    ....

}

Deklarieren Sie die Berechtigung RUN_USER_INITIATED_JOBS im Manifest:

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

Rufen Sie die Methode setUserInitiated() auf, wenn Sie ein JobInfo-Objekt erstellen. Diese Methode ist ab Android 14 verfügbar. Wir empfehlen außerdem, beim Erstellen des Jobs eine Schätzung der Nutzlastgröße durch Aufrufen von setEstimatedNetworkBytes() anzubieten.

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

Rufen Sie während der Ausführung des Jobs setNotification() für das JobService-Objekt auf. Durch den Aufruf von setNotification() wird der Nutzer sowohl im Task-Manager als auch im Benachrichtigungsbereich der Statusleiste darüber informiert, dass der Job ausgeführt wird.

Rufen Sie nach Abschluss der Ausführung jobFinished() auf, um dem System zu signalisieren, dass der Job abgeschlossen ist oder neu geplant werden soll.

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

Aktualisieren Sie die Benachrichtigung regelmäßig, um den Nutzer über den Status und Fortschritt des Jobs auf dem Laufenden zu halten. Wenn Sie die Übertragungsgröße nicht vor dem Planen des Jobs ermitteln können oder die geschätzte Übertragungsgröße aktualisieren müssen, verwenden Sie die neue API updateEstimatedNetworkBytes(), um die Übertragungsgröße zu aktualisieren, sobald sie bekannt ist.

Empfehlungen

So führen Sie UIDT-Jobs effektiv aus:

Definieren Sie Netzwerk- und Jobausführungseinschränkungen, um festzulegen, wann der Job ausgeführt werden soll.
Führen Sie die Aufgabe asynchron in onStartJob() aus. Dazu können Sie beispielsweise eine Coroutine verwenden. Wenn Sie die Aufgabe nicht asynchron ausführen, wird sie im Hauptthread ausgeführt und kann ihn blockieren, was zu einem ANR-Fehler führen kann.
Damit der Job nicht länger als nötig ausgeführt wird, rufen Sie jobFinished() auf, wenn die Übertragung abgeschlossen ist, unabhängig davon, ob sie erfolgreich war oder fehlgeschlagen ist. So wird der Job nicht länger als nötig ausgeführt. Wenn Sie herausfinden möchten, warum ein Job beendet wurde, implementieren Sie die Callback-Methode onStopJob() und rufen Sie JobParameters.getStopReason() auf.

Abwärtskompatibilität

Derzeit gibt es keine Jetpack-Bibliothek, die UIDT-Jobs unterstützt. Aus diesem Grund empfehlen wir, Ihre Änderung mit Code zu versehen, der prüft, ob Sie Android 14 oder höher verwenden. Bei niedrigeren Android-Versionen können Sie die Implementierung des Dienstes im Vordergrund von WorkManager als Fallback-Ansatz verwenden.

Hier ist ein Beispiel für Code, der die entsprechende Systemversion prüft:

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-Jobs beenden

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

Vom Nutzer über den Task-Manager

Der Nutzer kann einen vom Nutzer initiierten Datenübertragungsvorgang beenden, der im Task-Manager angezeigt wird.

Wenn der Nutzer auf Stopp drückt, geschieht Folgendes:

Der Prozess Ihrer App wird sofort beendet, einschließlich aller anderen Jobs oder Dienste im Vordergrund.
onStopJob() wird für keine laufenden Jobs aufgerufen.
Verhindert, dass nutzersichtbare Jobs neu geplant werden.

Aus diesen Gründen wird empfohlen, in der Benachrichtigung für den Job Steuerelemente bereitzustellen, mit denen der Job ordnungsgemäß beendet und neu geplant werden kann.

Unter bestimmten Umständen wird die Schaltfläche Beenden nicht neben dem Job im Task-Manager angezeigt oder der Job wird im Task-Manager gar nicht angezeigt.

Vom System

Unlike regular jobs, user-initiated data transfer jobs are unaffected by App Standby Buckets quotas. However, the system still stops the job if any of the following conditions occur:

A developer-defined constraint is no longer met.
The system determines that the job has run for longer than necessary to complete the data transfer task.
The system needs to prioritize system health and stop jobs due to increased thermal state.
The app process is killed due to low device memory.

When the job is stopped by the system for reasons other than low device memory, the system calls onStopJob(), and the system retries the job at a time that the system deems to be optimal. Make sure that your app can persist the data transfer state even if onStopJob() isn't called, and that your app can restore this state when onStartJob() is called again.

Bedingungen für das Planen vom Nutzer initiierter Datenübertragungsvorgänge

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

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

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

Zulässige Einschränkungen für vom Nutzer initiierte Datenübertragungsvorgänge

为了支持在最佳时间点运行的作业，Android 提供了为每种作业类型分配约束条件的功能。这些约束条件从 Android 13 开始就已经可用。

注意：下表仅比较了因作业类型而异的约束条件。如需了解所有约束条件，请参阅 JobScheduler 开发者页面或工作约束条件。

下表显示了支持给定作业约束条件的不同作业类型，以及 WorkManager 支持的作业约束条件集。您可以使用表格前的搜索栏按作业约束方法的名称过滤表格。

以下是用户发起的数据传输作业允许使用的约束条件：

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

Testen

Die folgende Liste enthält einige Schritte zum manuellen Testen der Jobs Ihrer Anwendung:

Um die Job-ID abzurufen, rufen Sie den Wert ab, der für den zu erstellenden Job definiert ist.
Führen Sie den folgenden Befehl aus, um einen Job sofort auszuführen oder einen beendeten Job noch einmal auszuführen: -Befehl in einem Terminalfenster:
```
adb shell cmd jobscheduler run -f APP_PACKAGE_NAME JOB_ID
```
Um zu simulieren, dass das System das Beenden eines Jobs (aufgrund des Systemzustands oder Out-of-quota-Bedingungen), führen Sie den folgenden Befehl in einem Terminalfenster aus:
```
adb shell cmd jobscheduler timeout TEST_APP_PACKAGE TEST_JOB_ID
```

Siehe auch

Zusätzliche Ressourcen

Weitere Informationen zu von Nutzern initiierten Datenübertragungen finden Sie in den folgenden zusätzlichen Ressourcen:

Fallstudie zur UIDT-Integration: Google Maps improved download reliability by 10% using user initiated data transfer API (Google Maps hat die Zuverlässigkeit von Downloads durch die Verwendung der User Initiated Data Transfer API um 10 % verbessert)

Vom Nutzer initiierte Datenübertragung Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.

Vom Nutzer initiierte Datenübertragungsvorgänge planen

Kotlin

Java

Kotlin

Java

Kotlin

Java

Empfehlungen

Abwärtskompatibilität

Kotlin

Java

UIDT-Jobs beenden

Vom Nutzer über den Task-Manager

Vom System

Bedingungen für das Planen vom Nutzer initiierter Datenübertragungsvorgänge

Zulässige Einschränkungen für vom Nutzer initiierte Datenübertragungsvorgänge

Testen

Siehe auch

Zusätzliche Ressourcen

Vom Nutzer initiierte Datenübertragung