zoukankan      html  css  js  c++  java
  • Java服务端极光推送整合Ios、Android

    https://blog.csdn.net/Jay_1989/article/details/82771886

    原创

    Java服务端极光推送整合Ios、Android

    版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。 
    本文链接:https://blog.csdn.net/Jay_1989/article/details/82771886

    推送是APP做推广的常用手段,比如节假日有啥活动,APP经常会弹出一个消息,上面写着xxx活动,请大家关注之类的,如下图:

    这次我们的APP采用极光推送,一开始比较懵逼,然后详细看了一下官方文档,做完之后,收获颇深。服务端推送之后,客户端不管Ios还是Android都是秒收到消息。

    讲代码之前需要先明确两个概念:消息和通知

    通知:发送后会在系统通知栏收到展现,同时响铃或振动提醒用户。 
    消息:以透传的形式传递给客户端,无显示,发送后不会在系统通知栏展现,第三方应用后需要开发者写代码才能看到。

    maven的pom.xml文件需要如下两个依赖

     

    <!-- 极光推送 -->

            <dependency>

                <groupId>cn.jpush.api</groupId>

                <artifactId>jpush-client</artifactId>

                <version>3.3.0</version>

            </dependency>

            <dependency>

                <groupId>cn.jpush.api</groupId>

                <artifactId>jiguang-common</artifactId>

                <version>1.0.8</version>

            </dependency>

    工具类JiPushUtil代码如下

    package com.hisap.xql.api.common.utils;

    import cn.jiguang.common.resp.APIConnectionException;

    import cn.jiguang.common.resp.APIRequestException;

    import cn.jpush.api.JPushClient;

    import cn.jpush.api.push.PushResult;

    import cn.jpush.api.push.model.Message;

    import cn.jpush.api.push.model.Options;

    import cn.jpush.api.push.model.Platform;

    import cn.jpush.api.push.model.PushPayload;

    import cn.jpush.api.push.model.audience.Audience;

    import cn.jpush.api.push.model.notification.AndroidNotification;

    import cn.jpush.api.push.model.notification.IosNotification;

    import cn.jpush.api.push.model.notification.Notification;

    import org.slf4j.Logger;

    import org.slf4j.LoggerFactory;

    import org.springframework.stereotype.Component;

    import java.util.List;

    /**

     * @Author: QijieLiu

     * @Description: 极光推送

     * @Date: Created in 16:35 2018/8/14

     */

    @Component

    public class JiPushUtil {

        private static final Logger LOGGER = LoggerFactory.getLogger(JiPushUtil.class);

        private final static String appKey = "*********************";

        private final static String masterSecret = "********************";

        private final static Boolean ApnsProduction = false;//上线之后要改为true

        private static JPushClient jPushClient = new JPushClient(masterSecret,appKey);

        /**

         * 推送给设备标识参数的用户

         * @param aliasList 别名或别名组

         * @param notification_title 通知内容标题

         * @param msg_title 消息内容标题

         * @param msg_content 消息内容

         * @param extrasparam 扩展字段

         * @return 0推送失败,1推送成功

         */

        public int sendToAliasList(List<String> aliasList, String notification_title, String msg_title, String msg_content, String extrasparam) {

            int result = 0;

            try {

                PushPayload pushPayload= buildPushObject_all_aliasList_alertWithTitle(aliasList,notification_title,msg_title,msg_content,extrasparam);

                LOGGER.info("推送给设备标识参数的用户"+pushPayload);

                PushResult pushResult=jPushClient.sendPush(pushPayload);

                LOGGER.info("推送结果"+pushResult);

                if(pushResult.getResponseCode()==200){

                    result=1;

                }

            } catch (APIConnectionException e) {

                e.printStackTrace();

            } catch (APIRequestException e) {

                e.printStackTrace();

            }

            return result;

        }

        /**

         * 推送给Tag参数的用户

         * @param tagsList Tag或Tag组

         * @param notification_title 通知内容标题

         * @param msg_title 消息内容标题

         * @param msg_content 消息内容

         * @param extrasparam 扩展字段

         * @return 0推送失败,1推送成功

         */

        public int sendToTagList(List<String> tagsList,String notification_title, String msg_title, String msg_content, String extrasparam) {

            int result = 0;

            try {

                PushPayload pushPayload= buildPushObject_all_tagList_alertWithTitle(tagsList,notification_title,msg_title,msg_content,extrasparam);

                LOGGER.info(""+pushPayload);

                PushResult pushResult=jPushClient.sendPush(pushPayload);

                LOGGER.info(""+pushResult);

                if(pushResult.getResponseCode()==200){

                    result=1;

                }

            } catch (APIConnectionException e) {

                e.printStackTrace();

            } catch (APIRequestException e) {

                e.printStackTrace();

            }

            return result;

        }

        /**

         * 发送给所有安卓用户

         * @param notification_title 通知内容标题

         * @param msg_title 消息内容标题

         * @param msg_content 消息内容

         * @param extrasparam 扩展字段

         * @return 0推送失败,1推送成功

         */

        public int sendToAllAndroid( String notification_title, String msg_title, String msg_content, String extrasparam) {

            int result = 0;

            try {

                PushPayload pushPayload= buildPushObject_android_all_alertWithTitle(notification_title,msg_title,msg_content,extrasparam);

                LOGGER.info(""+pushPayload);

                PushResult pushResult=jPushClient.sendPush(pushPayload);

                LOGGER.info(""+pushResult);

                if(pushResult.getResponseCode()==200){

                    result=1;

                }

            } catch (Exception e) {

                e.printStackTrace();

            }

            return result;

        }

        /**

         * 发送给所有IOS用户

         * @param notification_title 通知内容标题

         * @param msg_title 消息内容标题

         * @param msg_content 消息内容

         * @param extrasparam 扩展字段

         * @return 0推送失败,1推送成功

         */

        public int sendToAllIos(String notification_title, String msg_title, String msg_content, String extrasparam) {

            int result = 0;

            try {

                PushPayload pushPayload= buildPushObject_ios_all_alertWithTitle(notification_title,msg_title,msg_content,extrasparam);

                LOGGER.info(""+pushPayload);

                PushResult pushResult=jPushClient.sendPush(pushPayload);

                LOGGER.info(""+pushResult);

                if(pushResult.getResponseCode()==200){

                    result=1;

                }

            } catch (Exception e) {

                e.printStackTrace();

            }

            return result;

        }

        /**

         * 发送给所有用户

         * @param notification_title 通知内容标题

         * @param msg_title 消息内容标题

         * @param msg_content 消息内容

         * @param extrasparam 扩展字段

         * @return 0推送失败,1推送成功

         */

        public int sendToAll( String notification_title, String msg_title, String msg_content, String extrasparam) {

            int result = 0;

            try {

                PushPayload pushPayload= buildPushObject_android_and_ios(notification_title,msg_title,msg_content,extrasparam);

                LOGGER.info(""+pushPayload);

                PushResult pushResult=jPushClient.sendPush(pushPayload);

                LOGGER.info(""+pushResult);

                if(pushResult.getResponseCode()==200){

                    result=1;

                }

            } catch (Exception e) {

                e.printStackTrace();

            }

            return result;

        }

        /**

         * 向所有平台所有用户推送消息

         * @param notification_title

         * @param msg_title

         * @param msg_content

         * @param extrasparam

         * @return

         */

        public static PushPayload buildPushObject_android_and_ios(String notification_title, String msg_title, String msg_content, String extrasparam) {

            LOGGER.info("----------向所有平台所有用户推送消息中......");

            return PushPayload.newBuilder()

                    .setPlatform(Platform.android_ios())

                    .setAudience(Audience.all())

                    .setNotification(Notification.newBuilder()

                            .setAlert(notification_title)

                            .addPlatformNotification(AndroidNotification.newBuilder()

                                    .setAlert(notification_title)

                                    .setTitle(notification_title)

                                    //此字段为透传字段,不会显示在通知栏。用户可以通过此字段来做一些定制需求,如特定的key传要指定跳转的页面(value)

                                    .addExtra("androidNotification extras key",extrasparam)

                                    .build()

                            )

                            .addPlatformNotification(IosNotification.newBuilder()

                                    //传一个IosAlert对象,指定apns title、title、subtitle等

                                    .setAlert(notification_title)

                                    //直接传alert

                                    //此项是指定此推送的badge自动加1

                                    .incrBadge(1)

                                    //此字段的值default表示系统默认声音;传sound.caf表示此推送以项目里面打包的sound.caf声音来提醒,

                                    // 如果系统没有此音频则以系统默认声音提醒;此字段如果传空字符串,iOS9及以上的系统是无声音提醒,以下的系统是默认声音

                                    .setSound("default")

                                    //此字段为透传字段,不会显示在通知栏。用户可以通过此字段来做一些定制需求,如特定的key传要指定跳转的页面(value)

                                    .addExtra("iosNotification extras key",extrasparam)

                                    //此项说明此推送是一个background推送,想了解background看:http://docs.jpush.io/client/ios_tutorials/#ios-7-background-remote-notification

                                    // .setContentAvailable(true)

                                    .build()

                            )

                            .build()

                    )

                    //Platform指定了哪些平台就会像指定平台中符合推送条件的设备进行推送。 jpush的自定义消息,

                    // sdk默认不做任何处理,不会有通知提示。建议看文档http://docs.jpush.io/guideline/faq/的

                    // [通知与自定义消息有什么区别?]了解通知和自定义消息的区别

                    .setMessage(Message.newBuilder()

                            .setMsgContent(msg_content)

                            .setTitle(msg_title)

                            .addExtra("message extras key",extrasparam)

                            .build())

                    .setOptions(Options.newBuilder()

                            //此字段的值是用来指定本推送要推送的apns环境,false表示开发,true表示生产;对android和自定义消息无意义

                            .setApnsProduction(ApnsProduction)

                            //此字段是给开发者自己给推送编号,方便推送者分辨推送记录

                            .setSendno(1)

                            //此字段的值是用来指定本推送的离线保存时长,如果不传此字段则默认保存一天,最多指定保留十天,单位为秒

                            .setTimeToLive(86400)

                            .build()

                    )

                    .build();

        }

        /**

         * 向所有平台单个或多个指定别名用户推送消息

         * @param aliasList

         * @param notification_title

         * @param msg_title

         * @param msg_content

         * @param extrasparam

         * @return

         */

        private static PushPayload buildPushObject_all_aliasList_alertWithTitle(List<String> aliasList,String notification_title, String msg_title, String msg_content, String extrasparam) {

            LOGGER.info("----------向所有平台单个或多个指定别名用户推送消息中......");

            //创建一个IosAlert对象,可指定APNs的alert、title等字段

            //IosAlert iosAlert =  IosAlert.newBuilder().setTitleAndBody("title", "alert body").build();

            return PushPayload.newBuilder()

                    //指定要推送的平台,all代表当前应用配置了的所有平台,也可以传android等具体平台

                    .setPlatform(Platform.all())

                    //指定推送的接收对象,all代表所有人,也可以指定已经设置成功的tag或alias或该应应用客户端调用接口获取到的registration id

                    .setAudience(Audience.alias(aliasList))

                    //jpush的通知,android的由jpush直接下发,iOS的由apns服务器下发,Winphone的由mpns下发

                    .setNotification(Notification.newBuilder()

                            //指定当前推送的android通知

                            .addPlatformNotification(AndroidNotification.newBuilder()

                                    .setAlert(notification_title)

                                    .setTitle(notification_title)

                                    //此字段为透传字段,不会显示在通知栏。用户可以通过此字段来做一些定制需求,如特定的key传要指定跳转的页面(value)

                                    .addExtra("androidNotification extras key",extrasparam)

                                    .build())

                            //指定当前推送的iOS通知

                            .addPlatformNotification(IosNotification.newBuilder()

                                    //传一个IosAlert对象,指定apns title、title、subtitle等

                                    .setAlert(notification_title)

                                    //直接传alert

                                    //此项是指定此推送的badge自动加1

                                    .incrBadge(1)

                                    //此字段的值default表示系统默认声音;传sound.caf表示此推送以项目里面打包的sound.caf声音来提醒,

                                    // 如果系统没有此音频则以系统默认声音提醒;此字段如果传空字符串,iOS9及以上的系统是无声音提醒,以下的系统是默认声音

                                    .setSound("default")

                                    //此字段为透传字段,不会显示在通知栏。用户可以通过此字段来做一些定制需求,如特定的key传要指定跳转的页面(value)

                                    .addExtra("iosNotification extras key",extrasparam)

                                    //此项说明此推送是一个background推送,想了解background看:http://docs.jpush.io/client/ios_tutorials/#ios-7-background-remote-notification

                                    //取消此注释,消息推送时ios将无法在锁屏情况接收

                                    // .setContentAvailable(true)

                                    .build())

                            .build())

                    //Platform指定了哪些平台就会像指定平台中符合推送条件的设备进行推送。 jpush的自定义消息,

                    // sdk默认不做任何处理,不会有通知提示。建议看文档http://docs.jpush.io/guideline/faq/的

                    // [通知与自定义消息有什么区别?]了解通知和自定义消息的区别

                    .setMessage(Message.newBuilder()

                            .setMsgContent(msg_content)

                            .setTitle(msg_title)

                            .addExtra("message extras key",extrasparam)

                            .build())

                    .setOptions(Options.newBuilder()

                            //此字段的值是用来指定本推送要推送的apns环境,false表示开发,true表示生产;对android和自定义消息无意义

                            .setApnsProduction(ApnsProduction)

                            //此字段是给开发者自己给推送编号,方便推送者分辨推送记录

                            .setSendno(1)

                            //此字段的值是用来指定本推送的离线保存时长,如果不传此字段则默认保存一天,最多指定保留十天;

                            .setTimeToLive(86400)

                            .build())

                    .build();

        }

        /**

         *向所有平台单个或多个指定Tag用户推送消息

         * @param tagsList

         * @param notification_title

         * @param msg_title

         * @param msg_content

         * @param extrasparam

         * @return

         */

        private static PushPayload buildPushObject_all_tagList_alertWithTitle(List<String> tagsList,String notification_title, String msg_title, String msg_content, String extrasparam) {

            LOGGER.info("----------向所有平台单个或多个指定Tag用户推送消息中.......");

            //创建一个IosAlert对象,可指定APNs的alert、title等字段

            //IosAlert iosAlert =  IosAlert.newBuilder().setTitleAndBody("title", "alert body").build();

            return PushPayload.newBuilder()

                    //指定要推送的平台,all代表当前应用配置了的所有平台,也可以传android等具体平台

                    .setPlatform(Platform.all())

                    //指定推送的接收对象,all代表所有人,也可以指定已经设置成功的tag或alias或该应应用客户端调用接口获取到的registration id

                    .setAudience(Audience.tag(tagsList))

                    //jpush的通知,android的由jpush直接下发,iOS的由apns服务器下发,Winphone的由mpns下发

                    .setNotification(Notification.newBuilder()

                            //指定当前推送的android通知

                            .addPlatformNotification(AndroidNotification.newBuilder()

                                    .setAlert(notification_title)

                                    .setTitle(notification_title)

                                    //此字段为透传字段,不会显示在通知栏。用户可以通过此字段来做一些定制需求,如特定的key传要指定跳转的页面(value)

                                    .addExtra("androidNotification extras key",extrasparam)

                                    .build())

                            //指定当前推送的iOS通知

                            .addPlatformNotification(IosNotification.newBuilder()

                                    //传一个IosAlert对象,指定apns title、title、subtitle等

                                    .setAlert(notification_title)

                                    //直接传alert

                                    //此项是指定此推送的badge自动加1

                                    .incrBadge(1)

                                    //此字段的值default表示系统默认声音;传sound.caf表示此推送以项目里面打包的sound.caf声音来提醒,

                                    // 如果系统没有此音频则以系统默认声音提醒;此字段如果传空字符串,iOS9及以上的系统是无声音提醒,以下的系统是默认声音

                                    .setSound("default")

                                    //此字段为透传字段,不会显示在通知栏。用户可以通过此字段来做一些定制需求,如特定的key传要指定跳转的页面(value)

                                    .addExtra("iosNotification extras key",extrasparam)

                                    //此项说明此推送是一个background推送,想了解background看:http://docs.jpush.io/client/ios_tutorials/#ios-7-background-remote-notification

                                    //取消此注释,消息推送时ios将无法在锁屏情况接收

                                    // .setContentAvailable(true)

                                    .build())

                            .build())

                    //Platform指定了哪些平台就会像指定平台中符合推送条件的设备进行推送。 jpush的自定义消息,

                    // sdk默认不做任何处理,不会有通知提示。建议看文档http://docs.jpush.io/guideline/faq/的

                    // [通知与自定义消息有什么区别?]了解通知和自定义消息的区别

                    .setMessage(Message.newBuilder()

                            .setMsgContent(msg_content)

                            .setTitle(msg_title)

                            .addExtra("message extras key",extrasparam)

                            .build())

                    .setOptions(Options.newBuilder()

                            //此字段的值是用来指定本推送要推送的apns环境,false表示开发,true表示生产;对android和自定义消息无意义

                            .setApnsProduction(ApnsProduction)

                            //此字段是给开发者自己给推送编号,方便推送者分辨推送记录

                            .setSendno(1)

                            //此字段的值是用来指定本推送的离线保存时长,如果不传此字段则默认保存一天,最多指定保留十天;

                            .setTimeToLive(86400)

                            .build())

                    .build();

        }

        /**

         * 向android平台所有用户推送消息

         * @param notification_title

         * @param msg_title

         * @param msg_content

         * @param extrasparam

         * @return

         */

        private static PushPayload buildPushObject_android_all_alertWithTitle(String notification_title, String msg_title, String msg_content, String extrasparam) {

            LOGGER.info("----------向android平台所有用户推送消息中......");

            return PushPayload.newBuilder()

                    //指定要推送的平台,all代表当前应用配置了的所有平台,也可以传android等具体平台

                    .setPlatform(Platform.android())

                    //指定推送的接收对象,all代表所有人,也可以指定已经设置成功的tag或alias或该应应用客户端调用接口获取到的registration id

                    .setAudience(Audience.all())

                    //jpush的通知,android的由jpush直接下发,iOS的由apns服务器下发,Winphone的由mpns下发

                    .setNotification(Notification.newBuilder()

                            //指定当前推送的android通知

                            .addPlatformNotification(AndroidNotification.newBuilder()

                                    .setAlert(notification_title)

                                    .setTitle(notification_title)

                                    //此字段为透传字段,不会显示在通知栏。用户可以通过此字段来做一些定制需求,如特定的key传要指定跳转的页面(value)

                                    .addExtra("androidNotification extras key",extrasparam)

                                    .build())

                            .build()

                    )

                    //Platform指定了哪些平台就会像指定平台中符合推送条件的设备进行推送。 jpush的自定义消息,

                    // sdk默认不做任何处理,不会有通知提示。建议看文档http://docs.jpush.io/guideline/faq/的

                    // [通知与自定义消息有什么区别?]了解通知和自定义消息的区别

                    .setMessage(Message.newBuilder()

                            .setMsgContent(msg_content)

                            .setTitle(msg_title)

                            .addExtra("message extras key",extrasparam)

                            .build())

                    .setOptions(Options.newBuilder()

                            //此字段的值是用来指定本推送要推送的apns环境,false表示开发,true表示生产;对android和自定义消息无意义

                            .setApnsProduction(ApnsProduction)

                            //此字段是给开发者自己给推送编号,方便推送者分辨推送记录

                            .setSendno(1)

                            //此字段的值是用来指定本推送的离线保存时长,如果不传此字段则默认保存一天,最多指定保留十天,单位为秒

                            .setTimeToLive(86400)

                            .build())

                    .build();

        }

        /**

         * 向ios平台所有用户推送消息

         * @param notification_title

         * @param msg_title

         * @param msg_content

         * @param extrasparam

         * @return

         */

        private static PushPayload buildPushObject_ios_all_alertWithTitle( String notification_title, String msg_title, String msg_content, String extrasparam) {

            LOGGER.info("----------向ios平台所有用户推送消息中.......");

            return PushPayload.newBuilder()

                    //指定要推送的平台,all代表当前应用配置了的所有平台,也可以传android等具体平台

                    .setPlatform(Platform.ios())

                    //指定推送的接收对象,all代表所有人,也可以指定已经设置成功的tag或alias或该应应用客户端调用接口获取到的registration id

                    .setAudience(Audience.all())

                    //jpush的通知,android的由jpush直接下发,iOS的由apns服务器下发,Winphone的由mpns下发

                    .setNotification(Notification.newBuilder()

                            //指定当前推送的android通知

                            .addPlatformNotification(IosNotification.newBuilder()

                                    //传一个IosAlert对象,指定apns title、title、subtitle等

                                    .setAlert(notification_title)

                                    //直接传alert

                                    //此项是指定此推送的badge自动加1

                                    .incrBadge(1)

                                    //此字段的值default表示系统默认声音;传sound.caf表示此推送以项目里面打包的sound.caf声音来提醒,

                                    // 如果系统没有此音频则以系统默认声音提醒;此字段如果传空字符串,iOS9及以上的系统是无声音提醒,以下的系统是默认声音

                                    .setSound("default")

                                    //此字段为透传字段,不会显示在通知栏。用户可以通过此字段来做一些定制需求,如特定的key传要指定跳转的页面(value)

                                    .addExtra("iosNotification extras key",extrasparam)

                                    //此项说明此推送是一个background推送,想了解background看:http://docs.jpush.io/client/ios_tutorials/#ios-7-background-remote-notification

                                    // .setContentAvailable(true)

                                    .build())

                            .build()

                    )

                    //Platform指定了哪些平台就会像指定平台中符合推送条件的设备进行推送。 jpush的自定义消息,

                    // sdk默认不做任何处理,不会有通知提示。建议看文档http://docs.jpush.io/guideline/faq/的

                    // [通知与自定义消息有什么区别?]了解通知和自定义消息的区别

                    .setMessage(Message.newBuilder()

                            .setMsgContent(msg_content)

                            .setTitle(msg_title)

                            .addExtra("message extras key",extrasparam)

                            .build())

                    .setOptions(Options.newBuilder()

                            //此字段的值是用来指定本推送要推送的apns环境,false表示开发,true表示生产;对android和自定义消息无意义

                            .setApnsProduction(ApnsProduction)

                            //此字段是给开发者自己给推送编号,方便推送者分辨推送记录

                            .setSendno(1)

                            //此字段的值是用来指定本推送的离线保存时长,如果不传此字段则默认保存一天,最多指定保留十天,单位为秒

                            .setTimeToLive(86400)

                            .build())

                    .build();

        }

    ————————————————

    版权声明:本文为CSDN博主「Jay_1989」的原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接及本声明。

    原文链接:https://blog.csdn.net/Jay_1989/article/details/82771886

    推送之后,我们本地系统保存历史记录

    极光后台登录进去,查看推送历史也能看到

    文章最后发布于: 2018-09-19
  • 相关阅读:
    外观模式
    建造者模式
    原型模式
    工厂模式
    单例模式
    设计模式入门
    SpringBoot-SpringMVC开发总结
    SpringBoot日志
    IDEA Basics
    Kafka基础学习
  • 原文地址:https://www.cnblogs.com/sundaysjava/p/11958322.html
Copyright © 2011-2022 走看看