[筆記] Google Cloud Messaging

Google Cloud Messaging的前身是Cloud to Device Messaging Framework (簡稱 C2DM )，目的是將資料傳送到手機端進行處理，常見的應用如Chrome to Phone或其他會發通知的app都靠此功能完成。

教學連結 GCM: Getting Started

前置工作

建立Google API Project

• 開啟Google Cloud Messaging for Android

開啟Google Cloud Messaging服務

• 取得API Key

當Server端要發送資料時會需要

• 取得Sender ID

Sender ID是Android裝置跟服務註冊的時候指定發送者的ID，我只知道從網址列這種看法…

取得Sender ID，內容是一串數字。

建立Android VM

這段不是一定要做，主要是如果當初本來就是選了Google APIs的AVD就沒必要，要是原本使用的是Android AVD，因為模擬器中沒有Google API相關的libary所以會發生錯誤。

選取Google APIs的AVD

安裝相關libary

如連結中教學所示，到SDK Manager選Extras勾選下載 Google Cloud Messaging for Android Library

裝置端程式

• 修改AndroidManifest.xml

限制最低支援SDK版本(Android 2.2)

• 宣告必要權限

取得帳號其實並非必要權限，但伺服器端必須透過這些資訊管理要發送的對象

• 宣告broadcast receiver與intent service

• 撰寫自己的GCMIntentService

繼承com.google.android.gcm.GCMBaseIntentService，需注意這邊要宣告無參數的建構子

public class GCMIntentService extends GCMBaseIntentService {

 private static final String senderId = your_sender_id;

 public GCMIntentService() {
 super(senderId);
 Log.d("GCMIntentService", senderId);
 }

需要override各種方法，主要重點在onMessage這個接收到訊息後的相關處理，這邊是使用常見的通知列通知。

@Override
protected void onMessage(Context context, Intent intent) {
 String ns = Context.NOTIFICATION_SERVICE;
 NotificationManager mNotificationManager = (NotificationManager) getSystemService(ns);
//宣告圖示
 int icon = R.drawable.your_icon;
//通知標題
 CharSequence tickerText = "your ticker text";
 long when = System.currentTimeMillis();
 CharSequence contentTitle = "your content title";
//取得通知內容
 CharSequence contentText = intent.getStringExtra("message");
//點選通知後跳出的activity
 Intent notificationIntent = new Intent(this, YourActivity.class);
 PendingIntent contentIntent = PendingIntent.getActivity(this, 0, notificationIntent, 0);
 Notification notification = new Notification(icon, tickerText, when);
//點選後自動移除該通知
 notification.flags = Notification.FLAG_AUTO_CANCEL;
 notification.setLatestEventInfo(context, contentTitle, contentText, contentIntent);
 mNotificationManager.notify(notice_id, notification);
 }

在寫code的同時會發現IDE顯示裡面部份API都已經是deprecated，會建議使用NotificationBuilder，但會有無法向下相容到2.2的問題。

• 在主activity註冊訊息服務

程式啟動後利用Sender ID取得一組Registration ID，而Server端會利用這個Registration ID來找到要發送的目的裝置，但由於它只是個代碼，所以需搭配其他識別(如使用者帳號)進行處理。

 public static final String GSF_PACKAGE = "com.google.android.gsf";
 public static final String REQUEST_REGISTRATION_INTENT = "com.google.android.c2dm.intent.REGISTER";

private void init(){
 Intent registrationIntent = new Intent(REQUEST_REGISTRATION_INTENT);
 registrationIntent.setPackage(GSF_PACKAGE);
 GCMRegistrar.checkDevice(this);
 GCMRegistrar.checkManifest(this);
 final String regId = GCMRegistrar.getRegistrationId(this);
 Log.d("regId",regId);
 if (regId.equals("")) {
 GCMRegistrar.register(this, GCMIntentService.senderId());
 } else {
 Log.v("YourActivity", "Already registered");
 }
 }

伺服器端程式

• 建立Server接收Registration ID機制

由於Server在發動訊息時會透過此ID發送，所以需要一個機制來接收裝置端送來的Registration ID，自行實做即可，這邊我用cp大法就沒有範例了…

• 撰寫發送訊息程式

單機版也可以測試，程式需加入相依的jar檔，必備有的有gcm-server.jar(位於android-sdk\extras\google\gcm\gcm-server\dist\)以及JSON.Simple。

//建立sender
 Sender sender = new Sender("Your API key");
//加入欲發送的訊息，注意這裡message這個key是自訂的，與裝置端配合即可
 Message message = new Message.Builder().addData("message", "Your Message").build();
//發送時提供Registration ID來決定欲傳送裝置
 Result result = sender.send(message, "Registration ID", 5);
 if (result.getMessageId() != null) {
 String canonicalRegId = result.getCanonicalRegistrationId();
 if (canonicalRegId != null) {
 // same device has more than on registration ID: update database
 }
 } else {
 String error = result.getErrorCodeName();
 if (error.equals(Constants.ERROR_NOT_REGISTERED)) {
 // application has been removed from device - unregister database
 }
 }

完成

執行server端程式，裝置端收到通知就代表成功了。

大功告成

 

※注：如果看到your.package_name之類的，那就是要改成你自己在用的變數，比如project packagename是 hello.world, 那 your.package_name就要改成 hello.world以此類推….