制約されたネットワークでローカルプッシュ接続性を構築する

制約されたネットワークでローカルプッシュ接続性を構築する

ローカルプッシュ接続性を活用し、Appサーバーからネットワーク上のデバイスへ、インターネット接続の無い状況でも通知を配信できます。制約されたネットワーク環境で実行するApp向けに通知を構築する方法、期待されるインターネット接続時と同様の信頼性と体験を提供しコミュニケーションを継続するための通知を構築する方法をお伝えします。この技術を利用したくなった時にApp内でどう実装するか、テクニカルな詳細も説明します。

リソース
ダウンロード

こんにちは WWDCへようこそ
“制約されたネットワークでローカルプッシュ接続性を構築する” パレッシュ･サワントです本日はiOS 14の新機能ローカルプッシュ接続APIについてお話ししますプッシュ通知はアプリケーションユーザに対しタイムリーで関連性の高い情報を知らせ続けることができるすばらしい技術ですしかしプッシュ通知はAppleのプッシュ通知サービスに依存していますデバイスがインターネットに接続している時にしか使えません皆さんからのフィードバックでアプリケーションサーバーからメッセージを受け取る能力がアプリケーションの機能に欠かせずなおかつインターネット接続がなくても動作しなくてはならないというご意見がありましたアプリケーションへのこの要望を満たすために iOS 14では新しいAPIを追加しましたそれはWi-Fiネットワークで動作する独自のプッシュ接続サービスの作成を可能にしますまずAppleのプッシュ通知をおさらいしましょうそれから新しいAPIを使用してカスタムプッシュ通知サービスを構築する方法をお話ししますその後サンプルアプリケーションを使ってこの新しい機能のデモを行いますそして新しいAPIの使用についての詳細に進みますでは始めましょう皆さんの多くはプッシュ通知をよくご存知と思います多くのアプリケーションはプッシュ通知をニュース速報やスポーツの更新インスタントメッセージやVoIP電話の受信などその他多くのことに使用していますどのように動作するのか確認しておきましょうプロバイダサーバーから Appleプッシュ通知サービス別名APNへプッシュ通知依頼を送ります APNは各対象デバイスに対して対応する通知ペイロードを運びます通知を受け取るとシステムはデバイス上の適切なアプリケーションにそのペイロードを届けます通知タイプによってアプリケーションがペイロードを受け取るために PushKitかUserNotificationsのいずれかのフレームワークを使います APNはプッシュ通知機能の中で最も重要な部分ですプッシュ通知はAPN接続またはインターネットが利用可能なデバイスで使用するにはアプリケーションに適したソリューションですデバイス上のすべてのアプリケーションへ通知を届けるのに最適な方法ですデバイスとAPNの間の単一の接続を実装するからですプッシュ通知はアプリケーションで期待通りのユーザ体験をもたらしますそして最も重要なことにエネルギー効率も良好ですしたがってデベロッパーは PushKitかUserNotificationのどちらかのフレームワークでサーバーから発信する通知を取り扱うことを選ぶべきですただし APNの届かないネットワーク環境でアプリケーションが使われる場合アプリケーションはこれらの通知を受け取ることができませんたとえばクルーズ船や飛行機キャンプ場や病院では APN接続が限定されるかまったくないことがありますそうした条件ではアプリケーションのプッシュ通知機能が万全に働かない可能性がありますプッシュ通知はユーザにタイムリーな情報を提供しユーザがそれに反応して適切なアクションをとれるよう重要な役割を果たしていますそのためユーザに重要なことのために制限されたネットワーク環境でもプッシュ通知が機能し続けるようにすることが大切ですローカルプッシュ接続はこの問題を解決するために設計されたソリューションですそしてiOS 14にはローカルプッシュ接続APIが追加されましたこれはAPIのうちNetworkExtensionファミリーの新しい一員ですどう機能するかみてみましょうこの新しいAPIのおかげでローカルWi-Fiネットワークにあるプロバイダサーバーと通信するアプリケーション拡張機能を構築することができます APNはありませんのでプロバイダサーバーとアプリケーション拡張の間で通知を届けるプロトコルを独自で定義する必要がありますアプリケーションユーザ向けのローカルプッシュ通信を有効にするWi-Fiネットワークをアプリケーションで指定しておく必要がありますデバイスが指定されたWi-Fiネットワークに接続するとシステムがアプリケーション拡張機能を起動しますアプリケーション拡張機能はプロバイダサーバーとのネットワーク接続を維持し通知を受け取る責任を負いますデバイスが指定されたWi-Fiネットワークに接続しているかぎりアプリケーション拡張機能はバックグラウンドで実行し続けますデバイスが指定されたWi-Fiネットワークとの接続を失うとシステムはアプリケーション拡張機能を停止しますさて新しいローカルプッシュ接続APIについてご説明しましたそして標準のプッシュ通知についても再確認しましたそこでアプリケーションにとって正しいAPIを選択する一般的なガイドラインをご説明します一般的なプッシュ通知の要求には PushKitまたはUserNotifications フレームワークのいずれかを選ぶべきですローカルプッシュ接続APIは非常に特定されたユースケースのごく少数の場合のために設計されていますユースケースは主にネットワーク環境が限定されていることとその環境におけるユーザの要求によって定義されますローカルプッシュ接続は通知が必要不可欠でネットワーク環境が制限された場面で正しいソリューションになりえますローカルプッシュ接続APIを使った特定のユースケースを実装するには新しい権限を申請する必要がありますこれらの2つのメカニズムを互いに比較した時どのような特徴があるか見てみましょう新しいローカルプッシュ接続はすべてプロバイダサーバーとアプリケーション拡張機能との間の直接通信です指定したWi-Fiネットワークで独自のプロトコルを使用しますそれは完全にあなたの管理下にありますアプリケーション拡張機能が多様な通知をどのように取り扱うか確認しましょうユーザ向けの通知を受領するとアプリケーション拡張機能はローカル通知を使いユーザの注意を惹きますアプリケーション拡張機能コードは UserNotificationsフレームワークを使ってローカル通知を作成してスケジューリングしますアラートを表示したりサウンドを再生したりアプリケーションのアイコンにバッジをつけたりできますたとえばテキストメッセージの通知を受領するとこのように画面の上部から降りてくるバナーでユーザに通知しますアプリケーション拡張機能は常にユーザローカル通知を使ってユーザに対する通知を行います
ここでアプリケーション拡張機能がVoIP通知をどう扱えるのか見てみましょうこの通知はアプリケーションユーザに着信VoIP通話の情報を伝えます
VoIP通知を受け取るとアプリケーション拡張機能はNEAppPushProvider クラスを使ってシステムに着信があることを報告しますシステムはそれに反応して起動していない場合親アプリケーションを起動しそこへ着信情報を届けます親アプリケーションは CallKitフレームワークを使って着信電話のUIをこのように表示します後でアプリケーション内でVoIP通知の取り扱い方詳細をお話ししますそれではデモアプリケーションで動作を見ましょうクルーズ船ではインターネット接続は限定されているか使用できませんまたは有料データプランが提供されることもありますこのデモではクルーズ船会社がSimplePushという名前のアプリケーションを開発したとします新しいローカルプッシュ接続 APIを使用していますテキストメッセージングと VoIPサービスを提供します乗船中の友人や家族とこのアプリケーションで連絡を取り合えるようにしたいためですジェーンとジョンはこのアプリケーションの利用者です彼らはSimplePushアプリケーションを使って通信しています彼らのデバイスにはインターネット接続がありませんが
これはジェーンのデバイスでこちらがジョンのデバイスですジェーンのデバイスの中の SimplePushアプリケーションの設定を見ましょう
設定はプロバイダサーバーのホスト名とローカルプッシュ接続が有効な Wi-FiネットワークのSSIDは
この通りですジェーンのデバイスは Cruise Ship Wi-Fiに接続されています
連絡先ですジェーンからジョンに対してテキストメッセージを送信してみますするとジョンにはテキストメッセージが送信されます先に進みましょう連絡先からジョンを選択しテキストボタンをタップします
「こんにちはジョン」と打ち込み…
送信ボタンをタップしますするとジョンのデバイスには通知が表示されますジョンが通知をタップするとSimplePush アプリケーションのメッセージが開きます
次にジェーンがジョンに音声通話をかけます
するとジョンのデバイスには着信UIが表示されますジョンが通話をとると
通話が進行中であることがご覧いただけます
ジョンが電話を切ります
以上が簡単ですが iOS 14の新機能ローカルプッシュ接続APIを使った SimplePushアプリケーションのデモです新しいローカルプッシュ接続APIは２つのクラスからなります NEAppPushManagerとNEAppPushProviderです NEAppPushManagerクラスは親アプリケーションが使用しますアプリケーション拡張機能コードは NEAppPushProviderクラスのサブクラスを実装します
アプリケーション拡張機能と親アプリケーションは両方ともこのAPIを使ったNEAppPushProvider 権限を持っている必要があります親アプリケーションはNEAppPushManagerクラスのインスタンスを使用して設定を作成しますその中には主にローカルプッシュ接続が動作するWi-Fiネットワークの情報が入っていますこのクラスを使って設定をロード保存削除できます VoIPアプリケーションを実装するのであれば NEAppPushManagerクラスは着信VoIP通話を取り扱うデリゲートを設定するためにも使用しますアプリケーション拡張機能にはNEAppPushProvider クラスのサブクラスが実装されますこのクラスはサブクラス内でオーバーライドする必要があるライフサイクル管理メソッドを定義しますこのメソッドはアプリケーション拡張機能の起動時と終了時にシステムに呼び出されますデバイスが指定したWi-Fiネットワークに接続するとアプリケーション拡張機能が起動されますデバイスが指定したWi-Fiネットワークとの接続を失うとシステムはアプリケーション拡張機能を停止しますアプリケーション拡張機能は起動するとプロバイダサーバーとの間のネットワーク接続を確立しますそして終了時には接続を切断します VoIP通知を受け取るとアプリケーション拡張機能はこのクラスを使用してシステムに着信があったことを報告しますそれに対してシステムは親アプリケーションを起動して着信情報を渡します設定を作成するためアプリケーションがどのように NEAppPushManagerを使用するか見てみましょう NetworkExtensionモジュールをインポートする必要がありますローカルプッシュ接続APIを使用するためです
アプリケーションプッシュプロバイダ用の設定を作成するのは非常に簡単です
NEAppPushManagerクラスのインスタンスを作成する必要がありそれをこれらのプロパティを設定するのに使います対象SSIDはローカルプッシュ接続を有効にしたいWi-Fiネットワークの SSIDの範囲を指定します
providerBundleIdentifierはアプリケーション拡張機能のバンドルIDですこの設定でシステムは必要な時にアプリケーション拡張機能を実行できます
プロバイダ設定はアプリケーション拡張機能の設定データを規定する辞書です
最後にisEnabledを「true」に設定しますローカルプッシュ接続がこの設定を使用できるようにするためです
すべての設定が終わったら saveToPreferencesメソッドを呼び出して設定を処理します設定の保存に成功して有効化できたらシステムはこの設定を使ってローカルプッシュ接続を有効化しますアプリケーション拡張機能は NEAppPushProviderクラスを実装して必要なメソッドをオーバーライドします
システムはstartwithcompletionHandlerを呼び出してアプリケーション拡張機能を起動しますアプリケーション拡張機能はこのメソッドの中でサーバーとの間にネットワーク接続を確立しますアプリケーション拡張機能が停止した場合システムはstopwithreasonを呼び出しますアプリケーション拡張機能はこのメソッドでサーバー接続を切断します VoIP通知を受領するとアプリケーション拡張機能は reportincomingCallを呼び出して着信VoIP通話があることをシステムに報告しますそれに対してシステムは実行されていない場合は親アプリケーションを起動しますそして通話情報を渡します最後のスライドにあるようにアプリケーション拡張機能はVoIP着信があることをシステムに報告する責任がありますそれに反応してシステムはアプリケーションを起動します親アプリケーションには UIApplicationDelegateプロトコルに準拠したアプリケーションデリゲーションオブジェクトが実装されていなくてはなりませんアプリケーションプロセスが起動されたことを知るために必要ですアプリケーションは起動すると loadAllFromPreferncesを呼び出してすべての保存された設定をロードしなくてはなりません各NEAppPushManagerインスタンスに対して NEAppPushDelegateオブジェクトをこのようにセットします
システムは親アプリケーションに対してユーザ情報辞書をデリゲートメソッドを呼び出すことで提供しますアプリケーションのメインの待ち行列上の適切なNEAppPushManagerインスタンスに対してユーザ情報の受領と同時にアプリケーションはCallKitに対して着信があることを適切なCallKit APIを使い報告し通話UIを表示します着信の報告について詳細は CallKit APIのドキュメントをご覧くださいほかにはSimplePushサンプルアプリケーションコードをご参照ください着信情報を受領するには親アプリケーションは Voice over IPバックグラウンドモードを有効にしている必要があることにご注意くださいこのように Xcodeのプロジェクト特性ペーンにあります iOS 14から導入された新しいローカルプッシュ接続APIの詳細をご説明しましたアプリケーション内で通知を使用するための次のステップについてお話ししましょうアプリケーションにおける最も一般的なプッシュ通知の要件を満たすために PushKitまたはUserNotification フレームワークを使用する選択をすべきですローカルプッシュ接続は APNが使用できず通知がアプリケーションユーザにとって不可欠なネットワーク条件でのみ使用する必要があります
ローカルプッシュ接続がユーザにとって正しいソリューションだと判断した場合ローカルプッシュ接続APIを使用するためには NEAppPushProvider権限が必要であることをに注意してくださいご視聴ありがとうございます

import NetworkExtension

let manager = NEAppPushManager()
manager.matchSSIDs = [ "Cruise Ship Wi-Fi", "Cruise Ship Staff Wi-Fi" ]
manager.providerBundleIdentifier = "com.myexample.SimplePush.Provider"
manager.providerConfiguration = [ "host": "cruiseship.example.com" ]
manager.isEnabled = true

manager.saveToPreferences { (error) in
    if let error = error {
        // Handle error
        return
    }
    // Report success
}

11:11 - App Extension life cycle management and reporting VoIP call

// Manage App Extension life cycle and report VoIP call 

class SimplePushProvider: NEAppPushProvider {

    override func start(completionHandler: @escaping (Error?) -> Void) {
        // Connect to your provider server       
        completionHandler(nil)
    }

    override func stop(with reason: NEProviderStopReason,
                                   completionHandler: @escaping () -> Void) {
        // Disconnect your provider server
        completionHandler()
    }
    
    func handleIncomingVoIPCall(callInfo: [AnyHashable : Any]) {
        reportIncomingCall(userInfo: callInfo)
    }
}

11:57 - Handling incoming VoIP call in the containing app

class AppDelegate: UIResponder, UIApplicationDelegate, NEAppPushDelegate {
    func application(_ application: UIApplication,
                     didFinishLaunchingWithOptions launchOptions:       
                     [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
        NEAppPushManager.loadAllFromPreferences { (managers, error) in
            // Handle non-nil error
            for manager in managers {
                manager.delegate = self
            }
        }
        return true
    }
    
    func appPushManager(_ manager: NEAppPushManager,
                didReceiveIncomingCallWithUserInfo userInfo: [AnyHashable: Any] = [:]) {
        // Report incoming call to CallKit and let it display call UI
    }
}

特定のトピックをお探しの場合は、上にトピックを入力すると、関連するトピックにすばやく移動できます。

クエリの送信中にエラーが発生しました。インターネット接続を確認して、もう一度お試しください。

リソース