[iOS] BackgroundTasks Framework 간단 정리

목차 

1. BackgroundTasks Framework?
2. 무엇을 지원하는가
3. 주의 사항
4. 간단하게 써보자!
5. 테스트 해보기
6. 참고 글과 더 보면 좋을 것들

1. BackgroundTasks Framework?

https://developer.apple.com/documentation/backgroundtasks

 

앱이 백그라운드에서 작업을 수행할 수 있게 시스템에게 요청하는 걸 도와주는 프레임워크에요.

간단한 서버 호출 > 리프레쉬 작업부터, 에너지를 많이 사용하고 네트워크 연결을 요구하는 작업도 요청할 수 있다고 해요.

 

iOS 13부터 지원. 13 이후의 버전은 이 프레임워크를 사용해야한다고 해요.

setMinimumFetchInterval는 deprecated 되어버렸네요 🥺

2. 무엇을 지원하는가

앱이 백그라운드에서 특정 작업을 수행할 수 있게 해줍니다. 

작업의 복잡도와 에너지 양에 따라 두 가지 모드를 지원합니다.

 

1. App Refresh Task

가벼운 작업. 단순 API 호출 및 저장. 사용자가 폰을 사용하고 있는 시간(보통 낮)에도 실행해준다고 합니다.

 

2. Processing Task

DB등 크고 무거운 작업 할 때 사용. 옵션 중 추가 배터리를  사용하는가, 네트워크를 사용하는가 등의 요소도 지정해줄 수 있습니다.

무거운 작업이기 떄문에, 보통 앱이 충전 중이고, idle 할 때 (암 것도 안 하고 놀고 있을 때) 실행시켜 준다고 합니다.

 

3. 주의 사항

- 일정한 시간에 호출되지 않음 (시스템에서 판단했을 때 배터리, 메모리 상황이 괜찮을 때, 그리고 사용자가 이 앱을 언제 보통 켜는지 학습해 그 전에 호출함 = 알 수 없음)

- 사용자가 일주일 동안 앱을 켜지 않으면 더 이상 Background Fetch가 실행되지 않음.

- UI 조작 노노! 메인 스레드가 아니라서 크래시 남. (네트워크 인디케이터도 안됨... 어떻게 아냐고여? 저도 알고 싶지 않았어요..)

이런 이름의 별도의 스레드에서 실행됩니다 :)

4. 구현해보자!

애플 예제가 잘 되어 있어서 코드와 예제는 그대로 들고 왔습니다. 

 

1. 앱에게 Background Fetch, Background Processing 권한을 줍니다.

출처 : https://developer.apple.com/documentation/backgroundtasks/bgtaskscheduler

 

2. Info.plist에 BGTaskSchedulerPermittedIdentifiers를 추가합니다.

아래에 보이는 Permitted background task scheduler Identifiers 입니다. 문자열 배열로, 각 요소에 실행할 task의 Identifier를 입력해주면 됩니다. 

 

출처 : https://developer.apple.com/documentation/backgroundtasks/bgtaskscheduler

 

3. 위에 선언한 task의 Identifier로 task를 등록합니다.

예제에서의 시점은 didFinishLaunchingWithOptions네요. 

 

  //AppDelegate
  
  //앱 런칭
  func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
       
       //예제 서버에서 뷰컨트롤러를 갖고오고 하는 부분. 생략함.
        
        // 여기서는 태스크를 등록해줍니다. 스케줄하는 건 별도 에요!
        BGTaskScheduler.shared.register(forTaskWithIdentifier: "com.example.apple-samplecode.ColorFeed.refresh", using: nil) { task in
    
            //실제로 수행할 백그라운드 동작 구현
            //나중에 스케쥴 할 때, 해당 태스크의 클래스를 알고 등록을 하게 됩니다. 그래서 다운 캐스팅이 가능해요.
            self.handleAppRefresh(task: task as! BGAppRefreshTask)
        }
    
        BGTaskScheduler.shared.register(forTaskWithIdentifier: "com.example.apple-samplecode.ColorFeed.db_cleaning", using: nil) { task in
            
            // Downcast the parameter to a processing task as this identifier is used for a processing request.
            self.handleDatabaseCleaning(task: task as! BGProcessingTask)
        }

        return true
    }
   
   
   //실제로 태스크를 수행하는 곳에서는 두 가지를 신경써 주세요.
   // task.expirationHandler 구현
   // 작업의 결과가 어떻게 되었든, task.setTaskCompleted(success: 작업 성공 여부) 호출하기.
   func handleAppRefresh(task: BGAppRefreshTask) {

		//다음 동작을 또 스케쥴 합니다. 반복 수행 시 필요하겠죠?
        //스케쥴 하는 메소드는 이 코드 블럭 이후에 나옵니다!
		scheduleAppRefresh()
        
        let queue = OperationQueue()
        queue.maxConcurrentOperationCount = 1
        
        let context = PersistentContainer.shared.newBackgroundContext()
        let operations = Operations.getOperationsToFetchLatestEntries(using: context, server: server)
        let lastOperation = operations.last!
        
        
        //때에 따라서는 너무 오래걸린다던가 해서 종료될 때가 있죠. 그 때를 위한 정리 핸들러에요.
        task.expirationHandler = {
        
        	//예제에서는 OperationQueue를 사용하니까, 모든 동작을 취소했네요.
            queue.cancelAllOperations()
        }

		//이 부분은 Alamofire의 api ressponse 처리 블록 등이 될 수 있겠죠? 예제에서는 Operation Queue를 사용했네요.
        lastOperation.completionBlock = {
        
        //작업 완료 시, setTaskCompleted를 반드시 호출해주세요. 동기로 호출될 필요는 없어요!
            task.setTaskCompleted(success: !lastOperation.isCancelled)
        }

        queue.addOperations(operations, waitUntilFinished: false)
    }
    


//BGProcessingTask에서 수행할 것을 구현합니다. 위와 똑같아요!

    func handleDatabaseCleaning(task: BGProcessingTask) {
        let queue = OperationQueue()
        queue.maxConcurrentOperationCount = 1

        let context = PersistentContainer.shared.newBackgroundContext()
        let predicate = NSPredicate(format: "timestamp < %@", NSDate(timeIntervalSinceNow: -24 * 60 * 60))
        let cleanDatabaseOperation = DeleteFeedEntriesOperation(context: context, predicate: predicate)
        
        task.expirationHandler = {
            // After all operations are cancelled, the completion block below is called to set the task to complete.
            queue.cancelAllOperations()
        }

        cleanDatabaseOperation.completionBlock = {
            let success = !cleanDatabaseOperation.isCancelled
            if success {
                // Update the last clean date to the current time.
                PersistentContainer.shared.lastCleaned = Date()
            }
            
            task.setTaskCompleted(success: success)
        }
        
        queue.addOperation(cleanDatabaseOperation)
    }

 

4. 태스크를 등록했으면, 스케쥴 하자!

앱에서의 시점은 AppDelegate의 applicationDidEnterBackground, 혹은 위의 태스크의 구현 내부네요. 

후자의 경우는 반복 수행을 위해 들어가는 것입니다. (물론 주기는 시스템이 맘대루..)

 

이때, submit은 synchronous한 메소드이므로, launch 시점에서 submit을 하고 있다면, 다른 concurrent queue에서 등록 동작을 수행하길 권장한다고 하네요!

 

    //AppDelegate
    
    //앱이 백그라운드에 들어갔을 때 호출 됨.
    func applicationDidEnterBackground(_ application: UIApplication) 
    {
        scheduleAppRefresh()
        scheduleDatabaseCleaningIfNeeded()
    }
    

	// 실제로 태스크를 스케줄 하는 부분.
    
    //BGAppRefreshTaskRequest를 만들어 봅니다
    func scheduleAppRefresh() {
    
  		  //1. 원하는 형태의 TaskRequest를 만듭니다. 이 때, 사용되는 identifier는 위의 1, 2과정에서 등록한 info.plist의 identifier여야 해요!
        let request = BGAppRefreshTaskRequest(identifier: "com.example.apple-samplecode.ColorFeed.refresh")
        
        //2. 리퀘스트가 언제 실행되면 좋겠는지 지정합니다. 기존의 setMinimumFetchInterval과 동일하다고 합니다. 
        //여전히, 언제 실행될지는 시스템의 마음입니다...
        request.earliestBeginDate = Date(timeIntervalSinceNow: 15 * 60)
        
        
        //3. 실제로 task를 submit 합니다.
        //이 때 주의사항은, submit은 synchronous한 함수라, launching 때 실행하면 메인 스레드가 블락 될 수 있으니 
        //OperationQueue, GCD등을 이용해 다른 스레드에서 호출하는 것을 권장한다고 하네요.
        do {
            try BGTaskScheduler.shared.submit(request)
        } catch {
            print("Could not schedule app refresh: \(error)")
        }
    }
    
    
    //BGProcessingTaskRequest를 사용합니다. 옵션이 있는 걸 제외하면 위와 동일해요.
    func scheduleDatabaseCleaningIfNeeded() {
        let lastCleanDate = PersistentContainer.shared.lastCleaned ?? .distantPast

        let now = Date()
        let oneWeek = TimeInterval(7 * 24 * 60 * 60)

        // Clean the database at most once per week.
        guard now > (lastCleanDate + oneWeek) else { return }
        
        
        //이번엔 무거운 DB 작업이니까, BGProcessingTaskRequest를 스케쥴 해줍니다.
        let request = BGProcessingTaskRequest(identifier: "com.example.apple-samplecode.ColorFeed.db_cleaning")
        
        //네트워크 사용여부, 에너지 소모량 옵션도 있습니다.
        request.requiresNetworkConnectivity = false
        request.requiresExternalPower = true
        
        do {
            try BGTaskScheduler.shared.submit(request)
        } catch {
            print("Could not schedule database cleaning: \(error)")
        }
    }

 

5. 백그라운드 태스크 실행 테스트 해보기

기존의 Simulate Background Fetch로는 동작하지 않습니다 ㅠㅠㅠ 아래 처럼, 직접 콘솔에 명령어를 입력해줘야 해요.

 

2020/02/24 - [개발 삽질기/iOS] - [iOS]BackgroundTasks 프레임워크를 사용할 때, task 실행, 중단 테스트하기.

 

1. BGTaskScheduler에게 task를 submit하는 코드 실행.

2. 그 다음 시점에 break point 잡기

3. break 포인트가 걸리면 아래 명령어 입력하기.

4. 백 그라운드에서 실행시 (위 같이 didEnterBackground 시점) 아래 명령어 입력 후, 다시 앱을 foreground에서 실행시켜 주어야 제대로 명령어가 실행됩니다.

 

반드시 실 기기에서 실행시켜야 합니다. 그리고 디버그 용도로만 사용해달라고 경고가 있네요.

 

e -l objc -- (void)[[BGTaskScheduler sharedScheduler] _simulateLaunchForTaskWithIdentifier:@"Info.plist에 등록한 태스크 Identifier"]

 

위 명령어가 제대로 실행되면 콘솔에 아래 문구가 출력되고, 태스크 내에서의 BP도 잡힙니다.

 

Simulating launch for task with identifier 아까 실행 시킨 태스트 Identifier

Starting simulated task: <BGAppRefreshTask: 아까 실행 시킨 태스트 Identifier>

 

메인 스레드에서 실행되지 않는다는 점 참고해주세요.

 

요런 이름의 스레드에서 실행됩니다.

6. 참고 자료와 더 보면 좋을 것들

사용 예제가 잘 드러난 글

https://medium.com/snowdog-labs/managing-background-tasks-with-new-task-scheduler-in-ios-13-aaabdac0d95b

 

WWDC 2019 의 Background Execution 영상

https://developer.apple.com/videos/play/wwdc2019/707/

샘플 프로젝트는 반드시 실 기기에서 돌아가야 한다고 합니다!

 

애플 문서

Background Tasks Framework 설명

https://developer.apple.com/documentation/backgroundtasks

 

Background Task 테스트 하기

https://developer.apple.com/documentation/backgroundtasks/starting_and_terminating_tasks_during_development

 

+ 먼저 공부하면 좋을 것

OperationQueue. task를 추가하는 개념 등은 Operation Queue에서 온 것이 많아 보입니다. 저도 이 부분 코드를 이해하는 데 애먹어서... 공부를 좀 더 해야겠네요!

 

+ 사담

예제 코드에서 목 서버를 만든 방식이 꽤나 마음에 들어요. 나중에 테스트 프로젝트를 만들 떄 한 번 따라해볼까 합니다.