關於"極光"APP推送JPUSH的服務器端使用

前期準備

maven下準備jar包:

需要在pom.xml中添加如下代碼:

<dependency>
    <groupId>cn.jpush.api</groupId>
    <artifactId>jmessage-client</artifactId>
    <version>1.1.2</version>
</dependency>
<dependency>
    <groupId>cn.jpush.api</groupId>
    <artifactId>jiguang-common</artifactId>
    <version>1.0.8</version>
</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>


導入時需要注意原來自己的pom中是否有重複的配置,如果有則不添加這個配置

2.不使用maven

可以在https://github.com/jpush/jmessage-api-java-client/releases下載相關jar文件

依賴包

其中 slf4j 可以與 logback, log4j, commons-logging 等日誌框架一起工作,可根據你的需要配置使用。



之後就可以寫推送的工具類了

package cn.eleph.common.utils;
import cn.jpush.api.JPushClient;
import cn.jpush.api.common.resp.APIConnectionException;
import cn.jpush.api.common.resp.APIRequestException;
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 = "這裏寫極光中你的app的appKey";
 
    private final static String masterSecret = "這裏寫你的極光中的masterSecret";
    //這個JpushClient是jar包中封裝好的,如果你這裏不能導入則證明你jar包沒導入成功
    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("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)
                                //此項說明此推送是一個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");
       }
   }
}
 
 


下面這個東西沒太大用,也貼上來吧

package cn.eleph.common.utils;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import cn.jpush.api.JPushClient;
import cn.jpush.api.common.resp.APIConnectionException;
import cn.jpush.api.common.resp.APIRequestException;
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();  
   }  
}




發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章