เริ่มต้นใช้งาน Firebase Cloud Messaging ในแอปแพลตฟอร์ม Apple

คู่มือนี้อธิบายวิธีเริ่มต้นใช้งาน Firebase Cloud Messaging ในแอปไคลเอ็นต์แพลตฟอร์ม Apple (เช่น iOS) เพื่อให้คุณส่งข้อความได้อย่างน่าเชื่อถือ

สำหรับแอปไคลเอ็นต์ Apple คุณสามารถรับเพย์โหลดการแจ้งเตือนและข้อมูลได้สูงสุด 4, 096 ไบต์ผ่านอินเทอร์เฟซ Firebase Cloud Messaging APNs

หากต้องการเขียนโค้ดไคลเอ็นต์ใน Objective-C หรือ Swift เราขอแนะนำให้ใช้ FIRMessaging API ตัวอย่างคู่มือเริ่มใช้งานฉบับย่อมีโค้ดตัวอย่างสำหรับทั้ง 2 ภาษา

ก่อนเริ่มต้น ให้เพิ่ม Firebase ลงในโปรเจ็กต์ Apple

การแลกเปลี่ยนเมธอดใน Firebase Cloud Messaging

SDK ของ FCM จะทำการแลกเปลี่ยนเมธอดใน 2 ส่วนหลักๆ ได้แก่ การแมปโทเค็น APNs กับรหัสการติดตั้ง Firebase หรือโทเค็นการลงทะเบียน FCM และการบันทึกข้อมูลวิเคราะห์ระหว่างการจัดการการเรียกกลับของข้อความดาวน์สตรีม นักพัฒนาแอปที่ไม่ต้องการใช้ Swizzling สามารถปิดใช้ได้โดยเพิ่มแฟล็ก FirebaseAppDelegateProxyEnabled ในไฟล์ Info.plist ของแอปและตั้งค่าเป็นค่าบูลีน NO ส่วนที่เกี่ยวข้องของคู่มือจะมีตัวอย่างโค้ดทั้งแบบที่เปิดใช้และไม่ได้เปิดใช้การแลกเปลี่ยนเมธอด

อัปโหลดคีย์การตรวจสอบสิทธิ์ APN

อัปโหลดคีย์การตรวจสอบสิทธิ์ APNs ไปยัง Firebase หากยังไม่มีคีย์การตรวจสอบสิทธิ์ APNs ให้สร้างคีย์ใน Apple Developer Member Center

1. ในคอนโซล Firebase ให้ไปที่settings การตั้งค่า > ทั่วไป จากนั้นคลิกแท็บ Cloud Messaging
2. ในคีย์การตรวจสอบสิทธิ์ APNs ในส่วนการกำหนดค่าแอป iOS ให้คลิกอัปโหลดเพื่ออัปโหลดคีย์การตรวจสอบสิทธิ์เวอร์ชันพัฒนาหรือคีย์การตรวจสอบสิทธิ์เวอร์ชันที่ใช้งานจริง หรือทั้ง 2 อย่าง ทั้งนี้คุณต้องระบุอย่างน้อย 1 รายการ
3. เรียกดูตำแหน่งที่คุณบันทึกคีย์ไว้ เลือกคีย์ แล้วคลิกเปิด เพิ่มรหัสคีย์สำหรับคีย์ (ดูได้ใน Apple Developer Member Center) แล้วคลิกอัปโหลด

ลงทะเบียนรับการแจ้งเตือนระยะไกล

UNUserNotificationCenter.current().delegate = self

let authOptions: UNAuthorizationOptions = [.alert, .badge, .sound]
UNUserNotificationCenter.current().requestAuthorization(
  options: authOptions,
  completionHandler: { _, _ in }
)

application.registerForRemoteNotifications()
MigratedSnippets.swift

[UNUserNotificationCenter currentNotificationCenter].delegate = self;
UNAuthorizationOptions authOptions = UNAuthorizationOptionAlert |
    UNAuthorizationOptionSound | UNAuthorizationOptionBadge;
[[UNUserNotificationCenter currentNotificationCenter]
    requestAuthorizationWithOptions:authOptions
    completionHandler:^(BOOL granted, NSError * _Nullable error) {
      // ...
    }];

[application registerForRemoteNotifications];
ObjCMigratedSnippets.m

เข้าถึงรหัสการติดตั้ง Firebase

โดยค่าเริ่มต้น SDK ของ FCM จะลงทะเบียนอินสแตนซ์แอปกับ FCM และแสดงผล รหัสการติดตั้ง Firebase (FID) สำหรับอินสแตนซ์แอปไคลเอ็นต์เมื่อเปิดแอป FID นี้ช่วยให้คุณส่งการแจ้งเตือนที่กำหนดเป้าหมายไปยังอินสแตนซ์ที่เฉพาะเจาะจงของแอปได้ คล้ายกับโทเค็นอุปกรณ์ APNs

FCM จะให้ FID สำหรับการกำหนดเป้าหมายการแจ้งเตือนในลักษณะเดียวกับที่แพลตฟอร์ม Apple มักจะส่งโทเค็นอุปกรณ์ APNs เมื่อเริ่มต้นแอป SDK ของ FCM จะส่ง FID โดยใช้เมธอด messaging:didReceiveRegistration: ของ FIRMessagingDelegate, ตรวจสอบการเปลี่ยนแปลง FID โดยอัตโนมัติ และเรียกใช้เมธอดด้วย FID ใหม่เมื่อตรวจพบการเปลี่ยนแปลง เราขอแนะนำให้คุณดึงข้อมูลและอัปโหลด FID เป็นประจำ เนื่องจาก FID อาจหมุนเวียนหลังจากเริ่มต้นระบบครั้งแรก

เปิดใช้การลงทะเบียนโดยใช้รหัสการติดตั้ง Firebase

หากต้องการเปิดใช้การลงทะเบียนอินสแตนซ์แอปกับ FCM โดยใช้ รหัสการติดตั้ง Firebase (FID) ให้เพิ่มแฟล็กข้อมูลเมตาต่อไปนี้ลงในไฟล์ Info.plist ไม่ใช่ไฟล์ GoogleService-Info.plist

FirebaseMessagingInstallationIdEnabled = YES

ตั้งค่าผู้รับมอบสิทธิ์การรับส่งข้อความ

หากต้องการรับ FID ให้ใช้โปรโตคอลผู้รับมอบสิทธิ์การรับส่งข้อความและตั้งค่าพร็อพเพอร์ตี้ delegate ของ FIRMessaging หลังจากเรียกใช้ [FIRApp configure] เช่น หากผู้รับมอบสิทธิ์ของแอปพลิเคชันเป็นไปตามโปรโตคอลผู้รับมอบสิทธิ์การรับส่งข้อความ คุณสามารถตั้งค่าผู้รับมอบสิทธิ์ใน application:didFinishLaunchingWithOptions: เป็นตัวมันเองได้

Messaging.messaging().delegate = self

[FIRMessaging messaging].delegate = self;

ใช้เมธอด didReceiveRegistration

ระบบจะกำหนดเป้าหมายอินสแตนซ์แอปโดยใช้ FID เมื่อลงทะเบียนเสร็จสมบูรณ์ หากต้องการรับ FID เมื่อลงทะเบียน ให้ใช้เมธอด messaging:didReceiveRegistration: โดยปกติแล้ว ระบบจะเรียกใช้เมธอดนี้ 1 ครั้งต่อการเริ่มต้นแอปด้วย FID เมื่อเรียกใช้เมธอดนี้ คุณจะดำเนินการต่อไปนี้ได้

• หากคุณยังไม่ได้ส่ง FID ไปยังเซิร์ฟเวอร์ หรือเพิ่งส่ง FID ไปเมื่อเร็วๆ นี้ ให้ส่ง FID ไปยังเซิร์ฟเวอร์แอปพลิเคชัน
• หากการสมัครใช้บริการเป็นรายการใหม่หรือผู้ใช้ติดตั้งแอปอีกครั้ง ให้สมัครรับ FID ในหัวข้อ

func messaging(_ messaging: Messaging, didReceiveRegistration installationId: String?) {
  print("Firebase Installation ID: \(String(describing: installationId))")
  // Note: This callback is fired at each app startup.

  if let installationId = installationId {
    // Send the Firebase Installation ID to your app server.
    sendRegistrationToServer(installationId)
  }
}
    

- (void)messaging:(FIRMessaging *)messaging didReceiveRegistration:(nullable NSString *)installationId {
  NSLog(@"Firebase Installation ID: %@", installationId);
  // Note: This callback is fired at each app startup.

  if (installationId != nil) {
    // Send the Firebase Installation ID to your app server.
    [self sendRegistrationToServer:installationId];
  }
}
    

ลงทะเบียนด้วยตนเองเมื่อปิดใช้การเริ่มต้นอัตโนมัติ

หากคุณปิดใช้การเริ่มต้นอัตโนมัติ SDK ของ FCM จะไม่ลงทะเบียนอินสแตนซ์แอปกับ FCM โดยอัตโนมัติเมื่อเริ่มต้นแอป คุณต้องเรียกใช้ register เมื่อเริ่มต้นแอปเพื่อทริกเกอร์การลงทะเบียนและการส่ง FID ผ่านเมธอด messaging:didReceiveRegistration::

// Trigger manual registration if auto-initialization is turned off.
Messaging.messaging().register { error in
    if let error = error {
        // Handle the error
        print("Failed registering: \(error)")
        return
    }
    // Registration was successful. FID is delivered through the messaging:didReceiveRegistration: method.
    print("Successfully registered.")
}
    

// Trigger manual registration if auto-initialization is turned off.
[[FIRMessaging messaging] registerWithCompletion:^(NSError * _Nullable error) {
    if (error) {
        // Handle the error
        NSLog(@"Failed registering: %@", error);
        return;
    }
    // Registration was successful. FID is delivered through the messaging:didReceiveRegistration: method.
    NSLog(@"Successfully registered.");
}];
    

ปิดใช้ Swizzling: การแมปโทเค็น APN และ FID

หากปิดใช้การแลกเปลี่ยนเมธอดหรือกำลังสร้างแอป SwiftUI คุณต้องแมปโทเค็น APN กับรหัสการติดตั้ง Firebase (FID) อย่างชัดเจน ใช้เมธอด application(_:didRegisterForRemoteNotificationsWithDeviceToken:) เพื่อดึงข้อมูลโทเค็น APNs แล้วตั้งค่าพร็อพเพอร์ตี้ apnsToken ของ Messaging ดังนี้

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

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

เมื่อลงทะเบียน FID แล้ว คุณจะเข้าถึงและฟังเหตุการณ์การรีเฟรชได้โดยใช้วิธีการเดียวกับเมื่อเปิดใช้ Swizzling

เข้าถึงโทเค็นการลงทะเบียน (เลิกใช้งานแล้ว)

โดยค่าเริ่มต้น SDK ของ FCM จะสร้างโทเค็นการลงทะเบียนสำหรับอินสแตนซ์แอปไคลเอ็นต์เมื่อเปิดแอป โทเค็นนี้ช่วยให้คุณส่งการแจ้งเตือนที่กำหนดเป้าหมายไปยังอินสแตนซ์ที่เฉพาะเจาะจงของแอปได้ คล้ายกับโทเค็นอุปกรณ์ APNs

ในทำนองเดียวกันกับที่แพลตฟอร์ม Apple มักจะส่งโทเค็นอุปกรณ์ APNs เมื่อแอปเริ่มทำงาน FCM จะให้โทเค็นการลงทะเบียนผ่านเมธอด messaging:didReceiveRegistrationToken: ของ FIRMessagingDelegate FCM SDK จะดึงข้อมูลโทเค็นใหม่หรือโทเค็นที่มีอยู่ระหว่างการเปิดแอปครั้งแรก และเมื่อใดก็ตามที่มีการอัปเดตหรือทำให้โทเค็นใช้งานไม่ได้ ในทุกกรณี FCM SDK จะเรียก messaging:didReceiveRegistrationToken: พร้อมโทเค็นที่ถูกต้อง

โทเค็นการลงทะเบียนอาจเปลี่ยนแปลงในกรณีต่อไปนี้

• มีการกู้คืนแอปในอุปกรณ์เครื่องใหม่
• ผู้ใช้ถอนการติดตั้ง/ติดตั้งแอปอีกครั้ง
• ผู้ใช้ล้างข้อมูลแอป

ตั้งค่าผู้รับมอบสิทธิ์การรับส่งข้อความ

หากต้องการรับโทเค็นการลงทะเบียน ให้ใช้โปรโตคอลผู้รับมอบสิทธิ์การรับส่งข้อความและตั้งค่าพร็อพเพอร์ตี้ delegate ของ FIRMessaging หลังจากเรียกใช้ [FIRApp configure] เช่น หากผู้รับมอบสิทธิ์ของแอปพลิเคชันเป็นไปตามโปรโตคอลผู้รับมอบสิทธิ์การรับส่งข้อความ คุณสามารถตั้งค่าผู้รับมอบสิทธิ์ใน application:didFinishLaunchingWithOptions: เป็นตัวมันเองได้

Messaging.messaging().delegate = self

[FIRMessaging messaging].delegate = self;

กำลังดึงข้อมูลโทเค็นการลงทะเบียนปัจจุบัน

ระบบจะส่งโทเค็นการลงทะเบียนผ่านเมธอด messaging:didReceiveRegistrationToken: โดยทั่วไปแล้ว ระบบจะเรียกใช้เมธอดนี้ 1 ครั้งต่อการเริ่มต้นแอปด้วยโทเค็นการลงทะเบียน เมื่อมีการเรียกใช้เมธอดนี้ คุณควรดำเนินการต่อไปนี้

• หากโทเค็นการลงทะเบียนเป็นโทเค็นใหม่ ให้ส่งไปยังเซิร์ฟเวอร์แอปพลิเคชัน
• สมัครรับข้อมูลหัวข้อต่างๆ ด้วยโทเค็นการลงทะเบียน ซึ่งจำเป็นสำหรับการสมัครใช้บริการใหม่หรือในกรณีที่ผู้ใช้ติดตั้งแอปอีกครั้งเท่านั้น

คุณสามารถดึงข้อมูลโทเค็นได้โดยตรงโดยใช้ token(completion:) ระบบจะแสดงข้อผิดพลาดที่ไม่ใช่ค่า Null หากการดึงข้อมูลโทเค็นไม่สำเร็จไม่ว่าด้วยวิธีใดก็ตาม

Messaging.messaging().token { token, error in
  if let error = error {
    print("Error fetching remote FCM registration token: \(error)")
  } else if let token = token {
    print("Remote instance ID token: \(token)")
  }
}

[[FIRMessaging messaging] tokenWithCompletion:^(NSString * _Nullable token, NSError * _Nullable error) {
  if (error != nil) {
    NSLog(@"Error fetching the remote FCM registration token: %@", error);
  } else {
    NSLog(@"Remote FCM registration token: %@", token);
    NSString* message =
      [NSString stringWithFormat:@"FCM registration token: %@", token];
    // display message
    NSLog(@"%@", message);
  }
}];

คุณสามารถใช้วิธีนี้ได้ทุกเมื่อเพื่อเข้าถึงโทเค็นแทนการจัดเก็บ

ตรวจสอบการรีเฟรชโทเค็น

หากต้องการรับการแจ้งเตือนเมื่อมีการอัปเดตโทเค็น ให้ระบุผู้รับมอบสิทธิ์ที่สอดคล้องกับโปรโตคอลผู้รับมอบสิทธิ์การรับส่งข้อความ ตัวอย่างต่อไปนี้จะลงทะเบียนผู้รับมอบสิทธิ์และเพิ่มเมธอดผู้รับมอบสิทธิ์ที่เหมาะสม

func messaging(_ messaging: Messaging, didReceiveRegistrationToken fcmToken: String?) {
  print("Firebase registration token: \(String(describing: fcmToken))")
  // TODO: If necessary send token to application server.
  // Note: This callback is fired at each app startup and whenever a new token is generated.
}
MigratedSnippets.swift

- (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.
}
ObjCMigratedSnippets.m

หรือจะรอฟัง NSNotification ที่ชื่อว่า kFIRMessagingRegistrationTokenRefreshNotification แทนการระบุเมธอดผู้รับมอบสิทธิ์ก็ได้ พร็อพเพอร์ตี้โทเค็นจะมีค่าโทเค็นปัจจุบันเสมอ

ปิดใช้ Swizzling: การแมปโทเค็น APNs และโทเค็นการลงทะเบียน

หากปิดใช้การแลกเปลี่ยนเมธอดหรือกำลังสร้างแอป SwiftUI คุณจะต้องแมปโทเค็น APNs กับโทเค็นการลงทะเบียน FCM อย่างชัดเจน ใช้เมธอด application(_:didRegisterForRemoteNotificationsWithDeviceToken:) เพื่อดึงข้อมูลโทเค็น APNs แล้วตั้งค่าพร็อพเพอร์ตี้ apnsToken ของ Messaging ดังนี้

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

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

หลังจากสร้างโทเค็นการลงทะเบียน FCM แล้ว คุณจะเข้าถึงโทเค็นและฟังเหตุการณ์การรีเฟรชได้โดยใช้วิธีการเดียวกับที่เปิดใช้ Swizzling

ป้องกันการเริ่มต้นอัตโนมัติ

เมื่อมีการสร้างการลงทะเบียน FCM ไลบรารีจะอัปโหลดตัวระบุและข้อมูลการกำหนดค่าไปยัง Firebase หากต้องการให้ผู้ใช้เลือกรับอย่างชัดแจ้งก่อน คุณสามารถป้องกันการลงทะเบียนอัตโนมัติในเวลาที่กำหนดค่าได้โดยปิดใช้ FCM โดยเพิ่มค่าข้อมูลเมตาลงใน Info.plist (ไม่ใช่ GoogleService-Info.plist) ดังนี้

FirebaseMessagingAutoInitEnabled = NO

หากต้องการเปิดใช้ FCM อีกครั้ง คุณสามารถเรียกใช้รันไทม์ได้โดยทำดังนี้

Messaging.messaging().autoInitEnabled = true

[FIRMessaging messaging].autoInitEnabled = YES;

ค่านี้จะยังคงอยู่เมื่อรีสตาร์ทแอปเมื่อตั้งค่าแล้ว

ตั้งค่าส่วนขยายบริการการแจ้งเตือน

หากต้องการส่งการแจ้งเตือนที่มีรูปภาพไปยังอุปกรณ์ Apple คุณต้องเพิ่มส่วนขยายบริการการแจ้งเตือน ส่วนขยายนี้ช่วยให้อุปกรณ์แสดงรูปภาพที่ส่งในเพย์โหลดการแจ้งเตือนได้ หากคุณไม่ได้วางแผนที่จะส่งรูปภาพในการแจ้งเตือน คุณสามารถข้ามขั้นตอนนี้ได้

หากต้องการเพิ่มส่วนขยายบริการ ให้ดำเนินการตั้งค่าที่จำเป็นสำหรับการแก้ไขและแสดงการแจ้งเตือนใน APN จากนั้นเพิ่ม API ตัวช่วยส่วนขยาย FCM ใน NotificationService.m กล่าวคือ แทนที่จะเรียกใช้ Callback ด้วย self.contentHandler(self.bestAttemptContent); ให้เรียกใช้ด้วย FIRMessaging extensionHelper ดังที่แสดงต่อไปนี้

@interface NotificationService () <NSURLSessionDelegate>
@property(nonatomic) void (^contentHandler)(UNNotificationContent *contentToDeliver);
@property(nonatomic) UNMutableNotificationContent *bestAttemptContent;
@end

@implementation NotificationService

- (void)didReceiveNotificationRequest:(UNNotificationRequest *)request withContentHandler:(void (^)(UNNotificationContent * _Nonnull))contentHandler {
    self.contentHandler = contentHandler;
self.bestAttemptContent = [request.content mutableCopy];

    // Modify the notification content here as you want
self.bestAttemptContent.title = [NSString stringWithFormat:@"%@ [modified]",
self.bestAttemptContent.title];

  // Call FIRMessaging extension helper API.
  [[FIRMessaging extensionHelper] populateNotificationContent:self.bestAttemptContent
withContentHandler:contentHandler];

}
...

ส่งข้อความแจ้งเตือน

1. ติดตั้งและเรียกใช้แอปในอุปกรณ์เป้าหมาย ในอุปกรณ์ Apple ให้ยอมรับคำขอสิทธิ์เพื่อรับการแจ้งเตือนระยะไกล

2. ตรวจสอบว่าแอปทำงานอยู่เบื้องหลังในอุปกรณ์

3. ในคอนโซล Firebase ให้ไปที่ DevOps และการมีส่วนร่วม > การรับส่งข้อความ

4. สร้างแคมเปญ

   • หากนี่เป็นข้อความแรกของคุณ ให้ทำดังนี้

     1. เลือกสร้างแคมเปญแรก

     2. เลือกข้อความแจ้งเตือนของ Firebase แล้วเลือกสร้าง

   • หากคุณเคยสร้างแคมเปญไว้ก่อนหน้านี้ ให้ทำดังนี้

     1. ในแท็บแคมเปญ ให้เลือกแคมเปญใหม่

     2. คลิกการแจ้งเตือน

5. ป้อนข้อความ

6. เลือกส่งข้อความทดสอบจากแผงด้านขวา

7. ในช่องที่มีป้ายกำกับว่าเพิ่มรหัสการติดตั้ง Firebase หรือFCM โทเค็นการลงทะเบียน ให้ป้อนโทเค็นการลงทะเบียน

8. เลือกทดสอบ

หลังจากเลือกทดสอบแล้ว อุปกรณ์ไคลเอ็นต์เป้าหมายที่มีแอปทำงานอยู่เบื้องหลังควรได้รับการแจ้งเตือน

หากต้องการดูข้อมูลเชิงลึกเกี่ยวกับการส่งข้อความไปยังแอป ให้ไปที่แดชบอร์ดDevOps และการมีส่วนร่วม > การรับส่งข้อความ > รายงานในคอนโซล Firebase แดชบอร์ดนี้จะบันทึกจำนวนข้อความที่ส่งและเปิดในอุปกรณ์ Apple และอุปกรณ์ Android พร้อมกับข้อมูล "การแสดงผล" (การแจ้งเตือนที่ผู้ใช้เห็น) สำหรับแอป Android

ขั้นตอนถัดไป

หลังจากทำตามขั้นตอนการตั้งค่าเสร็จแล้ว ต่อไปนี้คือตัวเลือกบางส่วนสำหรับการดำเนินการต่อด้วย FCM สำหรับแพลตฟอร์ม Apple

• ส่งข้อความไปยังอุปกรณ์
• รับข้อความในแอป Apple
• ส่งข้อความไปยังหัวข้อ