原创作品,可以转载,但是请标注出处地址http://www.cnblogs.com/V1haoge/p/6439313.html
Java后台实现极光推送有两种方式,一种是使用极光推送官方提供的推送请求API:https://api.jpush.cn/v3/push,另一种则是使用官方提供的第三方Java SDK,这里先进行第一种方式推送的实现代码:
import org.apache.http.HttpResponseimport org.apache.http.client.HttpClient
import org.apache.http.client.methods.HttpPost
import org.apache.http.entity.StringEntity
import org.apache.http.impl.client.DefaultHttpClient
import org.apache.http.util.EntityUtils
import org.slf4j.Logger
import org.slf4j.LoggerFactory
import com.alibaba.fastjson.JSONArray
import net.sf.json.JSONObject
import sun.misc.BASE64Encoder
/**
* java后台极光推送方式一:使用Http API
* 此种方式需要自定义http请求发送客户端:HttpClient
*/
@SuppressWarnings({ "deprecation", "restriction" })
public class JiguangPush {
private static final Logger log = LoggerFactory.getLogger(JiguangPush.class)
private String masterSecret = "xxxxxxxxxxxxxxxxxxxx"
private String appKey = "xxxxxxxxxxxxxxxxxxx"
private String pushUrl = "https://api.jpush.cn/v3/push"
private boolean apns_production = true
private int time_to_live = 86400
private static final String ALERT = "推送信息"
/**
* 极光推送
*/
public void jiguangPush(){
String alias = "123456"//声明别名
try{
String result = push(pushUrl,alias,ALERT,appKey,masterSecret,apns_production,time_to_live)
JSONObject resData = JSONObject.fromObject(result)
if(resData.containsKey("error")){
log.info("针对别名为" + alias + "的信息推送失败!")
JSONObject error = JSONObject.fromObject(resData.get("error"))
log.info("错误信息为:" + error.get("message").toString())
}
log.info("针对别名为" + alias + "的信息推送成功!")
}catch(Exception e){
log.error("针对别名为" + alias + "的信息推送失败!",e)
}
}
/**
* 组装极光推送专用json串
* @param alias
* @param alert
* @return json
*/
public static JSONObject generateJson(String alias,String alert,boolean apns_production,int time_to_live){
JSONObject json = new JSONObject()
JSONArray platform = new JSONArray()//平台
platform.add("android")
platform.add("ios")
JSONObject audience = new JSONObject()//推送目标
JSONArray alias1 = new JSONArray()
alias1.add(alias)
audience.put("alias", alias1)
JSONObject notification = new JSONObject()//通知内容
JSONObject android = new JSONObject()//android通知内容
android.put("alert", alert)
android.put("builder_id", 1)
JSONObject android_extras = new JSONObject()//android额外参数
android_extras.put("type", "infomation")
android.put("extras", android_extras)
JSONObject ios = new JSONObject()//ios通知内容
ios.put("alert", alert)
ios.put("sound", "default")
ios.put("badge", "+1")
JSONObject ios_extras = new JSONObject()//ios额外参数
ios_extras.put("type", "infomation")
ios.put("extras", ios_extras)
notification.put("android", android)
notification.put("ios", ios)
JSONObject options = new JSONObject()//设置参数
options.put("time_to_live", Integer.valueOf(time_to_live))
options.put("apns_production", apns_production)
json.put("platform", platform)
json.put("audience", audience)
json.put("notification", notification)
json.put("options", options)
return json
}
/**
* 推送方法-调用极光API
* @param reqUrl
* @param alias
* @param alert
* @return result
*/
public static String push(String reqUrl,String alias,String alert,String appKey,String masterSecret,boolean apns_production,int time_to_live){
String base64_auth_string = encryptBASE64(appKey + ":" + masterSecret)
String authorization = "Basic " + base64_auth_string
return sendPostRequest(reqUrl,generateJson(alias,alert,apns_production,time_to_live).toString(),"UTF-8",authorization)
}
/**
* 发送Post请求(json格式)
* @param reqURL
* @param data
* @param encodeCharset
* @param authorization
* @return result
*/
@SuppressWarnings({ "resource" })
public static String sendPostRequest(String reqURL, String data, String encodeCharset,String authorization){
HttpPost httpPost = new HttpPost(reqURL)
HttpClient client = new DefaultHttpClient()
HttpResponse response = null
String result = ""
try {
StringEntity entity = new StringEntity(data, encodeCharset)
entity.setContentType("application/json")
httpPost.setEntity(entity)
httpPost.setHeader("Authorization",authorization.trim())
response = client.execute(httpPost)
result = EntityUtils.toString(response.getEntity(), encodeCharset)
} catch (Exception e) {
log.error("请求通信[" + reqURL + "]时偶遇异常,堆栈轨迹如下", e)
}finally{
client.getConnectionManager().shutdown()
}
return result
}
/**
* BASE64加密工具
*/
public static String encryptBASE64(String str) {
byte[] key = str.getBytes()
BASE64Encoder base64Encoder = new BASE64Encoder()
String strs = base64Encoder.encodeBuffer(key)
return strs
}
}
以上代码中使用的是第一种方式实现推送,下面介绍第二种方式:使用java SDK
import org.slf4j.Loggerimport org.slf4j.LoggerFactory
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.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
/**
* java后台极光推送方式二:使用Java SDK
*/
@SuppressWarnings({ "deprecation", "restriction" })
public class JiguangPush {
private static final Logger log = LoggerFactory.getLogger(JiguangPush.class)
private static String masterSecret = "xxxxxxxxxxxxxxxxx"
private static String appKey = "xxxxxxxxxxxxxxxx"
private static final String ALERT = "推送信息"
/**
* 极光推送
*/
public void jiguangPush(){
String alias = "123456"//声明别名
log.info("对别名" + alias + "的用户推送信息")
PushResult result = push(String.valueOf(alias),ALERT)
if(result != null && result.isResultOK()){
log.info("针对别名" + alias + "的信息推送成功!")
}else{
log.info("针对别名" + alias + "的信息推送失败!")
}
}
/**
* 生成极光推送对象PushPayload(采用java SDK)
* @param alias
* @param alert
* @return PushPayload
*/
public static PushPayload buildPushObject_android_ios_alias_alert(String alias,String alert){
return PushPayload.newBuilder()
.setPlatform(Platform.android_ios())
.setAudience(Audience.alias(alias))
.setNotification(Notification.newBuilder()
.addPlatformNotification(AndroidNotification.newBuilder()
.addExtra("type", "infomation")
.setAlert(alert)
.build())
.addPlatformNotification(IosNotification.newBuilder()
.addExtra("type", "infomation")
.setAlert(alert)
.build())
.build())
.setOptions(Options.newBuilder()
.setApnsProduction(false)//true-推送生产环境 false-推送开发环境(测试使用参数)
.setTimeToLive(90)//消息在JPush服务器的失效时间(测试使用参数)
.build())
.build()
}
/**
* 极光推送方法(采用java SDK)
* @param alias
* @param alert
* @return PushResult
*/
public static PushResult push(String alias,String alert){
ClientConfig clientConfig = ClientConfig.getInstance()
JPushClient jpushClient = new JPushClient(masterSecret, appKey, null, clientConfig)
PushPayload payload = buildPushObject_android_ios_alias_alert(alias,alert)
try {
return jpushClient.sendPush(payload)
} catch (APIConnectionException e) {
log.error("Connection error. Should retry later. ", e)
return null
} 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())
log.info("Msg ID: " + e.getMsgId())
return null
}
}
}
可以看出使用Java SDK实现推送的方式很简单,代码量也少,理解起来也不难,官方提供的SDK中讲很多内容都实现了,我们只是需要配置一下信息,然后发起推送即可。需要注意的是使用第二种方式,需要导入极光官网提供的jar包。
直接在maven中的pom文件中加入:
<dependency><groupId>cn.jpush.api</groupId>
<artifactId>jpush-client</artifactId>
<version>3.2.15</version>
</dependency> 注意:在这里极有可能会出现jar包冲突:具体哪个包我也忘记了,好像是个日志包,你找到后删除即可。
原本我们项目中也是采用第二种方式实现的,但是最后在提交代码时发现一个问题,那就是虽然我们只是带入了官网提供的那三个jar包,但是最后一统计,竟然无缘无故增多了80+个jar包,如此多的jar包提交过于臃肿,而且不现实,所以才临时改变方案,采用第一种方式进行编码。
代码中采用的是别名方式进行推送,需要在在手机APP端进行别名设置,最好就是在用户登录之后就设置好,这样只要用户登录一次,它的绑定别名就可以保存到极光服务器,而我们推送时,指定这个别名,就能将信息推送到对应用户的手机上。
其实我们发起推送请求,只是将信息发送到了极光服务器之上,这个信息有一个保存时限,默认一天,只要用户登录手机APP,极光服务器就会将信息自动推送到对应别名的手机上,由此可见,信息并非由我们后天直接推送到手机,而是通过极光服务器这个中转站,而这正式极光的工作。
注意:这里告知一个技巧,这个别名设置的时候,其实直接将用户ID设置为别名即可,既方便,又安全,不用再去想办法生成一个唯一的串来进行标识,甚至需要在后台数据库中用户表中新增字段。主动推送的优点就不用说啦,使用第三方的推送,省去应用开发者自己维护长连接的设备和人力的成本投入。工具/原料
移动开发包
方法/步骤
首先先去申请账号成为开发者。
这时会生成:开发者标识(DevKey) 和 API DevSecret
后面调用api时会使用到。
去资源下载页面下载对应的客户端sdk。
目前jpush只支持Android、ios、windows phone 三种系统。
步骤阅读
导入对应的SDK 开发包到你自己的应用程序项目。
按照这个步骤基本没啥,可以取手机的唯一标识给每个用户添加别名。
我这边就按登陆账号给每一个手机设置一个别名。
应用设置里面设置应用的基本信息
包名和AppKey必须与AndroidManifest.xml里配置的保持一致。
点击“推送”--“发送消息”
根据设备别名,发一个消息试试吧,指定别名如果不存在的话,会报错。
你也可以给所有设备发送消息
查看下历史记录消息成功发送出去了。
再去手机看看一切ok,正常接收。
客户端配置完成,具体推什么消息就交给服务器端去判断吧。
后续继续分享服务端API详细调用,欢迎关注!
jpush官方管理推送的页面具有各种推送功能选项,如果要推送单个用户,前提是你的软件在运行的时候注册了别名或者是标签:别名 alias
为安装了应用程序的用户,取个别名来标识。以后给该用户 Push 消息时,就可以用此别名来指定。
每个用户只能指定一个别名。
同一个应用程序内,对不同的用户,建议取不同的别名。这样,尽可能根据别名来唯一确定用户。
系统不限定一个别名只能指定一个用户。如果一个别名被指定到了多个用户,当给指定这个别名发消息时,服务器端API会同时给这多个用户发送消息。
举例:在一个用户要登录的游戏中,可能设置别名为 userid。游戏运营时,发现该用户 3 天没有玩游戏了,则根据 userid 调用服务器端API发通知到客户端提醒用户。
标签 tag
为安装了应用程序的用户,打上标签。其目的主要是方便开发者根据标签,来批量下发 Push 消息。
可为每个用户打多个标签。
不同应用程序、不同的用户,可以打同样的标签。
举例: game, old_page, women
欢迎分享,转载请注明来源:夏雨云
评论列表(0条)