極光推送工具類快速上手
依賴
<dependency> <groupId>cn.jpush.api</groupId> <artifactId>jpush-client</artifactId> <version>3.3.8</version> </dependency> <dependency> <groupId>cn.jpush.api</groupId> <artifactId>jiguang-common</artifactId> <version>1.1.3</version> </dependency> <dependency> <groupId>io.netty</groupId> <artifactId>netty-all</artifactId> <version>4.1.6.Final</version> <scope>compile</scope> </dependency>
代碼
package com.weiwend.jdpush.util;
import cn.jiguang.common.ClientConfig;
import cn.jiguang.common.resp.APIConnectionException;
import cn.jiguang.common.resp.APIRequestException;
import cn.jpush.api.JPushClient;
import cn.jpush.api.device.TagAliasResult;
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.IosAlert;
import cn.jpush.api.push.model.notification.IosNotification;
import cn.jpush.api.push.model.notification.Notification;
import cn.jpush.api.report.MessageStatus;
import cn.jpush.api.report.model.CheckMessagePayload;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
import java.util.*;
@Component
public class JPushUtils {
//@Value("${jpush.appKey}")
private static String appKey = "0365ae8d79163e434039f576";
//@Value("${jpush.masterSecret}")
private static String masterSecret = "66f66ec49b455cf6f1048057";
//@Value("${jpush.apnsProduction}")
private static boolean apnsProduction = false;
//@Value("${jpush.jpushTime}")
private static long jpushTime = 86400L;
private static JPushClient jPushClient = new JPushClient(masterSecret , appKey ,null,ClientConfig.getInstance());
private static final int RESPONSE_OK = 200;
private static final Logger logger = LoggerFactory.getLogger(JPushUtils.class);
public static void main(String[] args) {
PushPayload androidNotificationAll = createAndroidNotificationAll("測試 測試", "11111111", null);
PushResult pushResult = sendPush(androidNotificationAll);
System.out.println("pushResult = " + pushResult);
}
/****************************************************************************************************************************/
/****************** 如下是直接獲取pushPayload 本身獲取以後再推送 *******************/
/****************************************************************************************************************************/
/**
* @Method 設置推送對象PushPayload
* @Author MC
aliasList:設備惟一識別碼集合
msgTitle:推送標題
msgContent:推送內容
parm:擴展參數
* @Return
* @Date 2019/8/20 0020 15:06
*/
public static PushPayload setPushPayloadByRegId(List<String> aliasList, String msgTitle, String msgContent, Map<String, String> parm){
// 建立一個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(aliasList))這個是經過別名
.setAudience(Audience.registrationId(aliasList))//經過設備惟一識別碼進行推送
// jpush的通知，android的由jpush直接下發，iOS的由apns服務器下發，Winphone的由mpns下發
.setNotification(Notification.newBuilder()
// 指定當前推送的android通知
.addPlatformNotification(AndroidNotification.newBuilder()
.setAlert(msgContent)
.setTitle(msgTitle)
// 此字段爲透傳字段，不會顯示在通知欄。用戶能夠經過此字段來作一些定製需求，如特定的key傳要指定跳轉的頁面（value）
.addExtras(parm)
.build())
// 指定當前推送的iOS通知
.addPlatformNotification(IosNotification.newBuilder()
// 傳一個IosAlert對象，指定apns title、title、subtitle等
.setAlert(IosAlert.newBuilder()
.setTitleAndBody(msgTitle, "", msgContent)
.build())
// 直接傳alert
// 此項是指定此推送的badge自動加1
.incrBadge(1)
// 此字段的值default表示系統默認聲音；傳sound.caf表示此推送以項目裏面打包的sound.caf聲音來提醒，
// 若是系統沒有此音頻則以系統默認聲音提醒；此字段若是傳空字符串，iOS9及以上的系統是無聲音提醒，如下的系統是默認聲音
.setSound("default")
// 此字段爲透傳字段，不會顯示在通知欄。用戶能夠經過此字段來作一些定製需求，如特定的key傳要指定跳轉的頁面（value）
.addExtras(parm)
// 此項說明此推送是一個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(msgContent)
.setTitle(msgTitle)
.addExtras(parm)
.build())
.setOptions(Options.newBuilder()
// 此字段的值是用來指定本推送要推送的apns環境，false表示開發，true表示生產；對android和自定義消息無心義
.setApnsProduction(apnsProduction)
// 此字段是給開發者本身給推送編號，方便推送者分辨推送記錄
.setSendno(1)
// 此字段的值是用來指定本推送的離線保存時長，若是不傳此字段則默認保存一天，最多指定保留十天；
.setTimeToLive(jpushTime)
.build())
.build();
}
/**
* 對全部平臺全部設備上的進行推送通知
*
* @param alert 發送的通知
*/
public static PushPayload createAllNotificationAll(String title,String alert)
throws APIConnectionException, APIRequestException {
return PushPayload.newBuilder()
.setPlatform(Platform.all())
.setAudience(Audience.all())
.setNotification(Notification.newBuilder()
.addPlatformNotification(AndroidNotification.newBuilder()
.setAlert(alert)
.setTitle(title)
.build())
.addPlatformNotification(IosNotification.newBuilder()
.setAlert(IosAlert.newBuilder()
.setTitleAndBody(title, "", alert)
.build())
.build())
.build())
.build();
}
/**
desc :向 多個標籤取交集的用戶發送通知 附帶額外的參數信息extra
* @param title
* @param alert
* @param tags
* @param extras
*/
public static PushPayload createAllNotificationWithTagsAnd(String title,String alert,Collection<String> tags, Map<String,String> extras) throws APIConnectionException, APIRequestException {
return PushPayload.newBuilder()
.setPlatform(Platform.all())
.setAudience(Audience.tag_and(tags))
.setNotification(Notification.newBuilder()
.addPlatformNotification(AndroidNotification.newBuilder()
.addExtras(extras)
.setAlert(alert)
.setTitle(title)
.build())
.addPlatformNotification(IosNotification.newBuilder()
.addExtras(extras)
.setAlert(IosAlert.newBuilder()
.setTitleAndBody(title, "", alert)
.build())
.build())
.build())
.build();
}
/**
desc :向 多個標籤取並集的用戶發送通知 附帶額外的參數信息extra
* @param title
* @param alert
* @param tags
* @param extras
*/
public static PushPayload createAllNotificationWithTagsOr(String title,String alert,Collection<String> tags, Map<String,String> extras) throws APIConnectionException, APIRequestException {
return PushPayload.newBuilder()
.setPlatform(Platform.all())
.setAudience(Audience.tag(tags))
.setNotification(Notification.newBuilder()
.addPlatformNotification(AndroidNotification.newBuilder()
.addExtras(extras)
.setAlert(alert)
.setTitle(title)
.build())
.addPlatformNotification(IosNotification.newBuilder()
.addExtras(extras)
.setAlert(IosAlert.newBuilder()
.setTitleAndBody(title, "", alert)
.build())
.build())
.build())
.build();
}
/**
desc :向 註冊id用戶發送通知 附帶額外的參數信息extra
* @param title
* @param alert
* @param registrationIds
* @param extras
*/
public static PushPayload createAllNotificationWithRegistrationIds(String title,String alert,Collection<String> registrationIds, Map<String,String> extras) throws APIConnectionException, APIRequestException {
return PushPayload.newBuilder()
.setPlatform(Platform.all())
.setAudience(Audience.registrationId(registrationIds))
.setNotification(Notification.newBuilder()
.addPlatformNotification(AndroidNotification.newBuilder()
.addExtras(extras)
.setAlert(alert)
.setTitle(title)
.build())
.addPlatformNotification(IosNotification.newBuilder()
.addExtras(extras)
.setAlert(IosAlert.newBuilder()
.setTitleAndBody(title, "", alert)
.build())
.build())
.build())
.build();
}
/**
desc :向 多個標籤取交集的用戶發送通知 附帶額外的參數信息extra
* @param title
* @param alert
* @param alias
* @param extras
*/
public static PushPayload createAllNotificationWithAlias(String title,String alert,Collection<String> alias, Map<String,String> extras) throws APIConnectionException, APIRequestException {
return PushPayload.newBuilder()
.setPlatform(Platform.all())
.setAudience(Audience.alias(alias))
.setNotification(Notification.newBuilder()
.addPlatformNotification(AndroidNotification.newBuilder()
.addExtras(extras)
.setAlert(alert)
.setTitle(title)
.build())
.addPlatformNotification(IosNotification.newBuilder()
.addExtras(extras)
.setAlert(IosAlert.newBuilder()
.setTitleAndBody(title, "", alert)
.build())
.build())
.build())
.build();
}
/**
desc :向 別名用戶發送通知 附帶額外的參數信息extra
* @param title
* @param alert
* @param alias
* @param extras
*/
public static PushPayload createAndroidNotificationWithAlias(String title,String alert,Collection<String> alias, Map<String,String> extras) throws APIConnectionException, APIRequestException {
return PushPayload.newBuilder()
.setPlatform(Platform.android())
.setAudience(Audience.alias(alias))
.setNotification(Notification.newBuilder()
.addPlatformNotification(AndroidNotification.newBuilder()
.addExtras(extras)
.setAlert(alert)
.setTitle(title)
.build())
.build())
.build();
}
/**
desc :向 ios 平臺 別名用戶發送通知 附帶額外的參數信息extra
* @param alert
* @param alias
* @param extras
*/
public static PushPayload createIosNotificationWithAlias(IosAlert alert,Collection<String> alias, Map<String,String> extras) throws APIConnectionException, APIRequestException {
return PushPayload.newBuilder()
.setPlatform(Platform.android())
.setAudience(Audience.alias(alias))
.setNotification(Notification.newBuilder()
.addPlatformNotification(IosNotification.newBuilder()
.addExtras(extras)
.setAlert(alert)
.build())
.build())
.build();
}
/**
desc :向 ios 平臺 別名用戶發送通知 附帶額外的參數信息extra
* @param title
* @param alert
* @param tags
* @param extras
*/
public static PushPayload createIosNotificationWithTagsAnd(String title,String alert,Collection<String> tags, Map<String,String> extras) throws APIConnectionException, APIRequestException {
return PushPayload.newBuilder()
.setPlatform(Platform.android())
.setAudience(Audience.tag_and(tags))
.setNotification(Notification.newBuilder()
.addPlatformNotification(IosNotification.newBuilder()
.addExtras(extras)
.setAlert(IosAlert.newBuilder()
.setTitleAndBody(title, "", alert)
.build())
.build())
.build())
.build();
}
/**
desc :向 ios 平臺 別名用戶發送通知 附帶額外的參數信息extra
* @param title
* @param alert
* @param tags
* @param extras
*/
public static PushPayload createIosNotificationWithTagsOr(String title,String alert,Collection<String> tags, Map<String,String> extras) throws APIConnectionException, APIRequestException {
return PushPayload.newBuilder()
.setPlatform(Platform.android())
.setAudience(Audience.tag(tags))
.setNotification(Notification.newBuilder()
.addPlatformNotification(IosNotification.newBuilder()
.addExtras(extras)
.setAlert(IosAlert.newBuilder()
.setTitleAndBody(title, "", alert)
.build())
.build())
.build())
.build();
}
/**
desc :向 ios 平臺 別名用戶發送通知 附帶額外的參數信息extra
* @param alert
* @param registrationIds
* @param extras
*/
public static PushPayload createIosNotificationWithRegistrationIds(IosAlert alert,Collection<String> registrationIds, Map<String,String> extras) throws APIConnectionException, APIRequestException {
return PushPayload.newBuilder()
.setPlatform(Platform.android())
.setAudience(Audience.registrationId(registrationIds))
.setNotification(Notification.newBuilder()
.addPlatformNotification(IosNotification.newBuilder()
.addExtras(extras)
.setAlert(alert)
.build())
.build())
.build();
}
/**
desc :向 給定標籤交集用戶發送通知 附帶額外的參數信息extra
* @param title
* @param alert
* @param tags
* @param extras
*/
public static PushPayload createAndroidNotificationWithTagsAnd(String title,String alert,Collection<String> tags, Map<String,String> extras)
throws APIConnectionException, APIRequestException {
return PushPayload.newBuilder()
.setPlatform(Platform.android())
.setAudience(Audience.tag_and(tags))
.setNotification(Notification.newBuilder()
.addPlatformNotification(AndroidNotification.newBuilder()
.addExtras(extras)
.setAlert(alert)
.setTitle(title)
.build())
.build())
.build();
}
/**
desc :向 給定標籤並集用戶發送通知 附帶額外的參數信息extra
* @param title
* @param alert
* @param tags
* @param extras
*/
public static PushPayload createAndroidNotificationWithTagsOr(String title,String alert,Collection<String> tags, Map<String,String> extras) throws APIConnectionException, APIRequestException {
return PushPayload.newBuilder()
.setPlatform(Platform.android())
.setAudience(Audience.tag(tags))
.setNotification(Notification.newBuilder()
.addPlatformNotification(AndroidNotification.newBuilder()
.addExtras(extras)
.setAlert(alert)
.setTitle(title)
.build())
.build())
.build();
}
/**
desc :向 別名用戶發送通知 附帶額外的參數信息extra
* @param title
* @param alert
* @param registrationIds
* @param extras
*/
public static PushPayload createAndroidNotificationWithRegistrationIds(String title,String alert,Collection<String> registrationIds, Map<String,String> extras) throws APIConnectionException, APIRequestException {
return PushPayload.newBuilder()
.setPlatform(Platform.android())
.setAudience(Audience.registrationId(registrationIds))
.setNotification(Notification.newBuilder()
.addPlatformNotification(AndroidNotification.newBuilder()
.addExtras(extras)
.setAlert(alert)
.setTitle(title)
.build())
.build())
.build();
}
/**
desc :生成向安卓全部用戶推送的pushPayload通知
* @param title
* @param content
* @return
*/
public static PushPayload createAndroidNotificationAll(String title, String content,Map<String,String> extras) {
return PushPayload.newBuilder()
.setPlatform(Platform.android())
.setAudience(Audience.all())
.setNotification(Notification.newBuilder()
.addPlatformNotification(AndroidNotification.newBuilder()
.addExtras(extras)
.setAlert(content)
.setTitle(title)
.build())
.build())
.build();
}
/**
desc :生成向ios全部用戶推送的pushPayload通知
* @return
*/
public static PushPayload createIosNotificationAll(IosAlert alert, Map<String,String> extras) {
return PushPayload.newBuilder()
.setPlatform(Platform.android())
.setAudience(Audience.all())
.setNotification(Notification.newBuilder()
.addPlatformNotification(IosNotification.newBuilder()
.addExtras(extras)
.setAlert(alert)
.build())
.build())
.build();
}
/**
desc :向 多個標籤取交集的用戶發送Message 附帶額外的參數信息extra
* @param title
* @param alert
* @param tags
* @param extras
*/
public static PushPayload createAllMessageWithTagsAnd(String title,String alert,Collection<String> tags, Map<String,String> extras)
throws APIConnectionException, APIRequestException {
return PushPayload.newBuilder()
.setPlatform(Platform.all())
.setAudience(Audience.tag(tags))
.setMessage(Message.newBuilder()
.setMsgContent(alert)
.setTitle(title)
.addExtras(extras)
.build())
.build();
}
/**
* 發送
*/
public static PushResult sendPush(PushPayload pushPayload){
logger.info("pushPayload={}", pushPayload);
PushResult pushResult = null;
try {
pushResult = jPushClient.sendPush(pushPayload);
logger.info("" + pushResult);
if (pushResult.getResponseCode() == RESPONSE_OK) {
logger.info("push successful, pushPayload={}", pushPayload);
}
} catch (APIConnectionException e) {
logger.error("push failed: pushPayload={}, exception={}", pushPayload, e);
} catch (APIRequestException e) {
logger.error("push failed: pushPayload={}, exception={}", pushPayload, e);
}
return pushResult;
}
/**
desc :送達狀態查詢 默認當天的推送
@param ids 註冊id的list集合
@return map 鍵是註冊id 值是MessageStatus
*/
public static Map<String, MessageStatus> getReceiveStatus(Long msgId,List<String> ids) throws APIConnectionException, APIRequestException {
CheckMessagePayload build = CheckMessagePayload.newBuilder()
.setMsgId(msgId)
.setRegistrationsIds(ids)
.build();
return jPushClient.getMessageStatus(build);
}
/**
desc :送達狀態查詢
@param ids 註冊id的list集合
@param date 指定日期 格式：yyyy-mm-dd
@return map 鍵是註冊id 值是MessageStatus
*/
public static Map<String, MessageStatus> getReceiveStatus(Long msgId,List<String> ids,String date) throws APIConnectionException, APIRequestException {
CheckMessagePayload build = CheckMessagePayload.newBuilder()
.setDate(date)
.setMsgId(msgId)
.setRegistrationsIds(ids)
.build();
return jPushClient.getMessageStatus(build);
}
/**
desc :將拿到的新的註冊id 設置別名和標籤
*/
public static boolean setAliasAndTag(String registrationId)
throws APIConnectionException, APIRequestException {
HashSet<String> add = new HashSet<>();
jPushClient.updateDeviceTagAlias(registrationId,"",add,null);
return true;
}
/**
* 獲取=某個註冊id 的別名和標籤
*/
public static TagAliasResult getAliasAndTags(String registrationId) throws APIConnectionException, APIRequestException {
return jPushClient.getDeviceTagAlias(registrationId);
}
/**
* 綁定手機號
* @param registrationId
* @param mobile
* @throws APIConnectionException
* @throws APIRequestException
*/
public static void bindMobile(String registrationId, String mobile) throws APIConnectionException, APIRequestException {
jPushClient.bindMobile(registrationId,mobile);
}
/*public static void main(String[] args) throws APIConnectionException, APIRequestException {
List<String> strings = Arrays.asList("11","22","33");//存放設備識別碼
HashMap<String, String> objectObjectHashMap = new HashMap<>();
objectObjectHashMap.put("eee","eee");
objectObjectHashMap.put("cc","eecce");
// PushPayload payload = createAndroidNotificationWithRegistrationIds("這是標題", "這是內容測試長度==============================", strings, objectObjectHashMap);
PushPayload payload = setPushPayloadByRegId(strings, "這是標題", "這是內容測試長度==============================", objectObjectHashMap);
// PushPayload payload = createAllNotificationWithRegistrationIds("這是標題", "這是內容測試長度==============================", strings, objectObjectHashMap);
// PushPayload payload = createAllNotificationAll("這是標題", "這是內容測試長度==============================");
PushResult result = sendPush(payload);
System.out.println(result.msg_id);
System.out.println(result.sendno);
System.out.println(result.statusCode);
System.out.println(result.error);
}*/
}
個人雲筆記原文
文檔：極光推送工具類.md 連接：http://note.youdao.com/noteshare?id=f9ad0e3d99fc57f4fa00eb6fec9deb0d&sub=058832241DE9400FBD397CDFAB59819Ejava
相關文章
- 1. 極光推送工具類
- 2. 極光推送的快速集成
- 3. OBS推流工具快速上手
- 4. 極光推送
- 5. app推送-極光推送
- 6. git工具快速上手
- 7. iOS極光推送
- 8. ionic 極光推送
- 9. 1、【極光推送】
- 10. iOS: 極光推送
- 更多相關文章...
- • jQuery Mobile 工具欄 - jQuery Mobile 教程
- • SQL 快速參考 - SQL 教程
- • PHP開發工具
- • Kotlin學習（二）基本類型
相關標籤/搜索
每日一句
-
每一个你不满意的现在，都有一个你没有努力的曾经。
最新文章
- 1. python的安裝和Hello，World編寫
- 2. 重磅解讀：K8s Cluster Autoscaler模塊及對應華爲雲插件Deep Dive
- 3. 鴻蒙學習筆記2（永不斷更）
- 4. static關鍵字 和構造代碼塊
- 5. JVM筆記
- 6. 無法啓動 C/C++ 語言服務器。IntelliSense 功能將被禁用。錯誤: Missing binary at c:\Users\MSI-NB\.vscode\extensions\ms-vsc
- 7. 【Hive】Hive返回碼狀態含義
- 8. Java樹形結構遞歸（以時間換空間）和非遞歸（以空間換時間）
- 9. 數據預處理---缺失值
- 10. 都要2021年了，現代C++有什麼值得我們學習的？
歡迎關注本站公眾號,獲取更多信息
相關文章
- 1. 極光推送工具類
- 2. 極光推送的快速集成
- 3. OBS推流工具快速上手
- 4. 極光推送
- 5. app推送-極光推送
- 6. git工具快速上手
- 7. iOS極光推送
- 8. ionic 極光推送
- 9. 1、【極光推送】
- 10. iOS: 極光推送