プッシュ通知をnode-apnで送ってみよう！

はじめに

前回はFirebaseを利用してiOSにRemote Notificationを送信することについて書きました。
今後は自作せずにFirebaseを利用するプロダクトが増えてくると思うことに変わりはないのですが、ふと昔利用していたnode-apnが気になりました。
折角の機会なので、このnode-apnを利用してRemote Notificationを送信してみたいと思います。

プロジェクトの用意

ベースプロジェクトはExpressを使ってしまいましょう。
今回の各種バージョンは下記の通りです。

Node.js:  v7.3.0
npm:      v3.10.10
Express:  v4.15.0
nodebrew: v0.9.6

① Expressコマンドでpushtestプロジェクトの生成

$ express -t ejs pushtest

すると下記のプロジェクト構成が出来上がります。

pushtest
├── app.js
├── bin
│    └── www
├── package.json
├── public
├── routes
│    ├── index.js
│    └── users.js
└── views

因みに、expressコマンドを打つにはexpressとexpress-generatorのインストールが必要です。
また、グローバルインストールしたnode_modulesへのパスを.bash_profileに通しておきましょう。

export PATH=$HOME/.nodebrew/current/bin:$PATH
export NODE_PATH=$HOME/.nodebrew/current/lib/node_modules

source ~/.bash_profileで最新状況を読み込むのを忘れずに。

② node-apnのインストール

$ npm install node-apn --save

因みに、必要なモジュールをインストールしたつもりでも、何度もCannot find module xxxと出てしまうようであれば、app.jsと同じ階層下でnpm install -dを実行しましょう。

処理を実装

プロジェクトが用意できたので、処理を実装していきましょう。
今回は簡単のため要件としては下記のみとします。

・特定の端末のデバイストークンを指定
・GETリクエスト

① app.jsに処理を実装
まずはGETリクエストの受け口をapp.jsに用意します。

var express = require('express');
var path = require('path');
var favicon = require('serve-favicon');
var logger = require('morgan');
var cookieParser = require('cookie-parser');
var bodyParser = require('body-parser');

var index = require('./routes/index');
var users = require('./routes/users');
var apns = require('./routes/apns');// apns.jsは④で作成しますが、既にある体で追記

var app = express();

// 省略

app.use('/', index);
app.use('/users', users);
app.use('/apns', apns);// GETリクエストを受けられるように追記

// 省略

② routes/apns.jsを作成

最後にメインとなる処理を書いていきます。
専用のroutes/apns.jsを作成し、その内部にnode-apnを利用した処理を書いていきます。
推奨されているAPNS Keyを利用するため、別途AuthKey_xxxxxxxxxx.p8を用意しましょう。

その結果、プロジェクト構成としては下記のようになります。

pushtest
├── app.js
├── bin
│    └── www
├── key
│    └── AuthKey_xxxxxxxxxx.p8
├── package.json
├── public
├── routes
│    ├── apns.js
│    ├── index.js
│    └── users.js
└── views

続いて具体的な処理です。
昔よりもシンプルに書けるようになっているイメージです。

var express = require('express');
var apn = require('apn');
var qs = require('qs');
var router = express.Router();

router.get('/', function(req, res, next) {
  // GETパラメータからトークンを取得
  var arr = req.url.split("?");
  var obj = qs.parse(arr[1]);
  var deviceToken = obj.token;

  // プッシュ通知の設定
  var options = {
    token: {
      key: "./keys/AuthKey_xxxxxxxxxx.p8",
      keyId: "xxxxxxxxxx",
      teamId: "xxxxxxxxxx"
    },
    production: false
  };

  var apnProvider = new apn.Provider(options);
  var note = new apn.Notification();

  note.expiry = Math.floor(Date.now() / 1000) + 3600;
  note.badge = 3;
  note.sound = "ping.aiff";
  note.alert = "プッシュ通知が届きましたよ！";
  note.topic = "com.xxx.NotificationSample";

  // プッシュ送信
  apnProvider.send(note, deviceToken).then( (result) => {
    res.send("respond with a resource");
  });
});

module.exports = router;

プッシュ通知を送信

準備ができたのでプッシュ通知を送ってみましょう。

① Nodeを起動

デバッグしながら起動するために下記を実行します。

$ node --inspect --debug-brk bin/www

すると、下記出力がされるのでChromeでアクセスしましょう。

Debugger listening on port 9229.
Warning: This is an experimental feature and could change at any time.
To start debugging, open the following URL in Chrome:
    chrome-devtools://devtools/bundled/inspector.html?experiments=true&v8only=true&ws=127.0.0.1:9229/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

② プッシュ通知を送る

下記URLにアクセスしてGETリクエストを投げましょう。

http://localhost:3000/apns?token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

たったこれだけで下図のようにプッシュ通知が届きました。

node-apnで送ったプッシュ通知

まとめ

さて今回はnode-apnでのプッシュ通知について書きました。
3年以上前にSilent Remote Notificationを試そう！で利用したりしていたのですが、今見るといろいろと変わっているなと改めて感じました。
今更ではありますが、これも一つ勉強になったと思い、Firebaseに没頭していこうかなと…笑
と言ったところで本日はここまで。

Takahiro Octopress Blog

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