Vom Nutzer initiierte Datenübertragung

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

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

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

Vom Nutzer initiierte Datenübertragungsvorgänge planen

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

Ihre App muss die Berechtigung 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, die Änderung mit Code zu versehen, der prüft, ob Sie Android 14 oder höher verwenden. Bei älteren Android-Versionen können Sie die Implementierung des Diensts 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

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

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

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

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

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

Vom System

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

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

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

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

Apps können einen vom Nutzer initiierten Datenübertragungsvorgang nur starten, wenn sich die App im sichtbaren Fenster befindet oder bestimmte Bedingungen erfüllt sind:

Wenn eine App Aktivitäten aus dem Hintergrund starten kann, kann sie auch vom Nutzer initiierte Datenübertragungsjobs aus dem Hintergrund starten.
Wenn eine App eine Aktivität im Backstack einer vorhandenen Aufgabe auf dem Bildschirm Letzte hat, ist das allein noch kein Grund, einen vom Nutzer initiierten Datenübertragungsjob auszuführen.

Wenn der Job zu einem Zeitpunkt ausgeführt werden soll, zu dem die erforderlichen Bedingungen nicht erfüllt sind, schlägt er fehl und gibt den Fehlercode RESULT_FAILURE zurück.

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