2023/01動作確認及び掲載内容の確認が完了しました🎉
手順を画像と共に紹介していますので、参考にしてください
概要
- アプリを作るとき「プッシュ通知機能があったらいいな!」と思いませんか?でもどうやったら良いんだろ?と思う方も多いはず!そこで、今回は必要な証明書周りの話を書いてみました^^*
- この Qiita 記事で必要な証明書類の作成ができます
- ただしリリース用ではなく開発用の作成手順を書かせていただいています。リリース用も同じような手順でできますのでまずは開発用でチャレンジしてみてください
- プッシュ通知 ASP サービスには ニフクラ mobile backend を使っています
- mobile backend を利用してプッシュ通知機能の実装をする場合は以下ドキュメントを参考にしてください
- Xcode > Swiftはこちら
- https://mbaas.nifcloud.com/doc/current/push/basic_usage_swift.html ※本家ドキュメント
-
↓すぐ動作確認したい方におすすめのサンプルあります
【Swift】iOSアプリにプッシュ通知を実装したサンプルアプリを作ってみた - Qiita ※オリジナルコンテンツ
- Xcode > Objective-Cはこちら
- Monaca はこちら ※オリジナルコンテンツ
- Xcode > Swiftはこちら
- ニフクラ mobile backend はBasicプランなら 無料 で使えますので、気軽に使ってみてください
プッシュ通知の仕組み
プッシュ通知を送るには APNs と連携、さらにプッシュ通知の配信依頼には別途サーバーが必要です。サーバーを用意しなければいけないの??…じゃあ無理だ、、という方に朗報!! ニフクラ mobile backend でサーバーの部分は解決!(詳しい使い方は上記概要に掲載のリンク先をご覧ください)
さて、ではAPNsと配信サーバー(ここでは mobile backend)の関わりと配信までの流れを見ていきましょう。
- プッシュ通知の受信設定がされたアプリが起動されると、「①プッシュ通知の許可」依頼がAPNsにリクエストされます
- 許可依頼が通ると、レスポンスとしてAPNsから「②デバイストークンが発行」されます
- 配信サーバーとして mobile backend を利用している場合は、「②デバイストークンが発行」されたタイミングで、mobile backend に発行された「③デバイストークンの登録」処理がされます
- ここまでの処理がされている状態でプッシュ通知の配信依頼ができるようになります
- プッシュ通知の配信依頼を受けた配信サーバー(mobile backend)は「③デバイストークンの登録」で登録されたデバイストークン宛に「④プッシュ通知」の配信依頼をAPNsに向けてリクエストします
- APNsは該当の端末(アプリ)に向けて「⑤プッシュ通知」を届けます
ここでは省きましたが、上記①~⑤の流れを実現するには、APNsとの認証のために各種証明書を作成して、アプリ側及び配信サーバー側(mobile backend)に設定しておく必要があります。本ブログにて、必要な各種証明書を一式作成していきましょう。
プッシュ通知を送るために準備するもの
※記載のバージョンは動作確認時に用いたものです。参考にしてください。
- macOS Monterey 12.6.1
- Xcode 14.0.1
- iOS 15.7 (iPhone 11 Pro)
- Xcodeのバージョンと対応するバージョンである必要があります
-
Apple Developer Programの登録(有償:99米ドル/年または現地通貨の同等額)
- または Apple Developer Enterprise Program (有償:299米ドル/年または現地通貨の同等額)の登録
作成するものと順序
プッシュ通知を送るために作成するもの・しておくことは以下の7つあります
- CSRファイルの作成 ※初回作成すれば後は同じものを使いますので改めて作成不要です
- 開発用ビルド証明書(.cer)の作成 ※初回作成すれば後は同じものを使いますので改めて作成不要です
- AppIDの作成
- 端末の登録
- プロビショニングプロファイルの作成
- APNs用証明書(.cer)の作成
- APNs用証明書(.p12)の作成
※サーバーには ニフクラ mobile backend (無料) を使っています
作成方法
1. CSRファイルの作成
※初回作成すれば後は同じものを使いますので改めて作成不要です
- キーチェーンアクセスを開きます
- 「キーチェーンアクセス」>「証明書アシスタント」>「認証局に証明書を要求」をクリックします
- 「ユーザーのメールアドレス」を入力します
(「通称」はそのまま、「CAのメールアドレス」は空欄でOK) - 「要求の処理」は「ディスクに保存」を選択し「鍵ペア情報を設定」にチェックを入れます
- 「続ける」をクリックします
- 保存先の選択が出るので任意の場所を選択し「保存」をクリックします
- 「鍵ペア情報」画面を確認して「続ける」をクリックします
- 「設定結果」画面が出るので「完了」をクリックします
2. 開発用ビルド証明書(.cer)の作成
※初回作成すれば後は同じものを使いますので改めて作成不要です
- Apple Developer Program にログインします
- 「Certificates, Identifiers & Profiles」>「Certificates」をクリックします
- 「Certificates」の隣にある「+」をクリックします
- 「Create a New Certificate」画面が表示されるので設定していきます
- 「iOS App Development」にチェックをいれ、右上の方の「Continue」をクリックします
- 「Choose File」をクリックして、1.で作成した「CSRファイルの作成」を選択し、「Continue」をクリックします
- 開発者用証明書が作成されるので、「Download」をクリックして書き出しておきます
- 開発用ビルド証明書(.cer)の作成は完了です
- 左上の「All Certificates」をクリックして「Certificates, Identifiers & Profiles」の画面に戻ります
3. App ID の作成
-
左のメニューから「Identifiers」をクリックします
- 2.の作業がスキップだった場合は、Apple Developer Programにログインして、「Certificates, Identifiers & Profiles」>「Identifiers」をクリックします(※2.の画像参照)
-
「Identifiers」の右の「+」をクリックします
-
「Register a New Identifier」が表示されるので「App IDs」にチェックをいれ、右上の方の「Continue」をクリックします
- 「Selet a type」が表示されるので「App」を選択し、右上の方の「Continue」をクリックします
- 「Description」にアプリの概要を記入します
例) TestPushApp
- 「Bundle ID」では「Explicit」を選択し、「Bundle ID」を入力します
- 「Wildcard」を選択するとプッシュ通知が利用できないので注意!
- 「Bundle ID」は アプリ側で同じものを設定します ので必ず控えておきましょう!
- 下にスクロールして「Capabilities」の「Push Notifications」にチェックを入れます
- これを忘れるとプッシュ通知が利用できないので注意!
- 「Continue」をクリックします
- 確認画面が表示されるので「Push Notifications」にチェックが入っている事を確認して「Register」をクリックします
- これでApp ID 作成は完了です
4. 端末の登録
- 左のメニューから「Devices」をクリックして、「Devices」の隣にある「+」をクリックします
- 「Platform」は「iOS, tvOS, WatchOS」に選択します
- 端末の「Device Name」と「Device ID(UDID)」を入力します
- 「Device Name」は自由に設定できます
- 「Device ID(UDID)」はXcodeを使うと確認し易いです
- Mac に端末を接続し、Xcodeを起動します
- 「Window」>「Devices and Simulators」をクリックします
- 「identifier」としてUDIDが確認できます
- 記入できたら「Continue」をクリックします
- 次の画面で端末情報を確認して「Register」をクリックします
- これで端末登録は完了です
5. プロビショニングプロファイルの作成
- 左のメニューから「Profiles」をクリックして、「Profiles」の隣にある「+」をクリックします
- 「Development」の「iOS App Development」を選択し、「Continue」をクリックします
- 利用する App ID、開発用ビルド証明書、端末をそれぞれ紐付けていきます
- 3.で作成したApp IDを選択し、「Continue」をクリックします
- 2.で作成した(あるいは既存の) 開発用ビルド証明書 を選択し、「Continue」をクリックします
- 4.で登録した(あるいは既存の)端末を選択し、「Continue」をクリックします
- 最後に「Provisioning Profile Name」にファイル名入力します
例) TestPushApp Provisioning Profiles
- 紐付けを確認し「Generate」をクリックします
- プロビショニングプロファイルがが作成されるので、「Download」をクリックして書き出しておきます
- プロビショニングプロファイルの作成は完了です
- 左上の「All Profiles」をクリックして「Certificates, Identifiers & Profiles」の画面に戻ります
6. APNs用証明書(.cer)の作成
- 左のメニューから「Certificates」をクリックして、「Certificates」の隣にある「+」をクリックします
- 2.で開発用ビルド証明書を作成したときとは異なり、下にスクロールし、「Service」の「Apple Push Notification service SSL (Sandbox)」をチェックに入れます
- 「Continue」をクリックします
- 3.で作成した App ID を選択し、「Continue」をクリックします
- 1.で作成した(あるいは既存の)CSRファイルを選択し、「Continue」をクリックします
- APNs用証明書(.cer) が作成されるので、「Download」をクリックして書き出しておきます
- APNs用証明書(.cer) の作成は完了です
- 左上の「All Certificates」をクリックして「Certificates, Identifiers & Profiles」の画面に戻ります
7. APNs用証明書(.p12) の作成
- 6.で作成した「APNs用証明書(.cer)」をダブルクリックしてキーチェーンアクセスを開きます
- APNs用証明書(.cer) の左にある三角マークをクリックして開きます
- APNs用証明書(.cer) ファイルには鍵がセットされています
(参考)ここでもし「証明書が信頼されていません」と出た場合の対処方法
キーチェーンアクセスで「証明書が信頼されていません」と表示された場合は、下記の中間証明書を追加する必要のあります:
- Worldwide Developer Relations - G3 (Expiring 02/20/2030 00:00:00 UTC)
- ビルド用証明書の信頼に必要(試しに2.で作成した「開発用ビルド証明書(.cer)」もダブルクリックしてみましょう!)
- Worldwide Developer Relations - G4 (Expiring 12/10/2030 00:00:00 UTC)
- プッシュ通知証明書の信頼に必要
上記中間証明書は、下記のサイトでダウンロード可能です。ダウンロード後ダブルクリックでキーチェーンアクセスに反映することでエラーが解消されます。
- Apple PKI
- APNs用証明書(.p12) を書き出すには、開いた状態で 鍵ではなく証明書の上で右クリック をして「~を書き出す…」をクリックします
- ファイル名「名前」と保存先「場所」を指定して「保存」をクリックします
- パスワードを求められますが、 何も入力しない で「OK」をクリックします
※この後、システム側にパスワードを求められる場合があります。対応してください。
- APNs用証明書(.p12) が書き出されます
- APNs用証明書(.p12) 作成は完了です
これですべて必要なファイルが作成できました!
早速プッシュ通知の動作確認に進みたい方へ
冒頭に本家ドキュメント載せていますが、すぐに動作確認したい場合はサンプルアプリの利用が便利です!続きはこちらのブログへどうぞ!
【Swift】iOSアプリにプッシュ通知を実装したサンプルアプリを作ってみた - Qiita
終わりに
証明書の作成は、少し間違えるだけでプッシュ通知が正しく配信されない可能性があります。この方法で証明書を作成したのに上手くいかないのだけど…という方は下記内容をもう一度確認してみてください!
- 書類の作成順序を間違えている
- 最初に図で説明した通り、書類には参照の関係があります。上手く参照されていない可能性があります
- 途中で作成した書類を編集した
- 正しく作っていると思っていて、これで失敗していたことがありましたので注意!
- 開発用ビルド証明書が複数作成されている
- 混在してしまうとどちらを使用しているのかわからなくなってしまい上手くいかないことがあるようです。
- CSRファイルが複数作成されている
- 混在してしまうとどちらを使用しているのかわからなくなってしまい上手くいかないことがあるようです。
- AppIDを作成時に「Push Notifications」にチェックを入れ忘れている
- 上にも書きましたが意外とあるあるです
- 他にも可能性は…