iOS13におけるプッシュ通知に必要なデバイストークンの取得方法

はじめに

今回はiOS13のプッシュ通知用デバイストークンについて見ていきたいと思います。
Swift に関して言えば、歴史的変遷から、問題のない現場が多いと思うのですが、
Objective-C を中心に活用している現場では注意が必要かもしれません。

具体的には後述しますが、
description を利用してデバイストークンを取得する方式は iOS13 から見直す必要がありそうです。

プッシュ通知の受信処理の実装

折角なので、基本的な設定についても説明していきます。

Xcode11の設定

まずは、Xcode11上で下図の状態まで設定します。

▼確認観点
* Team ID が利用想定のものであること
* Bundle Identifier が利用想定のものであること
* Signing Certificate が利用想定のものであること
* Provisioning Profile の Capabilities に Push Notifications が含まれている
* Capability として Push Notifications が追加すること

Signing & Capabilities

AppDelegateの実装

続いて、 AppDelegate.swift 上の実装です。

基本的なステップは4つです。

① プッシュ通知の利用許可のリクエストを送信します
② 利用許可を得た場合に、プッシュ通知の利用登録を実行します
③ プッシュ通知の利用登録が成功したことをキャッチする Delegate メソッドを書きます
④ プッシュ通知の利用登録が失敗したことをキャッチする Delegate メソッドを書きます

import UIKit
import UserNotifications

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
        // Override point for customization after application launch.

        // ① プッシュ通知の利用許可のリクエスト送信
        UNUserNotificationCenter.current().requestAuthorization(options: [.alert, .sound, .badge]) { granted, error in
            guard granted else { return }

            DispatchQueue.main.async {
                // ② プッシュ通知利用の登録
                UIApplication.shared.registerForRemoteNotifications()
            }
        }

        return true
    }
    ...
}

extension AppDelegate {

    // ③ プッシュ通知の利用登録が成功した場合
    func application(_ application: UIApplication,
                     didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
        let token = deviceToken.map { String(format: "%.2hhx", $0) }.joined()
        print("Device token: \(token)")
    }

    // ④ プッシュ通知の利用登録が失敗した場合
    func application(_ application: UIApplication,
                     didFailToRegisterForRemoteNotificationsWithError error: Error) {
        print("Failed to register to APNs: \(error)")
    }
}

旧来のデバイストークンの取得方法

さて本題に入ります。
Objective-C 時代に主流と言われていたデバイストークンの取得方法は、以下のような description を利用した手法でした。

NSString *token = [[[[deviceToken description] stringByReplacingOccurrencesOfString:@"<"withString:@""]
                   stringByReplacingOccurrencesOfString:@">" withString:@""]
                   stringByReplacingOccurrencesOfString: @" " withString: @""];

これは、 [deviceToken description] で取得される値が、
<7097978d 1e438923 ... 6fdbf111> というような先頭と末尾を <> で括られていたためです。
そして、1文で書けるというのも当時から魅力的だったのかもしれません。

Swift に言語が変わってからも、上記手法が多くの場面で使われてきたことと思います。
しかし、 Swift3 になったタイミングで、状況が変わりました。

プッシュ通知の利用登録成功時の Delegate メソッドの deviceToken が NSData 型から Data 型に変わったことで、この手法が利用できなくなったのです。

この時点で

let token = deviceToken.map { String(format: "%.2hhx", $0) }.joined()

という書き方がデバイストークン取得の主流に完全に取って代わったと思います。

もしかしたら、 Data 型を NSData 型に変換することで、
引き続き旧来の手法を利用している現場があるかもしれませんが、
その場合は、即刻デバイストークンの取得方法を見直しましょう。

これはあくまでも Swift におけるデバイストークンの取得の変遷であって、
Objective-C は何ら変わることがなかったため、
旧来の書き方が続いている現場がまだまだ多い気がしています。

しかし、 iOS13 からはどうやら見直しが必須になったようです。
というのも、 description を利用すると

{ length = 32, bytes = 7097978d 1e438923 ... 6fdbf111 }

のような形で返ってきてしまうため、
<> を除去することでデバイストークンを取得することができなくなったようなんです。

では、 Swift は先程書いた通り1行で書けますが、
Objective-C ではどう書いていくべきなのでしょうか。
安心してください。 Facebook が1つの解を示してくれています。

// ↓ dataにDelegateメソッドに渡ってきたdeviceTokenを渡します
(NSString *)hexadecimalStringFromData:(NSData *)data
{
    NSUInteger dataLength = data.length;
    if (dataLength == 0) {
        return nil;
    }

    const unsigned char *dataBuffer = data.bytes;
    NSMutableString *hexString  = [NSMutableString stringWithCapacity:(dataLength * 2)];
    for (int i = 0; i < dataLength; ++i) {
        [hexString appendFormat:@"%02x", dataBuffer[i]];
    }
    return [hexString copy];
}

流石に1行で済ませることは難しいですが、
これで Objective-C でも正しくデバイストークンを取得できるようになりました。

まとめ

さて如何でしたでしょうか。
iOS13は細かいところも含めて様々な変更が入っているため、日々最新情報をキャッチしつつ、自身でも積極的に使い倒していく必要がありますね。

と言ったところで本日はここまで。

Takahiro Octopress Blog

-1から始める情弱プログラミング