相关文档
Java集成第三方推送(极光推送)——文档篇
Java集成第三方推送(极光推送)——代码篇
Web 配置操作
帐号创建
该步骤就不再赘述, 普通的帐号注册即可;
地址:https://www.jiguang.cn/accounts/login/login_message
创建应用
点击[创建应用]按钮即可;
输入应用名称 (必填), 上传一个图标,选择应用类型;
信息配置完成后,查看应用信息如下:
AppKey和Master Secret很重要,到时候写java后台服务要用的。这里不能给你们看,抱歉!
接下来,我们打开java开发工具,创建一个maven项目
Web API
添加极光依赖
<!-- 极光推送 -->
<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>
创建两个常量,AppKey 与 Master Secret
private final static String APPKER = "************************";
private final static String MASTERSECRET = "************************";
接下来是平台推送功能的实现,注释很详细,我就不细说了,复制代码,即可使用!
推送给设备标识参数的用户
public static int sendToRegistrationId( List<String> alias,String notification_title, String msg_title, String msg_content, String extrasparam) {
JPushClient jPushClient = new JPushClient(MASTERSECRET,APPKER);
int result = 0;
try {
PushPayload pushPayload= JPushUtil.buildPushObject_all_alias_alertWithTitle(alias,notification_title,msg_title,msg_content,extrasparam);
PushResult pushResult=jPushClient.sendPush(pushPayload);
if(pushResult.getResponseCode()==200){
result=1;
}
log.info("[极光推送]PushResult result is " + pushResult);
} 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());
}
return result;
}
推送给设备标识参数的用户(定时)
public static int sendToRegistrationId2( List<String> alias,String notification_title, String msg_title, String msg_content, String extrasparam, String time) {
JPushClient jPushClient = new JPushClient(MASTERSECRET,APPKER);
int result = 0;
try {
PushPayload pushPayload= JPushUtil.buildPushObject_all_alias_alertWithTitle(alias,notification_title,msg_title,msg_content,extrasparam);
ScheduleResult scheduleResult=jPushClient.createSingleSchedule("测试", time, pushPayload);
if(scheduleResult.getResponseCode()==200){
result=1;
}
log.info("[极光推送]ScheduleResult result is " + scheduleResult);
} 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());
}
return result;
}
发送给所有安卓用户
public static int sendToAllAndroid( String notification_title, String msg_title, String msg_content, String extrasparam) {
int result = 0;
try {
PushPayload pushPayload= JPushUtil.buildPushObject_android_all_alertWithTitle(notification_title,msg_title,msg_content,extrasparam);
PushResult pushResult=jPushClient.sendPush(pushPayload);
if(pushResult.getResponseCode()==200){
result=1;
}
log.info("[极光推送]PushResult result is " + pushResult);
} 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());
}
return result;
}
发送给所有IOS用户
public static int sendToAllIos(String notification_title, String msg_title, String msg_content, String extrasparam) {
int result = 0;
try {
PushPayload pushPayload= JPushUtil.buildPushObject_ios_all_alertWithTitle(notification_title,msg_title,msg_content,extrasparam);
PushResult pushResult=jPushClient.sendPush(pushPayload);
if(pushResult.getResponseCode()==200){
result=1;
}
log.info("[极光推送]PushResult result is " + pushResult);
} 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());
}
return result;
}
发送给所有用户
public static int sendToAll( String notification_title, String msg_title, String msg_content, String extrasparam) {
int result = 0;
try {
PushPayload pushPayload= JPushUtil.buildPushObject_android_and_ios(notification_title,msg_title,msg_content,extrasparam);
PushResult pushResult=jPushClient.sendPush(pushPayload);
if(pushResult.getResponseCode()==200){
result=1;
}
log.info("[极光推送]PushResult result is " + pushResult);
} 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());
}
return result;
}
发送给所有用户(定时推送)
public static int sendToAll2( String notification_title, String msg_title, String msg_content, String extrasparam, String time) {
int result = 0;
try {
PushPayload pushPayload= JPushUtil.buildPushObject_android_and_ios(notification_title,msg_title,msg_content,extrasparam);
ScheduleResult scheduleResult=jPushClient.createSingleSchedule("测试", time, pushPayload);
if(scheduleResult.getResponseCode()==200){
result=1;
}
log.info("[极光推送]scheduleResult result is " + scheduleResult);
} 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());
}
return result;
}
common
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(msg_content)
.addPlatformNotification(AndroidNotification.newBuilder()
.setAlert(msg_content)
.setTitle(notification_title)
//此字段为透传字段,不会显示在通知栏。用户可以通过此字段来做一些定制需求,如特定的key传要指定跳转的页面(value)
.addExtra("url",extrasparam)
.build()
)
.addPlatformNotification(IosNotification.newBuilder()
//传一个IosAlert对象,指定apns title、title、subtitle等
.setAlert(msg_content)
//直接传alert
//此项是指定此推送的badge自动加1
.incrBadge(1)
//此字段的值default表示系统默认声音;传sound.caf表示此推送以项目里面打包的sound.caf声音来提醒,
// 如果系统没有此音频则以系统默认声音提醒;此字段如果传空字符串,iOS9及以上的系统是无声音提醒,以下的系统是默认声音
.setSound("sound.caf")
//此字段为透传字段,不会显示在通知栏。用户可以通过此字段来做一些定制需求,如特定的key传要指定跳转的页面(value)
.addExtra("url",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("url",extrasparam)
.build())
.setOptions(Options.newBuilder()
//此字段的值是用来指定本推送要推送的apns环境,false表示开发,true表示生产;对android和自定义消息无意义
.setApnsProduction(true)
//此字段是给开发者自己给推送编号,方便推送者分辨推送记录
.setSendno(1)
//此字段的值是用来指定本推送的离线保存时长,如果不传此字段则默认保存一天,最多指定保留十天,单位为秒
.setTimeToLive(86400)
.build()
)
.build();
}
private static PushPayload buildPushObject_all_alias_alertWithTitle(List<String> alias,String notification_title, String msg_title, String msg_content, String extrasparam) {
//创建一个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(alias))
// .setAudience(Audience.registrationId(registrationId))
//jpush的通知,android的由jpush直接下发,iOS的由apns服务器下发,Winphone的由mpns下发
.setNotification(Notification.newBuilder()
//指定当前推送的android通知
.addPlatformNotification(AndroidNotification.newBuilder()
.setAlert(msg_content)
.setTitle(notification_title)
//此字段为透传字段,不会显示在通知栏。用户可以通过此字段来做一些定制需求,如特定的key传要指定跳转的页面(value)
.addExtra("url",extrasparam)
.build())
//指定当前推送的iOS通知
.addPlatformNotification(IosNotification.newBuilder()
//传一个IosAlert对象,指定apns title、title、subtitle等
.setAlert(msg_content)
//直接传alert
//此项是指定此推送的badge自动加1
.incrBadge(1)
//此字段的值default表示系统默认声音;传sound.caf表示此推送以项目里面打包的sound.caf声音来提醒,
// 如果系统没有此音频则以系统默认声音提醒;此字段如果传空字符串,iOS9及以上的系统是无声音提醒,以下的系统是默认声音
.setSound("sound.caf")
//此字段为透传字段,不会显示在通知栏。用户可以通过此字段来做一些定制需求,如特定的key传要指定跳转的页面(value)
.addExtra("url",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("url",extrasparam)
.build())
.setOptions(Options.newBuilder()
//此字段的值是用来指定本推送要推送的apns环境,false表示开发,true表示生产;对android和自定义消息无意义
.setApnsProduction(true)
//此字段是给开发者自己给推送编号,方便推送者分辨推送记录
.setSendno(1)
//此字段的值是用来指定本推送的离线保存时长,如果不传此字段则默认保存一天,最多指定保留十天;
.setTimeToLive(86400)
.build())
.build();
}
private static PushPayload buildPushObject_android_all_alertWithTitle(String notification_title, String msg_title, String msg_content, String extrasparam) {
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(msg_content)
.setTitle(notification_title)
//此字段为透传字段,不会显示在通知栏。用户可以通过此字段来做一些定制需求,如特定的key传要指定跳转的页面(value)
.addExtra("url",extrasparam)
.build())
.build()
)
//Platform指定了哪些平台就会像指定平台中符合推送条件的设备进行推送。 jpush的自定义消息,
// sdk默认不做任何处理,不会有通知提示。建议看文档http://docs.jpush.io/guideline/faq/的
// [通知与自定义消息有什么区别?]了解通知和自定义消息的区别
.setMessage(Message.newBuilder()
.setMsgContent(msg_content)
.setTitle(msg_title)
.addExtra("url",extrasparam)
.build())
.setOptions(Options.newBuilder()
//此字段的值是用来指定本推送要推送的apns环境,false表示开发,true表示生产;对android和自定义消息无意义
.setApnsProduction(true)
//此字段是给开发者自己给推送编号,方便推送者分辨推送记录
.setSendno(1)
//此字段的值是用来指定本推送的离线保存时长,如果不传此字段则默认保存一天,最多指定保留十天,单位为秒
.setTimeToLive(86400)
.build())
.build();
}
private static PushPayload buildPushObject_ios_all_alertWithTitle( String notification_title, String msg_title, String msg_content, String extrasparam) {
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(msg_content)
//直接传alert
//此项是指定此推送的badge自动加1
.incrBadge(1)
//此字段的值default表示系统默认声音;传sound.caf表示此推送以项目里面打包的sound.caf声音来提醒,
// 如果系统没有此音频则以系统默认声音提醒;此字段如果传空字符串,iOS9及以上的系统是无声音提醒,以下的系统是默认声音
.setSound("sound.caf")
//此字段为透传字段,不会显示在通知栏。用户可以通过此字段来做一些定制需求,如特定的key传要指定跳转的页面(value)
.addExtra("url",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("url",extrasparam)
.build())
.setOptions(Options.newBuilder()
//此字段的值是用来指定本推送要推送的apns环境,false表示开发,true表示生产;对android和自定义消息无意义
.setApnsProduction(true)
//此字段是给开发者自己给推送编号,方便推送者分辨推送记录
.setSendno(1)
//此字段的值是用来指定本推送的离线保存时长,如果不传此字段则默认保存一天,最多指定保留十天,单位为秒
.setTimeToLive(86400)
.build())
.build();
}
测试
接下来我们来测试推送功能
rid是移动端通过api获取的,没有rid是没法推送的(想测试的和移动端商量)
public static void main(String[] args) {
List<String> alias = new ArrayList<String>();
alias.add("**********************");
//alias.add("231");
//sendToRegistrationId(alias, "中奖通知", "中奖通知", "恭喜你中了100个亿!", "https://www.baidu.com");
//sendToRegistrationId2(alias,"中奖通知", "中奖通知", "恭喜你中了100个亿!", "https://www.baidu.com","2021-07-14 17:54:00");
//sendToAllAndroid("中奖通知", "中奖通知", "恭喜你中了100个亿!", "https://www.baidu.com");
//sendToAllIos("中奖通知", "中奖通知", "恭喜你中了100个亿", "https://www.baidu.com");
//sendToAll("中奖通知", "中奖通知", "恭喜你中了100个亿!", "https://www.baidu.com");
//sendToAll2("中奖通知", "中奖通知", "恭喜你中了100个亿!", "https://www.baidu.com","2021-07-14 17:54:00");
}
运行测试类
状态码等于0,说明推送成功
接下来我们登录极光推送后台,查看消息是否成功推送
对比发现,就是我们先前推送的消息
这样我们 使用Java实现第三方极光推送功能就完成了,小伙伴们可以稍作修改,集成到各自的项目里