.NET对接极光消息推送的实现方法

2024-08-01 16:18:56

什么是APP消息推送？

　　很多手机APP会不定时的给用户推送消息，例如一些新闻APP会给用户推送用户可能感兴趣的新闻，或者APP有更新了，会给用户推送是否选择更新的消息等等，这就是所谓的“消息推送”。

更多APP消息推送的介绍可查阅该篇文章：十分钟带你了解APP消息推送（Push）

如下是我们日常生活中常见的一些APP消息推送示例：

强营销类：

直接把营销力度，营销模式以一种叫卖式方式展现出来，目的通过优惠，时效性勾起用户贪小便宜的心理，好奇心理，如下所示：

强关联性：

在信息爆炸的时代，大脑会自动筛选对自己有价值的信息和没价值的信息，如果在一条信息中有@你，您之类的言语，大脑会自动识别，使用直接关联的技巧在于巧用“你”相关的字眼。

强热点：热点对眼球的吸引程度不言而喻，但是追热点这些事情呢，新闻资讯类由于其自身的属性，在热点话题这一块有天然优势，而其他类型的APP对热点的解读和追踪多少差强人意，尤其文案书写这块，没有杜蕾斯这样的能力，就别强撩用户，适得其反反而显得没水平。

强话题性：

营销界有这么一句话，没有违和感就创造不了传播，不出位就制造不了话题，那么强话题性的文案自带传播属性，一般都会击中用户内心的某个感触，比如对社会的愤世嫉俗，对高房价的逆反心理，对旅游的文艺心等等。

极光推送介绍

　　JPush 是经过考验的大规模 App 推送平台，每天推送消息量级为数百亿条。开发者集成 SDK 后，可以通过调用 API 推送消息。同时，JPush 提供可视化的 web 端控制台发送通知，统计分析推送效果。 JPush 全面支持 Android, iOS, Winphone 三大手机平台。

为什么选择极光作为APP的消息推送平台？

首先极光推送支持多平台推送
支持大规模的消息推送极光推送
对接方便，不同后端语言都提供了对应的SDK
对于免费账号支持也非常的友好（不过免费账号高峰期有资源瓶颈，假如需要及时性很强的话可以购买高级版收费服务）

特权对比

快速对接Jpush极光推送

极光详细对接文档

到极光推送官方网站注册开发者帐号；
登录进入管理控制台，创建应用程序，得到 Appkey（SDK 与服务器端通过 Appkey 互相识别）；
在推送设置中给 Android 设置包名、给 iOS 上传证书、启用 WinPhone，根据你的需求进行选择；

.NET FX 4.5项目接入

　　该项目是基于C#/.NET(.NET Framework4.5.1的示例)极光推送对接实例，主要是对接极光集成为我们.Neter提供的SKD。在这里我主要封装了单个设备注册ID推送，设备注册ID批量推送和广播推送三种推送三种方式，其他的推送方式大家可以参考文档去进行封装。

JPuhs-Sample（封装示例源码）

1、在项目中引入Jiguang.JPush nuget包

2、极光推送调用

namespace Jpush.Controllers
{
    /// <summary>
    /// 极光推送管理
    /// </summary>
    public class JPushManageController : Controller
    {

        private readonly JPushClientUtil _jPushClientUtil;

        public JPushManageController(JPushClientUtil jPushClientUtil)
        {
          this._jPushClientUtil=jPushClientUtil;
        }

        /// <summary>
        /// 单个设备注册ID推送
        /// </summary>
        /// <returns></returns>
        public ActionResult SendPushByRegistrationId()
        {
            var isOk = _jPushClientUtil.SendPushByRegistrationId("追逐时光者欢迎你！", "2022新年快乐", "1507bfd3f715abecfa4", new Dictionary<string, object>(), true);

            return Json(new { result = isOk });
        }

        /// <summary>
        /// 设备注册ID批量推送（一次推送最多1000个）
        /// </summary>
        /// <returns></returns>
        public ActionResult SendPushByRegistrationIdList()
        {
            var registrationIds = new List<string>() { "1507bfd3f715abecfa455", "1507bfd3f715abecfa433", "1507bfd3f715abecfa422" };
            var isOk = _jPushClientUtil.SendPushByRegistrationIdList("追逐时光者欢迎你！", "2022新年快乐", registrationIds, new Dictionary<string, object>(), true);

            return Json(new { result = isOk });
        }

        /// <summary>
        /// 广播推送
        /// </summary>
        /// <returns></returns>
        public ActionResult BroadcastPush()
        {
            var isOk = _jPushClientUtil.BroadcastPush("追逐时光者欢迎你！", "2022新年快乐", new Dictionary<string, object>(), true);

            return Json(new { result = isOk });
        }

    }
}

3、极光推送工具类（JPushClientUtil）

namespace Jpush.Common
{
    /// <summary>
    /// 极光推送工具类
    /// </summary>
    public class JPushClientUtil
    {
        private const string appKey = "youAppKey";
        private const string masterSecret = "youMasterSecret";
        private static JPushClient client = new JPushClient(appKey, masterSecret);

        /// <summary>
        /// 单个设备注册ID推送
        /// </summary>
        /// <param name="title">推送标题（Android才会存在）</param>
        /// <param name="noticeContent">通知内容</param>
        /// <param name="registrationid">设备注册ID(registration_id)</param>
        /// <param name="extrasParam">拓展参数(传入App接收的一些参数标识)</param>
        /// <param name="isApnsProduction">注意：iOS是否推送生产环境（true是，false否推开发环境）</param>
        /// <returns></returns>
        public bool SendPushByRegistrationId(string title, string noticeContent, string registrationid, Dictionary<string, object> extrasParam = null, bool isApnsProduction = true)
        {
            //设备标识参数拼接
            var pushRegistrationId = new RegistrationIdList();
            pushRegistrationId.registration_id.Add(registrationid);

            return JPushBaseSendMessage(title, noticeContent, isApnsProduction, pushRegistrationId, extrasParam);
        }

        /// <summary>
        /// 设备注册ID批量推送（一次推送最多1000个）
        /// </summary>
        /// <param name="title">推送标题（Android才会存在）</param>
        /// <param name="noticeContent">通知内容</param>
        /// <param name="registrationIds">注册ID(registration_id)列表,一次推送最多1000个</param>
        /// <param name="extrasParam">拓展参数(传入App接收的一些参数标识)</param>
        /// <param name="isApnsProduction">注意：iOS是否推送生产环境（true是，false否推开发环境）</param>
        /// <returns></returns>
        public bool SendPushByRegistrationIdList(string title, string noticeContent, List<string> registrationIds, Dictionary<string, object> extrasParam = null, bool isApnsProduction = true)
        {
            //设备标识参数拼接
            var pushRegistrationId = new RegistrationIdList();
            pushRegistrationId.registration_id.AddRange(registrationIds);

            return JPushBaseSendMessage(title, noticeContent, isApnsProduction, pushRegistrationId, extrasParam);
        }

        /// <summary>
        /// 广播推送
        /// </summary>
        /// <param name="title">推送标题（Android才会存在）</param>
        /// <param name="noticeContent">通知内容</param>
        /// <param name="extrasParam">拓展参数(传入App接收的一些参数标识)</param>
        /// <param name="isApnsProduction">注意：iOS是否推送生产环境（true是，false否推开发环境）</param>
        /// <returns></returns>
        public bool BroadcastPush(string title, string noticeContent, Dictionary<string, object> extrasParam = null, bool isApnsProduction = true)
        {
            return JPushBaseSendMessage(title, noticeContent, isApnsProduction, null, extrasParam, true);
        }

        /// <summary>
        /// 极光消息推送公共方法
        /// </summary>
        /// <param name="title">推送标题（Android才会存在）</param>
        /// <param name="noticeContent">通知内容</param>
        /// <param name="pushRegistrationId">设备注册ID(registration_id)</param>
        /// <param name="isApnsProduction">iOS是否推送生产环境（true是，false否推开发环境）</param>
        /// <param name="extrasParam">拓展参数</param>
        /// <param name="isRadioBroadcast">是否广播</param>
        /// <returns></returns>
        private bool JPushBaseSendMessage(string title, string noticeContent, bool isApnsProduction, RegistrationIdList pushRegistrationId, Dictionary<string, object> extrasParam, bool isRadioBroadcast = false)
        {
            try
            {
                object audience = pushRegistrationId;

                if (isRadioBroadcast)
                {
                    audience = "all";
                }

                var pushPayload = new PushPayload()
                {
                    Platform = new List<string> { "android", "ios" },//推送平台设置
                    Audience = audience,//推送目标
                    //notifacation：通知内容体。是被推送到客户端的内容。与 message 一起二者必须有其一，可以二者并存。
                    Notification = new Notification
                    {
                        Alert = noticeContent,//通知内容
                        Android = new Android
                        {
                            Alert = noticeContent,//通知内容
                            Title = title,//通知标题
                            URIActivity = "com.king.sysclearning.platform.app.JPushOpenClickActivity",//该字段用于指定开发者想要打开的 activity，值为 activity 节点的 “android:name”属性值;适配华为、小米、vivo厂商通道跳转
                            URIAction = "com.king.sysclearning.platform.app.JPushOpenClickActivity",//该字段用于指定开发者想要打开的 activity，值为 "activity"-"intent-filter"-"action" 节点的 "android:name" 属性值;适配 oppo、fcm跳转
                            Extras = extrasParam //这里自定义JSON格式的Key/Value信息，以供业务使用。
                        },
                        IOS = new IOS
                        {
                            Alert = noticeContent,
                            Badge = "+1",//此项是指定此推送的badge自动加1
                            Extras = extrasParam //这里自定义JSON格式的Key/Value信息，以供业务使用。
                        }
                    },
                    Options = new Options//可选参数
                    {
                        //iOS 环境不一致问题：API 推送消息给 iOS，需要设置 apns_production 指定推送的环境，false 为开发，true 为生产。
                        IsApnsProduction = isApnsProduction// 设置 iOS 推送生产环境。不设置默认为开发环境。
                    }
                };

                var response = client.SendPush(pushPayload);
                //200一定是正确。所有异常都不使用 200 返回码
                if (response.StatusCode == HttpStatusCode.OK)
                {
                    return true;
                }
                else
                {
                    return false;
                }
            }
            catch (Exception ex)
            {
                return false;
            }
        }
    }

    public class RegistrationIdList
    {
        /// <summary>
        /// 设备注册ID
        /// </summary>
        public List<string> registration_id { get; set; } = new List<string>();
    }
}