如何在 Xamarin 中使用 Firebase 实现推送通知和使用 C# 后端实现 Apple 推送通知

How to implement Push Notification in Xamarin with Firebase and Apple Push Notification with C# backend

在从本机 Android 和 iOS 迁移到 Xamarin.Forms 的过程中,我决定使用 AppCenter Push 进行通知,因为它免费且易于使用(当然我花了很多时间让它工作,因为它是相对较新的东西,在线指导较少)。你可以在.

找到我的原创分享

在 Microsoft 宣布将停用 AppCenter Push (https://devblogs.microsoft.com/appcenter/app-center-mbaas-retirement/) 并鼓励用户转移到 Azure(这是一项付费服务​​)之前,我一直很满意它。我决定返回使用本机 FCM 和 APN 进行推送通知。

问题是没有关于如何完成整个事情的直接教程。到处都有问题和解决方案,例如 iOS .P8 仅适用于 HTTP/2 而我的项目是 运行 在不受支持的 .Net Framework 上。只有 .Net Core 可以 HTTP/2 协议。

我当前的项目在 ASP.NET C# 上运行作为后端,它使用 Xamarin.Forms 向 Xamarin.Android 和 Xamarin.iOS 发送通知。如果您和我一样,请在下面找到我的答案,我在下面分享了完整的 C# 后端和 Xamarin.Forms 解决方案。让更多的用户可以从免费服务中受益,而不是被推送到 Azure 付费服务。

第 1 部分 C# 后端 - C# ASP.NET 后端。它将分为两部分,分别用于 FCM 和 APNs。

1.1) Firebase (FCM)

  1. 要设置 FCM,您需要注册一个帐户。网上有很多指南,这是最好的指南之一 https://xmonkeys360.com/2019/12/08/xamarin-forms-fcm-setup-configuration-part-i/. Remember to get the Server Key and download the google-services.json file to your Xamarin.Android project. Right-click and set the build action to "GoogleServiceJson" (Where can i add google-services.json in xamarin app)。

  2. 下面是我的 Firebase

    using Newtonsoft.Json.Linq;
    using System;
    using System.Collections.Generic;
    using System.IO;
    using System.Net;
    using System.Web.Script.Serialization;
    
    namespace PushNotificationLibrary
    {
        public class FirebaseCloudMessagingPush
        {
            private const string WEB_ADDRESS = "https://fcm.googleapis.com/fcm/send";
    
            private const string SENDER_ID = "YOUR SENDER ID";
            private const string SERVER_KEY = "YOUR SERVER KEY";
    
            public string SendNotification(string deviceToken, string title, string message, string priority = "high", int badge = 0, List<Tuple<string, string>> parameters = null)
            {
                var result = "-1";
                var httpWebRequest = (HttpWebRequest)WebRequest.Create(WEB_ADDRESS);
    
                parameters = parameters ?? new List<Tuple<string, string>>();
    
                httpWebRequest.ContentType = "application/json";
                httpWebRequest.Headers.Add(string.Format("Authorization: key={0}", SERVER_KEY));
                httpWebRequest.Headers.Add(string.Format("Sender: id={0}", SENDER_ID));
                httpWebRequest.Method = "POST";
    
                if (title.Length > 100)
                    title = title.Substring(0, 95) + "...";
    
                //Message cannot exceed 100
                if (message.Length > 100)
                    message = message.Substring(0, 95) + "...";
    
                JObject jObject = new JObject();
                jObject.Add("to", deviceToken);
                jObject.Add("priority", priority);
                jObject.Add("content_available", true);
    
                JObject jObjNotification = new JObject();
                jObjNotification.Add("body", message);
                jObjNotification.Add("title", title);            
    
                jObject.Add("notification", jObjNotification);
    
                JObject jObjData = new JObject();
    
                jObjData.Add("badge", badge);
                jObjData.Add("body", message);
                jObjData.Add("title", title);
    
                foreach (Tuple<string, string> parameter in parameters)
                {
                    jObjData.Add(parameter.Item1, parameter.Item2);
                }
    
                jObject.Add("data", jObjData);
    
                var serializer = new JavaScriptSerializer();
                using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))
                {
                    string json = jObject.ToString();
                    streamWriter.Write(json);
                    streamWriter.Flush();
                }
    
                var httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();
                using (var streamReader = new StreamReader(httpResponse.GetResponseStream()))
                {
                    result = streamReader.ReadToEnd();
                }
    
                return result;
            }
        }
    }
    

1.2) iOS (APNs)

  1. 对于 APN,有两种处理方式。一种是使用 .P12 常规方式。另一种方法是通过 .P8 使用 Apple Auth Keys。我更喜欢使用 .P8,因为 .P12 证书每年都会过期,需要每年更新 。使用 .P8 的问题在于,它使用的是 HTTP/2,这在 .Net Framework 中不受支持,但值得庆幸的是,我设法克服了这个问题。请参考 How to implement apple token based push notifications (using p8 file) in C#?,在 post 上找到我的 答案,了解如何为 .Net Framework 实现整个过程。 *如果您已经在使用 .Net Core,答案将与我的类似,但您不必使用自定义 WinHTTPHandler。只需普通的 HTTPClient 即可。

第 2 部分 Xamarin.Forms - 接下来,您必须在 Xamarin.Forms 项目中支持通知。

  1. 对于这部分来说,一点也不难。您所要做的就是参考 https://github.com/CrossGeeks/PushNotificationPlugin,下载 Nuget 并按照 link 中的说明设置您的 Xamarin 项目(Forms、Android、iOS)。

  2. 我唯一想强调的是获取设备令牌的方式和位置。最初我试图通过下面的代码 (OnTokenRefresh) 获取设备令牌。但是您很快就会注意到这段代码并不总是被调用,我怀疑它只会在令牌刷新后被调用,而不是每次调试时都会被调用。为了每次都能获得您的设备令牌,只需在项目的任何地方调用 CrossPushNotification.Current.Token 即可。将该设备令牌注册到您的服务器后端。并使用我在上面第 1 部分中的代码使用设备令牌发送通知。

    CrossPushNotification.Current.OnTokenRefresh += (s,p) =>
    {
        System.Diagnostics.Debug.WriteLine($"TOKEN : {p.Token}");
    };
    

就是这样!这很容易,但在将它们拼凑在一起之前,我花了数周时间反复尝试。希望它能为别人节省宝贵的时间。

服务器:

为服务器端尝试 FirebaseAdmin。这个包非常简单。

https://github.com/firebase/firebase-admin-dotnet

按照这些设置说明进行操作:

https://firebase.google.com/docs/admin/setup#c

对于 Xamarin 应用:

我决定不想使用 CrossGeeks 插件,它非常简单。

对于Android:

安装相关的 Xamarin.Firebase 包并在继承包 FirebaseMessagingService 的 Android 项目中创建自己的 Firebase Messaging Class。

[Service]
[IntentFilter(new[] { "com.google.firebase.INSTANCE_ID_EVENT" })]
[IntentFilter(new[] { "com.google.firebase.MESSAGING_EVENT" })]
class PushNotificationFirebaseMessagingService : FirebaseMessagingService
{
    private static string foregroundChannelId = "9001";

    public override void OnNewToken(string refreshedToken)
    {
        base.OnNewToken(refreshedToken);

        SendRegistrationToServer(refreshedToken);
    }

    private void SendRegistrationToServer(string token)
    {
        //Your code here to register device token on server
    }

    public override void OnMessageReceived(RemoteMessage message)
    {
        SendNotification(message);

        base.OnMessageReceived(message);
    }

    private void SendNotification(RemoteMessage message)
    {
        try
        {
            var notificationManager = GetSystemService(Context.NotificationService) as NotificationManager;

            var notificationChannel = new NotificationChannel(foregroundChannelId, "messaging_channel", NotificationImportance.High);

            var audioAttributes = new AudioAttributes.Builder()
                .SetContentType(AudioContentType.Sonification)
                .SetUsage(AudioUsageKind.Notification).Build();

            var notificationUri = RingtoneManager.GetDefaultUri(RingtoneType.Notification);

            notificationChannel.EnableLights(true);
            notificationChannel.EnableVibration(true);
            notificationChannel.SetSound(notificationUri, audioAttributes);


            notificationManager.CreateNotificationChannel(notificationChannel);

            var remoteNotification = message.GetNotification();

            var builder = new Notification.Builder(this, foregroundChannelId)
                .SetContentTitle(remoteNotification.Title)
                .SetContentText(remoteNotification.Body)
                .SetSmallIcon(Resource.Mipmap.icon);

            var notification = builder.Build();

            notificationManager.Notify(0, notification);
        }
        catch (Exception ex)
        {

        }
    }
}

将以下内容添加到应用程序标记中的 AndroidManifest.xml。

<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>