hanburn : a line of code

작성일 : 2013-03-11

작성자 : hanburn

이 글은 아래의 page를 기초로 해서 작성 되었습니다.

http://developer.android.com/google/gcm/gcm.html

여기서는 간한하게 테스트를 위해서 third-party application server가 없이 진행 하도록 하겠습니다. 보통은 서버를 구성하여 push 메시지를 보내고, 전송 상태등을 조회할 수 있는 기능을 만들지만 여기는 GCM-client 위주로 기술하기 때문에 직접 web browser로 메시지를 보내도록 하겠습니다.

0. 용어정리  

Registration ID : 단말기를 GCM 서버에 등록하고 나서 받는 key 값. GCM 서버에서 단말기를 구분하는 값이다. Push 요청을 할 때 이 key를 보내서 특정 단말에만 push 가 가도록 할 수 있다.

Sender ID : 구글 API Console에서 프로젝트를 등록하고 나서 얻을수 있다. 의미상으로는 Sender ID는 메시지를 수신하는 안드로이드 앱을 구분하게 된다.  

Sender Auth Token : push 메시지 전송시(third-party 서버 또는 Browser) 메시지를 보내는 곳을 인증하기 위한 token.  아무나 GCM서버에 push를 보낼 수 없도록 하기 위한 인증장치

1. Enabling GCM

GCM을 사용하기 위해서는 Google API console에서 Sender ID를 발급 받아야 한다.

https://code.google.com/apis/console/

그림에서 주소창의 project 옆의 숫자가 project ID가 인데, GCM에서는 이 값을 Sender ID로 사용한다. 참고로 API console에서 여러 개의 Google API Project를 만들고 관리 할 수 있는데, 필자는 test_gcm 이라는 project를 만들어서 사용하였다. 복수의  project를 생성할 수 있고 project마다 ID가 독립적이 된다.

2. Android 클라이언트 - manifest.xml 파일

1. GCM은 안드로이드 2.2 이상에서 지원하므로 최소 버전을 설정해야 한다.

2. GCM 메시지를 받기 위한 permission을 정의 한다. “my_app_package”는 자신의 package 로..

<permission android:name="my_app_package.permission.C2D_MESSAGE" android:protectionLevel="signature" />

<uses-permission android:name="my_app_package.permission.C2D_MESSAGE" /> 

3. 추가로 필요한 permisstion 추가

<!-- GCM messages 수신하기 위해서 -->

<uses-permission android:name="com.google.android.c2dm.permission.RECEIVE" />

<!-- 인터넷 접속 -->

<uses-permission android:name="android.permission.INTERNET" /> 

<!-- 구글계정 접근 -->

<uses-permission android:name="android.permission.GET_ACCOUNTS" />

<!-- 메시지 수신하려면 절전모드로 가면 안됨 -->

<uses-permission android:name="android.permission.WAKE_LOCK" />

4. Broadcast Receiver 등록 ( gcm.jar 파일에 GCMBroadcastReceiver 라는클래스가 있음. )

<receiver android:name="com.google.android.gcm.GCMBroadcastReceiver" android:permission="com.google.android.c2dm.permission.SEND" >

  <intent-filter>

    <action android:name="com.google.android.c2dm.intent.RECEIVE" />

    <action android:name="com.google.android.c2dm.intent.REGISTRATION" />

    <category android:name="my_app_package" />

  </intent-filter>

</receiver>

5. Intent service 추가 ( gcm.jar 파일에 GCMIntentService 클래스 있음)

<service android:name=".GCMIntentService" />

4,5번에서 사용하는 클래스는 google에서 제공하는 gcm.jar 파일에 정의되어 있으므로 그냥 사용하는게 편하다. 기존 C2DM에서 GCM으로 마이그레이션하는 경우에는 그냥 Sender ID만 변경해 주면 된다.

3. Android 클라이언트 – GCM서버에 등록

단말기에서는 push를 받기 위해서 GCM서버에 단말기를 등록해야 한다. gcm.jar 파일을 이용하는 경우에는 아래처럼 간단하다.

GCMRegistrar.checkDevice(this);

GCMRegistrar.checkManifest(this);

final String regId = GCMRegistrar.getRegistrationId(this);

if (regId.equals("")) {

  GCMRegistrar.register(this, SENDER_ID);

} else {

  Log.v(TAG, "Already registered");

}

여기서 GCMRegistrar.register(this, SENDER_ID) 는 실제로는 아래와 같은 동작을 한다.

Intent registrationIntent = new Intent("com.google.android.c2dm.intent.REGISTER");

// sets the app name in the intent

registrationIntent.putExtra("app", PendingIntent.getBroadcast(this, 0, new Intent(), 0));

registrationIntent.putExtra("sender", senderID);

startService(registrationIntent);

위 코드는 C2DM에서 사용하던 방법과 같다. gcm.jar는 GCM을 구현하는 코드가 정형화 되어 있어서 간단한 library 파일로 제공하는 것이다. 그래서 신규 개발시는 gcm.jar를 이용하면 편리하다.

GCM에 등록이 되면 callback으로 GCMIntentService의 onRegistered() 가 호출된다. 여기에 registrationId가 넘어온다.

GCMIntentService class에서 제공하는 다양한 callback 함수들을 아래와 같다. 이름만 보면 대충 언제 호출되는지 알 수 있다.

protected void onRegistered(Context context, String registrationId)

protected void onUnregistered(Context context, String registrationId)

protected void onMessage(Context context, Intent intent)

protected void onDeletedMessages(Context context, int total)

public void onError(Context context, String errorId)

protected boolean onRecoverableError(Context context, String errorId)

이제, 클라이언트 개발이 완료 되었으므로 실제로 test를 해서 잘 동작하는지 확인해 봐야 한다. GCM 서버는 아래의 url을 통해서 Broswer로 간단하게 테스트 할 수 있다. Browser에서 테스트할때 필요한 Authorization Key는 google API console에서 얻을 수 있다.

사진 보면 알겠지만, third-party Server를 사용할 경우에는 “Create new Server Key”를 눌러서 생성할수 있다. 위에서 얻은 키를 이용해서 아래처럼 호출하면 된다.

그리고 registration_ids는 앞에서 String regId = GCMRegistrar.getRegistrationId(this); 을 호출해서 얻은 값이다.

URL : https://android.googleapis.com/gcm/send.

Method : POST

Authorization: Key=xxxxx

Content-Type:application/json  

예)

Content-Type:application/json

Authorization:key=AIzaSyB-1uEai2WiUapxCs2Q0GZYzPu7Udno5aA



{

  "registration_ids" : ["APA91bHun4MxP5egoKMwt2KZFBaFUH-1RYqx..."],

  "data" : {

    ...

  },

}

POST로 호출해야 되므로 Chrome의 REST-CONSOLE 같은 것으로 전송을 테스트 해보면 된다.

보너스

GCM 샘플 소스 : 설치된 android SDK 경로에서 “Extras -> Google -> gcm->samples “ 에 client와 server의 샘플 소스가 있다. Client 샘플은 registrationId를 서버로 전송하므로 해당 부분을 빼고 browser로 테스트 할 수 있도록 변경한 샘플을 첨부 하였다.

 gcm-demo-client.zip