x***@sina.com
x***@sina.com
  • 发布:2019-11-30 21:13
  • 更新:2023-09-13 09:38
  • 阅读:21518

5+App使用UniPush发送消息,App在线、离线均能收到消息推送,并在通知栏进行提醒,苹果、华为、小米手机均测试通过

分类:HTML5+

【1】本文档中使用的全是逶传消息,没有使用个推的其他消息
【2】需要开通UniPush功能,并在华为、小米开发者中添加App,并开通Push权限,目前不需要上架各厂商应用市场就可以使用,后续不知道需要不需要
【3】本实例使用Java后台开发,其他语言请自行翻译
【5】关于receive事件,只有发送的是透传数据【而且】不是标准格式【而且】当前应用在活动,这3个条件同时满足,才可以响应receive事件!!!,但是消息中心并没有消息展示!!!需要创建本地消息!!!才能在消息中心提醒,对于IOS的,一定要控制死循环!!!【重要】【重要】【重要】
只有APP在线时,才会触发receive事件,透传消息不会触发系统消息,需要创建本地消息【重要】【重要】【重要】
【6】关于click事件,click一定是点击通知栏的消息,才能触发!!! 下面两句话很重要
【APP在线】,收到透传消息通过,不会提醒至通知栏目,需要发送本地消息,再进行点击触发的点击事件。
【APP离线】,收到离线透传消息,必须通过Java后台的Intent字符串携带payload,且符合格式才能触发click事件,格式不符合不会触发。
【7】厂商推送需要设置的Intent字符串格式,请将${packageName},${title},${content},${payload}替换为正确的内容
${packageName} 代表应用包名
${title} 通知的标题
${content} 通知的内容
${payload} 其他附加参数,请用 JSON.toJSONString(payload)进行转码。

intent:#Intent;launchFlags=0x04000000;action=android.intent.action.oppopush;package=${packageName};component=${packageName}/io.dcloud.PandoraEntry;S.UP-OL-SU=true;S.title=${title};S.content=${content};S.payload=${payload};end

【8】APP端的javaScript代码,不需要必须写在第一个页面,我的项目写在了里面的页面,只要App启动后能打开这个页面就可以:

        //收到透传消息  
        //只有APP在线时,才会触发receive事件,透传消息不会触发系统消息,需要创建本地消息  
        plus.push.addEventListener("receive", function(msg) {  
            console.log("(receive):" + JSON.stringify(msg));  
            if (app.isIOS()) { //如果是IOS  
                var payload = msg.payload;  
                //【APP离线】收到消息,但没有提醒(发生在一次收到多个离线消息时,只有一个有提醒,但其他的没有提醒)  
                //【APP在线】收到消息,不会触发系统消息,需要创建本地消息,但不能重复创建。必须加msg.type验证去除死循环                
                if (msg.aps == null && msg.type == "receive") {   
                    var messageTitle = payload.messageTitle;  
                    var messageContent = payload.messageContent;  
                    //创建本地消息,发送的本地消息也会被receive方法接收到,但没有type属性,且aps是null  
                    plus.push.createMessage(messageContent, JSON.stringify(payload), {title: messageTitle});  
                }  
            }  
            if (app.isAndroid()) { //如果是Android,当APP在线时,收到透传消息不会进入系统消息,需要发送本地提醒。  
                var payload = JSON.parse(msg.payload);  
                var messageTitle = payload.messageTitle;  
                var messageContent = payload.messageContent;  
                plus.push.createMessage(messageContent, msg.payload, {title: messageTitle});  
            }  
        }, false);  

        //消息点击事件  
        //【APP在线】,收到透传消息通过,不会提醒至通知栏目,需要发送本地消息,再进行点击触发的点击事件。  
        //【APP离线】,收到离线透传消息,必须通过Java后台的Intent字符串携带payload,且符合格式才能触发click事件,格式不符合不会触发。  
        plus.push.addEventListener("click", function(msg) {  
            console.log("(click):" + JSON.stringify(msg));  
            if (app.isIOS()) { //如果是IOS  
                var payload;  
                if (msg.type == "click") { //APP离线点击包含click属性,这时payload是JSON对象  
                    payload = msg.payload;  
                } else { //APP在线,收到消息不会包含type属性,这时的payload是JSON字符串,需要转为JSON对象  
                    payload = JSON.parse(msg.payload);  
                }  
                if (payload != null || payload != undefined) {  
                    var messageType = payload.messageType;  
                    messageClick(messageType, payload);  
                }  
            }  
            if (app.isAndroid()) { //如果是Android,收到playload均是是JSON字符串,需要转为JSON对象  
                var payload = JSON.parse(msg.payload);  
                if (payload != null || payload != undefined) {  
                    var messageType = payload.messageType;  
                    messageClick(messageType, payload);  
                }  
            }  
        }, false);

【9】java后台发送代码 ,代码中注释的内容,本人没有研究明白,未进行测试


    /**  
     * 推送消息至App所有用户,100次/天,每分钟不能超过5次,相同的消息内容,10分钟内不可以重复发送<br/>  
     * 华为,平果测试通过  
     *   
     * @param getuiMessage  
     * @return  
     */  
    public static IPushResult toApp(GetuiMessage getuiMessage) {  
        TransmissionTemplate template = PushTemplate.getTransmissionTemplateWith3rdNotifyInfoAndAPNPayload(getuiMessage.getMessageTitle(),  
                getuiMessage.getMessageContent(), "+1", getuiMessage);  
        AppMessage message = new AppMessage();  
        message.setData(template);  
        message.setOffline(true);  
        message.setOfflineExpireTime(24 * 1000 * 3600);  
        message.setAppIdList(Arrays.asList(GetuiConfig.me.getAppId()));  
        IPushResult ret = GetuiConfig.me.getPush().pushMessageToApp(message);  
        GetuiConfig.logger.info(GetuiConfig.logger.getName() + JSON.toJSONString(ret));  
        return ret;  
    }  

    /**  
     * 推送消息至特定的ClientID,频次限制:没有限制!  
     *   
     * @param getuiMessage 消息对象  
     * @param clientId     接收的ClientId  
     * @return  
     */  
    public static IPushResult toSingle(GetuiMessage getuiMessage, String clientId) {  
        // 获取消息模板  
        TransmissionTemplate template = PushTemplate.getTransmissionTemplateWith3rdNotifyInfoAndAPNPayload(getuiMessage.getMessageTitle(),  
                getuiMessage.getMessageContent(), "+1", getuiMessage);  
        // 制作消息  
        SingleMessage message = new SingleMessage();  
        message.setData(template);  
        message.setOffline(true);// 设置消息离线,并设置离线时间  
        message.setOfflineExpireTime(72 * 3600 * 1000); // 离线有效时间,单位为毫秒,可选  
//      message.setPriority(1);// 优先级  
//      message.setPushNetWorkType(0); // 判断客户端是否wifi环境下推送。1为仅在wifi环境下推送,0为不限制网络环境,默认不限  
        // 生成接收人  
        Target target = new Target();  
        target.setAppId(GetuiConfig.me.getAppId());  
        target.setClientId(clientId);  
        // 发送消息  
        IPushResult ret = GetuiConfig.me.getPush().pushMessageToSingle(message, target);  
        GetuiConfig.logger.info(GetuiConfig.logger.getName() + JSON.toJSONString(ret));  
        return ret;  
    }  

    /**  
     * 获取同时有Android第三方推送及IOS推送功能的很透传消息  
     *   
     * @param title       标题  
     * @param body        正文  
     * @param badge       IOS的角标数  
     * @param customParam 自定义属性  
     * @return  
     */  
    public static TransmissionTemplate getTransmissionTemplateWith3rdNotifyInfoAndAPNPayload(String title, String body, String badge,  
            Map<String, String> customParam) {  
        TransmissionTemplate template = new TransmissionTemplate();  

        // 设置APPID与APPKEY  
        template.setAppId(GetuiConfig.me.getAppId());  
        template.setAppkey(GetuiConfig.me.getAppKey());  

        // 透传消息设置,1为强制启动应用,客户端接收到消息后就会立即启动应用;2为等待应用启动  
        template.setTransmissionType(2);  
        template.setTransmissionContent(JSON.toJSONString(customParam)); // 透传内容  

        // 第三方厂商推送  
        template.set3rdNotifyInfo(get3rdNotifyInfo(title, body, customParam));  

        // 针对IOS,设置APNs  
        template.setAPNInfo(getAPNPayload(title, body, badge, customParam)); // ios消息推送  
        return template;  
    }  

    /**  
     * 第三方厂商通知  
     *   
     * @param title   标题  
     * @param content 正文  
     * @param payload 附带属性  
     * @return  
     */  
    private static Notify get3rdNotifyInfo(String title, String content, Map<String, String> payload) {  
        Notify notify = new Notify();  
        notify.setTitle(title);  
        notify.setContent(content);  
        notify.setType(Type._intent);  
        notify.setIntent(GetuiConfig.me.getIntent(title,content,payload));  
        notify.setPayload(JSON.toJSONString(payload));  
        return notify;  
    }  
    /**  
     * IOS的APNs消息  
     *   
     * @param title  
     * @param body  
     * @param badge  
     * @param customMsg  
     * @return  
     */  
    private static APNPayload getAPNPayload(String title, String body, String badge, Map<String, String> customMsg) {  
        APNPayload payload = new APNPayload();  
        // 在已有数字基础上加1显示,设置为-1时,在已有数字上减1显示,设置为数字时,显示指定数字  
        if (badge != null && badge.trim().length() > 0) {  
            payload.setAutoBadge(badge);  
        }  
        payload.setContentAvailable(1);  
        // ios 12.0 以上可以使用 Dictionary 类型的 sound  
        payload.setSound("default");  
//      payload.setCategory("$由客户端定义");  
        if (customMsg != null) {  
            for (Entry<String, String> enty : customMsg.entrySet()) {  
                payload.addCustomMsg(enty.getKey(), enty.getValue());  
            }  
        }  
//      payload.setAlertMsg(new APNPayload.SimpleAlertMsg("helloCCCC"));//简单模式APNPayload.SimpleMsg  
        payload.setAlertMsg(getDictionaryAlertMsg(title, body)); // 字典模式使用APNPayload.DictionaryAlertMsg  

//      // 设置语音播报类型,int类型,0.不可用 1.播放body 2.播放自定义文本  
//      payload.setVoicePlayType(2);  
//      // 设置语音播报内容,String类型,非必须参数,用户自定义播放内容,仅在voicePlayMessage=2时生效  
//      // 注:当"定义类型"=2, "定义内容"为空时则忽略不播放  
//      payload.setVoicePlayMessage("定义内容");  
//  
//      // 添加多媒体资源  
//      payload.addMultiMedia(new MultiMedia().setResType(MultiMedia.MediaType.pic).setResUrl("资源文件地址").setOnlyWifi(true));  

        return payload;  
    }  

    /**  
     * IOS通知提示样式  
     *   
     * @param title  
     * @param body  
     * @return  
     */  
    private static APNPayload.DictionaryAlertMsg getDictionaryAlertMsg(String title, String body) {  
        APNPayload.DictionaryAlertMsg alertMsg = new APNPayload.DictionaryAlertMsg();  
        alertMsg.setBody(body);  
//      alertMsg.setActionLocKey("显示关闭和查看两个按钮的消息");  
//      alertMsg.setLocKey("loc-key1");  
//      alertMsg.addLocArg("loc-ary1");  
//      alertMsg.setLaunchImage("调用已经在应用程序中绑定的图形文件名");  
        // iOS8.2以上版本支持  
        alertMsg.setTitle(title);  
//      alertMsg.setTitleLocKey("自定义通知标题");  
//      alertMsg.addTitleLocArg("自定义通知标题组");  
        return alertMsg;  
    }  

    /**  
     * 需要使用iOS语音传输,请使用VoIPPayload代替APNPayload【未测试】  
     *  
     *   
     * @return  
     */  
    private static VoIPPayload getVoIPPayload() {  
        //TODO 未测试,未开发完成  
        VoIPPayload payload = new VoIPPayload();  
        JSONObject jo = new JSONObject();  
        jo.put("key1", "value1");  
        payload.setVoIPPayload(jo.toString());  
        return payload;  
    }  

public class GetuiMessage extends HashMap<String, String> {  

    /**  
     *   
     */  
    private static final long serialVersionUID = -5993986890576211345L;  

    private final String messageTitle = "messageTitle";  
    private final String messageContent = "messageContent";  
    private final String messageType = "messageType";  

    /**  
     * 生成推送消息  
     *   
     * @param typeEnum    消息类型  
     * @param customParam 消息内容参数和消息点击需要的参加共享相同参数  
     */  
    public GetuiMessage(MessageType typeEnum, Map<String, String> customParam) {  
        if (customParam != null && customParam.size() > 0) {  
            this.putAll(customParam);  
        }  
        // 把优先级高的Key放在后面,即遍在customParam有重复的KEY,也不会影响。  
        this.put(messageTitle, typeEnum.getTitle());  
        this.put(messageType, typeEnum.getCode());  
        this.put(messageContent, typeEnum.getContent(customParam));  
    }  

参考(Push推送使用指南):https://ask.dcloud.net.cn/article/35622

17 关注 分享
w***@163.com BJ_Q 老哥教教我 这下真的舒服了 4***@qq.com 左右摇摆 1***@qq.com SimpleJalon 1***@qq.com 1***@qq.com 9***@qq.com Unlimited_S y***@163.com 2***@qq.com 4***@qq.com 2***@qq.com yyf

要回复文章请先登录注册

w***@hotmail.com

w***@hotmail.com

GetuiConfig不能贴出来吗
2020-09-27 11:12
aliang888

aliang888

回复 守护 :
我格式也跟你一样,在自定义基座下,苹果可以收到在线,离线消息;但安卓死活收不到离线消息,但是夜神模拟器app在离线状态下确可以收到消息,不懂为啥,折腾好几天了....会不会是当前应用新版本要发布上线才能测试离线的场景???
2020-08-20 15:18
钛鑫科技

钛鑫科技

文章很好,只是我们的对接通过上文代码不能实现效果。能把 receive 监听到的 msg 的数据格式展示出来吗?
2020-08-05 17:41
3***@qq.com

3***@qq.com

回复 xiaoliao998 :
请问搞定了么?这个问题我也很困惑
2020-07-30 17:22
3***@qq.com

3***@qq.com

private static Notify get3rdNotifyInfo(String title, String content, Map<String, String> payload) {
Notify notify = new Notify();
notify.setTitle(title);
notify.setContent(content);
notify.setType(Type._intent);
notify.setIntent(GetuiConfig.me.getIntent(title,content,payload));
notify.setPayload(JSON.toJSONString(payload));
return notify;
}
这传代码里面的Type._intent这个是什么
2020-07-30 16:29
y***@wellview.com.cn

y***@wellview.com.cn

回复 被梦想绊倒 :
大佬求指教啊,离线消息点击后,不会触发app.vue里面的click事件啊,无法跳转到指定的界面
2020-07-17 13:51
996上班族

996上班族

马克思
2020-07-16 17:56
风云杭州

风云杭州

if (msg.type == "click") { //APP离线点击包含click属性,这时payload是JSON对象
payload = msg.payload;
} else { //APP在线,收到消息不会包含type属性,这时的payload是JSON字符串,需要转为JSON对象
payload = JSON.parse(msg.payload);
}

貌似在线的时候收到的payload 也是自动被转换为对象了,也就是不需要JSON.parse 的处理了
2020-07-16 17:22
风云杭州

风云杭州

msg.type == "receive" 是自动就有的 还是需要服务器传递过来呀?
2020-07-16 16:31
1***@qq.com

1***@qq.com

请问我离线推送的intent格式没问题,还是无法触发click,有其他需要注意的吗
2020-07-09 17:42