極光推送工具類
阿新 • • 發佈：2017-11-21
tle 分辨 空字符 客戶端 配置 技術 連接錯誤 event ast 
之前項目有用到需要把數據推送到app端 采用的是極光推送
特此把工具類和pom.xml需要的jar整理如下
pom.xml需要jar如下
<!-- 極光推送 --> <dependency> <groupId>cn.jpush.api</groupId> <artifactId>jpush-client</artifactId> <version>3.3.0</version> </dependencyView Code> <dependency> <groupId>cn.jpush.api</groupId> <artifactId>jiguang-common</artifactId> <version>1.0.8</version> </dependency>
工具類代碼如下
import java.util.Map; import org.apache.commons.logging.Log;View Codeimport 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; public class JpushClientUtil { @Logger private static Log log ; private final static String appKey = ""; private final static String masterSecret = ""; private static JPushClient jPushClient = new JPushClient(masterSecret,appKey); /** * 推送給設備標識參數的用戶 * @param registrationId 設備標識 * @param notification_title 通知內容標題 * @param msg_title 消息內容標題 * @param msg_content 消息內容 * @param extrasparam 擴展字段 * @return 0推送失敗，1推送成功 * 推送消息調用該方法 */ public static int sendToRegistrationId( String registrationId,String notification_title, String msg_title, String msg_content, Map extrasparam) { int result = 0; try { PushPayload pushPayload= JpushClientUtil.buildPushObject_all_registrationId_alertWithTitle(registrationId,notification_title,msg_title,msg_content,extrasparam); //System.out.println(pushPayload); PushResult pushResult=jPushClient.sendPush(pushPayload); //System.out.println(pushResult); if(pushResult.getResponseCode()==200){ result=1; } } catch (APIConnectionException e) { if(log.isErrorEnabled()){ log.error("連接錯誤，稍後嘗試" + e); } e.printStackTrace(); } catch (APIRequestException e) { if(log.isErrorEnabled()){ log.error("極光推送內部錯誤", e); log.info("網絡請求狀態" + e.getStatus()); log.info("錯誤狀態碼" + e.getErrorCode()); log.info("錯誤信息" + e.getErrorMessage()); log.info("信息ID" + e.getMsgId()); } e.printStackTrace(); } 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= JpushClientUtil.buildPushObject_android_all_alertWithTitle(notification_title,msg_title,msg_content,extrasparam); System.out.println(pushPayload); PushResult pushResult=jPushClient.sendPush(pushPayload); System.out.println(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 static int sendToAllIos(String notification_title, String msg_title, String msg_content, String extrasparam) { int result = 0; try { PushPayload pushPayload= JpushClientUtil.buildPushObject_ios_all_alertWithTitle(notification_title,msg_title,msg_content,extrasparam); System.out.println(pushPayload); PushResult pushResult=jPushClient.sendPush(pushPayload); System.out.println(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 static int sendToAll( String notification_title, String msg_title, String msg_content, String extrasparam) { int result = 0; try { PushPayload pushPayload= JpushClientUtil.buildPushObject_android_and_ios(notification_title,msg_title,msg_content,extrasparam); System.out.println(pushPayload); PushResult pushResult=jPushClient.sendPush(pushPayload); System.out.println(pushResult); if(pushResult.getResponseCode()==200){ result=1; } } catch (Exception e) { e.printStackTrace(); } 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(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("sound.caf") //此字段為透傳字段，不會顯示在通知欄。用戶可以通過此字段來做一些定制需求，如特定的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(false) //此字段是給開發者自己給推送編號，方便推送者分辨推送記錄 .setSendno(1) //此字段的值是用來指定本推送的離線保存時長，如果不傳此字段則默認保存一天，最多指定保留十天，單位為秒 .setTimeToLive(86400) .build() ) .build(); } private static PushPayload buildPushObject_all_registrationId_alertWithTitle(String registrationId,String notification_title, String msg_title, String msg_content, Map extrasparam) { System.out.println("----------buildPushObject_all_all_alert"); //創建一個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(registrationId)) .setAudience(Audience.alias(registrationId)) //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("sound.caf") //此字段為透傳字段，不會顯示在通知欄。用戶可以通過此字段來做一些定制需求，如特定的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) //TODO可以傳map .addExtras(extrasparam) .build()) .setOptions(Options.newBuilder() //此字段的值是用來指定本推送要推送的apns環境，false表示開發，true表示生產；對android和自定義消息無意義 .setApnsProduction(false) //此字段是給開發者自己給推送編號，方便推送者分辨推送記錄 .setSendno(1) //此字段的值是用來指定本推送的離線保存時長，如果不傳此字段則默認保存一天，最多指定保留十天； .setTimeToLive(86400) .build()) .build(); } private static PushPayload buildPushObject_android_all_alertWithTitle(String notification_title, String msg_title, String msg_content, String extrasparam) { System.out.println("----------buildPushObject_android_registrationId_alertWithTitle"); 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(false) //此字段是給開發者自己給推送編號，方便推送者分辨推送記錄 .setSendno(1) //此字段的值是用來指定本推送的離線保存時長，如果不傳此字段則默認保存一天，最多指定保留十天，單位為秒 .setTimeToLive(86400) .build()) .build(); } private static PushPayload buildPushObject_ios_all_alertWithTitle( String notification_title, String msg_title, String msg_content, String extrasparam) { System.out.println("----------buildPushObject_ios_registrationId_alertWithTitle"); 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("sound.caf") //此字段為透傳字段，不會顯示在通知欄。用戶可以通過此字段來做一些定制需求，如特定的key傳要指定跳轉的頁面（value） .addExtra("iosNotification extras key",extrasparam) //.addExtra("order", 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) /*.addExtra("orderId","123456789") .addExtra("customer","李白") .addExtra("remark","測試")*/ .build()) .setOptions(Options.newBuilder() //此字段的值是用來指定本推送要推送的apns環境，false表示開發，true表示生產；對android和自定義消息無意義 .setApnsProduction(false) //此字段是給開發者自己給推送編號，方便推送者分辨推送記錄 .setSendno(1) //此字段的值是用來指定本推送的離線保存時長，如果不傳此字段則默認保存一天，最多指定保留十天，單位為秒 .setTimeToLive(86400) .build()) .build(); } }
1.appKey和masterSecret 這兩個參數的值需要自己設置
2.日誌那塊需要自己調整一下
如有問題歡迎評論交流
極光推送工具類