天天看點

JPush極光推送API工具類(JAVA)

package com.util.push;


import cn.jpush.api.common.resp.APIConnectionException;
import cn.jpush.api.common.resp.APIRequestException;
import cn.jpush.api.push.model.PushPayload.Builder;
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;
import org.apache.log4j.Logger;
import java.util.Map;

/**
 * @author SuperMudada
 * @ClassName: MessagePushUtil
 * @Description: TODO(消息推送工具類)
 * TODO(考察文檔 http://docs.jiguang.cn/jpush/server/push/rest_api_v3_push/)
 * @Created-Date: 2017/4/22  15:04
 */
public class MessagePushUtil {
    private static final String MASTER_SECRET = "";  //TODO(填寫你的MASTER_SECRET)
    private static final String APP_KEY = "";     //TODO(填寫你的APP_KEY)
    private static Logger logger = Logger.getLogger(JpushUtils.class);
    private static PushPayload pushPayload;
    private static Builder builder =PushPayload.newBuilder();

    public static void main(String[] args) throws Exception {
        //TODO(建構推送内容,推送目标,推送類型)
        //pushPayload = MessagePushUtil.pushAndroidAndIosByAlias("30", "哈哈", "hehei");
        pushPayload=PushPayload.alertAll("哈哈");
        //TODO(開始推送)
        sendPushTryCatch(pushPayload);
    }

    /**
     * @param @param payload
     * @Title: sendPushTryCatch TODO(開始推送)
     * @Description: try catch 推送
     */
    public static void sendPushTryCatch(PushPayload payload) {
        JPushClient jPushClient = new JPushClient(MASTER_SECRET, APP_KEY);
        try {
            PushResult pushResult = jPushClient.sendPush(payload);
            logger.info("傳回結果" + pushResult);
        } catch (APIConnectionException e) {
            logger.error("連接配接錯誤,稍後嘗試" + e);
        } catch (APIRequestException e) {
            logger.error("極光推送内部錯誤", e);
            logger.info("網絡請求狀态" + e.getStatus());
            logger.info("錯誤狀态碼" + e.getErrorCode());
            logger.info("錯誤資訊" + e.getErrorMessage());
            logger.info("資訊ID" + e.getMsgId());
            logger.info("極光推送錯誤資訊:" + e.getErrorMessage());
        }
    }



    /**
     * @param alias   推送别名
     * @param alert   推送标題
     * @param content 推送内容(推薦json格式)
     * @return
     */
    public static PushPayload pushAndroidAndIosByAlias(String alias, String alert, String content) {
        return builder
                .setPlatform(Platform.android_ios())  //推送平台
                .setAudience(Audience.alias(alias))   //推送目标,這裡指定進行别名推送
                .setNotification(Notification.newBuilder()
                        .setAlert(alert)
                        .addPlatformNotification(
                                AndroidNotification.newBuilder()
                                        .addExtra("sign", "5")
                                        .addExtra("content", content)
                                        .build())
                        .addPlatformNotification(IosNotification.newBuilder()
                                .addExtra("sign", "5")
                                .addExtra("content", content)
                                .build())
                        .build())
                .setOptions(
                        Options.newBuilder()
                                .setApnsProduction(false)//IOS推送環境、True 表示推送生産環境,False 表示要推送開發環境;
                                .setTimeToLive()   //推送目前使用者不線上時,為該使用者保留多長時間的離線消息,以便其上線時再次推送。預設 86400 (1 天),最長 10 天。設定為 0 表示不保留離線消息,隻有推送目前線上的使用者可以收到。
                                .build())
                .build();
    }

    /**
     * @param @param  alert
     * @param @return 設定檔案
     * @return PushPayload    傳回類型
     * @throws
     * @Title: buildPushObjectAllAllAlert
     * @Description: TODO(快捷地建構推送對象:所有平台,所有裝置,内容為 alert 的通知)
     */
    @SuppressWarnings("static-access")
    public static PushPayload buildPushObjectAllAllAlert(String alert) {
        return pushPayload.alertAll(alert);
    }

    /**
     * @param @param  alert
     * @param @param  alias
     * @param @return 設定檔案
     * @return PushPayload    傳回類型
     * @throws
     * @Title: buildPushObjectAliasAlert
     * @Description: TODO(所有平台,推送目标是别名為 alias,通知内容為 alert)
     */
    public static PushPayload buildPushObjectAliasAlert(String alert, String... alias) {
        return builder
                .setPlatform(Platform.android_ios())
                .setAudience(Audience.alias(alias))
                .setNotification(Notification.newBuilder()
                        .setAlert(alert)
                        .addPlatformNotification(
                                AndroidNotification.newBuilder()
                                        .addExtra("sign", "5")
                                        .build())
                        .addPlatformNotification(IosNotification.newBuilder()
                                .addExtra("sign", "5")
                                .build())
                        .build())
                .build();
    }

    /**
     * @param @param  alias
     * @param @param  alert
     * @param @param  badge
     * @param @return 設定檔案
     * @return PushPayload    傳回類型
     * @throws
     * @Title: buildPushObjectIos
     * @Description: TODO(iOS推送 badge sound)
     */
    public static PushPayload buildPushObjectIosAndroid(Map<String, String> params,
                                                        String[] alias, String alert, int badge, String sound, String msgContent) {
        return builder
                .setPlatform(Platform.android_ios())
                .setAudience(Audience.alias(alias))
                .setNotification(Notification.newBuilder()
                        .addPlatformNotification(IosNotification.newBuilder()
                                .setAlert(alert)
                                .setBadge(badge)
                                .addExtras(params)
                                .setSound(sound)
                                .build())
                        .addPlatformNotification(AndroidNotification.newBuilder()
                                .setAlert(alert)
                                .addExtras(params)
                                .build())
                        .build())
                .setMessage(Message.newBuilder()
                        .setMsgContent(msgContent)
                        .build())
                .build();
    }

    /**
     * @param @param  params
     * @param @param  alias
     * @param @return 設定檔案
     * @return PushPayload    傳回類型
     * @throws
     * @Title: buildPushObjectAllAliasAlert
     * @Description: TODO(所有平台,推送目标是别名為 alias,通知标題為 title,通知内容為 alert)
     */
    public static PushPayload buildPushObjectAllAliasAlert(Map<String, String> params, String alert, String title, String... alias) {
        return builder
                .setPlatform(Platform.android_ios())
                .setAudience(Audience.alias(alias))
                .setNotification(Notification.newBuilder()
                        .setAlert(alert)
                        .addPlatformNotification(AndroidNotification.newBuilder()
                                .setTitle(title)
                                .addExtras(params)
                                .build())
                        .addPlatformNotification(IosNotification.newBuilder()
                                .addExtras(params)
                                .build())
                        .build())
                .build();
    }


    /**
     * @param @param  tag
     * @param @param  alert
     * @param @param  title
     * @param @return 設定檔案
     * @return PushPayload    傳回類型
     * @throws
     * @Title: buildPushObjectAndroidTagAlertWithTitle
     * @Description: TODO(平台是 Android,目标是 tag 為 tag 的裝置,内容是 Android 通知 alert,并且标題為 title)
     */
    public static PushPayload buildPushObjectAndroidTagAlertWithTitle(String tag, String alert, String title) {
        return builder
                .setPlatform(Platform.android())
                .setAudience(Audience.tag(tag))
                .setNotification(Notification.android(alert, title, null))
                .build();
    }

    /**
     * @param @param  tag
     * @param @param  tagAll
     * @param @param  number
     * @param @param  alert
     * @param @param  msgContent
     * @param @return 設定檔案
     * @return PushPayload    傳回類型
     * @throws
     * @Title: buildPushObjectIosTagAndAlertWithExtrasAndMessage
     * @Description: TODO(建構推送對象:平台是 iOS,推送目标是 tag, tagAll 的交集, 推送内容同時包括通知與消息 - 通知資訊是 alert,角标數字為 number,消息内容是 msgContent。通知是 APNs 推送通道的,消息是 JPush 應用内消息通道的。
     * APNs 的推送環境是“開發”(如果不顯式設定的話,Library 會預設指定為開發)
     * True 表示推送生産環境,False 表示要推送開發環境
     *)
     */
    public static PushPayload buildPushObjectIosTagAndAlertWithExtrasAndMessage(
            String tag, String tagAll, int number, String alert, String msgContent) {
        return builder
                .setPlatform(Platform.ios())
                .setAudience(Audience.tag_and(tag, tagAll))
                .setNotification(Notification.newBuilder()
                        .addPlatformNotification(IosNotification.newBuilder()
                                .setAlert(alert)
                                .setBadge(number)
                                .build())
                        .build())
                .setMessage(Message.content(msgContent))
                .setOptions(Options.newBuilder()
                        .setApnsProduction(false)
                        .build())
                .build();
    }

    /**
     * 建構推送對象:平台是 Andorid 與 iOS,
     * 推送目标是 (tag1 與 tag2 的并集),
     * 推送内容是 - 内容為 msgContent 的消息
     *
     * @param @param  tag1
     * @param @param  tag2
     * @param @param  msgContent
     * @param @return 設定檔案
     * @return PushPayload    傳回類型
     * @throws
     * @Title: buildPushObjectIosAudienceMoreMessageWithExtras
     * @Description: TODO()
     */
    public static PushPayload buildPushObjectIosAudienceMoreMessageWithExtras(
            String tag1, String tag2, String msgContent) {
        return builder
                .setPlatform(Platform.android_ios())
                .setAudience(Audience.newBuilder()
                        .addAudienceTarget(AudienceTarget.tag(tag1, tag2))
                        .build())
                .setMessage(Message.newBuilder()
                        .setMsgContent(msgContent)
                        .build())
                .build();
    }
}