通过百度开始使用通知中心Get started with Notification Hubs using Baidu
百度云推送是一种中国云服务,可用于将推送通知发送到移动设备。Baidu cloud push is a Chinese cloud service that you can use to send push notifications to mobile devices.
由于 Google Play 和 FCM (Firebase Cloud Messaging) 在中国不可用,必须使用其他的应用商店和推送服务。As Google Play and FCM (Firebase Cloud Messaging) are not available in China, it is necessary to use different app stores and push services. 百度就是其中的一个,也是通知中心目前所使用的。Baidu is one of them, and the one currently used by Notification Hub.
先决条件Prerequisites
本教程需要:This tutorial requires:
- Android SDK(我们假设你使用 Android Studio),可从 Android 站点下载Android SDK (we assume that you use Android Studio), which you can download from the Android site
- 百度推送 Android SDKBaidu Push Android SDK
备注
要完成本教程,必须有一个有效的 Azure 帐户。To complete this tutorial, you must have an active Azure account. 如果没有帐户,可以创建一个试用帐户,只需几分钟即可完成。If you don't have an account, you can create a trial account in just a couple of minutes. 有关详细信息,请参阅试用版订阅。For details, see Trial Subscription.
若要开始,请执行以下操作:To get started, do the following:
- 创建一个百度帐户。Create a Baidu account.
- 创建一个百度云推送项目,并记下 API 密钥和密钥。Create a Baidu cloud push project, and make a note of the API key and secret key.
配置新通知中心Configure a new notification hub
登录 Azure 门户。Sign in to the Azure portal.
在左侧菜单上选择“所有服务” ,然后在“移动”部分中选择“通知中心”。 Select All services on the left menu, and then select Notification Hubs in the Mobile section. 选择服务名称旁边的星形图标,以便将服务添加到左侧菜单上的“收藏夹”部分。 Select the star icon next to the service name to add the service to the FAVORITES section on the left menu. 在将“通知中心” 添加到“收藏夹” 之后,在左侧菜单上选择它。After you add Notification Hubs to FAVORITES, select it on the left menu.
在“通知中心” 页面上,在工具栏上选择“添加” 。On the Notification Hubs page, select Add on the toolbar.
在“通知中心” 页面上,执行以下步骤:On the Notification Hub page, do the following steps:
将一个名称输入“通知中心”。 Enter a name in Notification Hub.
在“创建新的命名空间”中输入名称。 Enter a name in Create a new namespace. 命名空间包含一个或多个中心。A namespace contains one or more hubs.
从“位置”下拉列表框中选择值。 Select a value from the Location drop-down list box. 此值指定要在其中创建通知中心的位置。This value specifies the location in which you want to create the hub.
在“资源组”中选择现有的资源组,或者为新资源组创建一个名称。 Select an existing resource group in Resource Group, or create a name for a new resource group.
选择“创建” 。Select Create.
选择“通知”(钟形图标),然后选择“转到资源” 。Select Notifications (the bell icon), and then select Go to resource. 还可以刷新“通知中心” 页上的列表,然后选择通知中心。You can also refresh the list on the Notification Hubs page and select your hub.
从列表中选择“访问策略” 。Select Access Policies from the list. 记下向你提供的两个连接字符串。Note that the two connection strings are available to you. 稍后在处理推送通知时需要它们。You'll need them later to handle push notifications.
重要
请勿 在应用程序中使用 DefaultFullSharedAccessSignature 策略。Do not use the DefaultFullSharedAccessSignature policy in your application. 这只能在后端使用。This is meant to be used in your back end only.
6. 6. 在通知中心选择“通知服务”,然后选择“百度(Android China)”。 In your notification hub, select Notification Services and then Baidu (Android China).
7. 7. 向下滚动到百度通知设置部分。Scroll down to the Baidu notification settings section. 在百度云推送项目中,输入从百度控制台获得的 API 密钥和密钥。Enter the API key and secret key that you obtained from the Baidu console, in the Baidu cloud push project. 然后单击“保存”。Then click Save.
通知中心现在已配置为使用百度。Your notification hub is now configured to work with Baidu. 此外还有连接字符串,用于注册发送和接收推送通知的应用。You also have the connection strings to register your app to both send and receive push notifications.
记下“访问连接信息”窗口中的 DefaultListenSharedAccessSignature
和 DefaultFullSharedAccessSignature
。Make a note of the DefaultListenSharedAccessSignature
and DefaultFullSharedAccessSignature
from the Access connection information window.
将应用连接到通知中心Connect your app to the notification hub
在 Android Studio 中创建新的 Android 项目(“文件”>“新建”>“新建项目”)。In Android Studio, create a new Android project (File > New > New Project).
输入应用程序名称,并确保将要求的最低 SDK 版本设为“API 16:Android 4.1”。Enter an Application Name and ensure that the Minimum Required SDK version is set to API 16: Android 4.1. 另请确保应用包名与百度云推送门户中的相同Also please make sure your package name (应用包名) is the same as in the Baidu Cloud Push Portal
单击“下一步”,并继续执行向导,直到显示“创建活动”窗口。Click Next and continue following the wizard until the Create Activity window appears. 确保选中了“空活动”,最后选择“完成”以创建新的 Android 应用程序。Make sure that Empty Activity is selected, and finally select Finish to create a new Android Application.
确保“项目生成目标”已正确设置。Make sure that the Project Build Target is set correctly.
然后添加 Azure 通知中心库。Then add Azure Notification Hubs libraries. 在应用的
Build.Gradle
文件中,在 dependencies 节添加以下行。In theBuild.Gradle
file for the app, add the following lines in the dependencies section.implementation 'com.microsoft.azure:notification-hubs-android-sdk:0.6@aar' implementation 'com.microsoft.azure:azure-notifications-handler:1.0.1@aar'
在 dependencies 节的后面添加以下存储库。Add the following repository after the dependencies section.
repositories { maven { url "https://dl.bintray.com/microsoftazuremobile/SDK" } }
为了避免列表冲突,请在项目的
Manifest.xml
文件中添加以下代码:To avoid the List conflict, add the following code in the project'sManifest.xml
file:<manifest package="YOUR.PACKAGE.NAME" xmlns:tools="http://schemas.android.com/tools" xmlns:android="http://schemas.android.com/apk/res/android">
然后在
<application/>
标记中执行以下操作:and in the<application/>
tag:<application tools:replace="android:allowBackup,icon,theme,label">
下载并解压缩百度推送 Android SDK。Download and unzip the Baidu Push Android SDK. 复制 libs 文件夹中的
pushservice-x.y.z jar
文件。Copy thepushservice-x.y.z jar
file in the libs folder. 然后复制 Android 应用程序的src/main/jniLibs
(创建新文件夹)文件夹中的.so
文件。Then copy the.so
files in thesrc/main/jniLibs
(create a new folder) folders of your Android application.在项目的
libs
文件夹中,右键单击pushervice-x.y.z.jar
文件,选择“作为库添加”,以便将此库包括在项目中。 In the project'slibs
folder, right click on thepushervice-x.y.z.jar
file; select Add as Library to including this library in the project.打开 Android 项目的
AndroidManifest.xml
文件,添加百度 SDK 所需的权限。Open the Android project'sAndroidManifest.xml
file and add the permissions required by the Baidu SDK. 将YOURPACKAGENAME
替换为包名。ReplaceYOURPACKAGENAME
with your package name.<uses-permission android:name="android.permission.INTERNET" /> <uses-permission android:name="android.permission.READ_PHONE_STATE" /> <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" /> <uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED" /> <uses-permission android:name="android.permission.WRITE_SETTINGS" /> <uses-permission android:name="android.permission.VIBRATE" /> <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" /> <uses-permission android:name="android.permission.DISABLE_KEYGUARD" /> <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" /> <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" /> <uses-permission android:name="android.permission.ACCESS_DOWNLOAD_MANAGER" /> <uses-permission android:name="android.permission.DOWNLOAD_WITHOUT_NOTIFICATION" /> <uses-permission android:name="android.permission.EXPAND_STATUS_BAR" /> !! <uses-permission android:name="baidu.push.permission.WRITE_PUSHINFOPROVIDER.YOURPACKAGENAME" /> !!<permission android:name="baidu.push.permission.WRITE_PUSHINFOPROVIDER.YOURPACKAGENAME"android:protectionLevel="normal" />
在
.MainActivity
活动元素后的 application 元素内添加以下配置,并替换 yourprojectname(例如com.example.BaiduTest
):Add the following configuration within the application element after the.MainActivity
activity element, replacing yourprojectname (for example,com.example.BaiduTest
):<activity android:name="com.baidu.android.pushservice.richmedia.MediaViewActivity" android:configChanges="orientation|keyboardHidden" android:label="MediaViewActivity" /> <activity android:name="com.baidu.android.pushservice.richmedia.MediaListActivity" android:configChanges="orientation|keyboardHidden" android:label="MediaListActivity" android:launchMode="singleTask" /> <!-- Push application definition message --> <receiver android:name=".MyPushMessageReceiver"> <intent-filter> <!-- receive push message--> <action android:name="com.baidu.android.pushservice.action.MESSAGE" /> <!-- receive bind,unbind,fetch,delete.. message--> <action android:name="com.baidu.android.pushservice.action.RECEIVE" /> <action android:name="com.baidu.android.pushservice.action.notification.CLICK" /> </intent-filter> </receiver> <receiver android:name="com.baidu.android.pushservice.PushServiceReceiver" android:process=":bdservice_v1"> <intent-filter> <action android:name="android.intent.action.BOOT_COMPLETED" /> <action android:name="android.net.conn.CONNECTIVITY_CHANGE" /> <action android:name="com.baidu.android.pushservice.action.notification.SHOW" /> <action android:name="com.baidu.android.pushservice.action.media.CLICK" /> <action android:name="android.intent.action.MEDIA_MOUNTED" /> <action android:name="android.intent.action.USER_PRESENT" /> <action android:name="android.intent.action.ACTION_POWER_CONNECTED" /> <action android:name="android.intent.action.ACTION_POWER_DISCONNECTED" /> </intent-filter> </receiver> <receiver android:name="com.baidu.android.pushservice.RegistrationReceiver" android:process=":bdservice_v1"> <intent-filter> <action android:name="com.baidu.android.pushservice.action.METHOD" /> <action android:name="com.baidu.android.pushservice.action.BIND_SYNC" /> </intent-filter> <intent-filter> <action android:name="android.intent.action.PACKAGE_REMOVED" /> <data android:scheme="package" /> </intent-filter> </receiver> <service android:name="com.baidu.android.pushservice.PushService" android:exported="true" android:process=":bdservice_v1"> <intent-filter> <action android:name="com.baidu.android.pushservice.action.PUSH_SERVICE" /> </intent-filter> </service> <service android:name="com.baidu.android.pushservice.CommandService" android:exported="true" /> <!-- Adapt the ContentProvider declaration required for the Android N system, and the write permissions include the application package name--> <provider android:name="com.baidu.android.pushservice.PushInfoProvider" android:authorities="com.baidu.push.example.bdpush" android:exported="true" android:protectionLevel="signature" android:writePermission="baidu.push.permission.WRITE_PUSHINFOPROVIDER. yourprojectname " /> <!-- API Key of the Baidu application --> <meta-data android:name="api_key" !! android:value="api_key" /> </application>
将名为
ConfigurationSettings.java
的新类添加到项目。Add a new class calledConfigurationSettings.java
to the project.public class ConfigurationSettings { public static String API_KEY = "..."; public static String NotificationHubName = "..."; public static String NotificationHubConnectionString = "..."; }
使用百度云项目中的 API_KEY 设置
API_KEY
字符串的值。Set the value of theAPI_KEY
string with the API_KEY from the Baidu Cloud Project.使用 Azure 门户中的通知中心名称设置
NotificationHubName
字符串的值,然后使用 Azure 门户中的DefaultListenSharedAccessSignature
设置NotificationHubConnectionString
的值。Set the value of theNotificationHubName
string with your notification hub name from the Azure portal; and thenNotificationHubConnectionString
withDefaultListenSharedAccessSignature
from the Azure portal.打开 MainActivity.java,并将以下内容添加到 onCreate 方法中:Open MainActivity.java, and add the following to the onCreate method:
PushManager.startWork(this, PushConstants.LOGIN_TYPE_API_KEY, API_KEY );
添加一个名为
MyPushMessageReceiver.java
的新类,并向此类中添加以下代码:Add a new class calledMyPushMessageReceiver.java
, and add the following code to it. 此类用于处理从百度推送服务器收到的推送通知。It is the class that handles the push notifications that are received from the Baidu push server.package your.package.name; import android.content.Context; import android.content.Intent; import android.os.AsyncTask; import android.text.TextUtils; import android.util.Log; import com.baidu.android.pushservice.PushMessageReceiver; import com.microsoft.windowsazure.messaging.NotificationHub; import org.json.JSONException; import org.json.JSONObject; import java.util.List; public class MyPushMessageReceiver extends PushMessageReceiver { public static final String TAG = MyPushMessageReceiver.class .getSimpleName(); public static NotificationHub hub = null; public static String mChannelId, mUserId; @Override public void onBind(Context context, int errorCode, String appid, String userId, String channelId, String requestId) { String responseString = "onBind errorCode=" + errorCode + " appid=" + appid + " userId=" + userId + " channelId=" + channelId + " requestId=" + requestId; Log.d(TAG, responseString); if (errorCode == 0) { // Binding successful Log.d(TAG, " Binding successful"); } try { if (hub == null) { hub = new NotificationHub( ConfigurationSettings.NotificationHubName, ConfigurationSettings.NotificationHubConnectionString, context); Log.i(TAG, "Notification hub initialized"); } } catch (Exception e) { Log.e(TAG, e.getMessage()); } mChannelId = channelId; mUserId = userId; registerWithNotificationHubs(); } private void registerWithNotificationHubs() { new AsyncTask<Void, Void, Void>() { @Override protected Void doInBackground(Void... params) { try { hub.registerBaidu(mUserId, mChannelId); Log.i(TAG, "Registered with Notification Hub - '" + ConfigurationSettings.NotificationHubName + "'" + " with UserId - '" + mUserId + "' and Channel Id - '" + mChannelId + "'"); } catch (Exception e) { Log.e(TAG, e.getMessage()); } return null; } }.execute(null, null, null); } @Override public void onMessage(Context context, String message, String customContentString) { String messageString = " onMessage=\"" + message + "\" customContentString=" + customContentString; Log.d(TAG, messageString); if (!TextUtils.isEmpty(customContentString)) { JSONObject customJson = null; try { customJson = new JSONObject(customContentString); String myvalue = null; if (!customJson.isNull("mykey")) { myvalue = customJson.getString("mykey"); } } catch (JSONException e) { e.printStackTrace(); } } } @Override public void onNotificationArrived(Context context, String title, String description, String customContentString) { String notifyString = " Notice Arrives onNotificationArrived title=\"" + title + "\" description=\"" + description + "\" customContent=" + customContentString; Log.d(TAG, notifyString); if (!TextUtils.isEmpty(customContentString)) { JSONObject customJson = null; try { customJson = new JSONObject(customContentString); String myvalue = null; if (!customJson.isNull("mykey")) { myvalue = customJson.getString("mykey"); } } catch (JSONException e) { // TODO Auto-generated catch block e.printStackTrace(); } } } @Override public void onNotificationClicked(Context context, String title, String description, String customContentString) { String notifyString = " onNotificationClicked title=\"" + title + "\" description=\"" + description + "\" customContent=" + customContentString; Log.d(TAG, notifyString); Intent intent = new Intent(context.getApplicationContext(),MainActivity.class); intent.putExtra("title",title); intent.putExtra("description",description); intent.putExtra("isFromNotify",true); intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK); context.getApplicationContext().startActivity(intent); } @Override public void onSetTags(Context context, int errorCode, List<String> successTags, List<String> failTags, String requestId) { String responseString = "onSetTags errorCode=" + errorCode + " successTags=" + successTags + " failTags=" + failTags + " requestId=" + requestId; Log.d(TAG, responseString); } @Override public void onDelTags(Context context, int errorCode, List<String> successTags, List<String> failTags, String requestId) { String responseString = "onDelTags errorCode=" + errorCode + " successTags=" + successTags + " failTags=" + failTags + " requestId=" + requestId; Log.d(TAG, responseString); } @Override public void onListTags(Context context, int errorCode, List<String> tags, String requestId) { String responseString = "onListTags errorCode=" + errorCode + " tags=" + tags; Log.d(TAG, responseString); } @Override public void onUnbind(Context context, int errorCode, String requestId) { String responseString = "onUnbind errorCode=" + errorCode + " requestId = " + requestId; Log.d(TAG, responseString); if (errorCode == 0) { // Unbinding is successful Log.d(TAG, " Unbinding is successful "); } } }
向应用程序发送通知Send notifications to your app
可以在 Azure 门户中快速测试通知接收情况:使用通知中心配置屏幕中的“发送” 按钮,如以下屏幕所示:You can quickly test receiving notifications from the Azure portal: use the Send button in the notification hub configuration screen, as shown in the following screens:
通常,推送通知是在后端服务(例如,移动服务,或者使用兼容库的 ASP.NET)中发送的。Push notifications are normally sent in a back-end service like Mobile Services or ASP.NET using a compatible library. 如果后端没有可用的库,则可直接使用 REST API 发送通知消息。If a library is not available for your back-end, you can use the REST API directly to send notification messages.
为简单起见,本教程使用一个控制台应用演示如何通过 .NET SDK 来发送通知。For simplicity, this tutorial uses a console app as a demonstration on how to send a notification with the .NET SDK. 但是,建议你接下来学习使用通知中心向用户推送通知教程,了解如何从 ASP.NET 后端发送通知。However, we recommend the Use Notification Hubs to push notifications to users tutorial as the next step for sending notifications from an ASP.NET backend.
下面是用于发送通知的不同方法:Here are different approaches for sending notifications:
- REST 接口:可以使用 REST 接口在任何后端平台上支持通知。REST Interface: You can support notification on any backend platform using the REST interface.
- Azure 通知中心 .NET SDK:在 Visual Studio 的 NuGet 包管理器中,运行 Install-Package Microsoft.Azure.NotificationHubs。Azure Notification Hubs .NET SDK: In the Nuget Package Manager for Visual Studio, run Install-Package Microsoft.Azure.NotificationHubs.
- Node.js:如何通过 Node.js 使用通知中心。Node.js: How to use Notification Hubs from Node.js.
- 移动应用:有关如何从通知中心集成的 Azure 应用服务移动应用后端发送通知的示例,请参阅 将推送通知添加到移动应用。Mobile Apps: For an example of how to send notifications from an Azure App Service Mobile Apps backend that's integrated with Notification Hubs, see Add push notifications to your mobile app.
- Java/PHP:有关如何使用 REST API 发送通知的示例,请参阅“如何通过 Java/PHP 使用通知中心”(Java | PHP)。Java / PHP: For an example of how to send notifications by using the REST APIs, see "How to use Notification Hubs from Java/PHP" (Java | PHP).
(可选)通过 .NET 控制台应用发送通知。(Optional) Send notifications from a .NET console app.
在本部分,我们演示如何使用 .NET 控制台应用发送通知。In this section, we show sending a notification using a .NET console app.
创建新的 Visual C# 控制台应用程序:Create a new Visual C# console application:
在“包管理器控制台”窗口中,将“默认项目”设置为新的控制台应用程序项目,并在控制台窗口中执行以下命令: In the Package Manager Console window, set the Default project to your new console application project, and then in the console window, execute the following command:
Install-Package Microsoft.Azure.NotificationHubs
此指令会使用 Microsoft.Azure.Notification Hubs NuGet 包添加对 Azure 通知中心 SDK 的引用。This instruction adds a reference to the Azure Notification Hubs SDK using the Microsoft.Azure.Notification Hubs NuGet package.
打开
Program.cs
文件并添加以下 using 语句:Open the fileProgram.cs
and add the following using statement:using Microsoft.Azure.NotificationHubs;
在
Program
类中添加以下方法,并使用自己的值替换DefaultFullSharedAccessSignatureSASConnectionString
和NotificationHubName
。In yourProgram
class, add the following method and replaceDefaultFullSharedAccessSignatureSASConnectionString
andNotificationHubName
with the values that you have.private static async void SendNotificationAsync() { NotificationHubClient hub = NotificationHubClient.CreateClientFromConnectionString("DefaultFullSharedAccessSignatureSASConnectionString", "NotificationHubName"); string message = "{\"title\":\"((Notification title))\",\"description\":\"Hello from Azure\"}"; var result = await hub.SendBaiduNativeNotificationAsync(message); }
在
Main
方法中添加以下行:Add the following lines in yourMain
method:SendNotificationAsync(); Console.ReadLine();
测试应用程序Test your app
要使用实际的手机测试此应用,只需使用 USB 电缆将该手机连接到你的计算机。To test this app with an actual phone, just connect the phone to your computer by using a USB cable. 此操作会将应用加载到连接的手机中。This action loads your app onto the attached phone.
若要使用模拟器测试此应用,请在 Android Studio 顶部工具栏中单击“运行”,然后选择用于启动模拟器、加载和运行应用的应用。 To test this app with the emulator, on the Android Studio top toolbar, click Run, and then select your app: it starts the emulator, loads, and runs the app.
该应用将从百度推送通知服务检索 userId
和 channelId
,并注册到通知中心。The app retrieves the userId
and channelId
from the Baidu Push notification service and registers with the notification hub.
若要发送测试通知,可以使用 Azure 门户的调试选项卡。To send a test notification, you can use the debug tab of the Azure portal. 如果为 Visual Studio 生成了 .NET 控制台应用程序,只需在 Visual Studio 中按 F5 键以运行该应用程序。If you built the .NET console application for Visual Studio, just press the F5 key in Visual Studio to run the application. 该应用程序会发送一条通知,该通知显示在设备或模拟器的顶部通知区域。The application sends a notification that appears in the top notification area of your device or emulator.