com.apifan.framework.jpush.component.JPushApi Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jpush-spring-boot-starter Show documentation
Show all versions of jpush-spring-boot-starter Show documentation
简单易用的极光推送服务端辅助工具包。可直接快速集成到您的 SpringBoot 项目中。
package com.apifan.framework.jpush.component;
import cn.jiguang.common.ClientConfig;
import cn.jiguang.common.connection.HttpProxy;
import cn.jiguang.common.resp.APIConnectionException;
import cn.jiguang.common.resp.APIRequestException;
import cn.jiguang.common.resp.DefaultResult;
import cn.jpush.api.JPushClient;
import cn.jpush.api.device.AliasDeviceListResult;
import cn.jpush.api.push.PushResult;
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;
import com.apifan.framework.jpush.config.JPushProperties;
import com.apifan.framework.jpush.vo.PushMessage;
import com.google.common.base.Preconditions;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.util.CollectionUtils;
import java.util.List;
/**
* 极光推送API辅助工具
*
* @author yin
*/
public class JPushApi {
private static final Logger logger = LoggerFactory.getLogger(JPushApi.class);
private JPushProperties jPushProperties;
private JPushClient jPushClient;
private boolean initSuccess;
public JPushApi(JPushProperties jPushProperties) {
this.jPushProperties = jPushProperties;
}
/**
* 初始化
*/
public void init() {
if (initSuccess) {
return;
}
Preconditions.checkArgument(StringUtils.isNotEmpty(jPushProperties.getAppKey()), "appKey为空");
Preconditions.checkArgument(StringUtils.isNotEmpty(jPushProperties.getMasterSecret()), "masterSecret为空");
ClientConfig clientConfig = ClientConfig.getInstance();
HttpProxy proxy = null;
if (jPushProperties.isUseProxy()) {
Preconditions.checkArgument(StringUtils.isNotEmpty(jPushProperties.getProxyHost()), "代理服务器主机名或IP为空");
Preconditions.checkArgument(jPushProperties.getProxyPort() > 1, "代理服务器主机端口无效");
if (StringUtils.isNotEmpty(jPushProperties.getProxyUsername())) {
proxy = new HttpProxy(StringUtils.trim(jPushProperties.getProxyHost()), jPushProperties.getProxyPort()
, StringUtils.trim(jPushProperties.getProxyUsername()), StringUtils.trim(jPushProperties.getProxyPassword()));
} else {
proxy = new HttpProxy(StringUtils.trim(jPushProperties.getProxyHost()), jPushProperties.getProxyPort());
}
}
jPushClient = new JPushClient(jPushProperties.getMasterSecret(), jPushProperties.getAppKey(), proxy, clientConfig);
initSuccess = true;
logger.info("初始化JPushApi成功!");
}
/**
* 根据设备ID推送
*
* @param registrationIdList 设备Registration ID列表
* @param pm 消息
* @return 成功时返回消息ID
*/
public Long pushToDevices(List registrationIdList, PushMessage pm) {
Preconditions.checkArgument(!CollectionUtils.isEmpty(registrationIdList), "设备Registration ID为空");
Preconditions.checkArgument(registrationIdList.size() <= 1000, "设备Registration ID不超过1000个");
return push(createPushPayload(pm, Audience.registrationId(registrationIdList)));
}
/**
* 根据别名推送
*
* @param aliasList 别名列表
* @param pm 消息
* @return 成功时返回消息ID
*/
public Long pushToAliases(List aliasList, PushMessage pm) {
Preconditions.checkArgument(!CollectionUtils.isEmpty(aliasList), "别名为空");
Preconditions.checkArgument(aliasList.size() <= 1000, "别名不超过1000个");
return push(createPushPayload(pm, Audience.alias(aliasList)));
}
/**
* 根据标签推送
*
* @param tagsList 标签列表
* @param pm 消息
* @return 成功时返回消息ID
*/
public Long pushToTags(List tagsList, PushMessage pm) {
Preconditions.checkArgument(!CollectionUtils.isEmpty(tagsList), "标签为空");
Preconditions.checkArgument(tagsList.size() <= 1000, "标签不超过1000个");
return push(createPushPayload(pm, Audience.tag(tagsList)));
}
/**
* 推送给所有客户端
*
* @param pm 消息
* @return 成功时返回消息ID
*/
public Long pushToAll(PushMessage pm) {
return push(createPushPayload(pm, Audience.all()));
}
/**
* 查询指定别名下的设备Registration ID
*
* @param alias 待查询的别名
* @return 关联的设备Registration ID列表
*/
public List findRegistrationId(String alias) {
if (StringUtils.isEmpty(alias)) {
return null;
}
try {
AliasDeviceListResult result = jPushClient.getAliasDeviceList(alias, null);
if (result == null || 200 != result.getResponseCode()) {
return null;
}
return result.registration_ids;
} catch (APIConnectionException | APIRequestException e) {
logger.error("查询别名关联的设备时发生异常! alias:{}", alias, e);
}
return null;
}
/**
* 删除别名
*
* @param aliasList 待删除的别名列表
*/
public void deleteAlias(List aliasList) {
if (CollectionUtils.isEmpty(aliasList)) {
return;
}
aliasList.forEach(a -> {
if (StringUtils.isEmpty(a)) {
return;
}
try {
DefaultResult result = jPushClient.deleteAlias(a, null);
logger.info("删除别名接口返回码: {}, alias: {}", result != null ? result.getResponseCode() : null, a);
} catch (APIConnectionException | APIRequestException e) {
logger.error("删除别名时发生异常! alias:{}", a, e);
}
});
}
/**
* 进行推送
*
* @param payload 消息体
* @return 成功时返回消息ID
*/
private Long push(PushPayload payload) {
if (jPushProperties.getRetryMaxAttempts() != null && jPushProperties.getRetryMaxAttempts() > 0) {
try {
return pushWithRetry(payload);
} catch (Exception e) {
logger.error("推送时发生异常", e);
}
return null;
} else {
return executePush(payload);
}
}
/**
* 进行推送(支持重试)
*
* @param payload 消息体
* @return 成功时返回消息ID
*/
@SuppressWarnings("BusyWait")
private Long pushWithRetry(PushPayload payload) throws Exception {
Long msgId = executePush(payload);
if (msgId == null) {
long sleepTime = jPushProperties.getRetryInterval() > 0 ? jPushProperties.getRetryInterval() : 500L;
for (int i = 0; i < jPushProperties.getRetryMaxAttempts(); i++) {
Thread.sleep(sleepTime);
msgId = executePush(payload);
if (msgId != null) {
break;
}
sleepTime *= 2;
}
}
return msgId;
}
/**
* 执行推送
*
* @param payload 消息体
* @return 成功时返回消息ID
*/
private Long executePush(PushPayload payload) {
logger.info("推送消息体: {}", payload.toJSON());
try {
PushResult result = jPushClient.sendPush(payload);
if (result == null) {
return null;
}
if (200 == result.getResponseCode()) {
logger.info("消息推送成功，消息ID: {}", result.msg_id);
return result.msg_id;
}
logger.error("消息推送失败，ResponseCode={}", result.getResponseCode());
} catch (APIConnectionException e) {
logger.error("推送消息出现APIConnectionException异常", e);
} catch (APIRequestException e) {
logger.error("推送消息出现APIRequestException异常", e);
logger.error("推送消息出现异常, status={}, errorCode={}, errorMessage={}", e.getStatus(), e.getErrorCode(), e.getErrorMessage());
}
return null;
}
private PushPayload createPushPayload(PushMessage pm, Audience audience) {
Preconditions.checkArgument(pm != null, "消息为空");
Preconditions.checkArgument(StringUtils.isNotEmpty(pm.getContent()), "消息内容为空");
return PushPayload.newBuilder()
.setPlatform(Platform.all())
.setAudience(audience)
.setOptions(Options.newBuilder().setApnsProduction(true).build())
.setNotification(Notification.newBuilder().setAlert(StringUtils.trim(pm.getContent()))
.addPlatformNotification(IosNotification.newBuilder().setSound("default").setBadge(pm.getBadge() != null ? pm.getBadge() : 1).addExtras(pm.getExtras()).build())
.addPlatformNotification(AndroidNotification.newBuilder().setBuilderId(1).setPriority(pm.getPriority() != null ? pm.getPriority() : 0).addExtras(pm.getExtras()).build()).build()
).build();
}
}