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

사용자 시작 데이터 전송

시간이 오래 걸릴 수 있는 데이터 전송을 실행해야 하는 경우 JobScheduler 작업을 만들고 사용자 시작 데이터 전송 (UIDT) 작업으로 식별하면 됩니다. UIDT 작업은 원격 서버에서 파일을 다운로드하는 등 기기 사용자가 시작하는 장기 데이터 전송을 위한 것입니다. UIDT 작업은 Android 14 (API 수준 34)에서 도입되었습니다.

사용자 시작 데이터 전송 작업은 사용자가 시작합니다. 이러한 작업은 알림이 필요하고, 즉시 시작되며, 시스템 조건에서 허용하는 한 장시간 실행될 수 있습니다. 사용자가 시작한 데이터 전송 작업 여러 개를 동시에 실행할 수 있습니다.

사용자가 시작한 작업은 애플리케이션이 사용자에게 표시되는 동안 (또는 허용된 조건 중 하나로) 예약되어야 합니다. 모든 제약 조건이 충족되면 시스템 상태 제한에 따라 OS에서 사용자가 시작한 작업을 실행할 수 있습니다. 또한 시스템은 제공된 예상 페이로드 크기를 사용하여 작업 실행 시간을 판단할 수도 있습니다.

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

如需运行用户发起的数据传输作业，请执行以下操作：

确保您的应用已在其清单中声明 JobService 和关联的权限：

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

此外，还要为数据转移定义 JobService 的具体子类：

Kotlin

class CustomTransferService : JobService() {
  ...
}

Java

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

在作业执行期间，对 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
    }
}

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

定期更新通知，让用户了解作业的状态和进度。如果在安排作业之前无法确定传输大小，或者需要更新估计的传输大小，请在知道传输大小之后使用新的 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 작업 중지

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

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

사용자는 작업 관리자에 표시되는 사용자 시작 데이터 전송 작업을 중지할 수 있습니다.

사용자가 중지를 누르면 시스템은 다음 작업을 실행합니다.

실행 중인 다른 모든 작업 또는 포그라운드 서비스를 포함하여 앱의 프로세스를 즉시 종료합니다.
실행 중인 작업의 onStopJob()을 호출하지 않습니다.
사용자에게 표시되는 작업의 일정이 변경되는 것을 방지합니다.

따라서 작업을 단계적으로 중지하고 일정을 변경할 수 있도록 작업에 관해 게시된 알림에 컨트롤을 제공하는 것이 좋습니다.

특수한 상황에서는 중지 버튼이 작업 관리자의 작업 옆에 표시되지 않거나 작업이 작업 관리자에 아예 표시되지 않을 수 있습니다.

시스템에 의해

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

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

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

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

앱은 표시되는 창에 있거나 특정 조건이 충족되는 경우에만 사용자가 시작한 데이터 전송 작업을 시작할 수 있습니다.

앱이 백그라운드에서 활동을 실행할 수 있는 경우 사용자가 시작한 데이터 전송 작업도 백그라운드에서 실행할 수 있습니다.
앱의 최근 화면에 있는 기존 작업의 백 스택에 활동이 있어도 이것만으로는 사용자가 시작한 데이터 전송 작업을 실행할 수 없습니다.

필요한 조건이 충족되지 않는 시간에 작업이 실행되도록 예약되면 작업이 실패하고 RESULT_FAILURE 오류 코드가 반환됩니다.

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

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

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

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

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

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

테스트

다음 목록은 앱의 작업을 수동으로 테스트하는 방법에 관한 몇 가지 단계를 보여줍니다.

작업 ID를 가져오려면 빌드 중인 작업에 정의된 값을 가져옵니다.
작업을 즉시 실행하거나 중지된 작업을 다시 시도하려면 터미널 창에서 다음 명령어를 실행합니다.
```
adb shell cmd jobscheduler run -f APP_PACKAGE_NAME JOB_ID
```
시스템 상태 또는 할당량 부족 상태로 인해 작업을 강제 종료하는 시스템을 시뮬레이션하려면 터미널 창에서 다음 명령어를 실행합니다.
```
adb shell cmd jobscheduler timeout TEST_APP_PACKAGE TEST_JOB_ID
```

참고 항목

추가 리소스

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

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

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

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

Kotlin

Java

Kotlin

Java

Kotlin

Java

建议

이전 버전과의 호환성

Kotlin

Java

UIDT 작업 중지

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

시스템에 의해

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

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

테스트

참고 항목

추가 리소스

사용자 시작 데이터 전송