Table of Contents

プッシュ通知を使用するアプリは、これまでも何度か実装してきたのですが、使用するメソッドなどが曖昧なまま実装していました。改めてゼロからセットアップしながら、プッシュ通知の実装方法、実装するメソッドをまとめます。

プッシュ通知で登場する3つの通知 #

はじめに、プッシュ通知関連の用語を整理します。特に以下の3種類の言葉を使い分けることで、機能の理解がぐっと深まります。

リモート通知・リモートプッシュ（Remote Notification）: Appleのプッシュ通知基盤である「APNs」を介して、開発者側からユーザーの端末にデータを通知する仕組みのこと。
ローカル通知（Local Notification）: 時刻やタイマー・位置情報などのトリガーに発火する通知のこと。端末内で完結する通知のこと。
ユーザー通知（User Notification）: ユーザーを巻き込んだ通知のこと。音や振動をともなって、画面の上部にバナーが表示されたり、通知センターにアイテムが表示されたりする。

これらのなかでも、特に「リモート通知」による「ユーザー通知」のことが「プッシュ通知」と呼ばれています。この投稿でも、リモート通知でユーザー通知をする方法を扱います。

それでは、セットアップと実装を進めていきます。

ユーザー通知の許可を求める #

まず、ユーザー通知の許可を求めます。この許可を得る作業は「通知センターやバナーで情報を表示すること = ユーザーの邪魔をすること」に対して許可を求めるものであって、リモート通知の許可を得ているわけではありません。通知する情報がたどってくる「経路」と、通知の「表示」は区別して考えます。

リモート通知に許諾は不要です、後述のCapability追加でセットアップします。
バックグラウンドプッシュのみの場合は、この作業は不要です。

実装するコードは以下のコードです。

// ViewControllerなどに実装する

import UserNotifications

let center = UNUserNotificationCenter.current()
center.requestAuthorization(options: [.alert, .badge, .sound]) { [weak self] granted, error in
    // grantedやerrorを使用して、後続処理を実装する
}

この実装によって、いつもの通知許諾のアラートダイアログを表示することができます。

ちなみに、optionsにつけられる値もいくつかあるので見ておきます。

badge: アプリアイコンに数字のバッジ（赤丸）をつけられる
sound: 音を鳴らすことができる
alert: アラート（通知）を画面に表示する
providesAppNotificationSettings: 設定アプリから、アプリ内の通知設定画面へ誘導できるようになる（後述）
provisional: 通知のお試し期間を設けられる。通知センターの通知アイテムに「このアプリからの通知をまだ受けますか」と表示される。（後述）

soundだけbadgeだけというのはあまり見かけません。ほとんどは、.alert, .sound, .badgeを指定します。通知がそれほど重要ではないアプリ（たとえばプロモーションだけなど）の場合は、 .provisionalを使うこともあるかもしれません。

`.provisional`を指定したときの挙動 #

requestAuthorizationのoptionsに.provisionalを指定した場合は、ユーザー通知の許諾ダイアログは表示されません。その代わり、requestAuthorizationメソッドを実行したタイミングで、すぐに通知が許可されます。ただし、通知は、通知センターにしか表示されません。（バナー・サウンド・バッジは無い）

このときの通知設定状況は「目立たない形で配信」になっています。ユーザーが通知に気づくまでは、邪魔にならないようにしているようです。

通知センターの通知から、通知の受信を「続ける」を選択すると、「すぐに配信」か「時刻指定要約で配信」を選べます（iOS 15から）。

「すぐに配信」を選択しても、バナーやサウンドの許可状態は変わらないようです。ユーザーが、設定アプリでバナーやサウンドの許可をする必要があります。

もし通知センターで通知を「オフにする…」をタップすると、アクションシートが表示され「通知をすべてオフにする」を選択することになります。もし、requestAuthorizationで.providesAppNotificationSettingsの指定も入れていた場合は、アプリの通知設定画面へ誘導するボタンも追加されます。

`.providesAppNotificationSettings`を指定したときの挙動 #

設定アプリの通知設定画面に、アプリ内の通知設定画面へ誘導するボタンが表示されるようになります。

リモート通知をセットアップする 1: 端末とAPNsの連携 #

ユーザー通知の許諾を実装したら、次はリモート通知をセットアップしていきます。ここからはまず、端末とAPNsを連携させる部分を行います。

Push NotificationをCapablityに追加する #

リモート通知を使用できるようにするため、アプリのターゲットに対してPush NotificationのCapabilityを追加します。プロビジョニングプロファイルを自動で設定している場合は、このタイミングでプロビジョニングプロファイルが更新されます。

リモート通知を受信できるようにするため、APNsに端末を登録する #

CapabilityにPush Notificationを追加できたら、次はAPNsからリモート通知を受信できるようにするため、以下の実装を追加します。

import UIKit

// ViewControllerやAppDelegateなどで

UIApplication.shared.registerForRemoteNotifications()

これを呼び出すタイミングに特別な指定はなく、APNsに端末を登録したくなったタイミングで行います。よく見かける実装では、最初に実装したUNUserNotificationCenter.current().requestAuthorization(options:completionHandler)メソッドのCompletion Handler内で行うことが多いです。

ただし、registerForRemoteNotificationsとrequestAuthorizationは区別して考えてください。「リモート通知」を受けるためにAPNsに端末を登録することと、「ユーザー通知」の許可を得ることは、別のものです。ユーザー通知の許可を得ないとAPNsに端末を登録できないのではありません。ユーザー通知の許可を得ていなくても、バックグラウンド通知は受信することができます。

バックグラウンドプッシュ（サイレントプッシュ）する場合は、registerForRemoteNotificationsを呼ぶだけで十分です。AppDelegateのdidFinishLaunchingWithOptionsなどの初期化処理のうちに済ませるのが都合が良さそうです。

参考

Registering Your App with APNs

デバイストークンを受け取る #

registerForRemoteNotifications()を呼んだので、次はデバイストークンを受け取ります。実装するメソッドは以下のとおりです。

application(_:didRegisterForRemoteNotificationsWithDeviceToken)
application(_:didFailToRegisterForRemoteNotificationsWithError)

ここは定型文で良いでしょう。

func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
    let tokenParts = deviceToken.map { data -> String in
        return String(format: "%02.2hhx", data)
    }
    let token = tokenParts.joined()
    logger.info("Device Token: \(token)")

    // 自身の管理するサーバにトークンを送信するなど、トークンを保持する作業をします
    // Appleのドキュメントでは、トークンはローカルに置かないようにしましょうとのこと。
}

func application(_ application: UIApplication, didFailToRegisterForRemoteNotificationsWithError error: Error) {
    logger.error("Failed to register for remote notifications with error: \(error.localizedDescription)")
}

ここまでの作業で、端末とAPNsを連携させる部分が実装できました。

参考

リモート通知をセットアップする 2: サーバとAPNsの連携 #

次は、自身の管理するサーバやFirebase・AWSなどのマネージドサービスと、APNsを連携させていきます。

リモートプッシュの証明書またはキーを作成する #

サーバからAPNsへの通信には、証明書(p12)による署名またはキー(p8)による暗号化が必要です。 Apple Developerのサイトへログインしたら、証明書を使用する場合は「Identifiers」から、キーを使用する場合は「Keys」のメニューから行います。どちらを選ぶかは、今後の運用方法なども考慮して決めると良いでしょう。

	証明書(p12)	キー(p8)
適用範囲	AppIDごと	1チーム(開発者)で共通
更新の有無	あり(1年に1回)	なし(同じキーを永続使用)
紛失時の再発行	あり(秘密鍵は紛失しないことが条件)	なし(紛失時は再作成)
証明書・鍵交換時のダウンタイム	なし(証明書は2つ作れるので、ダウンタイム無しで交換できる。p12ファイルの差し替えでOK)	あり(キーの再作成時にダウンタイムが発生する)