Java から Notification Hubs を使用する方法

[アーティクル]
06/01/2023

このトピックでは、新しい Azure Notification Hub Java SDK の主な機能について説明します。Azure Notification Hub Java SDK は、完全にサポートされている公式の SDK です。このプロジェクトはオープンソースのプロジェクトであるため、Java SDK で SDK コード全体を表示できます。

MSDN のトピック「 Notification Hubs の REST API」の説明にあるように、通常は、Notification Hub REST インターフェイスを使用して、Java/PHP/Python/Ruby バックエンドから Notification Hubs のすべての機能にアクセスできます。この Java SDK は、これらの REST インターフェイスを使用して、Java で Thin ラッパーを提供します。

現在、SDK のサポート対象は次のとおりです。

Notification Hubs の CRUD
登録の CRUD
インストール管理
登録のインポート/エクスポート
通常の送信
スケジュールされた送信
Java NIO を使用した非同期操作
サポート対象のプラットフォーム: APNS (iOS)、FCM (Android)、WNS (Windows ストアアプリ)、MPNS (Windows Phone)、ADM (Amazon Kindle Fire)、Baidu (Google のサービスを使用しない Android)

注意

Microsoft プッシュ通知サービス (MPNS) は非推奨とされ、サポートされなくなりました。

SDK の使用例

コンパイルとビルド

Maven

次のコードを使用してビルドします。

mvn package

コード

Notification Hub の CRUD

NamespaceManager を作成する:

NamespaceManager namespaceManager = new NamespaceManager("connection string")

Notification Hub を作成する:

NotificationHubDescription hub = new NotificationHubDescription("hubname");
hub.setWindowsCredential(new WindowsCredential("sid","key"));
hub = namespaceManager.createNotificationHub(hub);

hub = new NotificationHub("connection string", "hubname");

Notification Hub を取得する:

hub = namespaceManager.getNotificationHub("hubname");

Notification Hub を更新する:

hub.setMpnsCredential(new MpnsCredential("mpnscert", "mpnskey"));
hub = namespaceManager.updateNotificationHub(hub);

Notification Hub を削除する:

namespaceManager.deleteNotificationHub("hubname");

登録の CRUD

Notification Hub クライアントを作成する:

hub = new NotificationHub("connection string", "hubname");

Windows の登録を作成する:

WindowsRegistration reg = new WindowsRegistration(new URI(CHANNELURI));
reg.getTags().add("myTag");
reg.getTags().add("myOtherTag");
hub.createRegistration(reg);

iOS の登録を作成する:

AppleRegistration reg = new AppleRegistration(DEVICETOKEN);
reg.getTags().add("myTag");
reg.getTags().add("myOtherTag");
hub.createRegistration(reg);

同様に、Android (FCM)、Windows Phone (MPNS)、および Kindle Fire (ADM) の登録を作成できます。

テンプレートの登録を作成する:

WindowsTemplateRegistration reg = new WindowsTemplateRegistration(new URI(CHANNELURI), WNSBODYTEMPLATE);
reg.getHeaders().put("X-WNS-Type", "wns/toast");
hub.createRegistration(reg);

登録 ID およびアップサートパターンの作成を使用して登録を作成する:

デバイスで登録 ID を格納すると応答が失われる場合があるため、重複を削除します。

String id = hub.createRegistrationId();
WindowsRegistration reg = new WindowsRegistration(id, new URI(CHANNELURI));
hub.upsertRegistration(reg);

登録を更新する:

hub.updateRegistration(reg);

登録を削除する:

hub.deleteRegistration(regid);

登録をクエリする:

1 つの登録を取得する:

hub.getRegistration(regid);

ハブ内のすべての登録を取得する:

hub.getRegistrations();

タグ付きの登録を取得する:

hub.getRegistrationsByTag("myTag");

チャネルにより登録を取得する:

hub.getRegistrationsByChannel("devicetoken");

すべてのコレクションクエリでは $top トークンと継続トークンがサポートされます。

インストール API の使用例

インストール API は登録管理の代替メカニズムです。複数の登録を保持する (これは大変な作業であり、簡単に間違って、または非効率的に実行される可能性があります) 代わりに、単一インストールオブジェクトを使用できるようになりました。

Installation には、プッシュチャネル (デバイストークン)、タグ、テンプレート、セカンダリタイル (WNS および APNS 用) などの必要な情報がすべて格納されます。 ID を取得するためにサービスを呼び出す必要はもうありません。GUID またはその他の任意の識別子を生成してデバイス上に保持し、プッシュチャネル (デバイストークン) と共にバックエンドに送信するだけです。

バックエンドでは、CreateOrUpdateInstallation を 1 回呼び出すだけで済みます。これは完全にべき等であるため、必要に応じて自由に再試行できます。

Amazon Kindle Fire の例を次に示します。

Installation installation = new Installation("installation-id", NotificationPlatform.Adm, "adm-push-channel");
hub.createOrUpdateInstallation(installation);

更新する場合は、次のようになります。

installation.addTag("foo");
installation.addTemplate("template1", new InstallationTemplate("{\"data\":{\"key1\":\"$(value1)\"}}","tag-for-template1"));
installation.addTemplate("template2", new InstallationTemplate("{\"data\":{\"key2\":\"$(value2)\"}}","tag-for-template2"));
hub.createOrUpdateInstallation(installation);

高度なシナリオの場合は、インストールオブジェクトの特定のプロパティのみを変更できる部分更新機能を使用します。部分更新は、インストールオブジェクトに対して実行できる JSON Patch 操作のサブセットです。

PartialUpdateOperation addChannel = new PartialUpdateOperation(UpdateOperationType.Add, "/pushChannel", "adm-push-channel2");
PartialUpdateOperation addTag = new PartialUpdateOperation(UpdateOperationType.Add, "/tags", "bar");
PartialUpdateOperation replaceTemplate = new PartialUpdateOperation(UpdateOperationType.Replace, "/templates/template1", new InstallationTemplate("{\"data\":{\"key3\":\"$(value3)\"}}","tag-for-template1")).toJson());
hub.patchInstallation("installation-id", addChannel, addTag, replaceTemplate);

Installation を削除する:

hub.deleteInstallation(installation.getInstallationId());

CreateOrUpdate、Patch、Delete は最終的に Get と整合性がとれます。要求された操作は、単に呼び出し中にシステムキューに移動し、バックグラウンドで実行されます。 Get はメインのランタイムシナリオのためではなく、単にデバッグやトラブルシューティングのために設計されているため、サービスによって密接に調整されます。

インストールの送信フローは登録の場合と同じです。通知を特定のインストールに送信するには、タグ "InstallationId:{desired-id}" を使用するだけです。この場合、コードは次のようになります。

Notification n = Notification.createWindowsNotification("WNS body");
hub.sendNotification(n, "InstallationId:{installation-id}");

複数のテンプレートのうちの 1 つを使用する場合、コードは次のようになります。

Map<String, String> prop =  new HashMap<String, String>();
prop.put("value3", "some value");
Notification n = Notification.createTemplateNotification(prop);
hub.sendNotification(n, "InstallationId:{installation-id} && tag-for-template1");

通知のスケジュール設定 (標準階層の場合に使用可能)

通常の送信と同じですが、通知がいつ配信されるかを示す scheduledTime という 1 つのパラメーターが追加されています。サービスは、現在 + 5 分～現在 + 7 日の任意の時点を受け入れます。

Windows のネイティブの通知のスケジュールを設定する:

Calendar c = Calendar.getInstance();
c.add(Calendar.DATE, 1);
Notification n = Notification.createWindowsNotification("WNS body");
hub.scheduleNotification(n, c.getTime());

インポート/エクスポート (標準階層の場合に使用可能)

登録に対する一括操作の実行が必要な場合があります。通常は、別のシステムとの統合や、タグを更新するための大規模な修正を行う場合です。数千の登録が関連している場合、Get/Update フローの使用はお勧めできません。システムのインポート/エクスポート機能は、このようなシナリオに対応しています。受信データのソースおよび出力のための場所として、ストレージアカウントの BLOB コンテナーへのアクセスを提供します。

エクスポートジョブを送信する:

NotificationHubJob job = new NotificationHubJob();
job.setJobType(NotificationHubJobType.ExportRegistrations);
job.setOutputContainerUri("container uri with SAS signature");
job = hub.submitNotificationHubJob(job);

インポートジョブを送信する:

NotificationHubJob job = new NotificationHubJob();
job.setJobType(NotificationHubJobType.ImportCreateRegistrations);
job.setImportFileUri("input file uri with SAS signature");
job.setOutputContainerUri("container uri with SAS signature");
job = hub.submitNotificationHubJob(job);

ジョブが完了するまで待機する:

while(true){
    Thread.sleep(1000);
    job = hub.getNotificationHubJob(job.getJobId());
    if(job.getJobStatus() == NotificationHubJobStatus.Completed)
        break;
}

すべてのジョブを取得する:

List<NotificationHubJob> jobs = hub.getAllNotificationHubJobs();

SAS 署名を含む URI:

この URL は、ある BLOB ファイルまたは BLOB コンテナーの URL に、一連のパラメーター (アクセス許可や期限切れ日時など) と、アカウントの SAS キーを使用して作成されたこれらのすべてのものの署名を加えたものです。 Azure Storage Java SDK には、これらの URI を作成を含む豊富な機能が用意されています。簡単な代替手段として、署名アルゴリズムの基本的でコンパクトな実装を含む (GitHub の場所にある) ImportExportE2E テストクラスを参照します。

通知の送信

Notification オブジェクトはヘッダー付きの本文にすぎません。一部のユーティリティメソッドはネイティブオブジェクトとテンプレート通知オブジェクトのビルドに役立ちます。

Windows ストアおよび Windows Phone 8.1 (非 Silverlight)

String toast = "<toast><visual><binding template=\"ToastText01\"><text id=\"1\">Hello from Java!</text></binding></visual></toast>";
Notification n = Notification.createWindowsNotification(toast);
hub.sendNotification(n);

iOS

String alert = "{\"aps\":{\"alert\":\"Hello from Java!\"}}";
Notification n = Notification.createAppleNotification(alert);
hub.sendNotification(n);

Android

String message = "{\"data\":{\"msg\":\"Hello from Java!\"}}";
Notification n = Notification.createFcmNotification(message);
hub.sendNotification(n);

Windows Phone 8.0 および 8.1 Silverlight

String toast = "<?xml version=\"1.0\" encoding=\"utf-8\"?>" +
            "<wp:Notification xmlns:wp=\"WPNotification\">" +
                "<wp:Toast>" +
                    "<wp:Text1>Hello from Java!</wp:Text1>" +
                "</wp:Toast> " +
            "</wp:Notification>";
Notification n = Notification.createMpnsNotification(toast);
hub.sendNotification(n);

Kindle Fire

String message = "{\"data\":{\"msg\":\"Hello from Java!\"}}";
Notification n = Notification.createAdmNotification(message);
hub.sendNotification(n);

タグに送信する

Set<String> tags = new HashSet<String>();
tags.add("boo");
tags.add("foo");
hub.sendNotification(n, tags);

タグ式に送信する

hub.sendNotification(n, "foo && ! bar");

テンプレート通知を送信する

Map<String, String> prop =  new HashMap<String, String>();
prop.put("prop1", "v1");
prop.put("prop2", "v2");
Notification n = Notification.createTemplateNotification(prop);
hub.sendNotification(n);

Java コードを実行すると、ターゲットデバイスに表示される通知が生成されます。

次の手順

このトピックでは、Notification Hubs 用の単純な Java REST クライアントを作成する方法を示しました。ここでは、次の操作を実行できます。

Java SDK をすべてダウンロードします。Java SDK には SDK コード全体が含まれています。
サンプルを試します。

次の方法で共有