More than 3 years have passed since last update.

追加要件：FCMにて画像付きPush通知を送る iOS10以上

Posted at 2020-06-03

前置き

FCMコンソールからのPush通知が実装済みからの追加要件という内容です。
今回の記事では送信方法としてPostmanを使用しております。
なるべく細かく書くつもりですが、後半になるにつれ適当になる可能性があります。

概要

iOS10から追加された Notification Service Extension を利用する。
これは「送信されたペイロード」 -> 「端末に表示」　までの間の部分をあれこれ出来る。
そのため表示される前に画像を読み込んで、それを表示させるといった流れを行える。

Certificates, Identifiers & Profiles -> Profiles -> 「+」押下
App Store -> 先ほど作成したApp IDs選択 -> メインと同じCertificateファイルで作成
作成すると既存Provisioningファイルが無効になるため Edit -> Save をし更新する。
xcodeに戻る。
XcodeメニューバーのXcode -> Preferences -> Download Manual Profiles より先ほど作成したProvisioningファイルをDL
各TARGETSに適切なProvisioningProfileを選択

MainAppのSigning & CapabilitiesにBackground　Modesを追加

Notification Service Extension編集

NotificationService.swift

override func didReceive(_ request: UNNotificationRequest, withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void) {
    
    self.contentHandler = contentHandler
    bestAttemptContent = (request.content.mutableCopy() as? UNMutableNotificationContent)
    
    self.realmWrite(request: request, bestAttemptContent: bestAttemptContent)
    
    if let imageUrl = request.content.userInfo["image_url"] as? String {
        let session = URLSession(configuration: URLSessionConfiguration.default)
        let task = session.dataTask(with: URL(string: imageUrl)!, completionHandler: {[weak self](data, response, error) in
            do {
                if let writePath = NSURL(fileURLWithPath:NSTemporaryDirectory())
                    .appendingPathComponent("tmp.jpg") {
                    try data?.write(to: writePath)
                    let identifier = "hogehoge"

                    if let bestAttemptContent = self?.bestAttemptContent {
                        let attachment = try UNNotificationAttachment(identifier: identifier, url: writePath, options: nil)
                        bestAttemptContent.attachments = [attachment]
                        contentHandler(bestAttemptContent)
                    }
                } else {
                    if let bestAttemptContent = self?.bestAttemptContent {
                        contentHandler(bestAttemptContent)
                    }
                }
            } catch let error as NSError {
                print(error.localizedDescription)

                if let bestAttemptContent = self?.bestAttemptContent {
                    contentHandler(bestAttemptContent)
                }
            }
        })
        task.resume()
    } else {
        if let bestAttemptContent = self.bestAttemptContent {
            contentHandler(bestAttemptContent)
        }
    }
}

override func serviceExtensionTimeWillExpire() {
    if let contentHandler = contentHandler, let bestAttemptContent =  bestAttemptContent {
        // 実行時間をすぎた場合の救済
        contentHandler(bestAttemptContent)
    }
}

送信

送り先

POST: https://fcm.googleapis.com/fcm/send

Header

Content-Type:application/json
Authorization:key=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Firebase
歯車アイコン -> プロジェクト設定 -> CloudMessaging

サーバーキーのトークンをコピー

「xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx」をコピーしたトークンに変更

Body

{
    "data" : {
        "image_url":"https://hogehoge.jp/fugafuga.png",
    	"type" : "1"
    },
    "notification" : {
    	"title": "タイトル",
        "body": "ボディ"
	},
	"mutable_content": true,
	"content_available": true,
    "to" : "token or topic"
}

Key:toに指定するもの

少しAppDelegateに追加

AppDelegate.swift

extension AppDelegate: MessagingDelegate {
    func messaging(_ messaging: Messaging, didReceiveRegistrationToken fcmToken: String) {
        print("fcmToken:\(fcmToken)")
        Messaging.messaging().subscribe(toTopic: "/topics/global") { error in
            if let error = error {
                print("TopicErrorRegistError: \(error)")
            }
        }
    }
}

この状態でビルドし、コンソールに表示されたものを利用。

デバイス単体に送りたい場合はfcmToken:xxxxxxxxxxxxxxxxxのxxxxxxxxxxxxxxxxx部分
topic購読している全デバイスに送りたい場合は/topics/global

toTopicはお好きなもので。

いざ！送信！！
届かなかった方はコメントください。

追記

Debug

NotificationServiceがきちんと走っている？？
と気になりDebugで止めたい場合はMainAppをビルドし一旦メインをデバイスに流した後、NotificationServiceを指定してビルドすることで可能

脱線

今回の内容と少し違いますが
AppGroupsを利用することでMainとPushに共通データを持つことが可能。
例えば通知を見逃したユーザのために、通知履歴などをアプリに実装。

~流れ~

通知を送る
NotificationService.swiftにてRealm等に保存処理(SharingPath)
MainAppにてSharingPathを元に通知Appにて保存したデータを共有Realmから読み取る
データを元に履歴List画面作成

jsonのdataに任意の値(この記事でいうtype)を追加するなどすれば、履歴リストからタップし、画面遷移なども行えますね！

需要がありそうなら細かく書きますが、、
こんなこともできますよーという話でした。

You get articles that match your needs
You can efficiently read back useful information
You can use dark theme

What you can do with signing up