极光推送之服务器端向android等客户端推送实例

1. 原文：http://blog.csdn.net/u014733374/article/details/43560983

   找了两天，总算找到一个靠谱的了。开始测试的时候总是报各种错误，尤其是不能找到audience的错误，偶然想到，用极光开放平台集成的客户端，果不其然OK了。
   

   java端示例demo 下载位置 https://github.com/jpush/jpush-api-java-client/releases
   

   最近一直在做后台开发，但心里还是总惦记着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

   :

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

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

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

[java]  view plain copy

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

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

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

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

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

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

[java]  view plain copy

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

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

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

最后我们来看一张图，再深入理解下极光推送的原理

=============分组还是个人，一个参数分分钟搞定==================