이 페이지는 Cloud Translation API를 통해 번역되었습니다.

사용자 시작 데이터 전송

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.

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

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

앱이 매니페스트에서 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() {

    ....

}

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

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

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

작업이 실행되는 동안 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
    }
}

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

권장사항

UIDT 작업을 효과적으로 실행하려면 다음을 수행하세요.

작업이 실행되어야 하는 시점을 지정하려면 네트워크 제약 조건과 작업 실행 제약 조건을 명확하게 정의하세요.
onStartJob()에서 비동기적으로 작업을 실행합니다. 예를 들어 코루틴을 사용하여 이 작업을 실행할 수 있습니다. 비동기적으로 작업을 실행하지 않으면 기본 스레드에서 작업이 실행되어 기본 스레드가 차단될 수 있으며 이로 인해 ANR이 발생할 수 있습니다.
필요 이상으로 작업을 실행하지 않으려면 전송이 성공하든 실패하든 전송이 완료되면 jobFinished()를 호출하세요. 이렇게 하면 작업이 필요 이상으로 오래 실행되지 않습니다. 작업이 중지된 이유를 알아보려면 onStopJob() 콜백 메서드를 구현하고 JobParameters.getStopReason()를 호출합니다.

이전 버전과의 호환성

현재 UIDT 작업을 지원하는 Jetpack 라이브러리는 없습니다. 따라서 Android 14 이상에서 실행 중인지 확인하는 코드로 변경사항을 관리하는 것이 좋습니다. 하위 Android 버전에서는 WorkManager의 포그라운드 서비스 구현을 대체 접근 방식으로 사용할 수 있습니다.

다음은 적절한 시스템 버전을 확인하는 코드의 예입니다.

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

사용자와 시스템 모두 사용자가 시작한 전송 작업을 중지할 수 있습니다.

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

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.

시스템에 의해

일반 작업과 달리 사용자가 시작한 데이터 전송 작업은 앱 대기 버킷 할당량의 영향을 받지 않습니다. 그러나 다음 조건 중 하나가 발생하면 시스템은 여전히 작업을 중지합니다.

개발자가 정의한 제약 조건이 더 이상 충족되지 않습니다.
작업이 데이터 전송 작업을 완료하는 데 필요한 시간보다 오래 실행되었다고 시스템에서 판단합니다.
시스템이 시스템 상태를 우선하고 열 상태 증가로 인해 작업을 중지해야 합니다.
기기 메모리가 부족하여 앱 프로세스가 종료됩니다.

기기 메모리 부족 이외의 이유로 작업이 시스템에 의해 중지되면 시스템은 onStopJob()을 호출하고 최적으로 간주하는 시점에 작업을 재시도합니다. onStopJob()이 호출되지 않더라도 앱이 데이터 전송 상태를 유지할 수 있는지, onStartJob()이 다시 호출되면 앱이 이 상태를 복원할 수 있는지 확인합니다.

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

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.

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

최적의 지점에서 실행되는 작업을 지원하기 위해 Android는 각 작업 유형에 제약 조건을 할당하는 기능을 제공합니다. 이러한 제약 조건은 Android 13부터 사용할 수 있습니다.

참고: 다음 표에서는 각 작업 유형에 따라 달라지는 제약 조건만 비교합니다. 모든 제약 조건은 JobScheduler 개발자 페이지 또는 작업 제약 조건을 참고하세요.

다음 표에서는 특정 작업 제약 조건을 지원하는 다양한 작업 유형과 WorkManager에서 지원하는 작업 제약 조건 집합을 보여줍니다. 표 앞에 있는 검색창을 사용하여 작업 제약 조건 메서드의 이름으로 표를 필터링합니다.

사용자가 시작한 데이터 전송 작업에서 허용되는 제약 조건은 다음과 같습니다.

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% 개선

사용자 시작 데이터 전송 컬렉션을 사용해 정리하기 내 환경설정을 기준으로 콘텐츠를 저장하고 분류하세요.

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

Kotlin

자바

Kotlin

자바

Kotlin

자바

권장사항

이전 버전과의 호환성

Kotlin

Java

UIDT 작업 중지

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

시스템에 의해

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

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

테스트

참고 항목

추가 리소스

사용자 시작 데이터 전송