這篇筆記只記錄如何在本機把 APNS 推送環境跑起來,推送原理與整體流程這裡就不展開了。
注意 App ID 不能使用萬用字元(wildcard),建立時要勾選 Push Notification Service。如果 App ID 已經存在,也可以事後編輯補上這項服務。
這部分步驟省略,但有兩點要特別留意:
1. 建立 Profile 時,App ID 與 Certification 必須對應正確。已建立的 Profile 也可以再次編輯,修改憑證或 Devices;改完只要到 Xcode => Preferences => Accounts 中 Refresh 一次即可。
2. 建立憑證時 KeyChain 會在本機產生一個 .certSigningRequest 檔,請務必保存。因為憑證到期後如果不是用這個檔案更新,而是重新產生一個新的 .certSigningRequest,伺服器端要用的憑證就得再走一次下面這套流程。
1. 從 KeyChain 匯出對應憑證的 Private Key(這裡記為 Push.p12)。
openssl x509 -in aps_developer_identity.cer -inform der -out PushChatCert.pem openssl pkcs12 -nocerts -out PushChatKey.pem -in Push.p12 cat PushChatCert.pem PushChatKey.pem > ck.pem
先測試能不能連上 APNS:
$ telnet gateway.sandbox.push.apple.com 2195 Trying 17.172.232.226... Connected to gateway.sandbox.push-apple.com.akadns.net. Escape character is '^]'.
這會嘗試建立一個未加密的規則連線到 APNS。看到上面的回應,就代表你的機器能連通 APNS;按 Ctrl+C 中斷連線。若出現錯誤訊息,請確認防火牆有放行 2195 埠。
接著用 SSL 憑證與私鑰建立安全連線:
$ openssl s_client -connect gateway.sandbox.push.apple.com:2195 -cert PushChatCert.pem -key PushChatKey.pem Enter pass phrase for PushChatKey.pem:
這時會看到完整的輸出,能了解 OpenSSL 在背後做了哪些事。連線成功後可以輸入一些字元,按 Enter 服務端就會中斷連線。若建立連線時出問題,OpenSSL 會直接印出錯誤訊息。前面合併出的 ck.pem,就是 Push 伺服器要用来連上 APNS 的檔案。
以 Mac OS X 10.5.6 為例,系統自帶 Apache 2.2.9,直接在命令列執行 apachectl start 就完成了。此時網站根目錄是 /Library/WebServer/Documents/,把檔案放進去就能測試。
系統自帶 PHP 5,我們要做的只是把它掛到 Apache 上。修改 /etc/apache2/httpd.conf,把下面這行前面的註解符號拿掉:
#LoadModule php5_module libexec/apache2/libphp5.so
改為:
LoadModule php5_module libexec/apache2/libphp5.so
接著把預設設定檔複製一份:
cp /etc/php.ini.default /etc/php.ini
之後可依習慣調整 php.ini,例如把
error_reporting = E_ALL & ~E_NOTICE
改成
error_reporting = E_ALL
重新啟動 Apache 後,在 /Library/WebServer/Documents/ 建立一個 phpinfo.php 就能驗證:
sudo apachectl restart
把第四步產生的 ck.pem 複製到 /Library/WebServer/Documents/,再建立 push.php 放到同一個目錄:
<?php
// 這裡填入上面取得的 deviceToken(記得去掉空格)
// 測試版本與正式版本的 deviceToken 不一樣
$deviceToken = 'f5b70734ea5f4b91c904544f75457d6ecb908488317e097abaab769e741e6752';
// 私鑰的通行密碼
$passphrase = '1111';
// 你的測試訊息內容
$message = array(
'msg' => '小小說閱讀器',
'title' => '小小說',
'url' => 'https://www.apple.com.cn'
);
$ctx = stream_context_create();
stream_context_set_option($ctx, 'ssl', 'local_cert', 'ck.pem');
stream_context_set_option($ctx, 'ssl', 'passphrase', $passphrase);
// 建立與 APNS 的連線
// 正式環境網址:
// $fp = stream_socket_client('ssl://gateway.push.apple.com:2195', $err, $errstr, 60, STREAM_CLIENT_CONNECT, $ctx);
// 沙盒測試網址(上架 App Store 後記得改掉)
$fp = stream_socket_client('ssl://gateway.sandbox.push.apple.com:2195', $err, $errstr, 60, STREAM_CLIENT_CONNECT | STREAM_CLIENT_PERSISTENT, $ctx);
if (!$fp) {
exit("Failed to connect: $err $errstr" . PHP_EOL);
}
echo 'Connected to APNS' . PHP_EOL;
// 組出 payload
$body['aps'] = array(
'alert' => '逗你玩!哈哈。',
'sound' => 'beep.wav',
'badge' => 1
);
$body['type'] = 2;
$body['data'] = $message;
// 轉成 JSON
$payload = json_encode($body);
// 組出二進位通知內容
$msg = chr(0) . pack('n', 32) . pack('H*', $deviceToken) . pack('n', strlen($payload)) . $payload;
// 送出
$result = fwrite($fp, $msg, strlen($msg));
if (!$result) {
echo 'Message not delivered' . PHP_EOL;
} else {
echo 'Message successfully delivered' . PHP_EOL;
}
fclose($fp);
?>
程式碼裡的 deviceToken 必須先在真機上跑起來,從 App 那邊複製出來替換。之後重新啟動 Apache:
sudo apachectl restart
這樣只要訪問一次 https://localhost/push/push.php,你的裝置就會收到通知了。
最後補充兩個實務上常遇到的地雷:正式環境與沙盒環境的 gateway 網址不同,上架前務必切換;deviceToken 每一台裝置、每一種憑證環境都不一樣,除錯時先確認拿到的是正確那組 token,能省下不少時間。