콘솔로 이동

iOS에서 Firebase 클라우드 메시징 클라이언트 앱 설정

iOS 클라이언트 앱의 경우 상호 보완적인 2가지 방법으로 Firebase 클라우드 메시징을 구현할 수 있습니다.

  • Firebase 클라우드 메시징 APN 인터페이스를 통해 최대 4KB의 기본 푸시 메시지를 수신합니다.

  • 포그라운드 앱에서 최대 4KB의 업스트림 메시지를 보내거나 다운스트림 페이로드를 수신합니다.

Objective-C 또는 Swift로 클라이언트 코드를 작성하려면 FIRMessaging API를 사용하는 것이 좋습니다. 빠른 시작 예시에서는 두 언어의 샘플 코드를 제공합니다.

Firebase 클라우드 메시징의 메소드 재구성

FCM SDK는 FCM 등록 토큰에 APN 토큰을 매핑하고 다운스트림 메시지 콜백 처리 중에 애널리틱스 데이터를 캡처하는 2가지 주요 영역에서 메소드를 재구성합니다. 재구성을 사용하지 않으려는 개발자는 앱의 Info.plist 파일에 FirebaseAppDelegateProxyEnabled 플래그를 추가하고 NO(부울 값)로 설정하여 재구성을 해제할 수 있습니다. 이 가이드의 관련 영역에서는 메소드 재구성을 사용할 때와 그렇지 않을 때의 코드 예를 모두 제공합니다.

iOS 프로젝트에 Firebase 추가

이 섹션에서 설명하는 작업은 앱에서 다른 Firebase 기능을 사용 설정한 경우 이미 완료된 상태일 수 있습니다. 특히 FCM의 경우 APN 인증 키를 업로드하고 원격 알림을 등록해야 합니다.

기본 요건

  • Xcode 10.1 이상을 설치합니다.

  • CocoaPods 1.4.0 이상을 설치합니다.

  • Xcode에서 프로젝트를 엽니다.

    • 프로젝트에서 iOS 8 이상을 타겟팅해야 합니다.

    • Swift 프로젝트에서 Swift 3.0 이상을 사용해야 합니다.

  • 앱을 실행할 실제 iOS 기기 또는 iOS 시뮬레이터를 설정합니다.

    • 클라우드 메시징에는 다음이 필요합니다.

      • 실제 iOS 기기
      • Apple 개발자 계정의 Apple 푸시 알림 인증 키
      • Xcode의 App(앱) > Capabilities(기능)에서 푸시 알림 사용 설정
    • 다른 모든 Firebase 제품의 경우 실제 iOS 기기 또는 iOS 시뮬레이터를 사용할 수 있습니다.

  • Google 계정을 사용하여 Firebase에 로그인합니다.

Xcode 프로젝트가 준비되지 않았다면 빠른 시작 샘플 중 하나를 다운로드하여 Firebase 제품을 사용해 볼 수 있습니다.

Firebase 프로젝트 만들기

Firebase를 iOS 앱에 추가하려면 먼저 iOS 앱에 연결할 Firebase 프로젝트를 만드세요. Firebase 프로젝트에 대한 자세한 내용은 Firebase 프로젝트 이해를 참조하세요.

Firebase에 앱 등록

Firebase 프로젝트가 준비되었으면 iOS 앱을 추가할 수 있습니다.

여러 빌드 변형을 처리하는 방법을 비롯하여 앱을 Firebase 프로젝트에 추가할 때의 권장사항 및 고려사항을 자세히 알아보려면 Firebase 프로젝트 이해를 참조하세요.

  1. Firebase Console의 프로젝트 개요 페이지 중앙에 있는 iOS 아이콘을 클릭하여 설정 워크플로를 시작합니다.

    Firebase 프로젝트에 앱을 이미 추가한 경우 앱 추가를 클릭하여 플랫폼 옵션을 표시합니다.

  2. iOS 번들 ID 필드에 앱의 번들 ID를 입력합니다.

    • XCode에서 앱을 열고 최상위 Runner 디렉터리의 General(일반) 탭에 액세스하여 이 번들 ID를 찾습니다. Bundle Identifier(번들 식별자) 필드의 값이 iOS 번들 ID입니다(예: com.yourcompany.yourproject).
  3. (선택사항) 설정 워크플로의 안내를 따라 기타 앱 정보를 입력합니다.

  4. 앱 등록을 클릭합니다.

Firebase 구성 파일 추가

  1. Download GoogleService-Info.plist(GoogleService-Info.plist 다운로드)를 클릭하여 Firebase iOS 구성 파일(GoogleService-Info.plist)을 가져옵니다.

    • 언제든지 다시 Firebase iOS 구성 파일을 다운로드할 수 있습니다.

    • 구성 파일에 (2)와 같은 추가 문자가 포함되지 않았는지 확인합니다.

  2. 구성 파일을 Xcode 프로젝트의 루트로 이동합니다. 메시지가 표시되면 모든 대상에 구성 파일을 추가하도록 선택합니다.

프로젝트에 번들 ID가 여러 개 있으면 각각 자체 GoogleService-Info.plist 파일이 포함되도록 각 번들 ID를 Firebase Console의 등록된 앱에 연결해야 합니다.

앱에 Firebase SDK 추가

CocoaPods를 사용하여 Firebase 라이브러리를 설치하는 것이 좋습니다. 하지만 CocoaPods를 사용하지 않으려는 경우 SDK 프레임워크를 직접 통합할 수 있습니다.

빠른 시작 샘플 중 하나를 사용할 경우 Xcode 프로젝트 및 Podfile(pod 포함)이 이미 있어도 Firebase 구성 파일을 추가하고 pod를 설치해야 합니다.

지원되는 Firebase 제품을 iOS 앱에 추가할 수 있습니다.

  1. Podfile이 없으면 만듭니다.

    cd your-project-directory
    pod init
  2. 앱에 사용할 pod를 Podfile에 추가합니다.

    pod 'Firebase/Core'
    pod 'Firebase/Messaging'

    이 pod는 iOS 앱에서 Firebase를 사용하기 위한 필수 라이브러리를 추가합니다.

  3. pod를 설치하고 .xcworkspace 파일을 열어 Xcode에서 프로젝트를 확인합니다.

    pod install
    open your-project.xcworkspace

APN 인증 키 업로드

Firebase에 APN 인증 키를 업로드합니다. 아직 APN 인증 키가 없으면 FCM에서 APN 구성을 참조하세요.

  1. Firebase Console의 프로젝트 내에서 톱니바퀴 아이콘을 선택하고 프로젝트 설정을 선택한 다음 클라우드 메시징 탭을 선택합니다.

  2. iOS 앱 구성APN 인증 키에서 업로드 버튼을 클릭합니다.

  3. 키를 저장한 위치로 이동하여 키를 선택하고 열기를 클릭합니다. 해당하는 키 ID(Apple Developer Member CenterCertificates, Identifiers & Profiles(인증서, 식별자, 프로필)에서 확인 가능)를 추가하고 Upload(업로드)를 클릭합니다.

앱에서 Firebase 초기화

애플리케이션에 Firebase 초기화 코드를 추가해야 합니다. 다음과 같이 Firebase 모듈을 가져오고 공유 인스턴스를 구성합니다.

  1. UIApplicationDelegate에서 Firebase 모듈을 가져옵니다.

    Swift

    import Firebase

    Objective-C

    @import Firebase;
  2. 일반적으로 앱의 application:didFinishLaunchingWithOptions: 메소드에서 FirebaseApp 공유 인스턴스를 구성합니다.

    Swift

    // Use Firebase library to configure APIs
    FirebaseApp.configure()

    Objective-C

    // Use Firebase library to configure APIs
    [FIRApp configure];

원격 알림 등록

애플리케이션이 시작될 때 또는 적절한 시점에 원격 알림에 앱을 등록합니다. 다음과 같이 registerForRemoteNotifications를 호출합니다.

Swift

if #available(iOS 10.0, *) {
  // For iOS 10 display notification (sent via APNS)
  UNUserNotificationCenter.current().delegate = self

  let authOptions: UNAuthorizationOptions = [.alert, .badge, .sound]
  UNUserNotificationCenter.current().requestAuthorization(
    options: authOptions,
    completionHandler: {_, _ in })
} else {
  let settings: UIUserNotificationSettings =
  UIUserNotificationSettings(types: [.alert, .badge, .sound], categories: nil)
  application.registerUserNotificationSettings(settings)
}

application.registerForRemoteNotifications()

Objective-C

if ([UNUserNotificationCenter class] != nil) {
  // iOS 10 or later
  // For iOS 10 display notification (sent via APNS)
  [UNUserNotificationCenter currentNotificationCenter].delegate = self;
  UNAuthorizationOptions authOptions = UNAuthorizationOptionAlert |
      UNAuthorizationOptionSound | UNAuthorizationOptionBadge;
  [[UNUserNotificationCenter currentNotificationCenter]
      requestAuthorizationWithOptions:authOptions
      completionHandler:^(BOOL granted, NSError * _Nullable error) {
        // ...
      }];
} else {
  // iOS 10 notifications aren't available; fall back to iOS 8-9 notifications.
  UIUserNotificationType allNotificationTypes =
  (UIUserNotificationTypeSound | UIUserNotificationTypeAlert | UIUserNotificationTypeBadge);
  UIUserNotificationSettings *settings =
  [UIUserNotificationSettings settingsForTypes:allNotificationTypes categories:nil];
  [application registerUserNotificationSettings:settings];
}

[application registerForRemoteNotifications];

등록 토큰 액세스

기본적으로 FCM SDK는 앱을 시작할 때 클라이언트 앱 인스턴스용 등록 토큰을 생성합니다. APN 기기 토큰과 마찬가지로 이 토큰을 사용하여 타겟팅한 알림을 앱의 모든 특정 인스턴스로 전송할 수 있습니다.

iOS가 일반적으로 앱 시작 시 APN 기기 토큰을 전달하는 것과 마찬가지로, FCM은 FIRMessagingDelegatemessaging:didReceiveRegistrationToken: 메소드를 통해 등록 토큰을 제공합니다. FCM SDK는 최초 앱 시작 시 및 토큰이 업데이트/무효화될 때마다 신규 또는 기존 토큰을 검색합니다. 어떠한 경우든 FCM SDK는 유효한 토큰이 있는 messaging:didReceiveRegistrationToken:을 호출합니다.

다음과 같은 경우에 등록 토큰이 변경될 수 있습니다.

  • 새 기기에서 앱 복원
  • 사용자가 앱 삭제/재설치
  • 사용자가 앱 데이터 소거

메시지 대리자 설정

등록 토큰을 받으려면 [FIRApp configure]을 호출한 후 메시지 대리자 프로토콜을 구현하고 FIRMessagingdelegate 속성을 설정합니다. 예를 들어 애플리케이션 대리자가 메시지 대리자 프로토콜을 준수하는 경우 application:didFinishLaunchingWithOptions:에서 대리자를 애플리케이션 대리자로 설정할 수 있습니다.

Swift

Messaging.messaging().delegate = self

Objective-C

[FIRMessaging messaging].delegate = self;

현재 등록 토큰 가져오기

등록 토큰은 messaging:didReceiveRegistrationToken: 메소드를 통해 전달됩니다. 일반적으로 앱 시작 시 등록 토큰을 사용하여 이 메소드를 한 번 호출합니다. 이 메소드가 호출되면 다음과 같은 작업을 할 수 있습니다.

  • 새 등록 토큰이라면 애플리케이션 서버에 전송합니다.
  • 등록 토큰을 주제에 구독 처리합니다. 이 작업은 신규 구독 또는 사용자의 앱 재설치 같은 상황에서만 필요합니다.

instanceIDWithHandler:를 사용하여 직접 토큰을 검색할 수 있습니다. 이 콜백은 토큰을 포함하는 InstanceIDResult를 제공합니다. 어떤 방식으로든 InstanceID 검색이 실패할 경우 null이 아닌 오류가 제공됩니다.

Swift

InstanceID.instanceID().instanceID { (result, error) in
  if let error = error {
    print("Error fetching remote instance ID: \(error)")
  } else if let result = result {
    print("Remote instance ID token: \(result.token)")
    self.instanceIDTokenMessage.text  = "Remote InstanceID token: \(result.token)"
  }
}

Objective-C

[[FIRInstanceID instanceID] instanceIDWithHandler:^(FIRInstanceIDResult * _Nullable result,
                                                    NSError * _Nullable error) {
  if (error != nil) {
    NSLog(@"Error fetching remote instance ID: %@", error);
  } else {
    NSLog(@"Remote instance ID token: %@", result.token);
    NSString* message =
      [NSString stringWithFormat:@"Remote InstanceID token: %@", result.token];
    self.instanceIDTokenMessage.text = message;
  }
}];

일반적으로 로컬에서 토큰을 사용할 수 있기 때문에 이 메소드는 네트워크 연결을 열지 않습니다. 언제든지 이 메소드를 사용하여 저장하는 대신 토큰에 액세스할 수 있습니다.

토큰 새로고침 모니터링

토큰이 업데이트될 때마다 알림을 받으려면 메시지 대리자 프로토콜을 준수하는 대리자를 제공합니다. 다음 예시에서는 대리자를 등록하고 적절한 대리자 메소드를 추가합니다.

Swift

func messaging(_ messaging: Messaging, didReceiveRegistrationToken fcmToken: String) {
  print("Firebase registration token: \(fcmToken)")

  let dataDict:[String: String] = ["token": fcmToken]
  NotificationCenter.default.post(name: Notification.Name("FCMToken"), object: nil, userInfo: dataDict)
  // TODO: If necessary send token to application server.
  // Note: This callback is fired at each app startup and whenever a new token is generated.
}

Objective-C

- (void)messaging:(FIRMessaging *)messaging didReceiveRegistrationToken:(NSString *)fcmToken {
    NSLog(@"FCM registration token: %@", fcmToken);
    // Notify about received token.
    NSDictionary *dataDict = [NSDictionary dictionaryWithObject:fcmToken forKey:@"token"];
    [[NSNotificationCenter defaultCenter] postNotificationName:
     @"FCMToken" object:nil userInfo:dataDict];
    // TODO: If necessary send token to application server.
    // Note: This callback is fired at each app startup and whenever a new token is generated.
}

대리자 메소드를 제공하는 대신 NSNotification이라는 kFIRMessagingRegistrationTokenRefreshNotification을 수신 대기할 수도 있습니다. 토큰 속성은 항상 현재 토큰 값을 갖습니다.

재구성 사용 중지됨: APN 토큰과 등록 토큰 매핑

메소드 재구성을 사용 중지했다면 APN 토큰을 명시적으로 FCM 등록 토큰에 매핑해야 합니다. didRegisterForRemoteNotificationsWithDeviceToken 메소드를 재정의하여 APN 토큰을 검색한 후 FIRMessagingAPNSToken 속성을 설정합니다.

Swift

func application(application: UIApplication,
                 didRegisterForRemoteNotificationsWithDeviceToken deviceToken: NSData) {
  Messaging.messaging().apnsToken = deviceToken
}

Objective-C

// With "FirebaseAppDelegateProxyEnabled": NO
- (void)application:(UIApplication *)application
    didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {
    [FIRMessaging messaging].APNSToken = deviceToken;
}

FCM 등록 토큰이 생성된 후 재구성이 사용 설정되었을 때와 동일한 메소드를 사용하여 토큰에 액세스하고 새로고침 이벤트를 수신 대기할 수 있습니다.

기존 사용자 APN 토큰 가져오기

기존 사용자층을 FCM 클라이언트 앱으로 흡수하려면 인스턴스 ID가 제공하는 batchImport API를 사용합니다. 이 API를 사용하면 기존 iOS APN 토큰을 대량으로 FCM에 가져와서 유효한 새 등록 토큰에 매핑할 수 있습니다.

자동 초기화 방지

FCM은 FCM 내에서 등록 토큰으로 사용하는 인스턴스 ID를 생성합니다. 인스턴스 ID가 생성되면 라이브러리는 ID와 구성 데이터를 Firebase에 업로드합니다.명시적인 수신 동의를 얻은 후 인스턴스 ID를 사용하려면 FCM을 사용 중지하여 구성 시 인스턴스 ID가 생성되는 것을 방지할 수 있습니다. FCM을 사용 중지하려면 GoogleService-Info.plist가 아닌 Info.plist에 메타데이터 값을 추가합니다.

FirebaseMessagingAutoInitEnabled = NO

FCM을 다시 사용 설정하려면 런타임 호출을 만들면 됩니다.

Swift

Messaging.messaging().autoInitEnabled = true

Objective-C

[FIRMessaging messaging].autoInitEnabled = YES;

이 값을 설정하고 나면 앱을 다시 시작해도 유지됩니다.

다음 단계

iOS 클라이언트를 설정하고 나면 앱에 메시지 처리 및 다른 고급 동작을 추가할 수 있습니다. 자세한 내용은 다음 가이드를 참조하세요.