[iOS] Notification Service Extension와 Firebase 정리

[Emmanuel Jason Eliphalet] https://www.pexels.com/ko-kr/photo/9956765/

UNNotificationServiceExtension

원격 푸시 노티피케이션의 컨텐츠를 수정하는 객체. 사용자에게 전달되기 전에 수행됨

class UNNotificationServiceExtension : NSObject

• notification service 앱 기능 확장 => 사용자에게 remote notification 이 전달되기 이전에 컨텐츠를 커스터마이징 할 수 있는 기능
• UI를 가지지 않음
• notification 이 사용자의 기기에 전달되면 런칭됨
• notification 의 내용을 수정하거나 이미지, 비디오 등을 다운로드 받을 수 있으며 암호화 혹은 복호화를 수행할 수도 있음
• silent notification, 사운드만 재생시키기, 앱 아이콘에 표시되는 뱃지는 변경 불가
• UNNotificationServiceExtension을 직접 생성하는 것이 아니라 target을 추가하여 사용함
• target을 추가하면 UNNotificationServiceExtension의 서브 클래스가 포함되어 있으며 이를 수정하여 사용함
• 앱이 remote notification을 받음 -> 시스템이 UNNotificationServiceExtension의 didRecive(_:withContentHandler:) 메소드를 로드함

---

타겟 추가하기

• File > New > Target 을 순서대로 선택하여 Target을 추가해 줌 또는 xcodeproj에서 하단에 + 버튼 눌러서 추가

• Notification Service Extension 선택 

• Product Name과 Team 설정 후 Finish 선택. Language는 obj-c 선택 가능

 

타겟 설정하기

• 빌드 하지 말고 xcodeproj 에서 추가해 준 notification service target 선택 후 Automatically manage signing 체크 해지 (체크 해 놓으면 Bundle Identifier부터 Provisioning Profile까지 자동으로 생성됨 ) 
• 바로 밑에 내용은 수동 생성시 참고

• 바이너리 이슈 때문에 앱 심사 안올라감 => Automatically manage signing 체크 하면 자동으로 프로비저닝 프로파일을 설정해 줌

• 만약 수동으로 설치했다면 developer.apple.com > Identifiers > notification service extension identifiers 선택 > Capabilities 추가  
• 확인해 보니 Push Notifications를 포함시키지 않아도 됨

• save > confirm 누르면 기존에 생성해 두었던 provisioning profile이 invoke 됨

• 프로젝트로 돌아와서 Notification Service Extension Target 선택 > 상단에 + 버튼 눌러서 Capabilities 추가 > Push Notifications 선택
• 확인해 보니 Notification Service에 Push Notifications Capabilities는 추가하지 않아도 됨

⭐ 중요 ⭐

• target 선택된 상태에서 General 탭으로 이동
• Identity에서 version build는 앱 버전 따라가야 함. 빌드나 개발에서 run은 정상 동작하지만 앱 스토어에 업로드할 때 문제 생김
• 꼭 Deployment Info 버전이 앱에서 설정한 OS 버전과 같은지 확인

Bundle Identifier와 Provisioning Profile 생성하기

• developer 사이트에 로그인 후 Certificates, Identifiers & Profiles 항목에서  Identifiers 선택

• + 버튼 눌러서 Bundle Identifier 추가

• App IDs 선택 후 Continue 선택 -> App 선택 후 Continue 

• Description와 Bundle ID 작성
• ⭐ 이때 Bundle ID는 앱의 번들 아이디가 com.test.app 이었다면 com.test.app.XXXX 이렇게 prefix를 따라가야함 (XXXX 부분은 원하시는 이름으로 하시면 됩니다)

• ⭐ 만약 com.test.app.XXXX.XXXX 이렇게 dot이 두 번 들어가는 경우 앱 스토어 올릴 때 Bad Identifier 경고 발생함 (미리 좀 알려주지 애플...)

• Bundle ID 생성 후 provisioning profile 생성 (기존 앱의 provisioning profile 생성과 동일)

• 개발에서는 iOS App Development, 앱스토어 올릴 때 App Store 생성해 주면됨(기존 앱 provisioning profile 생성과 동일)

• App ID에서 방금 notification service extension을 위해 생성한 Bundle Identifier 선택 후 continue, download

• 다시 프로젝트로 돌아와서 Bundle Identifier 수정, Provisioning Profile 에 Import 해주면 됨 (개발시에는 configurations를 Debug, 스토어 배포시 Release 에 적용)

Pod 추가

target 'Notification Service Extension 이름 ' do
pod 'Firebase/Messaging'
end

• target 명칭은 target 추가시 입력해 주었던 Product Name (아래 이미지 참고)

Processing Notifications

func didReceive(
    _ request: UNNotificationRequest,
    withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void
)

• notification 변경을 요청한 뒤 완료되면 cotentHandler로 변경된 content 전달
• request에 원래 notification request 정보가 담겨 있음. 

    override func didReceive(_ request: UNNotificationRequest, withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void) {
        var bestAttemptContent = (request.content.mutableCopy() as? UNMutableNotificationContent)
        
        if let bestAttemptContent = bestAttemptContent {

            bestAttemptContent.title = "수정 됨 : \(bestAttemptContent.title)"
            bestAttemptContent.body = "수정 됨 : \(bestAttemptContent.content)"

            Messaging.serviceExtension().populateNotificationContent(bestAttemptContent, withContentHandler: contentHandler)
            
            contentHandler(bestAttemptContent)
        }
    }

• request.content를 수정한 뒤 contentHandler로 전달, Firebase의 Messagin.serviceExtension().populateNotificationContent에 수정된 notification과 handler 전달

추가

func serviceExtensionTimeWillExpire()

• didReceive에서 completion block 처리가 오래 걸리는 경우 해당 메소드를 호출함 (도큐먼트에는 last chance to execute the block이라 설명되어 있음)
• 용량이 큰 이미지 다운로드 할 경우 해당 메소드 처리 필요(만약 didReceive에서 시간이 오래 걸리는 작업을 수행해서 정해진 시간 내에 completion handler을 실행하지 못한 경우 오리지널 컨텐츠가 표시됨)

mutable_content 추가하기

• apns 파일을 사용할 때 "mutable-content" : true 혹은 "mutable-content" : 1 을 보내야 함

• firebase에서 페이로드는 "mutable_content" : true 혹은 "mutable_content" : 1 
• ⭐주의 사항(삽질 구간 주의⛔) : firebase에서 payload는 언더바!!!, apns에서는 짝대기
• (삽질 구간 주의⛔) 혹시 푸시 작업하시는 백엔드 분 따로 있고 나는 프론트만 한다 -> 변경된 푸시로 안오는데 백엔드 작업 끝났다고 안내받음 ->프론트도 문제 없는거 같다 -> 아래 방법으로 확인

func userNotificationCenter(_ center: UNUserNotificationCenter, willPresent notification: UNNotification, withCompletionHandler completionHandler: @escaping (UNNotificationPresentationOptions) -> Void)

func userNotificationCenter(_ center: UNUserNotificationCenter, didReceive response: UNNotificationResponse, withCompletionHandler completionHandler: @escaping () -> Void)

• UNUserNotificationCenterDelegate 의 didReceive, willPresent에서 브레이크 포인트 걸고 콘솔로 
• didReceive에서는 response.notification.request, willPresent에서는 notification.requet 확인

• mutableContent: YES로 와야 정상 작동. 이 부분이 NO로 오면 payload 위치나, 오타 확인

앱스토어 업로드

• 스크롤 내려서 NotificationService의 배포용 프로비저닝 파일 선택

 

에러 핸들링

• 수정된 푸시로 안올경우
  • mutable_content 를 true로 보내고 있는지 확인
• 빌드가 안됨
  • DerivedData 삭제 -> 빌드 클린 -> 재빌드 (DerivedData 삭제하는 법 : terminal에서 rm -rf ~/Library/Developer/Xcode/DerivedData   입력하여 삭제)
  • pod 파일의 문제일 가능성이 큼 : pod update > 빌드 클린 > 재 빌드
  • multiple pod 확인 : target에 중복된 pod이 들어간 경우 

=> 중복되는 pod을 shared_pods으로 정의하여 사용. 

=> 타겟에 use_frameworks! 추가하기 -> pod update

=> GoogleUtilities 추가해야 하는 경우 위와 같이 경고 뜸 이때 pod에 추가해주고 pod update 혹은 install

• 앱스토어에 안올라감
  • Notification Service extension version이 앱의 버전과 일치하는 지 확인
  • bad identifier인지 확인 (bundle ID 기준이 생각보다 엄격...) : 예를 들어 앱의 번들 아이디가 com.app.ex인데 Notification Service Extension 의 bundle id의 .이 두 개 이상인 경우 bad identifier! com.app.ex.notification.service => com.app.ex.notification으로 수정
   

 

참고 사이트 

https://developer.apple.com/documentation/usernotifications/unnotificationserviceextension

Apple Developer Documentation

https://velog.io/@dody_/RN-Library-rn-firebase-cloud-messaging-FCM-%EC%84%B8%ED%8C%85%ED%95%98%EA%B8%B0

[RN Library 📚] rn에서 푸시알림 보내기! firebase cloud messaging FCM 세팅하기

https://yoonandro.tistory.com/98

[Swift] iOS Push Image도 받아보기(Feat.FCM) 2/2

혹시 이상하거나 잘 못된 것이 있다면 언제든 댓글 부탁드려요!