Xamarin で Windows Azure モバイルサービスを使う(その

#Xamarin#XAC13#iOS#Android#csharp#Azure#BaaS

Posted on 2013/12/19 00:00:00(+9:00)

たぶん最終回です。前回は、OAuth認証を実装しました。今回は、前回のサンプルの続きとして、Xamarin.iOS + Azure Mobile Service によるプッシュ通知を実装してみます。

プッシュ通知を組み込むためのチュートリアルはこちら

Get started with push notifications (Xamarin iOS) ｜ Mobile Dev Center

では、早速いってみましょう。

プッシュ通知用の証明書ファイルを作成する

Generate the Certificate Signing Request file

Register your app and enable push notifications

Create a provisioning profile for the app

についてです。

iOS でプッシュ通知を行うには Apple Push Notification Service(APNS) を使用しますので、その準備から始まります。「もう知ってるよ」という人は「4. Configure Mobile Services」から読んでも良いかと思います。

初めて行う人は、こちら↓の説明の方が日本語で分かりやすいかと思います。

iPhoneのプッシュ通知(APNS)の証明書の作り方｜三度の飯とエレクトロン

この手順で最後に必要なのは「p12ファイル」です。パスワードはかかっていても問題ありません。

Azure モバイルサービスにプッシュの設定をする

4 Configure Mobile Services

についてです。

まず、Azure マネージメントポータル (https://manage.windowsazure.com/) から、モバイルサービス → 項目 → を選んで、上部にある「プッシュ」を選択します。次に「apple プッシュ通知の設定」の証明書に、先に手順で入手した「.p12ファイル」をアップロードします。パスワードはその時決めたものを入力します。

アプリケーションにプッシュ通知を実装する

5 Add push notifications to your app

について。ここ、ハマりどころ多いです。

Xamarin Studio で、前回のサンプルを開いてコードを追加していきます。

AppDelegate.cs に、端末を識別するためのIDを保持するプロパティを作ります。

//AppDelegate.cs
public string DeviceToken { get; set; }

ToDoItem.cs にも同じく DeviceToken を追加します。が、説明にある [DataMember… は間違いです。正しくは [JsonProperty… です。

//ToDoItem.cs
×[DataMember(Name = "deviceToken")]
[JsonProperty(PropertyName = "deviceToken")]
public string DeviceToken { get; set; }

再び AppDelegate.cs に戻って、アプリが起動完了した時に、APNS サーバにアプリを登録するコードを追加します。

//AppDelegate.cs
public override bool FinishedLaunching(UIApplication application, NSDictionary launchOptions)
{
    UIRemoteNotificationType notificationTypes = UIRemoteNotificationType.Alert | 
        UIRemoteNotificationType.Badge | UIRemoteNotificationType.Sound;
    UIApplication.SharedApplication.RegisterForRemoteNotificationTypes(notificationTypes); 

    return true;
}

次に同じく AppDelegate.cs に、アプリ登録完了時にデバイストークンを受け取るコールバックを実装します。

ここが2つ目のハマりポイントです。 deviceToken.Description を使用していますが、これは iOSネイティブと異なり 空白入りの文字列を返す ようです。そのためそのまま DeviceToken として利用すると、通知が来ません。エラーにもならないので原因究明に数時間要しました…。Replace で空白も取り除きます。

//AppDelegate.cs
public override void RegisteredForRemoteNotifications(UIApplication application, NSData deviceToken)
{
    string trimmedDeviceToken = deviceToken.Description;
    if (!string.IsNullOrWhiteSpace(trimmedDeviceToken))
    {
        trimmedDeviceToken = trimmedDeviceToken.Trim('<');
        trimmedDeviceToken = trimmedDeviceToken.Trim('>');
        trimmedDeviceToken = trimmedDeviceToken.Replcae(“ “, “”); // ←追加
    }
    DeviceToken = trimmedDeviceToken;
}

そして、AppDelegate.cs に、プッシュ通知受信時のコードを書きます。

//AppDelegate.cs
public override void ReceivedRemoteNotification(UIApplication application, NSDictionary userInfo)
{
    Debug.WriteLine(userInfo.ToString());
    NSObject inAppMessage;

    bool success = userInfo.TryGetValue(new NSString("inAppMessage"), out inAppMessage);

    if (success)
    {
        var alert = new UIAlertView("Got push notification", inAppMessage.ToString(), null, "OK", null);
        alert.Show();
    }
}

最後に QSTodoListViewController.cs の OnAdd を次のように変更して、追加するデータに DeviceToken を含めるようにします。この値を使って、Azure 側でプッシュ通知を送ります。

//QSTodoListViewController.cs
var deviceToken = ((AppDelegate)UIApplication.SharedApplication.Delegate).DeviceToken;

var newItem = new ToDoItem() 
{
    Text = itemText.Text, 
    Complete = false,
    DeviceToken = deviceToken
};

コードの記述はこれで終わりですが、Xamarin Studio から、iOS アプリを実機で動かしたことがない人は、iOS Developer Account の設定をしておきましょう。

システムメニュー → Preferences、Environment → Developer Accounts から追加しておきます。

マネージメントポータルで、データの追加時のスクリプトを登録する

6 Update the registered insert script in the Management Portal

についてです。

まず、マネージメントポータル https://manage.windowsazure.com/ を開き、モバイルサービス → サービス名 → データ → テーブル名と選択します。

次に、スクリプトを選択し、ドロップダウンから「挿入」を選択します。テーブルにデータが追加された時に実行するスクリプトが表示されます。

スクリプトを以下に置き換えます。

function insert(item, user, request) {
    request.execute();
    // Set timeout to delay the notification, to provide time for the 
    // app to be closed on the device to demonstrate toast notifications
    setTimeout(function() {
        push.apns.send(item.deviceToken, {
            alert: "Toast: " + item.text,
            payload: {
                inAppMessage: "Hey, a new item arrived: '" + item.text + "'"
            }
        });
    }, 2500);
}

これにより、データの追加から 2.5秒後に、APNS にプッシュ通知のリクエストを投げます。

動かす

7 Test push notifications in your app

やっと試せます。

Xamarin Studio から、実機で実行します。

アプリ起動直後、通知の受信を許可するかどうかを尋ねられますので「Yes」で。

Twitter 認証後、適当に項目を追加します。

しばらく待っていると…

無事、プッシュ通知を受信できましたー。 (実はここに辿り着くまで数十回試しているので最初に通知を受け取った時の感激と言ったら…)

まあ、たぶんどっかでハマるだろうなーと思いながら、やっぱりハマった！という感じでしたので、皆さんも最初はどこかでハマるんじゃないかと。

ハマりどころは文中にも書きましたが、下にもトラブルシューティングとして書きました。何かのお役に立てば。

トラブルシューティング

iOS Dev Center で Bundle ID 入力したらエラーになった

プロジェクト名にアンダースコアが含まれてるとダメです。 Xamarin Studio のプロジェクトプロパティ → iOS Application で直しましょう。

アプリが起動直後(認証を通過した後)に落ちるようになった

チュートリアルにある、

[DataMember(Name = "deviceToken")]
public string DeviceToken { get; set; }

は間違いです。下記が正しいです。

[JsonProperty(PropertyName = "deviceToken")]
public string DeviceToken { get; set; }

クライアントで「追加」しても、プッシュ通知が来ません

まずは、Azure マネージメントポータルで「ログ」を見てみましょう。下記からアクセスできます。

データ挿入時のスクリプトでエラーが出ていれば、ここに出力されるはずです。スクリプト内で console.log した内容もここに出力されます。

それでもまだ、プッシュ通知が来ません

チュートリアル(リンクが死んだ…)にある、

public override void RegisteredForRemoteNotifications(UIApplication application, NSData deviceToken)
{
    string trimmedDeviceToken = deviceToken.Description;
    if (!string.IsNullOrWhiteSpace(trimmedDeviceToken))
    {
        trimmedDeviceToken = trimmedDeviceToken.Trim('<');
        trimmedDeviceToken = trimmedDeviceToken.Trim('>');
    }
    DeviceToken = trimmedDeviceToken;
}

は、コードが足りません。これでは trimmedDeviceToken の文字列内に空白が含まれてしまい、正しい DeviceToken にならないようです。

public override void RegisteredForRemoteNotifications(UIApplication application, NSData deviceToken)
{
    string trimmedDeviceToken = deviceToken.Description;
    if (!string.IsNullOrWhiteSpace(trimmedDeviceToken))
    {
        trimmedDeviceToken = trimmedDeviceToken.Trim('<');
        trimmedDeviceToken = trimmedDeviceToken.Trim('>');
        trimmedDeviceToken = trimmedDeviceToken.Replcae(“ “, “”); // ←追加
    }
    DeviceToken = trimmedDeviceToken;
}

と、空白を除去する必要があります。

しかしそれでもまだ、プッシュ通知が来ません

最初の手順、キーチェーンアクセスで CSR を作る時、「ユーザーのメールアドレス」「通称」を iOS Developer Center に登録しているものと同じにする必要があるみたいです。これが間違っていると、.p12 ファイルを書き出す時に選択すべき「Apple Development IOS Push Services: net.azure-mobile.amay077-baas-test」という鍵が見つからない(文字化けしてる)はずです。

また、iOS Developer Center に .p12 ファイルを再登録するとプロビジョニングファイルを再作成→端末に更新する必要があります。

これらを忘れると通知が来ません。そしてエラーにもならないので厄介です。

雑感

しかし Azure のチュートリアル、これ一度も試してないんじゃないの？

クラス名の接頭辞や大文字小文字の間違いはまだかわいいものだけど、ここミスると致命的という点が２つも。一度辿れば気づくと思うんだけどなあ。最後にある completed example project ではちゃっかり正しいコードだったりするので、コンテンツの修正漏れなんだろうか。。。

それはともかく、何かトラブルがあると Xamarin のようなネイティブに皮を被せてるプラットフォームは途端に不安になります。どこに原因があるのか追求しづらいから。

今回も、コードの修正後、いきなりアプリが落ちるようになって、まずα版を使っていたのでそれを疑って stable に戻して、次に実機が悪いのかとシミュレータで動かしてみたり、いろいろ試行錯誤してやっとチュートリアルの誤記だと分かったり。まだノウハウが無いといえばそれまで、α版が自己責任なのはその通りですが、イレギュラー時のリスクはあるなあと思いました。