1、pom.xml
cn.jpush.api jpush-client 3.3.4
2、到极光官网获取AppKey和Master Secret
3、配置相关的推送证书
4、JPushUtils
package com.ovu.config.jpush; 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.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 lombok.extern.slf4j.Slf4j; import java.util.List; /** * 极光推送工具包 */ @SuppressWarnings("ALL") @Slf4j public class JPushUtil { private final static Boolean ApnsProduction = false;//上线之后要改为true /** * 推送给设备标识参数的用户 * @param aliasList 别名或别名组 * @param msg_content 消息内容 * @param extrasparam 扩展字段 * @return 0推送失败,1推送成功 */ public static int sendToAliasList(JPushClient jPushClient,ListaliasList, String msg_content, String extraKey,String extrasparam,String notification_title ) { int result = 0; try { PushPayload pushPayload= buildPushObject_all_aliasList_alertWithTitle(aliasList,msg_content,extraKey,extrasparam,notification_title); log.info("推送给设备标识参数的用户"+pushPayload); PushResult pushResult=jPushClient.sendPush(pushPayload); log.info("推送结果"+pushResult); if(pushResult.getResponseCode()==200){ result=1; } } catch (APIConnectionException e) { e.printStackTrace(); } catch (APIRequestException e) { e.printStackTrace(); } return result; } /** * 发送给所有用户 * @param msg_content 消息内容 * @param extrasparam 扩展字段 * @return 0推送失败,1推送成功 */ public static int sendToAll(JPushClient jPushClient, String msg_content,String extraKey, String extrasparam,String notification_title) { int result = 0; try { PushPayload pushPayload= buildPushObject_android_and_ios(msg_content,extraKey,extrasparam,notification_title); log.info(""+pushPayload); PushResult pushResult=jPushClient.sendPush(pushPayload); log.info(""+pushResult); if(pushResult.getResponseCode()==200){ result=1; } } catch (Exception e) { e.printStackTrace(); } return result; } /** * 推送给Tag参数的用户 * @param tagsList Tag或Tag组 * @param msg_content 消息内容 * @param extrasparam 扩展字段 * @return 0推送失败,1推送成功 */ public static int sendToTagList(JPushClient jPushClient,List tagsList, String msg_content,String extra, String extrasparam,String notification_title) { int result = 0; try { PushPayload pushPayload= buildPushObject_all_tagList_alertWithTitle(tagsList,msg_content,extra,extrasparam,notification_title); log.info(""+pushPayload); PushResult pushResult=jPushClient.sendPush(pushPayload); log.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_content 消息内容 * @param extrasparam 扩展字段 * @return 0推送失败,1推送成功 */ public static int sendToAllAndroid(JPushClient jPushClient, String notification_title, String msg_content,String extraKey, String extrasparam) { int result = 0; try { PushPayload pushPayload= buildPushObject_android_all_alertWithTitle(notification_title,msg_content,extraKey,extrasparam); log.info(""+pushPayload); PushResult pushResult=jPushClient.sendPush(pushPayload); log.info(""+pushResult); if(pushResult.getResponseCode()==200){ result=1; } } catch (Exception e) { e.printStackTrace(); } return result; } /** * 发送给所有IOS用户 * @param msg_content 消息内容 * @param extrasparam 扩展字段 * @return 0推送失败,1推送成功 */ public static int sendToAllIos(JPushClient jPushClient, String msg_content,String extraKey, String extrasparam) { int result = 0; try { PushPayload pushPayload= buildPushObject_ios_all_alertWithTitle(msg_content,extraKey,extrasparam); log.info(""+pushPayload); PushResult pushResult=jPushClient.sendPush(pushPayload); log.info(""+pushResult); if(pushResult.getResponseCode()==200){ result=1; } } catch (Exception e) { e.printStackTrace(); } return result; } /** * 向所有平台单个或多个指定别名用户推送消息 * @param aliasList * @param msg_content * @param extrasparam * @return */ private static PushPayload buildPushObject_all_aliasList_alertWithTitle(List aliasList, String msg_content,String extraKey, String extrasparam,String notification_title) { log.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(msg_content) .setTitle(notification_title) //此字段为透传字段,不会显示在通知栏。用户可以通过此字段来做一些定制需求,如特定的key传要指定跳转的页面(value) .addExtra(extraKey,extrasparam) .build()) //指定当前推送的iOS通知 .addPlatformNotification(IosNotification.newBuilder() //传一个IosAlert对象,指定apns title、title、subtitle等 .setAlert(msg_content) //直接传alert //此项是指定此推送的badge自动加1 .incrBadge(1) //此字段的值default表示系统默认声音;传sound.caf表示此推送以项目里面打包的sound.caf声音来提醒, // 如果系统没有此音频则以系统默认声音提醒;此字段如果传空字符串,iOS9及以上的系统是无声音提醒,以下的系统是默认声音 .setSound("default") //此字段为透传字段,不会显示在通知栏。用户可以通过此字段来做一些定制需求,如特定的key传要指定跳转的页面(value) .addExtra(extraKey,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(); } /** * 向所有平台所有用户推送消息 * @param msg_content * @param extrasparam * @return */ public static PushPayload buildPushObject_android_and_ios(String msg_content,String extraKey, String extrasparam,String notification_title) { log.info("----------向所有平台所有用户推送消息中......"); return PushPayload.newBuilder() .setPlatform(Platform.android_ios()) .setAudience(Audience.all()) .setNotification(Notification.newBuilder() .setAlert(msg_content) .addPlatformNotification(AndroidNotification.newBuilder() .setTitle(notification_title) //此字段为透传字段,不会显示在通知栏。用户可以通过此字段来做一些定制需求,如特定的key传要指定跳转的页面(value) .addExtra(extraKey,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(extraKey,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(); } /** *向所有平台单个或多个指定Tag用户推送消息 * @param tagsList * @param msg_content * @param extrasparam * @return */ private static PushPayload buildPushObject_all_tagList_alertWithTitle(List tagsList, String msg_content,String extraKey, String extrasparam,String notification_title) { log.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(msg_content) .setTitle(notification_title) //此字段为透传字段,不会显示在通知栏。用户可以通过此字段来做一些定制需求,如特定的key传要指定跳转的页面(value) .addExtra(extraKey,extrasparam) .build()) //指定当前推送的iOS通知 .addPlatformNotification(IosNotification.newBuilder() //传一个IosAlert对象,指定apns title、title、subtitle等 .setAlert(msg_content) //直接传alert //此项是指定此推送的badge自动加1 .incrBadge(1) //此字段的值default表示系统默认声音;传sound.caf表示此推送以项目里面打包的sound.caf声音来提醒, // 如果系统没有此音频则以系统默认声音提醒;此字段如果传空字符串,iOS9及以上的系统是无声音提醒,以下的系统是默认声音 .setSound("default") //此字段为透传字段,不会显示在通知栏。用户可以通过此字段来做一些定制需求,如特定的key传要指定跳转的页面(value) .addExtra(extraKey,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_content * @param extrasparam * @return */ private static PushPayload buildPushObject_android_all_alertWithTitle(String notification_title, String msg_content,String extraKey, String extrasparam) { log.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(msg_content) .setTitle(notification_title) //此字段为透传字段,不会显示在通知栏。用户可以通过此字段来做一些定制需求,如特定的key传要指定跳转的页面(value) .addExtra(extraKey,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 msg_content * @param extrasparam * @return */ private static PushPayload buildPushObject_ios_all_alertWithTitle( String msg_content,String extraKey, String extrasparam) { log.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(msg_content) //直接传alert //此项是指定此推送的badge自动加1 .incrBadge(1) //此字段的值default表示系统默认声音;传sound.caf表示此推送以项目里面打包的sound.caf声音来提醒, // 如果系统没有此音频则以系统默认声音提醒;此字段如果传空字符串,iOS9及以上的系统是无声音提醒,以下的系统是默认声音 .setSound("default") //此字段为透传字段,不会显示在通知栏。用户可以通过此字段来做一些定制需求,如特定的key传要指定跳转的页面(value) .addExtra(extraKey,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(); } }
5、JPushMessage
package com.ovu.config.jpush; import cn.jiguang.common.ClientConfig; import cn.jpush.api.JPushClient; import org.springframework.stereotype.Component; import java.util.List; @Component public class JPushManage { public static final String pushPath = "xyaq"; //在极光注册上传应用的 appKey 和 masterSecret public static final String appKey = "APPKEY";//必填,例如466f7032ac604e02fb7bda89 public static final String masterSecret = "masterSecret";//必填,每个应用都对应一个masterSecret public Integer sendPush(ListaliasList){ JPushClient jpushClient = new JPushClient(masterSecret, appKey, null, ClientConfig.getInstance()); return JPushUtil.sendToAliasList(jpushClient,aliasList,"这是一个IOS推送测试","extra_key","extra_value","测试"); } }