今天接到一个需求说需要调用第三方推送(极光推送),所以就去官网看了一下api,感觉挺有意思的,想记录一下个人学习的过程。不喜勿喷!
注册极光的账号
- 极光的官网地址:https://www.jiguang.cn/
- 极光api文档(java):https://docs.jiguang.cn/jpush/server/sdk/java_sdk/
登录账号创建应用获取AppKey以及Master Secret
点击刚创建好的应用,进去后就可以获取到AppKey和Master Secret
调用极光推送添加依赖或下载jar包
-
maven项目在pom.xml里添加如下依赖:
- jar包下载地址:https://github.com/jpush/jpush-api-java-client/releases
实现推送功能
- 实现类
import java.util.Map;
import cn.jiguang.common.resp.APIConnectionException;
import cn.jiguang.common.resp.APIRequestException;
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.notification.*;
public class JpushUtil {
private final static String APPKEY = "这是你的appkey";
private final static String MASTERSECRET = "这是你的mastersecret";
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, Map<String, String> extrasparams) {
int result = 0;
try {
PushPayload pushPayload= JpushUtil.buildPushObject_all_registrationId_alertWithTitle(registrationId,notification_title,msg_title,msg_content,extrasparams);
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 registrationId 设备标识
* @param notification_title 通知内容标题
* @param msg_title 消息内容标题
* @param msg_content 消息内容
* @param extrasparam 扩展字段
* @return 0推送失败，1推送成功
*/
public static int sendToBieMing( String bieming,String notification_title, String msg_title, String msg_content, Map<String, String> extrasparams) {
int result = 0;
try {
PushPayload pushPayload= JpushUtil.buildPushObject_all_BieMing_alertWithTitle(bieming,notification_title,msg_title,msg_content,extrasparams);
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, Map<String, String> extrasparams) {
int result = 0;
try {
PushPayload pushPayload= JpushUtil.buildPushObject_android_all_alertWithTitle(notification_title,msg_title,msg_content,extrasparams);
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= JpushUtil.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, Map<String, String> extrasparams) {
int result = 0;
try {
PushPayload pushPayload= JpushUtil.buildPushObject_android_and_ios(notification_title,msg_title,msg_content,extrasparams);
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 extrasparams 附加字段
* @return
*/
public static PushPayload buildPushObject_android_and_ios(String notification_title, String msg_title, String msg_content, Map<String, String> extrasparams) {
return PushPayload.newBuilder()
.setPlatform(Platform.android_ios())
.setAudience(Audience.all())
.setNotification(Notification.newBuilder()
.setAlert(notification_title)
.addPlatformNotification(AndroidNotification.newBuilder()//android推送设置
.setAlert(notification_title)
.setTitle(notification_title)//设置通知标题
.addExtras(extrasparams)//设置附加字段map 也可以设置(key,value)格式
.build()
)
.addPlatformNotification(IosNotification.newBuilder()//ios推送设置
//传一个IosAlert对象，指定apns title、title、subtitle等
.setAlert(notification_title)
//此项是指定此推送的badge自动加1
.incrBadge(1)
//此字段的值default表示系统默认声音；传sound.caf表示此推送以项目里面打包的sound.caf声音来提醒，
// 如果系统没有此音频则以系统默认声音提醒；此字段如果传空字符串，iOS9及以上的系统是无声音提醒，以下的系统是默认声音
.setSound("default")
.addExtras(extrasparams)
//此项说明此推送是一个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)//通知内容标题
.build())
.setOptions(Options.newBuilder()
//此字段的值是用来指定本推送要推送的apns环境，false表示开发，true表示生产；对android和自定义消息无意义
.setApnsProduction(false)
//此字段是给开发者自己给推送编号，方便推送者分辨推送记录
.setSendno(1)
//此字段的值是用来指定本推送的离线保存时长，如果不传此字段则默认保存一天，最多指定保留十天，单位为秒
.setTimeToLive(86400)
.build()
)
.build();
}
/**
* 给指定设备id推送所有设备
* @param registrationId 设备id
* @param notification_title 通知标题
* @param msg_title 消息标题
* @param msg_content 消息内容
* @param extrasparams 附加字段
* @return
*/
private static PushPayload buildPushObject_all_registrationId_alertWithTitle(String registrationId,String notification_title, String msg_title, String msg_content, Map<String, String> extrasparams) {
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)
.addExtras(extrasparams)
.build())
//指定当前推送的iOS通知
.addPlatformNotification(IosNotification.newBuilder()
//传一个IosAlert对象，指定apns title、title、subtitle等
.setAlert(notification_title)
.incrBadge(1)
//此字段的值default表示系统默认声音；传sound.caf表示此推送以项目里面打包的sound.caf声音来提醒，
// 如果系统没有此音频则以系统默认声音提醒；此字段如果传空字符串，iOS9及以上的系统是无声音提醒，以下的系统是默认声音
.setSound("sound.caf")
//此字段为透传字段，不会显示在通知栏。用户可以通过此字段来做一些定制需求，如特定的key传要指定跳转的页面（value）
//此项说明此推送是一个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)
.addExtras(extrasparams)
.build())
.setOptions(Options.newBuilder()
//此字段的值是用来指定本推送要推送的apns环境，false表示开发，true表示生产；对android和自定义消息无意义
.setApnsProduction(false)
//此字段是给开发者自己给推送编号，方便推送者分辨推送记录
.setSendno(1)
//此字段的值是用来指定本推送的离线保存时长，如果不传此字段则默认保存一天，最多指定保留十天；
.setTimeToLive(86400)
.build())
.build();
}
/**
* 别名
* @param bieming
* @param notification_title
* @param msg_title
* @param msg_content
* @param extrasparam
* @return
*/
private static PushPayload buildPushObject_all_BieMing_alertWithTitle(String bieming,String notification_title, String msg_title, String msg_content, Map<String, String> extrasparams) {
return PushPayload.newBuilder()
//指定要推送的平台，all代表当前应用配置了的所有平台，也可以传android等具体平台
.setPlatform(Platform.all())
//指定推送的接收对象，all代表所有人，也可以指定已经设置成功的tag或alias或该应应用客户端调用接口获取到的registration id
.setAudience(Audience.alias(bieming))
//jpush的通知，android的由jpush直接下发，iOS的由apns服务器下发，Winphone的由mpns下发
//jpush的通知，android的由jpush直接下发，iOS的由apns服务器下发，Winphone的由mpns下发
.setNotification(Notification.newBuilder()
.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）
.addExtras(extrasparams)
//此项说明此推送是一个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)
.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, Map<String, String> extrasparams) {
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）
.addExtras(extrasparams)
.build())
.build()
)
//Platform指定了哪些平台就会像指定平台中符合推送条件的设备进行推送。 jpush的自定义消息，
// sdk默认不做任何处理，不会有通知提示。建议看文档http://docs.jpush.io/guideline/faq/的
// [通知与自定义消息有什么区别？]了解通知和自定义消息的区别
.setMessage(Message.newBuilder()
.setMsgContent(msg_content)
.setTitle(msg_title)
.addExtras(extrasparams)
.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) {
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）
//此项说明此推送是一个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();
}
}
- 需要的jar包及文件
https://pan.baidu.com/s/190qj7fvIMcaNqkOPANsmrA
提取码:qggf
