Kullanıcı tarafından başlatılan veri aktarımı

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

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

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

Kullanıcı tarafından başlatılan veri aktarımı işlerini planlama

Kullanıcı tarafından başlatılan bir veri aktarımı işini çalıştırmak için aşağıdakileri yapın:

  1. Uygulamanızın manifest dosyasında JobService ve ilişkili izinlerin belirtildiğinden emin olun:

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

    Ayrıca, veri aktarımınız için JobService öğesinin somut bir alt sınıfını tanımlayın:

    Kotlin

    class CustomTransferService : JobService() {
      ...
    }

    Java

    class CustomTransferService extends JobService() {
    
        ....
    
    }
  2. Manifest'te RUN_USER_INITIATED_JOBS iznini beyan edin:

    <manifest ...>
        <uses-permission android:name="android.permission.RUN_USER_INITIATED_JOBS" />
        <application ...>
            ...
        </application>
    </manifest>
    
  3. setUserInitiated() yöntemini bir JobInfo nesnesi oluştururken çağırın. (Bu yöntem, Android 14'ten itibaren kullanılabilir.) Ayrıca, işinizi oluştururken setEstimatedNetworkBytes() işlevini çağırarak bir yük boyutu tahmini sunmanızı öneririz.

    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. İş yürütülürken JobService nesnesinde setNotification() işlevini çağırın. Çağrı setNotification(), kullanıcının hem Görev Yöneticisi'nde hem de durum çubuğu bildirim alanında işin çalıştığından haberdar olmasını sağlar.

    Yürütme tamamlandığında, işin tamamlandığını veya yeniden planlanması gerektiğini sisteme bildirmek için jobFinished() işlevini çağırın.

    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. Kullanıcıyı işin durumu ve ilerleme durumu hakkında bilgilendirmek için bildirimi düzenli olarak güncelleyin. İşi planlamadan önce aktarım boyutunu belirleyemiyorsanız veya tahmini aktarım boyutunu güncellemeniz gerekiyorsa aktarım boyutu bilindikten sonra güncellemek için yeni API'yi (updateEstimatedNetworkBytes()) kullanın.

Öneriler

UIDT işlerini etkili bir şekilde çalıştırmak için aşağıdakileri yapın:

  1. İşin ne zaman yürütülmesi gerektiğini belirtmek için ağ kısıtlamalarını ve iş yürütme kısıtlamalarını net bir şekilde tanımlayın.

  2. Görevi onStartJob() içinde eşzamansız olarak yürütün. Örneğin, bunu eş yordam kullanarak yapabilirsiniz. Görevi eşzamanlı olarak çalıştırmazsanız çalışma ana iş parçacığında çalışır ve onu engelleyebilir. Bu durum ANR'ye neden olabilir.

  3. İşin gereğinden uzun süre çalışmasını önlemek için aktarım başarılı olsa da olmasa da tamamlandığında jobFinished() işlevini çağırın. Böylece iş, gerekenden daha uzun sürmez. Bir işin neden durdurulduğunu öğrenmek için onStopJob() geri çağırma yöntemini uygulayın ve JobParameters.getStopReason() yöntemini çağırın.

Geriye dönük uyumluluk

Şu anda UIDT işlerini destekleyen bir Jetpack kitaplığı yoktur. Bu nedenle, değişikliğinizi Android 14 veya daha yeni bir sürümde çalıştığınızı doğrulayan bir kodla sınırlamanızı öneririz. Daha düşük Android sürümlerinde, alternatif bir yaklaşım olarak WorkManager'ın ön plan hizmeti uygulamasını kullanabilirsiniz.

Aşağıda, uygun sistem sürümünü kontrol eden bir kod örneği verilmiştir:

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 işlerini durdurma

Hem kullanıcı hem de sistem, kullanıcı tarafından başlatılan aktarım işlerini durdurabilir.

Kullanıcı tarafından, görev yöneticisinden

Kullanıcı, Görev Yöneticisi'nde görünen kullanıcı tarafından başlatılan bir veri aktarımı işini durdurabilir.

Kullanıcı Durdur'a bastığında sistem aşağıdakileri yapar:

  • Çalışan diğer tüm işler veya ön plan hizmetleri dahil olmak üzere uygulamanızın işlemini anında sonlandırır.
  • Çalışan işler için onStopJob() çağrılmaz.
  • Kullanıcı tarafından görülebilen işlerin yeniden planlanmasını engeller.

Bu nedenle, işin sorunsuz bir şekilde durdurulmasına ve yeniden planlanmasına olanak tanımak için iş için yayınlanan bildirimde kontroller sağlamanız önerilir.

Özel durumlarda Görev Yöneticisi'nde işin yanında Durdur düğmesinin görünmediğini veya işin Görev Yöneticisi'nde hiç gösterilmediğini unutmayın.

Sistem tarafından

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

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

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

Kullanıcı tarafından başlatılan veri aktarımı işlerinin planlanmasına izin verilen koşullar

Uygulamalar, yalnızca görünür penceredeyse veya belirli koşullar karşılanıyorsa kullanıcı tarafından başlatılan bir veri aktarımı işi başlatabilir:

  • Bir uygulama arka plandan etkinlik başlatabiliyorsa kullanıcı tarafından başlatılan veri aktarımı işlerini de arka plandan başlatabilir.
  • Bir uygulamanın En son ekranındaki mevcut bir görevin arka yığınında etkinliği varsa bu durum tek başına kullanıcı tarafından başlatılan veri aktarma işinin çalışmasına izin vermez.
unutulmamalıdır.

Görev, gerekli koşulların karşılanmadığı bir zamanda çalışacak şekilde planlanırsa başarısız olur ve RESULT_FAILURE hata kodu döndürür.

Kullanıcı tarafından başlatılan veri aktarımı işlerine izin verilen kısıtlamalar

Android, işlerin en uygun noktalarda çalışmasını desteklemek için her iş türüne kısıtlamalar atama olanağı sunar. Bu kısıtlamalar Android 13'ten itibaren kullanılabilir.

Not: Aşağıdaki tabloda yalnızca her iş türü arasında farklılık gösteren kısıtlamalar karşılaştırılmaktadır. Tüm kısıtlamalar için JobScheduler geliştirici sayfası veya iş kısıtlamaları sayfasına bakın.

Aşağıdaki tabloda, belirli bir iş kısıtlamasını destekleyen farklı iş türlerinin yanı sıra WorkManager'ın desteklediği iş kısıtlamaları grubu gösterilmektedir. Tabloyu bir iş kısıtlama yönteminin adına göre filtrelemek için tablonun önündeki arama çubuğunu kullanın.

Kullanıcı tarafından başlatılan veri aktarım işlerinde izin verilen kısıtlamalar şunlardır:

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

Test

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

  • 如需获取作业 ID,请获取在构建作业时定义的值。
  • 如需立即运行作业或重试已停止的作业,请在终端窗口中运行以下命令:

    adb shell cmd jobscheduler run -f APP_PACKAGE_NAME JOB_ID
  • 如需模拟系统强行停止作业(由于系统运行状况或超出配额条件),请在终端窗口中运行以下命令:

    adb shell cmd jobscheduler timeout TEST_APP_PACKAGE TEST_JOB_ID

Ayrıca bkz.

Ek kaynaklar

Kullanıcı tarafından başlatılan veri aktarımları hakkında daha fazla bilgi için aşağıdaki ek kaynaklara bakın: