首页 > 代码库 > 通过PhoneGap在Android上去推送通知

通过PhoneGap在Android上去推送通知

需求

必备知识

这篇文章至少需要有过一个中等层次的PhoneGap的开发经验

必须产品

PhoneGap Build


用户级

全部适用


上一篇文章是通过PhoneGap能够在苹果设备上推送通知。在这篇文章中,我将会讲解如何在Android平台上使用PhoneGap去推送通知。通过对比,我发下我的通知在Android设备上的推送速度更快。


Google Cloud Messaging


Android的通知推送可以通过 GoogleCloud Messaging(GCM)的服务,这个和苹果的通知推送服务相似。以前它们都是对C2DM支持(用于云与设备之间消息传递的框架),但是现在那些API已经放弃使用了,还有就是GoogleCloud Message提供了更多增强实现,这些都是C2DM所提供不到的。通过 Cordova/PhoneGap 插件能够帮组你利用到GoogleCloud Messaging的服务。


消息的大小分配给GCM的净负荷是4kb(只是字符串数据),明显地比苹果推送所要求的256个位要大很多。这里有一篇文章关于这些消息发送到底支持那些数据类型。还有我建议你在你构建你的应用程序之前先在这里阅读一下应该怎样去使用这样服务,因为我在这篇文章中很多关于这方面的细节都没有讨论到。某些点我需要在这篇文章中着重强调一下是:

  • GCM并不保证消息的分发或者它的顺序。
  • 并不需要在一个Android设备上运行一个Android应用才能接受到消息。其实它是通过网络的广播,当一个消息到达的时候,系统就会唤醒Android应用,当然这需要你为你的应用程序设置好正确的广播接受者和权限。
  • GCM并不提供任何内建的用户接口或者消息的处理。GCM只是简单的传递没处理过的消息数据然后直接送到对应的Android应用上,这样你就拥有全部对数据处理的权利。例如应用可以发送一个通知、显示一个自定义的用户接口或者悄悄地同步数据。

设置如何去推送通知

通过这些步骤就能在你的Android 应用程序去推送通知:

1.      通过命令行工具或者Eclipse去创建一个AndroidCordova 项目(我们推荐使用命令行)

2.      下载GCM Cordova 插件

3.      跟着插件说明的以下步骤:

  •   要跟着说明文档所写地去设置你的Google Cloud Messaging 帐号和注意记下位于URL中的项目ID。举个例子,下面加粗的数字就是你需要发送给register()方法:






  1. <?xml:namespace prefix = "o" />

  2. https://code.google.com/apis/console/?pli=1#project:824841663942
复制代码


  •   不要忘记将以下代码换成你的GCM项目的ID






  1. window.GCM.register("[your_sender_id]", "GCM_Event", GCM_Success, GCM_Fail );
复制代码




  •   包含你的发送器的ID






  1. window.GCM.register("824841663942", "GCM_Event", GCM_Success, GCM_Fail );
复制代码




4. 当一个应用接受到一个消息的时候要为它添加处理函数决定它是否打开。例如你可能会显示一个弹出警告或者一个状态栏通知。

Note:这个插件将会处理GCM的登记,并有对应的方法去接收一个消息,但它实际上并不为这些通知做出响应,这些就是你需要添加的东西。你也可以去更深入阅读关于如何了解怎么添加原生代码去产生一个状态栏通知。


如果你需要更多有关于创建GCM项目的资料,某些特定的步骤你可以在这里找到。


PhoneGap插件包含一个简单的项目,并已经为通知推送设置寄存器,包括改变了AndroidManifest.xml和插件的配置。而你所要做的事就是修改CORDOVA_GCM_script.js文件,这样你就能够在你的register()函数里面使用GCM发送者/项目的ID,这有你立马运行它或者将这个项目作为参考并根据自己的需求做修改。


如果你偏向于利用Eclipse去编写你的代码,那么你简单地通过导入之前所创建并包含该插件的Android项目,这样你就可以开始你的工作了。

1. Choose File | New |Project

2. 选择“Android Project from Existing Code”

android-push-notifications-with-phonegap-fig01.jpg

2013-5-14 16:04:00 上传
下载附件 (23.84 KB)

图1.选择“Android Project from Existing Code”。


运行示例应用

当你运行插件中的示例代码时,它会尝试自动注册你的设备。如果注册成功,你会看到消息中包含一个注册ID。(看看下面截图中我圈起来的REGID字符串,这是我在我的Galaxy Tablet中运行得到的结果)

android-push-notifications-with-phonegap-fig02.jpg

2013-5-14 16:04:00 上传
下载附件 (14.69 KB)

图2:你会看到消息中包含一个注册的ID

当然你也应该可以在你的控制面板中看看一下的输出:




  1. 10-24 18:24:20.720: V/GCMReceiver:onRegistered(21989): Registration ID arrived!
  2. 10-24 18:24:20.730: V/GCMReceiver:onRegisterd(21989): {"regid":"APA91bFobAwM7P3Okxy2al8RI12VcJFUS-giXWTOoWXIObtSPOE1h7FuH1VPLBPgshDI_Fp7aIYVET-ssvGUErlWYA0cKPGhoXT1daqyDsEfem9ZtgZNRhQFv7kLCIVSigYlpMluToPiSHSsFSEdtCDfKoOZqNPsfg","event":"registered"}
  3. 10-24 18:24:20.730: V/GCMPlugin:sendJavascript(21989): javascript:GCM_Event({"regid":"APA91bFobAwM7P3Okxy2al8RI12VcJFUS-giXWTOoWXIObtSPOE1h7FuH1VPLBPgshDI_Fp7aIYVET-ssvGUErlWYA0cKPGhoXT1daqyDsEfem9ZtgZNRhQFv7kLCIVSigYlpMluToPiSHSsFSEdtCDfKoOZqNPsfg","event":"registered"})
复制代码




一旦你得到了像以上所示的注册ID,你就可以开始编写你的服务端代码。以下的部分将会讲解怎么使用Node.JS代码去发送一条消息给你的应用程序。或者,你也可以使用Urban Airship或者PushWoosh去发送一个通知。当收到这个消息时,你将会看到如下面截图所示的文本显示在屏幕上:

android-push-notifications-with-phonegap-fig03.jpg

2013-5-14 16:04:01 上传
下载附件 (13.26 KB)

图3.当收到一条消息时,你将会看到这些信息显示出来。


这是虽然这个插件不做任何的处理。接下来的部分我们将会讲解通过添加一些代码使得但接收到一条消息的时候将会显示一个状态栏通知。


状态栏通知


由于这个插件只是简单地接收消息——不管你的应用程序是否是在运行——但是即使消息到达了也没有做任何处理,你决定它应该做出怎样的响应。一个常见的需求就是把这个消息显示在一个原生的状态栏上。在IOS上,这个过程会有所不同,这个通知会被自动显示。但是在Android上你需要为它编写明确的代码。


其中一个选择就是使用Cordova StatusBarNotification 插件去实现这样的效果。如果你想用更快的解决方案,你可以通过简单添加原生的Java代码到你的GCMIntentService.javaonMessage()方法里面,就像一下代码那样:


  1. String message = extras.getString("message");
  2. String title = extras.getString("title");
  3. Notification notif = new Notification(android.R.drawable.btn_star_big_on, message, System.currentTimeMillis() );
  4. notif.flags = Notification.FLAG_AUTO_CANCEL;
  5. notif.defaults |= Notification.DEFAULT_SOUND;
  6. notif.defaults |= Notification.DEFAULT_VIBRATE;

  7. Intent notificationIntent = new Intent(context, TestSampleApp.class);
  8. notificationIntent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
  9. PendingIntent contentIntent = PendingIntent.getActivity(context, 0, notificationIntent, 0);

  10. notif.setLatestEventInfo(context, title, message, contentIntent);
  11. String ns = Context.NOTIFICATION_SERVICE;
  12. NotificationManager mNotificationManager = (NotificationManager)
  13. context.getSystemService(ns);
  14. mNotificationManager.notify(1, notif);
复制代码



还有要记得要添加以下的导入,这样上面的代码才能实现:





  1. import android.app.Notification;
  2. import android.app.NotificationManager;
  3. import android.app.PendingIntent;
复制代码




要确定你已经使用YourActivityClassName.class替换继承至DroidGap的子类的名字。例如,在示例项目中我们叫它MainActivity。


以上的代码将会设置一个带有一个星星图片的通知,并伴随震动和默认声音。这个例子已经在我的Android Galaxy Tablet上运行了,图如下所示(红色圈圈标记)


android-push-notifications-with-phonegap-fig04.jpg

2013-5-14 16:04:02 上传
下载附件 (20.39 KB)

图4.状态栏通知(包含星型图片和震动、默认声音)


当你点击这个通知后,那么应用程序将会打开并显示它说真实收到的消息。

android-push-notifications-with-phonegap-fig05.jpg

2013-5-14 16:04:03 上传
下载附件 (13.26 KB)

图5.点击那个通知将会触发应用程序打开并显示它所收到的消息。


状态栏的显示因不同的设备而有所不同。在一般的Android手机上,是会显示在最上面而不是像我的截图那样显示在底端。


通过node-gcm去发送一条消息


这里是通过Node.js 库使得Google Cloud Messaging去发送通知。它被称为称为node-gcm。下面的这些代码是为了让我的设备能发送一条消息。

相信你们注意到我改变了那些键。在发送的参数中,用你在申请Google Cloud Messaging 服务时Google给你的ID去指定你自己的API键。你会收到两个API键,一个浏览器键和服务器键,这里两个可能都会用到。如果其中一个不能用,试一下另外一个。还有就是当你注册使用到以上插件的时候,也要指定返回给你的应用程序的值。当你运行你的应用程序并调用GCM register函数的时候,注册的ID将会在你的屏幕和控制台上显示。





  1. var gcm = require(‘node-gcm‘);

  2. var message = new gcm.Message();
  3. var sender = new gcm.Sender(‘AIzaSyCDx8v9R0fMsAsjoAffF-P3FCFWXlvwKgL‘);
  4. var registrationIds = [];

  5. message.addData(‘title‘,‘My Game‘);
  6. message.addData(‘message‘,‘Your turn!!!!‘);
  7. message.addData(‘msgcnt‘,‘1‘);
  8. message.collapseKey = ‘demo‘;
  9. message.delayWhileIdle = true;
  10. message.timeToLive = 3;

  11. // At least one token is required - each app registers a different token
  12. registrationIds.push(‘APA91bFobAwN7P3Okxy2al8RI12VcJFUS-giXWTOoWXIObtSPOE1h7FuH1VPLBPgshDI_Fp7aIYVET-ssvGUErlWYA0cKPGhoXT1daqyDsEfem9ZtgZNRhQFv7kLCIVSigYlpMluToPiSHSsFSEdtCDfKoOZqNPgfs‘);

  13. /**
  14. * Parameters: message-literal, registrationIds-array, No. of retries, callback-function
  15. */
  16. sender.send(message, registrationIds, 4, function (result) {
  17.     console.log(result);
  18. });
  19. /** Use the following line if you want to send the message without retries
  20. sender.sendNoRetry(message, registrationIds, function (result) {
  21. console.log(result); });
  22. **/
复制代码




要为title键和message键明确地指定titlemessage,因为程序的插件将会在GCMIntentService.java中查找它:


  1. Bundle extras = intent.getExtras();
  2.     if (extras != null) {
  3.         try {
  4.           String title = extras.getString("title");
  5.           String message = extras.getString("message");
  6.           ....
  7.         }
  8.      }
复制代码




折叠键

根据Android的开发文档,当你定义一个折叠键时,它只会分发给你最后收到的通知和一个给定的折叠键,为了不让用户被“过多的通知”烦扰例如像体育比赛中的分数。

android-push-notifications-with-phonegap-fig06.jpg

2013-5-14 16:04:04 上传
下载附件 (23.25 KB)

图6.为title键和message键指定明确的title和message。注意在弹出列表中所出现的状态栏通知(如果被受理),像图7所示

android-push-notifications-with-phonegap-fig07.jpg

2013-5-14 16:04:04 上传
下载附件 (23.86 KB)

图7.状态栏通知在弹出框中显示


其它可供选择的插件

迟点我将会解释那些你在Android上使用Cordova去推送通知时要用到的资料,你可能会想到在GitHub那里的另外一个插件。这个插件是为了能够让捏充分利用PushWoosh去推送通知而设计出来的,这个我在我的博文中发布过,“使用Pushwoosh让你能够简单通过PhoneGap去推送通知”。这个插件的API和IOS上的Cordova 通知推送插件类似,有趣的是,当我测试它的时候,即使不在PushWoosh服务器的环境下,我的Node.js服务仍然能够接收到所推送的消息。此外,我并不需要添加任何原生的Java代码,能够让上面的状态栏通知显示。


下一步

以下的这些连接你可能需要点击进去看一下

  •   通过Pushwoosh去利用PhoneGap去推送通知

  •   Cordovapush项目——依据node-apnnode-gcm的跨平台的推送服务。

  •   Urban Airship 通知推送服务器——融合了PhoneGap



这些只能在CreativeCommons Attribution-Noncommercial-Share Alike 3.0 Unported License的许可下被运用到。权限只能在许可范围内,关于这个例子的代码(包括项目中用到的)都可以在Adobe上找到。

原文链接:http://www.adobe.com/devnet/phonegap/articles/android-push-notifications-with-phonegap.html

通过PhoneGap在Android上去推送通知