Jpush (極光推送)自定義推送聲音(服務端寫法)
阿新 • • 發佈:2019-02-19
1.JpushClientUtil package com.liuhuan.service; 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.*; public class JpushClientUtil { private final static String appKey ="你的Appkey(極光推送給你的)"; private final static String masterSecret ="你的master_Secret (極光推送給你的)"; 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, String 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) { e.printStackTrace(); } catch (APIRequestException e) { 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, String 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)) //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) .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("sound",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) //此項說明此推送是一個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(); } // public static void main(String[] args){ // if(JpushClientUtil.sendToAllIos("testIos","testIos","this is a ios Dev test","")==1){ // System.out.println("success"); // } // } }
2.Jdpush package com.liuhuan.service; 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.audience.AudienceTarget; 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 Jdpush { protected static final Logger LOG = LoggerFactory.getLogger(Jdpush.class); // demo App defined in resources/jpush-api.conf public static final String TITLE = "申通快遞"; public static final String ALERT = ""; public static final String MSG_CONTENT = "申通快遞祝新老客戶新春快樂"; public static final String REGISTRATION_ID = "0900e8d85ef"; public static final String TAG = "tag_api"; public static JPushClient jpushClient=null; public static void testSendPush(String appKey ,String masterSecret) { jpushClient = new JPushClient(masterSecret, appKey, 3); // HttpProxy proxy = new HttpProxy("localhost", 3128); // Can use this https proxy: https://github.com/Exa-Networks/exaproxy // For push, all you need do is to build PushPayload object. //PushPayload payload = buildPushObject_all_all_alert(); //生成推送的內容,這裡我們先測試全部推送 PushPayload payload=buildPushObject_all_alias_alert(); try { System.out.println(payload.toString()); PushResult result = jpushClient.sendPush(payload); System.out.println(result+"................................"); LOG.info("Got result - " + result); } catch (APIConnectionException e) { LOG.error("Connection error. Should retry later. ", e); } catch (APIRequestException e) { LOG.error("Error response from JPush server. Should review and fix it. ", e); LOG.info("HTTP Status: " + e.getStatus()); LOG.info("Error Code: " + e.getErrorCode()); LOG.info("Error Message: " + e.getErrorMessage()); LOG.info("Msg ID: " + e.getMsgId()); } } public static PushPayload buildPushObject_all_all_alert() { return PushPayload.alertAll(ALERT); } public static PushPayload buildPushObject_all_alias_alert() { return PushPayload.newBuilder() .setPlatform(Platform.all())//設定接受的平臺 .setAudience(Audience.all())//Audience設定為all,說明採用廣播方式推送,所有使用者都可以接收到 .setNotification(Notification.alert(ALERT)) .build(); } public static PushPayload buildPushObject_android_tag_alertWithTitle() { return PushPayload.newBuilder() .setPlatform(Platform.android()) .setAudience(Audience.all()) .setNotification(Notification.android(ALERT, TITLE, null)) .build(); } public static PushPayload buildPushObject_android_and_ios() { return PushPayload.newBuilder() .setPlatform(Platform.android_ios()) .setAudience(Audience.tag("tag1")) .setNotification(Notification.newBuilder() .setAlert("alert content") .addPlatformNotification(AndroidNotification.newBuilder() .setTitle("Android Title").build()) .addPlatformNotification(IosNotification.newBuilder() .incrBadge(1) .addExtra("extra_key", "extra_value").build()) .build()) .build(); } public static PushPayload buildPushObject_ios_tagAnd_alertWithExtrasAndMessage() { return PushPayload.newBuilder() .setPlatform(Platform.ios()) .setAudience(Audience.tag_and("tag1", "tag_all")) .setNotification(Notification.newBuilder() .addPlatformNotification(IosNotification.newBuilder() .setAlert(ALERT) .setBadge(5) .setSound("happy") .addExtra("from", "JPush") .build()) .build()) .setMessage(Message.content(MSG_CONTENT)) .setOptions(Options.newBuilder() .setApnsProduction(true) .build()) .build(); } public static PushPayload buildPushObject_ios_audienceMore_messageWithExtras() { return PushPayload.newBuilder() .setPlatform(Platform.android_ios()) .setAudience(Audience.newBuilder() .addAudienceTarget(AudienceTarget.tag("tag1", "tag2")) .addAudienceTarget(AudienceTarget.alias("alias1", "alias2")) .build()) .setMessage(Message.newBuilder() .setMsgContent(MSG_CONTENT) .addExtra("from", "JPush") .build()) .build(); } }
測試的話新建一個Main 函式測試就行。我測試的程式碼如下
3 Test001(測試類) package com.liuhuan.service; import java.util.HashMap; import java.util.List; import java.util.Map; public class Test001 { public static void main(String[] args) { // TODO Auto-generated method stub Jdpush.testSendPush("af585b64479d2b2ac79ddc03", "8881754d58b086d22ca2cbb8"); JpushClientUtil.sendToAllAndroid("", "true", "3701TEST004", "jj.mp3"); } }
需要用到的jar包