사용자 시작 데이터 전송

If you need to perform a data transfer that may take a long time, you can create a JobScheduler job and identify it as a user-initiated data transfer (UIDT) job. UIDT jobs are intended for longer-duration data transfers that are initiated by the device user, such as downloading a file from a remote server. UIDT jobs were introduced with Android 14 (API level 34).

User-initiated data transfer jobs are started by the user. These jobs require a notification, start immediately, and may be able to run for an extended period of time as system conditions allow. You can run several user-initiated data transfer jobs concurrently.

User initiated jobs must be scheduled while the application is visible to the user (or in one of the allowed conditions). After all constraints are met, user initiated jobs can be executed by the OS, subject to system health restrictions. The system may also use the provided estimated payload size to determine how long the job executes.

사용자가 시작한 데이터 전송 작업 예약

사용자가 시작한 데이터 전송 작업을 실행하려면 다음을 실행하세요.

1. 앱이 매니페스트에서 JobService 및 관련 권한을 선언했는지 확인합니다.

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

   데이터 전송을 위해 JobService의 구체적인 하위 클래스도 정의합니다.

   Kotlin

   class CustomTransferService : JobService() {
     ...
   }

   자바

   class CustomTransferService extends JobService() {
   
       ....
   
   }

2. 매니페스트에서 RUN_USER_INITIATED_JOBS 권한을 선언합니다.

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

3. JobInfo 객체를 빌드할 때 setUserInitiated() 메서드를 호출합니다. (이 메서드는 Android 14부터 사용할 수 있습니다.) 또한 작업을 만드는 동안 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)
           // ...
           .build()

   자바

   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)
       // ...
       .build();

4. 작업이 실행되는 동안 JobService 객체에서 setNotification()를 호출합니다. setNotification()를 호출하면 작업 관리자 및 상태 표시줄 알림 영역에서 모두 작업이 실행 중임을 사용자에게 알립니다.

   실행이 완료되면 jobFinished()를 호출하여 시스템에 작업이 완료되었거나 작업을 다시 예약해야 한다고 알립니다.

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

   자바

   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. 사용자에게 작업의 상태와 진행 상황을 계속 알릴 수 있도록 주기적으로 알림을 업데이트합니다. 작업을 예약하기 전에 전송 크기를 확인할 수 없거나 예상 전송 크기를 업데이트해야 하는 경우 새 API updateEstimatedNetworkBytes()를 사용하여 전송 크기를 파악한 후 업데이트합니다.

권장사항

UIDT 작업을 효과적으로 실행하려면 다음 단계를 따르세요.

1. 작업이 실행되어야 하는 시점을 지정하려면 네트워크 제약 조건과 작업 실행 제약 조건을 명확하게 정의하세요.

2. onStartJob()에서 비동기적으로 작업을 실행합니다. 예를 들어 코루틴을 사용하여 이 작업을 실행할 수 있습니다. 비동기적으로 작업을 실행하지 않으면 작업이 기본 스레드에서 실행되어 기본 스레드를 차단할 수 있으며 이로 인해 ANR이 발생할 수 있습니다.

3. 필요 이상으로 작업을 실행하지 않으려면 전송이 성공하든 실패하든 전송이 완료되면 jobFinished()를 호출하세요. 이렇게 하면 작업이 필요 이상으로 오래 실행되지 않습니다. 작업이 중지된 이유를 알아보려면 onStopJob() 콜백 메서드를 구현하고 JobParameters.getStopReason()를 호출합니다.

이전 버전과의 호환성

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:

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

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 작업 중지

Both the user and the system can stop user-initiated transfer jobs.

작업 관리자에서 사용자에 의해

The user can stop a user-initiated data transfer job that appears in the Task Manager.

At the moment that the user presses Stop, the system does the following:

• Terminates your app's process immediately, including all other jobs or foreground services running.
• Doesn't call onStopJob() for any running jobs.
• Prevents user-visible jobs from being rescheduled.

For these reasons, it's recommended to provide controls in the notification posted for the job to allow gracefully stopping and rescheduling the job.

Note that, under special circumstances, the Stop button doesn't appear next to the job in the Task Manager, or the job isn't shown in the Task Manager at all.

시스템에 의해

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.

사용자가 시작한 데이터 전송 작업을 예약할 수 있는 조건

Apps can only start a user-initiated data transfer job if the app is in the visible window, or if certain conditions are met:

• If an app can launch activities from the background, it can also launch user-initiated data transfer jobs from the background.
• If an app has an activity in the back stack of an existing task on the Recents screen, that alone doesn't allow a user-initiated data transfer job to run.

If the job is scheduled to run at a time when the necessary conditions are not met, the job fails and returns a RESULT_FAILURE error code.

사용자가 시작한 데이터 전송 작업에 허용되는 제약 조건

To support jobs running at optimal points, Android offers the ability to assign constraints to each job type. These constraints are available as of Android 13.

Note: The following table only compares the constraints that vary between each job type. See JobScheduler developer page or work constraints for all constraints.

The following table shows the different job types that support a given job constraint, as well as the set of job constraints that WorkManager supports. Use the search bar before the table to filter the table by the name of a job constraint method.

These are the constraints allowed with user-initiated data transfer jobs:

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

테스트

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

참고 항목

• 백그라운드 작업 개요
• 데이터 전송 백그라운드 작업 옵션

추가 리소스

사용자 시작 데이터 전송에 관한 자세한 내용은 다음 추가 리소스를 참고하세요.

• UIDT 통합 사례 연구: Google 지도에서 사용자 시작 데이터 전송 API를 사용하여 다운로드 안정성 10% 개선