1、添加依賴
如果使用 Maven 構建項目,則需要在你的項目 pom.xml 裏增加:
<dependency> <groupId>cn.jpush.api</groupId> <artifactId>jiguang-common</artifactId> <version>1.1.11</version> </dependency> <dependency> <groupId>io.netty</groupId> <artifactId>netty-all</artifactId> <version>4.1.6.Final</version> <scope>compile</scope> </dependency> <dependency> <groupId>com.google.code.gson</groupId> <artifactId>gson</artifactId> <version>2.3</version> </dependency> <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-api</artifactId> <version>1.7.7</version> </dependency> <!-- For log4j --> <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-log4j12</artifactId> <version>1.7.7</version> </dependency> <dependency> <groupId>log4j</groupId> <artifactId>log4j</artifactId> <version>1.2.17</version> </dependency>
2、封裝工具類
package com.AttackingApe.deom.webScoket.springboot.util; import java.util.Collection; import java.util.List; import java.util.ArrayList; import org.slf4j.Logger; import org.slf4j.LoggerFactory; 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 cn.jpush.api.schedule.ScheduleResult; /** * 極光推送工具類 */ public class JPushUtil { private static Logger logger = LoggerFactory.getLogger(JPushUtil.class); /** * 設置好賬號的app_key和masterSecret是必須的 */ private final static String APPKER = "a8ddf5f47*********05b3b"; private final static String MASTERSECRET = "172e28*******299f3659c"; /** * ApnsProduction * 此字段的值是用來指定本推送要推送的apns環境,false表示開發,true表示生產;對android和自定義消息無意義 * 上線之後要改爲 true */ private final static Boolean ApnsProduction = false; private static JPushClient jPushClient = new JPushClient(MASTERSECRET,APPKER); private JPushUtil() { throw new AssertionError("不能產生該對象"); } /** * 推送給設備標識(別名)參數的用戶 * @param alias 設備標識(別名) * @param notification_title 通知內容標題 * @param msg_title 消息內容標題 * @param msg_content 消息內容 * @param extrasparam 擴展字段(通常傳跳轉的鏈接) * @return 0推送失敗,1推送成功 */ public static int sendToAlias( List<String> alias,String notification_title, String msg_title, String msg_content, String extrasparam) { JPushClient jPushClient = new JPushClient(MASTERSECRET,APPKER); int result = 0; try { PushPayload pushPayload= JPushUtil.buildPushObject_all_alias_alertWithTitle(alias,notification_title,msg_title,msg_content,extrasparam); PushResult pushResult = jPushClient.sendPush(pushPayload); if(pushResult.getResponseCode()==200){ result = 1; } logger.info("[極光推送]PushResult result is " + pushResult); } catch (APIConnectionException e) { logger.error("[極光推送]Connection error. Should retry later. ", e); } catch (APIRequestException e) { logger.error("[極光推送]Error response from JPush server. Should review and fix it. ", e); logger.info("[極光推送]HTTP Status: " + e.getStatus()); logger.info("[極光推送]Error Code: " + e.getErrorCode()); logger.info("[極光推送]Error Message: " + e.getErrorMessage()); } return result; } /** * 推送給設備標識(別名)參數的用戶(定時) * @param alias 設備標識(別名) * @param notification_title 通知內容標題 * @param msg_title 消息內容標題 * @param msg_content 消息內容 * @param extrasparam 擴展字段 * @param time 格式:yyyy-MM-dd HH:mm:ss * @return 0推送失敗,1推送成功 */ public static int sendToAlias2( List<String> alias,String notification_title, String msg_title, String msg_content, String extrasparam, String time) { JPushClient jPushClient = new JPushClient(MASTERSECRET,APPKER); int result = 0; try { PushPayload pushPayload= JPushUtil.buildPushObject_all_alias_alertWithTitle(alias,notification_title,msg_title,msg_content,extrasparam); ScheduleResult scheduleResult=jPushClient.createSingleSchedule("點唄生活", time, pushPayload); if(scheduleResult.getResponseCode()==200){ result=1; } logger.info("[極光推送]ScheduleResult result is " + scheduleResult); } catch (APIConnectionException e) { logger.error("[極光推送]Connection error. Should retry later. ", e); } catch (APIRequestException e) { logger.error("[極光推送]Error response from JPush server. Should review and fix it. ", e); logger.info("[極光推送]HTTP Status: " + e.getStatus()); logger.info("[極光推送]Error Code: " + e.getErrorCode()); logger.info("[極光推送]Error Message: " + e.getErrorMessage()); } return result; } /** * 推送給設備RegistrationIds參數的用戶 * @param registrationIdList 設備註冊ID * @param notification_title 通知內容標題 * @param msg_title 消息內容標題 * @param msg_content 消息內容 * @param extrasparam 擴展字段 * @return 0推送失敗,1推送成功 */ public static int sendToRegistrationIds( List<String> registrationIdList,String notification_title, String msg_title, String msg_content, String extrasparam) { JPushClient jPushClient = new JPushClient(MASTERSECRET,APPKER); int result = 0; try { PushPayload pushPayload= JPushUtil.buildPushObject_all_registrationIds_alertWithTitle(registrationIdList,notification_title,msg_title,msg_content,extrasparam); PushResult pushResult=jPushClient.sendPush(pushPayload); if(pushResult.getResponseCode()==200){ result=1; } logger.info("[極光推送]PushResult result is " + pushResult); } catch (APIConnectionException e) { logger.error("[極光推送]Connection error. Should retry later. ", e); } catch (APIRequestException e) { logger.error("[極光推送]Error response from JPush server. Should review and fix it. ", e); logger.info("[極光推送]HTTP Status: " + e.getStatus()); logger.info("[極光推送]Error Code: " + e.getErrorCode()); logger.info("[極光推送]Error Message: " + e.getErrorMessage()); } return result; } /** * 發送給所有安卓用戶 * @param notification_title 通知內容標題 * @param msg_title 消息內容標題 * @param msg_content 消息內容 * @param extrasparam 擴展字段 * @return 0推送失敗,1推送成功 */ public static int sendToAllAndroid( String notification_title, String msg_title, String msg_content, String extrasparam) { int result = 0; try { PushPayload pushPayload= JPushUtil.buildPushObject_android_all_alertWithTitle(notification_title,msg_title,msg_content,extrasparam); PushResult pushResult=jPushClient.sendPush(pushPayload); if(pushResult.getResponseCode()==200){ result=1; } logger.info("[極光推送]PushResult result is " + pushResult); } catch (APIConnectionException e) { logger.error("[極光推送]Connection error. Should retry later. ", e); } catch (APIRequestException e) { logger.error("[極光推送]Error response from JPush server. Should review and fix it. ", e); logger.info("[極光推送]HTTP Status: " + e.getStatus()); logger.info("[極光推送]Error Code: " + e.getErrorCode()); logger.info("[極光推送]Error Message: " + e.getErrorMessage()); } return result; } /** * 發送給所有IOS用戶 * @param notification_title 通知內容標題 * @param msg_title 消息內容標題 * @param msg_content 消息內容 * @param extrasparam 擴展字段 * @return 0推送失敗,1推送成功 */ public static int sendToAllIos(String notification_title, String msg_title, String msg_content, String extrasparam) { int result = 0; try { PushPayload pushPayload= JPushUtil.buildPushObject_ios_all_alertWithTitle(notification_title,msg_title,msg_content,extrasparam); PushResult pushResult=jPushClient.sendPush(pushPayload); if(pushResult.getResponseCode()==200){ result=1; } logger.info("[極光推送]PushResult result is " + pushResult); } catch (APIConnectionException e) { logger.error("[極光推送]Connection error. Should retry later. ", e); } catch (APIRequestException e) { logger.error("[極光推送]Error response from JPush server. Should review and fix it. ", e); logger.info("[極光推送]HTTP Status: " + e.getStatus()); logger.info("[極光推送]Error Code: " + e.getErrorCode()); logger.info("[極光推送]Error Message: " + e.getErrorMessage()); } return result; } /** * 發送給所有用戶 * @param notification_title 通知內容標題 * @param msg_title 消息內容標題 * @param msg_content 消息內容 * @param extrasparam 擴展字段 * @return 0推送失敗,1推送成功 */ public static int sendToAll( String notification_title, String msg_title, String msg_content, String extrasparam) { int result = 0; try { PushPayload pushPayload= JPushUtil.buildPushObject_android_and_ios(notification_title,msg_title,msg_content,extrasparam); PushResult pushResult=jPushClient.sendPush(pushPayload); if(pushResult.getResponseCode()==200){ result=1; } logger.info("[極光推送]PushResult result is " + pushResult); } catch (APIConnectionException e) { logger.error("[極光推送]Connection error. Should retry later. ", e); } catch (APIRequestException e) { logger.error("[極光推送]Error response from JPush server. Should review and fix it. ", e); logger.info("[極光推送]HTTP Status: " + e.getStatus()); logger.info("[極光推送]Error Code: " + e.getErrorCode()); logger.info("[極光推送]Error Message: " + e.getErrorMessage()); } return result; } /** * 發送給所有用戶(定時推送) * @param notification_title 通知內容標題 * @param msg_title 消息內容標題 * @param msg_content 消息內容 * @param extrasparam 擴展字段 * @param time 格式:yyyy-MM-dd HH:mm:ss * @return 0推送失敗,1推送成功 */ public static int sendToAll2( String notification_title, String msg_title, String msg_content, String extrasparam, String time) { int result = 0; try { PushPayload pushPayload= JPushUtil.buildPushObject_android_and_ios(notification_title,msg_title,msg_content,extrasparam); ScheduleResult scheduleResult=jPushClient.createSingleSchedule("測試", time, pushPayload); if(scheduleResult.getResponseCode()==200){ result=1; } logger.info("[極光推送]scheduleResult result is " + scheduleResult); } catch (APIConnectionException e) { logger.error("[極光推送]Connection error. Should retry later. ", e); } catch (APIRequestException e) { logger.error("[極光推送]Error response from JPush server. Should review and fix it. ", e); logger.info("[極光推送]HTTP Status: " + e.getStatus()); logger.info("[極光推送]Error Code: " + e.getErrorCode()); logger.info("[極光推送]Error Message: " + e.getErrorMessage()); } return result; } public static PushPayload buildPushObject_android_and_ios(String notification_title, String msg_title, String msg_content, String extrasparam) { return PushPayload.newBuilder() .setPlatform(Platform.android_ios()) .setAudience(Audience.all()) .setNotification(Notification.newBuilder() .setAlert(msg_content) .addPlatformNotification(AndroidNotification.newBuilder() .setAlert(msg_content) .setTitle(notification_title) //此字段爲透傳字段,不會顯示在通知欄。用戶可以通過此字段來做一些定製需求,如特定的key傳要指定跳轉的頁面(value) .addExtra("url",extrasparam) .build() ) .addPlatformNotification(IosNotification.newBuilder() //傳一個IosAlert對象,指定apns title、title、subtitle等 .setAlert(msg_content) //直接傳alert //此項是指定此推送的badge自動加1 .incrBadge(1) //此字段的值default表示系統默認聲音;傳sound.caf表示此推送以項目裏面打包的sound.caf聲音來提醒, // 如果系統沒有此音頻則以系統默認聲音提醒;此字段如果傳空字符串,iOS9及以上的系統是無聲音提醒,以下的系統是默認聲音 .setSound("sound.caf") //此字段爲透傳字段,不會顯示在通知欄。用戶可以通過此字段來做一些定製需求,如特定的key傳要指定跳轉的頁面(value) .addExtra("url",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("url",extrasparam) .build()) .setOptions(Options.newBuilder() //此字段的值是用來指定本推送要推送的apns環境,false表示開發,true表示生產;對android和自定義消息無意義 .setApnsProduction(ApnsProduction) //此字段是給開發者自己給推送編號,方便推送者分辨推送記錄 .setSendno(1) //此字段的值是用來指定本推送的離線保存時長,如果不傳此字段則默認保存一天,最多指定保留十天,單位爲秒 .setTimeToLive(86400) .build() ) .build(); } private static PushPayload buildPushObject_all_alias_alertWithTitle(List<String> alias,String notification_title, String msg_title, String msg_content, String extrasparam) { //創建一個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(alias)) //.setAudience(Audience.registrationId(registrationId)) //jpush的通知,android的由jpush直接下發,iOS的由apns服務器下發,Winphone的由mpns下發 .setNotification(Notification.newBuilder() //指定當前推送的android通知 .addPlatformNotification(AndroidNotification.newBuilder() .setAlert(msg_content) .setTitle(notification_title) //此字段爲透傳字段,不會顯示在通知欄。用戶可以通過此字段來做一些定製需求,如特定的key傳要指定跳轉的頁面(value) .addExtra("url",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("sound.caf") //此字段爲透傳字段,不會顯示在通知欄。用戶可以通過此字段來做一些定製需求,如特定的key傳要指定跳轉的頁面(value) .addExtra("url",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("url",extrasparam) .build()) .setOptions(Options.newBuilder() //此字段的值是用來指定本推送要推送的apns環境,false表示開發,true表示生產;對android和自定義消息無意義 .setApnsProduction(ApnsProduction) //此字段是給開發者自己給推送編號,方便推送者分辨推送記錄 .setSendno(1) //此字段的值是用來指定本推送的離線保存時長,如果不傳此字段則默認保存一天,最多指定保留十天; .setTimeToLive(86400) .build()) .build(); } private static PushPayload buildPushObject_all_registrationIds_alertWithTitle(List<String> registrationIds,String notification_title, String msg_title, String msg_content, String extrasparam) { //創建一個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.registrationId(registrationIds)) //jpush的通知,android的由jpush直接下發,iOS的由apns服務器下發,Winphone的由mpns下發 .setNotification(Notification.newBuilder() //指定當前推送的android通知 .addPlatformNotification(AndroidNotification.newBuilder() .setAlert(msg_content) .setTitle(notification_title) //此字段爲透傳字段,不會顯示在通知欄。用戶可以通過此字段來做一些定製需求,如特定的key傳要指定跳轉的頁面(value) .addExtra("url",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("sound.caf") //此字段爲透傳字段,不會顯示在通知欄。用戶可以通過此字段來做一些定製需求,如特定的key傳要指定跳轉的頁面(value) .addExtra("url",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("url",extrasparam) .build()) .setOptions(Options.newBuilder() //此字段的值是用來指定本推送要推送的apns環境,false表示開發,true表示生產;對android和自定義消息無意義 .setApnsProduction(ApnsProduction) //此字段是給開發者自己給推送編號,方便推送者分辨推送記錄 .setSendno(1) //此字段的值是用來指定本推送的離線保存時長,如果不傳此字段則默認保存一天,最多指定保留十天; .setTimeToLive(86400) .build()) .build(); } private static PushPayload buildPushObject_android_all_alertWithTitle(String notification_title, String msg_title, String msg_content, String extrasparam) { List<String> rids=new ArrayList<>(); 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("url",extrasparam) .build()) .build() ) //Platform指定了哪些平臺就會像指定平臺中符合推送條件的設備進行推送。 jpush的自定義消息, // sdk默認不做任何處理,不會有通知提示。建議看文檔http://docs.jpush.io/guideline/faq/的 // [通知與自定義消息有什麼區別?]瞭解通知和自定義消息的區別 .setMessage(Message.newBuilder() .setMsgContent(msg_content) .setTitle(msg_title) .addExtra("url",extrasparam) .build()) .setOptions(Options.newBuilder() //此字段的值是用來指定本推送要推送的apns環境,false表示開發,true表示生產;對android和自定義消息無意義 .setApnsProduction(ApnsProduction) //此字段是給開發者自己給推送編號,方便推送者分辨推送記錄 .setSendno(1) //此字段的值是用來指定本推送的離線保存時長,如果不傳此字段則默認保存一天,最多指定保留十天,單位爲秒 .setTimeToLive(86400) .build()) .build(); } private static PushPayload buildPushObject_ios_all_alertWithTitle( String notification_title, String msg_title, String msg_content, String extrasparam) { 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("sound.caf") //此字段爲透傳字段,不會顯示在通知欄。用戶可以通過此字段來做一些定製需求,如特定的key傳要指定跳轉的頁面(value) .addExtra("url",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("url",extrasparam) .build()) .setOptions(Options.newBuilder() //此字段的值是用來指定本推送要推送的apns環境,false表示開發,true表示生產;對android和自定義消息無意義 .setApnsProduction(ApnsProduction) //此字段是給開發者自己給推送編號,方便推送者分辨推送記錄 .setSendno(1) //此字段的值是用來指定本推送的離線保存時長,如果不傳此字段則默認保存一天,最多指定保留十天,單位爲秒 .setTimeToLive(86400) .build()) .build(); } }
3、添加測試類
@Test void jpushContent() { List<String> alias = new ArrayList<>(); alias.add("bc84647b112e40fd98c6fb036421e4de"); JPushUtil.sendToAlias(alias,"通知標題","推送標題","推送內容","json"); }