【转载】极光推送使用实例（一）服务端

左手的ㄟ右手 2022-08-21 10:38 319阅读 0赞

最近一直在做后台开发，但心里还是总惦记着Android，感觉还是Android有意思。正好项目中要用到极光推送，今天抽空来记录下这两天的研究成果。

我们知道IOS有自己的推送服务，但很遗憾Android没有原生的推送服务，现在有很多第三方的推送服务，比如个推、极光、亚马逊、百度云、聚能等。今天我们就来研究下极光推送的后台服务器如何实现。

关键点：

1.首先最好是把极光官网java后台服务器的demo下载下来，里面有我们需要的jar包，以及example.

2.极光推送的关键jpushClient = new JPushClient(masterSecret, appKey, 3);就是这个类。其中的参数需要我们从极光官网注册开发者，然后创建具体项目获取相应的两                 个key值。其中appKey值就是我们手机端对应的key值

3.极光推送给我们提供了很多种推送的方式，我们可以选择某一个平台进行推送（Android ,IOS ,Windows Phone），也可以全部推送；我们可以针对某个特别的用户进行推送（设置alisa），也可以针对特别的群体进行推送（设置tag），第三个参数是设置推送保留的时间，只要在有效时间内上线就可以收到推送信息

4. 极光推送现在都用https连接，提交请求是post，获取数据为get

ok 接下来就看服务端的实现（JAVA）,JdPush推送方法+一个Servlet

:![极光推送 使用实例 （一）服务端 - 柏杨树 - 柏杨树的博客][_ _ - _ -]

**\[java\]**  [view plain][] [copy][view plain]

1.  **package** com.weiwend.jdpush;  
2.    
3.  **import** org.slf4j.Logger;  
4.  **import** org.slf4j.LoggerFactory;  
5.    
6.  **import** cn.jpush.api.JPushClient;  
7.  **import** cn.jpush.api.common.resp.APIConnectionException;  
8.  **import** cn.jpush.api.common.resp.APIRequestException;  
9.  **import** cn.jpush.api.push.PushResult;  
10. **import** cn.jpush.api.push.model.Message;  
11. **import** cn.jpush.api.push.model.Options;  
12. **import** cn.jpush.api.push.model.Platform;  
13. **import** cn.jpush.api.push.model.PushPayload;  
14. **import** cn.jpush.api.push.model.audience.Audience;  
15. **import** cn.jpush.api.push.model.audience.AudienceTarget;  
16. **import** cn.jpush.api.push.model.notification.AndroidNotification;  
17. **import** cn.jpush.api.push.model.notification.IosNotification;  
18. **import** cn.jpush.api.push.model.notification.Notification;  
19.   
20. **public** **class** Jdpush \{  
21.      **protected** **static** **final** Logger LOG = LoggerFactory.getLogger(Jdpush.**class**);  
22.   
23.      // demo App defined in resources/jpush-api.conf   
24.   
25.     **public** **static** **final** String TITLE = "申通快递";  
26.     **public** **static** **final** String ALERT = "祝大家新春快乐";  
27.     **public** **static** **final** String MSG\_CONTENT = "申通快递祝新老客户新春快乐";  
28.     **public** **static** **final** String REGISTRATION\_ID = "0900e8d85ef";  
29.     **public** **static** **final** String TAG = "tag\_api";  
30.       
31.     **public**  **static** JPushClient jpushClient=**null**;  
32.       
33.     **public** **static** **void** testSendPush(String appKey ,String masterSecret) \{  
34.           
35.           
36.           
37.          jpushClient = **new** JPushClient(masterSecret, appKey, 3);  
38.           
39.         // HttpProxy proxy = new HttpProxy("localhost", 3128);  
40.         // Can use this https proxy: https://github.com/Exa-Networks/exaproxy  
41.          
42.           
43.         // For push, all you need do is to build PushPayload object.  
44.         //PushPayload payload = buildPushObject\_all\_all\_alert();  
45.          //生成推送的内容，这里我们先测试全部推送  
46.         PushPayload payload=buildPushObject\_all\_alias\_alert();  
47.           
48.           
49.         **try** \{  
50.             System.out.println(payload.toString());  
51.             PushResult result = jpushClient.sendPush(payload);  
52.             System.out.println(result+"................................");  
53.               
54.             LOG.info("Got result - " + result);  
55.               
56.         \} **catch** (APIConnectionException e) \{  
57.             LOG.error("Connection error. Should retry later. ", e);  
58.               
59.         \} **catch** (APIRequestException e) \{  
60.             LOG.error("Error response from JPush server. Should review and fix it. ", e);  
61.             LOG.info("HTTP Status: " + e.getStatus());  
62.             LOG.info("Error Code: " + e.getErrorCode());  
63.             LOG.info("Error Message: " + e.getErrorMessage());  
64.             LOG.info("Msg ID: " + e.getMsgId());  
65.         \}  
66.     \}  
67.       
68.     **public** **static** PushPayload buildPushObject\_all\_all\_alert() \{  
69.         **return** PushPayload.alertAll(ALERT);  
70.     \}  
71.       
72.     **public** **static** PushPayload buildPushObject\_all\_alias\_alert() \{  
73.         **return** PushPayload.newBuilder()  
74.                 .setPlatform(Platform.all())//设置接受的平台  
75.                 .setAudience(Audience.all())//Audience设置为all，说明采用广播方式推送，所有用户都可以接收到  
76.                 .setNotification(Notification.alert(ALERT))  
77.                 .build();  
78.     \}  
79.       
80.     **public** **static** PushPayload buildPushObject\_android\_tag\_alertWithTitle() \{  
81.         **return** PushPayload.newBuilder()  
82.                 .setPlatform(Platform.android())  
83.                 .setAudience(Audience.all())  
84.                 .setNotification(Notification.android(ALERT, TITLE, **null**))  
85.                 .build();  
86.     \}  
87.       
88.     **public** **static** PushPayload buildPushObject\_android\_and\_ios() \{  
89.         **return** PushPayload.newBuilder()  
90.                 .setPlatform(Platform.android\_ios())  
91.                 .setAudience(Audience.tag("tag1"))  
92.                 .setNotification(Notification.newBuilder()  
93.                         .setAlert("alert content")  
94.                         .addPlatformNotification(AndroidNotification.newBuilder()  
95.                                 .setTitle("Android Title").build())  
96.                         .addPlatformNotification(IosNotification.newBuilder()  
97.                                 .incrBadge(1)  
98.                                 .addExtra("extra\_key", "extra\_value").build())  
99.                         .build())  
100.                 .build();  
101.     \}  
102.       
103.     **public** **static** PushPayload buildPushObject\_ios\_tagAnd\_alertWithExtrasAndMessage() \{  
104.         **return** PushPayload.newBuilder()  
105.                 .setPlatform(Platform.ios())  
106.                 .setAudience(Audience.tag\_and("tag1", "tag\_all"))  
107.                 .setNotification(Notification.newBuilder()  
108.                         .addPlatformNotification(IosNotification.newBuilder()  
109.                                 .setAlert(ALERT)  
110.                                 .setBadge(5)  
111.                                 .setSound("happy")  
112.                                 .addExtra("from", "JPush")  
113.                                 .build())  
114.                         .build())  
115.                  .setMessage(Message.content(MSG\_CONTENT))  
116.                  .setOptions(Options.newBuilder()  
117.                          .setApnsProduction(**true**)  
118.                          .build())  
119.                  .build();  
120.     \}  
121.       
122.     **public** **static** PushPayload buildPushObject\_ios\_audienceMore\_messageWithExtras() \{  
123.         **return** PushPayload.newBuilder()  
124.                 .setPlatform(Platform.android\_ios())  
125.                 .setAudience(Audience.newBuilder()  
126.                         .addAudienceTarget(AudienceTarget.tag("tag1", "tag2"))  
127.                         .addAudienceTarget(AudienceTarget.alias("alias1", "alias2"))  
128.                         .build())  
129.                 .setMessage(Message.newBuilder()  
130.                         .setMsgContent(MSG\_CONTENT)  
131.                         .addExtra("from", "JPush")  
132.                         .build())  
133.                 .build();  
134.     \}  
135. \}

可以看到上面我们推送平台设置的是所有平台，Audience设置为all（所有用户），这里key值和masterSecret值放在servlet中了。

servlet很简单，只要传入两个key值，调用该方法就可以

**\[java\]**  [view plain][] [copy][view plain]

1.  **package** com.weiwend.jdpush.servlet;  
2.    
3.  **import** java.io.IOException;  
4.    
5.  **import** javax.servlet.ServletException;  
6.  **import** javax.servlet.http.HttpServlet;  
7.  **import** javax.servlet.http.HttpServletRequest;  
8.  **import** javax.servlet.http.HttpServletResponse;  
9.    
10. **import** com.sun.org.apache.xml.internal.serializer.utils.Utils;  
11. **import** com.weiwend.jdpush.Jdpush;  
12. **import** com.weiwend.jdpush.utils.Base64Utils;  
13.   
14. /\*\* 
15.  \* Servlet implementation class tuisong 
16.  \*/  
17. **public** **class** tuisong **extends** HttpServlet \{  
18.     **private** **static** **final** **long** serialVersionUID = 1L;  
19.          
20.     **private** **static** **final** String appKey ="84cf5ee2099c654aa03a5d70";  
21.     **private** **static** **final** String masterSecret = "7cf23f25a41806d5fd29e3c5";  
22.       
23.     **public** tuisong() \{  
24.         **super**();  
25.         // TODO Auto-generated constructor stub  
26.     \}  
27.   
28.     /\*\* 
29.      \* @see HttpServlet\#doGet(HttpServletRequest request, HttpServletResponse response) 
30.      \*/  
31.     **protected** **void** doGet(HttpServletRequest request, HttpServletResponse response) **throws** ServletException, IOException \{  
32.         Jdpush.testSendPush(appKey,masterSecret);  
33.         System.out.println("sucess");  
34.     \}  
35.   
36.     /\*\* 
37.      \* @see HttpServlet\#doPost(HttpServletRequest request, HttpServletResponse response) 
38.      \*/  
39.     **protected** **void** doPost(HttpServletRequest request, HttpServletResponse response) **throws** ServletException, IOException \{  
40.         // TODO Auto-generated method stub  
41.     \}  
42.   
43. \}

最后来看下运行的结果，可以看到，提交数据是以json格式。如果返回\{"msg\_id":1663001319,"sendno":1981162191\}这样数据说明推送已经成功发送

**\[java\]**  [view plain][] [copy][view plain]

1.  \{ "platform":"all","audience":"all","notification":\{ "alert":"祝大家新春快乐"\},"options":\{ "sendno":1981162191,"apns\_production":**false**\}\}  
2.  \{ "msg\_id":1663001319,"sendno":1981162191\}................................  
3.  sucess

源码分析：

JPushClient jpushClient = new JPushClient(masterSecret, appKey, 3);实际上是实例化了一下三个类

**\[java\]**  [view plain][] [copy][view plain]

1.  **public** JPushClient(String masterSecret, String appKey, **int** maxRetryTimes) \{  
2.          \_pushClient = **new** PushClient(masterSecret, appKey, maxRetryTimes);  
3.          \_reportClient = **new** ReportClient(masterSecret, appKey, maxRetryTimes);  
4.          \_deviceClient = **new** DeviceClient(masterSecret, appKey, maxRetryTimes);  
5.      \}

PushPayload payload = buildPushObject\_all\_all\_alert();，PushPayload类里包含了传递和返回的所有数据

**\[java\]**  [view plain][] [copy][view plain]

1.  **public** **class** PushPayload **implements** PushModel \{  
2.      **private** **static** **final** String PLATFORM = "platform";  
3.      **private** **static** **final** String AUDIENCE = "audience";  
4.      **private** **static** **final** String NOTIFICATION = "notification";  
5.      **private** **static** **final** String MESSAGE = "message";  
6.      **private** **static** **final** String OPTIONS = "options";  
7.        
8.      **private** **static** **final** **int** MAX\_GLOBAL\_ENTITY\_LENGTH = 1200;  // Definition acording to JPush Docs  
9.      **private** **static** **final** **int** MAX\_IOS\_PAYLOAD\_LENGTH = 220;  // Definition acording to JPush Docs  
10.       
11.     **private** **static** Gson \_gson = **new** Gson();  
12.       
13.     **private** **final** Platform platform;  
14.     **private** **final** Audience audience;  
15.     **private** **final** Notification notification;  
16.     **private** **final** Message message;  
17.     **private** Options options;  
18.       
19.       
20.     **private** PushPayload(Platform platform, Audience audience,   
21.             Notification notification, Message message, Options options) \{  
22.         **this**.platform = platform;  
23.         **this**.audience = audience;  
24.         **this**.notification = notification;  
25.         **this**.message = message;  
26.         **this**.options = options;  
27.     \}

PushResult result = jpushClient.sendPush(payload);可以看到就是sendPost方法，然后接受返回的数据

**\[java\]**  [view plain][] [copy][view plain]

1.  **public** PushResult sendPush(PushPayload pushPayload) **throws** APIConnectionException, APIRequestException \{  
2.         Preconditions.checkArgument(! (**null** == pushPayload), "pushPayload should not be null");  
3.           
4.         **if** (\_globalSettingEnabled) \{  
5.             pushPayload.resetOptionsTimeToLive(\_timeToLive);  
6.             pushPayload.resetOptionsApnsProduction(\_apnsProduction);  
7.         \}  
8.           
9.         ResponseWrapper response = \_httpClient.sendPost(\_baseUrl + PUSH\_PATH, pushPayload.toString());  
10.          
11.        **return** BaseResult.fromResponse(response, PushResult.**class**);  
12.    \}

另外我专门找了下sendNo如何生成的，其实就是随机生成的一个数字

**\[java\]**  [view plain][] [copy][view plain]

1.  **public** **static** Options sendno() \{  
2.         **return** newBuilder().setSendno(ServiceHelper.generateSendno()).build();  
3.     \}

**\[java\]**  [view plain][] [copy][view plain]

1.  **public** **static** **int** generateSendno() \{  
2.         **return** RANDOM.nextInt((MAX - MIN) + 1) + MIN;  
3.     \}

大家有兴趣也可以详细看一下代码的实现.

刚开始值直接下载的demo运行，一直提示Audience没有对应的用户，是引文Audience设置了别名alias，而用户里面并没有设置对应的alias，所以找不到对应的用户。

最后我们来看一张图，再深入理解下极光推送的原理 ![极光推送 使用实例 （一）服务端 - 柏杨树 - 柏杨树的博客][_ _ - _ - 1]

[_ _ - _ -]: /images/20220724/26b7b0426aa24a18ba5ee9c810f1a5e4.png
[view plain]: http://blog.csdn.net/u014733374/article/details/43560983#
[_ _ - _ - 1]: /images/20220724/13fd08f2ce714328a9b3811734be18b0.png

发表评论取消回复

表情：

评论列表（有 0 条评论，319人围观）

还没有评论，来说两句吧...

相关阅读

相关极光推送后端使用

[官方开发包及示例][Link 1] [官方api文档][api] 开发包

超、凢脫俗/ 2023年08月17日 15:21/ 0 赞/ 125 阅读

相关集成推送(极光+小米+华为)总结(java服务端)

公司app集成了极光推送，前前后后在这上面费了不少时间了，总结下自己的理解和遇到的问题。只用过极光推送,所以下面都以极光推送为例。（后面新增小米和华为） 1.

骑猪看日落/ 2023年07月01日 08:36/ 0 赞/ 12 阅读

相关【极光推送】jpush服务端开发详尽过程

前言今天突然要做一个手机的推送消息功能，综合了网上各路大神的意见最终选择了极光推送。然而作为一个从来没开发过web项目的人来说，大神们说的很简单的官网教程让我看的一头雾水。

客官°小女子只卖身不卖艺/ 2022年08月21日 10:38/ 0 赞/ 303 阅读

相关【转载】极光推送使用实例（一）服务端

最近一直在做后台开发，但心里还是总惦记着Android，感觉还是Android有意思。正好项目中要用到极光推送，今天抽空来记录下这两天的研究成果。我们知道

左手的ㄟ右手/ 2022年08月21日 10:38/ 0 赞/ 320 阅读

相关使用极光推送实现分组发送和服务端集成

　　推送功能在手机应用开发中越来越重要，几乎成为所有App必备的功能，由于Android本身没有消息推送机制，通常采用的是基于XMPP协议的推送，但这种开发很麻烦，因此在市场上

朱雀/ 2022年08月18日 02:18/ 0 赞/ 151 阅读

相关极光推送服务端向手机app即时推送消息或通知

`以前一直在做后台开发，对消息的推送很感兴趣，正好项目中要用到极光推送，今天抽空来记录下这两天的研究成果。` 我们知道IOS有自己的推送服务，但很遗憾Android没有原生的

╰+哭是因爲堅強的太久メ/ 2022年07月24日 08:24/ 0 赞/ 381 阅读

相关极光推送

1. 引入maven依赖  <dependency>

╰+哭是因爲堅強的太久メ/ 2022年05月25日 14:26/ 0 赞/ 396 阅读

相关极光推送服务端参考

官网：[https://www.jiguang.cn/][https_www.jiguang.cn] 文档：[https://docs.jiguang.cn/][https

亦凉/ 2022年05月08日 14:12/ 0 赞/ 353 阅读

相关 app推送-极光推送

> 会不会有小伙伴一脸懵逼，问我什么是App推送? 先甩一个熟悉的界面。这些就是推送。 ![file][] 这些推送有什么作用呢，我百度百科了一下好处 ![201812

ゝ一世哀愁。/ 2022年04月08日 16:48/ 0 赞/ 538 阅读

相关极光推送

[2019独角兽企业重金招聘Python工程师标准>>> ][2019_Python_] ![hot3.png][] 极光推送消息推送转载于:https://my.os

我就是我/ 2022年01月14日 09:37/ 0 赞/ 423 阅读