Windows Azure NotificationHub+Firebase Cloud Message 實現訊息推動(付原始碼)
前期專案一直用的是Windows azure NotificationHub+Google Cloud Message 實現訊息推送, 但是GCM google已經不再推薦使用,慢慢就不再維護了, 現在Google 主推 FCM, 另一方面,google在android生態中的許可權要求越來越嚴格,不像以前那樣將許可權宣告在AndroidManifest中,在安裝的時候做一次提醒就好了, 現在對於一些主要的許可權需要動態申請並且使用者同意才能使用,比如呼叫相機,使用電話本等等,同樣對於後臺的常駐服務也做了一定的限制,旨在提升android系統的使用者體驗以及提高電池的續航時間,在2018-11-1強制執行編譯的Target SDK API Leve必須是26+,否則是不允許上Goolge Play , GCM也只支援到2019-11-1,之後就不再支援,專案老的推送服務要依賴於後臺常駐Service。 基於以上原因我對當前的android專案做了一次全面升級。這裡分享一下GCM到FCM的遷移過程。
我們的專案用的微軟的Azure平臺,自然所有的一切技術都圍繞著Windows Azure 平臺展開。 Web App, Web API 使用的是Azure Cloud Service, Mobile APP 使用的是Xamarin, 資料庫使用的是Azure SQL Database, 是不是很微軟系。
自然在訊息推送的時候想到的還是Azure平臺上的技術 Notification Hub。
名詞解釋:
GCM: Google Cloud Message.
FCM: Firebase Cloud Message.
遷移步驟
1. 建立一個Firebase 專案並且開啟Firebase Cloud Messaging功能。
2. 在Azure上建立一個NotificationHub。
3.將Firebase和ConnectionHub關聯上。
4.建立一個Xiamarin android APP 並關聯上 NotificationHub和 Firebase Cloud Message。
5. 測試訊息傳送。
注意:由於需要連線到Firebase Cloud Message 牽涉到牆的問題,需要手機能夠FQ, 否則測試將不能成功,另外,在做FCM的設定也是寸步難行。
準備工作
1. 需要一個google賬號,用於建立Firebase 專案並開啟 Firebase Cloud Message。
2.需要一個azure賬號,用於建立NotificationHub。
3.Visual Studio 並且要安裝Xamarin 外掛。
4. 準備一個VPN 用於測試。
建立一個Firebase 專案並且開啟Firebase Cloud Messaging功能
開啟 Firebase 開發控制檯https://console.firebase.google.com/新增一個專案 如圖:
這裡我建立一個專案叫:XamarinAndroidFCM。建立好後像下面這樣:
這一步暫時就建立到這裡,我們需要一個android app的Package 名稱, 下面我們將建立一個android專案建立好以後再回來設定這個包的名稱。
在Azure上建立一個NotificationHub
登入到Azure 在雲端在左邊的選單中找到NotificationHub項, 點選想建立一個Notification Hub Namespaces, 然後進入NameSpace並且建立一個NotificaitonHub。
然後點選建立的NotificaitonHub名字進入設定介面,並且點選中間的選單GCM(google),設定這個API key
這個key 來自上一步建立的Firebase 專案:
這樣FCM 和Notifaction Hub就關聯好了。
建立一個Xiamarin android APP 並關聯上 NotificationHub和 Firebase Cloud Message
開啟VS 建立一個xiamarin for Android的專案。建立好後如下:
開啟專案將的配置檔案:AndroidManifest.xml, 將裡面的包名改成小寫(這裡很重要,如果不改成小寫,你將不會收到任何訊息,這是個坑,做GCM的時候也是一樣, 測試了很多次才找出來這個原因)
<manifest xmlns:android="http://schemas.android.com/apk/res/android" android:versionCode="1" android:versionName="1.0" package="xamarinandroidfcm.xamarinandroidfcm">
這裡我們將這個包名“xamarinandroidfcm.xamarinandroidfcm” 填到第一步FCM中去 並儲存。
儲存完成後點選右邊的google-service.json 檔案下載到本地並加入到建立的android專案中
這樣FCM的相關設定就完了。
在android的專案中做FCM 以及Azure NotificationHub的連線並接收訊息
1. 新增相關的依賴包: Xamarin.Firebase.Messaging 和 Xamarin.Azure.NotificationHubs.Android
2. 設定google-service.json 的build action 為“GoogleServicesJson”(如果找不到這一項,重啟一下VS重新設定就可以找到了)
3. 在AndroidManifest.xmal 的Application節點中加入以下配置:
<receiver android:name="com.google.firebase.iid.FirebaseInstanceIdInternalReceiver" android:exported="false" /> <receiver android:name="com.google.firebase.iid.FirebaseInstanceIdReceiver" android:exported="true" android:permission="com.google.android.c2dm.permission.SEND"> <intent-filter> <action android:name="com.google.android.c2dm.intent.RECEIVE" /> <action android:name="com.google.android.c2dm.intent.REGISTRATION" /> <category android:name="${applicationId}" /> </intent-filter> </receiver>
如下:
4. 配置Notification Hub 賬號到程式碼中。
在專案中建立一個Class 叫:Constants, 並建立兩個常量用於儲存NotificaiotnHub的連線字串和名稱。開啟azrue中建立的Hub 點選左邊的Access Policy,看到如下介面:
將DefaultListenSharedAccessSignature的Connection String值拷貝到剛剛建立的那個常量 ListenConnectionString 中。並把Notificaiton Hub的名字儲存在
NotificationHubName中。
5.建立MyFirebaseIidService 服務類用於接收和重新整理Firebase的token, 並將token以及tag註冊到Notificationhub.
using System.Collections.Generic; using Android.App; using Android.Util; using WindowsAzure.Messaging; using Firebase.Iid; namespace XamarinAndroidFCM { [Service] [IntentFilter(new[] {"com.google.firebase.INSTANCE_ID_EVENT"})] public class MyFirebaseIidService : FirebaseInstanceIdService { private const string Tag = "MyFirebaseIIDService"; NotificationHub _hub; public override void OnTokenRefresh() { var refreshedToken = FirebaseInstanceId.Instance.Token; Log.Debug(Tag, "FCM token: " + refreshedToken); SendRegistrationToServer(refreshedToken); } void SendRegistrationToServer(string token) { // Register with Notification Hubs _hub = new NotificationHub(Constants.NotificationHubName,Constants.ListenConnectionString, this); var tags = new List<string>() { "1" }; var regID = _hub.Register(token, tags.ToArray()).RegistrationId; Log.Debug(Tag, $"Successful registration of ID {regID}"); } } }
6. 建立接收訊息的服務:MyFirebaseMessagingService 用於接收訊息並顯示給使用者:
using System; using System.Linq; using Android.App; using Android.Content; using Android.Util; using Android.Widget; using Firebase.Messaging; namespace XamarinAndroidFCM { [Service] [IntentFilter(new[] {"com.google.firebase.MESSAGING_EVENT"})] public class MyFirebaseMessagingService : FirebaseMessagingService { private const string Tag = "MyFirebaseMsgService"; public override void OnMessageReceived(RemoteMessage message) { Log.Debug(Tag, "From: " + message.From); if (message.GetNotification() != null) { //These is how most messages will be received Log.Debug(Tag, "Notification Message Body: " + message.GetNotification().Body); SendNotification(message.GetNotification().Body); } else { //Only used for debugging payloads sent from the Azure portal CreateNotification("Test FCM", message.Data.Values.First(), "15:30"); } } void SendNotification(string messageBody) { var intent = new Intent(this, typeof(MainActivity)); intent.AddFlags(ActivityFlags.ClearTop); var pendingIntent = PendingIntent.GetActivity(this, 0, intent, PendingIntentFlags.OneShot); var notificationBuilder = new Notification.Builder(this) .SetContentTitle("FCM Message") .SetSmallIcon(Resource.Drawable.ic_launcher) .SetContentText(messageBody) .SetAutoCancel(true) .SetContentIntent(pendingIntent); var notificationManager = NotificationManager.FromContext(this); notificationManager.Notify(0, notificationBuilder.Build()); } void CreateNotification(string title, string desc, string time) { var notificationManager = GetSystemService(Context.NotificationService) as NotificationManager; var uiIntent = new Intent(this, typeof(MainActivity)); var notification = new Notification(Resource.Mipmap.ic_launcher, title); notification.Flags = NotificationFlags.AutoCancel; notification.Defaults = NotificationDefaults.All; notification.Vibrate = new long[] { 0, 100, 200, 300 }; if (Android.OS.Build.VERSION.SdkInt >= Android.OS.BuildVersionCodes.JellyBean) { var contentView = new RemoteViews(PackageName, Resource.Layout.Custom_Notification); contentView.SetTextViewText(Resource.Id.txtTitle, title); contentView.SetTextViewText(Resource.Id.txtTime, time); contentView.SetTextViewText(Resource.Id.txtContent, desc); notification.BigContentView = contentView; } notification.SetLatestEventInfo(this, title, desc, PendingIntent.GetActivity(this, 0, uiIntent, PendingIntentFlags.UpdateCurrent)); var rnd = new Random(); var notificationId = rnd.Next(10000, 99999); notificationManager.Notify(notificationId, notification); } } }
程式碼部分全部實現完成。
測試
開啟模擬器或手機,設定代理, 除錯應用, 並且再次開啟Azure Notifiaciton Hub 進入到測試介面進行測試:
手機端接收到的訊息如下:
總結,Notificaiton Hub + FCM傳送訊息比較簡單,但是也有許多坑,設定比較多,比如應用包的大小寫問題,FQ的問題都是一些小的阻礙,但是這個訊息推送還是比較穩定的, 適合一些國外的專案。 如果做國內的專案可以考慮Notification Hub+ 百度message來做訊息推送,當然也可以原則一些第三方的SDK來做。