极光phpsdk干货 SpringBoot集成极光推送JavaSDK建议珍藏

1.pom.xml

<!-- 极光推送 begin --><dependency> <groupId>cn.jpush.api</groupId> <artifactId>jpush-client</artifactId> <version>3.3.10</version></dependency><dependency> <groupId>cn.jpush.api</groupId> <artifactId>jiguang-common</artifactId> <version>1.1.4</version></dependency><!-- 极光推送 end -->2.application.yml

jpush: appKey: xxx masterSecret: xxxx apnsProduction: false # 是否天生环境，true表示天生环境3.MyJPushClient

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.beans.factory.annotation.Value;import org.springframework.stereotype.Component;import java.util.List;/ 极光推送客户端 @author Mengday Zhang @version 1.0 @since 2019-04-01 /@Componentpublic class MyJPushClient { @Value("${jpush.appKey}") private String appKey; @Value("${jpush.masterSecret}") private String masterSecret; @Value("${jpush.apnsProduction}") private boolean apnsProduction; private static JPushClient jPushClient = null; private static final int RESPONSE_OK = 200; private static final Logger logger = LoggerFactory.getLogger(MyJPushClient.class); public JPushClient getJPushClient() { if (jPushClient == null) { jPushClient = new JPushClient(masterSecret, appKey); } return jPushClient; } / 推送到alias列表 @param alias 别名或别名组 @param notificationTitle 关照内容标题 @param msgTitle 内容标题 @param msgContent 内容 @param extras 扩展字段 / public void sendToAliasList(List<String> alias, String notificationTitle, String msgTitle, String msgContent, String extras) { PushPayload pushPayload = buildPushObject_all_aliasList_alertWithTitle(alias, notificationTitle, msgTitle, msgContent, extras); this.sendPush(pushPayload); } / 推送到tag列表 @param tagsList Tag或Tag组 @param notificationTitle 关照内容标题 @param msgTitle 内容标题 @param msgContent 内容 @param extras 扩展字段 / public void sendToTagsList(List<String> tagsList, String notificationTitle, String msgTitle, String msgContent, String extras) { PushPayload pushPayload = buildPushObject_all_tagList_alertWithTitle(tagsList, notificationTitle, msgTitle, msgContent, extras); this.sendPush(pushPayload); } / 发送给所有安卓用户 @param notificationTitle 关照内容标题 @param msgTitle 内容标题 @param msgContent 内容 @param extras 扩展字段 / public void sendToAllAndroid(String notificationTitle, String msgTitle, String msgContent, String extras) { PushPayload pushPayload = buildPushObject_android_all_alertWithTitle(notificationTitle, msgTitle, msgContent, extras); this.sendPush(pushPayload); } / 发送给所有IOS用户 @param notificationTitle 关照内容标题 @param msgTitle 内容标题 @param msgContent 内容 @param extras 扩展字段 / public void sendToAllIOS(String notificationTitle, String msgTitle, String msgContent, String extras) { PushPayload pushPayload = buildPushObject_ios_all_alertWithTitle(notificationTitle, msgTitle, msgContent, extras); this.sendPush(pushPayload); } / 发送给所有用户 @param notificationTitle 关照内容标题 @param msgTitle 内容标题 @param msgContent 内容 @param extras 扩展字段 / public void sendToAll(String notificationTitle, String msgTitle, String msgContent, String extras) { PushPayload pushPayload = buildPushObject_android_and_ios(notificationTitle, msgTitle, msgContent, extras); this.sendPush(pushPayload); } private PushResult sendPush(PushPayload pushPayload) { logger.info("pushPayload={}", pushPayload); PushResult pushResult = null; try { pushResult = this.getJPushClient().sendPush(pushPayload); logger.info("" + pushResult); if (pushResult.getResponseCode() == RESPONSE_OK) { logger.info("push successful, pushPayload={}", pushPayload); } } catch (APIConnectionException e) { logger.error("push failed: pushPayload={}, exception={}", pushPayload, e); } catch (APIRequestException e) { logger.error("push failed: pushPayload={}, exception={}", pushPayload, e); } return pushResult; } / 向所有平台所有用户推送 @param notificationTitle @param msgTitle @param msgContent @param extras @return / public PushPayload buildPushObject_android_and_ios(String notificationTitle, String msgTitle, String msgContent, String extras) { return PushPayload.newBuilder() .setPlatform(Platform.android_ios()) .setAudience(Audience.all()) .setNotification(Notification.newBuilder() .setAlert(notificationTitle) .addPlatformNotification(AndroidNotification.newBuilder() .setAlert(notificationTitle) .setTitle(notificationTitle) // 此字段为透传字段，不会显示在关照栏。
用户可以通过此字段来做一些定制需求，如特定的key传要指定跳转的页面（value） .addExtra("androidNotification extras key", extras) .build() ) .addPlatformNotification(IosNotification.newBuilder() // 传一个IosAlert工具，指定apns title、title、subtitle等 .setAlert(notificationTitle) // 直接传alert // 此项是指定此推送的badge自动加1 .incrBadge(1) // 此字段的值default表示系统默认声音；传sound.caf表示此推送以项目里面打包的sound.caf声音来提醒， // 如果系统没有此音频则以系统默认声音提醒；此字段如果传空字符串，iOS9及以上的系统是无声音提醒，以下的系统是默认声音 .setSound("default") // 此字段为透传字段，不会显示在关照栏。
用户可以通过此字段来做一些定制需求，如特定的key传要指定跳转的页面（value） .addExtra("iosNotification extras key", extras) // 此项解释此推送是一个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(msgContent) .setTitle(msgTitle) .addExtra("message extras key", extras) .build()) .setOptions(Options.newBuilder() // 此字段的值是用来指定本推送要推送的apns环境，false表示开拓，true表示生产；对android和自定义无意义 .setApnsProduction(apnsProduction) // 此字段是给开拓者自己给推送编号，方便推送者分辨推送记录 .setSendno(1) // 此字段的值是用来指定本推送的离线保存时长，如果不传此字段则默认保存一天，最多指定保留十天，单位为秒 .setTimeToLive(86400) .build()) .build(); } / 向所有平台单个或多个指定别名用户推送 @param aliasList @param notificationTitle @param msgTitle @param msgContent @param extras @return / private PushPayload buildPushObject_all_aliasList_alertWithTitle(List<String> aliasList, String notificationTitle, String msgTitle, String msgContent, String extras) { // 创建一个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(notificationTitle) .setTitle(notificationTitle) // 此字段为透传字段，不会显示在关照栏。
用户可以通过此字段来做一些定制需求，如特定的key传要指定跳转的页面（value） .addExtra("androidNotification extras key", extras) .build()) // 指定当前推送的iOS关照 .addPlatformNotification(IosNotification.newBuilder() // 传一个IosAlert工具，指定apns title、title、subtitle等 .setAlert(notificationTitle) // 直接传alert // 此项是指定此推送的badge自动加1 .incrBadge(1) // 此字段的值default表示系统默认声音；传sound.caf表示此推送以项目里面打包的sound.caf声音来提醒， // 如果系统没有此音频则以系统默认声音提醒；此字段如果传空字符串，iOS9及以上的系统是无声音提醒，以下的系统是默认声音 .setSound("default") // 此字段为透传字段，不会显示在关照栏。
用户可以通过此字段来做一些定制需求，如特定的key传要指定跳转的页面（value） .addExtra("iosNotification extras key", extras) // 此项解释此推送是一个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(msgContent) .setTitle(msgTitle) .addExtra("message extras key", extras) .build()) .setOptions(Options.newBuilder() // 此字段的值是用来指定本推送要推送的apns环境，false表示开拓，true表示生产；对android和自定义无意义 .setApnsProduction(apnsProduction) // 此字段是给开拓者自己给推送编号，方便推送者分辨推送记录 .setSendno(1) // 此字段的值是用来指定本推送的离线保存时长，如果不传此字段则默认保存一天，最多指定保留十天； .setTimeToLive(86400) .build()) .build(); } / 向所有平台单个或多个指定Tag用户推送 @param tagsList @param notificationTitle @param msgTitle @param msgContent @param extras @return / private PushPayload buildPushObject_all_tagList_alertWithTitle(List<String> tagsList, String notificationTitle, String msgTitle, String msgContent, String extras) { //创建一个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(notificationTitle) .setTitle(notificationTitle) //此字段为透传字段，不会显示在关照栏。
用户可以通过此字段来做一些定制需求，如特定的key传要指定跳转的页面（value） .addExtra("androidNotification extras key", extras) .build()) // 指定当前推送的iOS关照 .addPlatformNotification(IosNotification.newBuilder() // 传一个IosAlert工具，指定apns title、title、subtitle等 .setAlert(notificationTitle) // 直接传alert // 此项是指定此推送的badge自动加1 .incrBadge(1) // 此字段的值default表示系统默认声音；传sound.caf表示此推送以项目里面打包的sound.caf声音来提醒， // 如果系统没有此音频则以系统默认声音提醒；此字段如果传空字符串，iOS9及以上的系统是无声音提醒，以下的系统是默认声音 .setSound("default") // 此字段为透传字段，不会显示在关照栏。
用户可以通过此字段来做一些定制需求，如特定的key传要指定跳转的页面（value） .addExtra("iosNotification extras key", extras) // 此项解释此推送是一个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(msgContent) .setTitle(msgTitle) .addExtra("message extras key", extras) .build()) .setOptions(Options.newBuilder() // 此字段的值是用来指定本推送要推送的apns环境，false表示开拓，true表示生产；对android和自定义无意义 .setApnsProduction(apnsProduction) // 此字段是给开拓者自己给推送编号，方便推送者分辨推送记录 .setSendno(1) // 此字段的值是用来指定本推送的离线保存时长，如果不传此字段则默认保存一天，最多指定保留十天； .setTimeToLive(86400) .build()) .build(); } / 向android平台所有用户推送 @param notificationTitle @param msgTitle @param msgContent @param extras @return / private PushPayload buildPushObject_android_all_alertWithTitle(String notificationTitle, String msgTitle, String msgContent, String extras) { 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(notificationTitle) .setTitle(notificationTitle) // 此字段为透传字段，不会显示在关照栏。
用户可以通过此字段来做一些定制需求，如特定的key传要指定跳转的页面（value） .addExtra("androidNotification extras key", extras) .build()) .build() ) // Platform指定了哪些平台就会像指定平台中符合推送条件的设备进行推送。
jpush的自定义， // sdk默认不做任何处理，不会有关照提示。
建议看文档http://docs.jpush.io/guideline/faq/的 // [关照与自定义有什么差异？]理解关照和自定义的差异 .setMessage(Message.newBuilder() .setMsgContent(msgContent) .setTitle(msgTitle) .addExtra("message extras key", extras) .build()) .setOptions(Options.newBuilder() // 此字段的值是用来指定本推送要推送的apns环境，false表示开拓，true表示生产；对android和自定义无意义 .setApnsProduction(apnsProduction) // 此字段是给开拓者自己给推送编号，方便推送者分辨推送记录 .setSendno(1) // 此字段的值是用来指定本推送的离线保存时长，如果不传此字段则默认保存一天，最多指定保留十天，单位为秒 .setTimeToLive(86400) .build()) .build(); } / 向ios平台所有用户推送 @param notificationTitle @param msgTitle @param msgContent @param extras @return / private PushPayload buildPushObject_ios_all_alertWithTitle(String notificationTitle, String msgTitle, String msgContent, String extras) { 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(notificationTitle) // 直接传alert // 此项是指定此推送的badge自动加1 .incrBadge(1) // 此字段的值default表示系统默认声音；传sound.caf表示此推送以项目里面打包的sound.caf声音来提醒， // 如果系统没有此音频则以系统默认声音提醒；此字段如果传空字符串，iOS9及以上的系统是无声音提醒，以下的系统是默认声音 .setSound("default") // 此字段为透传字段，不会显示在关照栏。
用户可以通过此字段来做一些定制需求，如特定的key传要指定跳转的页面（value） .addExtra("iosNotification extras key", extras) // 此项解释此推送是一个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(msgContent) .setTitle(msgTitle) .addExtra("message extras key", extras) .build()) .setOptions(Options.newBuilder() // 此字段的值是用来指定本推送要推送的apns环境，false表示开拓，true表示生产；对android和自定义无意义 .setApnsProduction(apnsProduction) // 此字段是给开拓者自己给推送编号，方便推送者分辨推送记录 .setSendno(1) // 此字段的值是用来指定本推送的离线保存时长，如果不传此字段则默认保存一天，最多指定保留十天，单位为秒 .setTimeToLive(86400) .build()) .build(); } public static void main(String[] args) {// MyJPushClient jPushUtil = new MyJPushClient();// List<String> aliasList = Arrays.asList("239");// String notificationTitle = "notificationTitle";// String msgTitle = "msgTitle";// String msgContent = "msgContent";// jPushUtil.sendToAliasList(aliasList, notificationTitle, msgTitle, msgContent, "exts"); }}4.test

@RunWith(SpringRunner.class)@SpringBootTestpublic class JPushApplicationTests { @Autowired private MyJPushClient jPushClient; @Test public void testJPush() { List<String> aliasList = Arrays.asList("239"); String notificationTitle = "notification_title"; String msgTitle = "msg_title"; String msgContent = "msg_content"; jPushClient.sendToAliasList(aliasList, notificationTitle, msgTitle, msgContent, "exts"); }}