GCM 3.0 + PHP 예제 코드

1. 개요

 

  GCM이란 Google Cloud Messaging Service로 구글이 제공하고 있는 API 기능 중 하나입니다. 직접 Sender가 Receiver에게 메시지를 보내는 것이 아니라 GCM에게 메시지를 보내고 해당 메시지를 GCM이 다시 Receiver에게 전달해 줍니다.

  추가로 기존 eclipse에서 제공하던 Google Cloud Messaging기능이 IDE가 Andoird Studio로 변경되면서 Ant 기반 빌드 방식을 Gradle로 변경하였습니다. 즉 기존 프로젝트의 hash키를 등록하는 방식이 아닌 프로젝트 내 build.gradle에 GCM을 사용한다는 문장을 추가함으로써 쉽게 GCM을 사용하실 수 있습니다.

  Sender가 GCM에게 메시지를 전달하는 방법에는 php를 이용한 방식과 node.js를 이용한 방식이 있는데, 이번 글에서는 php를 이용하여 GCM을 구현하였습니다.

 아래 영상은 완성본 영상입니다.  웹 페이지(sender)에서 핸드폰(receiver)에게 메시지를 보내며 핸드폰은 해당 메시지를 수신하여 Notification으로 알려줍니다.

2. 프로젝트 생성하기

 

  우선 빈 프로젝트를 생성합니다. 생성시 Application name에 _(언더바)를 포함한 특수문자나 한글이 들어가지 않도록 합니다.

3. 앱 등록하기

 

  GCM 서비스를 이용하기 위해서는 구글 개발자 포럼에 GCM 기능을 사용하겠다고 등록을 해야합니다. - https://developers.google.com/cloud-messaging/

 우선 로그인을 하시고 해당 페이지의 우측 상단의 TRY IT ON ANDROID을 클릭합니다.

  이전에 생성한 어플리케이션을 등록시킬것이기 때문에 add Cloud Messaging to your existing app을 누릅니다. 

  어느정도 페이지를 내려가시다 보면 GET A CONFIGURATION FILE버튼이 보이실 겁니다. 해당 버튼을 눌러 등록 페이지로 넘어갑니다.

  기존에 생성한 프로젝트의 정보를 입력합니다.

ENABLE GOOGLE CLOUD MESSAGING버튼을 눌러 활성화를 시켜줍니다. 

  서비스 이용에 필요한 json파일을 받기위해 아래 Generate configuration files버튼을 누릅니다.

  이전에는 Server API Key와 Sender ID를 따로 메모해 두었으나 현재에는 이 정보들이 들어있는 json파일을 다운받아 해당 안드로이드 프로젝트에 추가합니다. json파일을 열어보시면 Server API Key와 Sender ID 정보가 들어 있을 겁니다.

4. 안드로이드 프로젝트 설정 하기

 

  우선 다운받은 google-services.json 파일을 위 사진과 같은 위치에 복사합니다.

이후 app->src->build.gradle의
상단에 apply plugin: 'com.google.gms.google-services'
하단에 dependencies에 compile 'com.google.android.gms:play-services-gcm:8.3.0'를 추가합니다.

  추가로 app->gradle->build.gradle의 dependencies에 classpath 'com.google.gms:google-services:1.5.0-beta2'를 추가합니다.
모든 추가가 끝나시면 오른쪽 상위 Sync Now나 디버깅을 한번해주시기 바랍니다.

 지금 한 프로젝트 설정은 https://developers.google.com/cloud-messaging/android/client#add-config에 자세히 설명하고 있습니다. 참고하시기 바랍니다.

5. Sample Code(Android)

 

  해당 셈플 코드는 구글에서 제공하고 있는 셈플코드를 변경하여 만든 것입니다. 구글 셈플 코드는 https://github.com/googlesamples/google-services/tree/master/android/gcm에 들어가시면 다운받으실 수 있습니다.

  우선 일반 클레스(자바) 파일 3개를 추가 하여 위 사진처럼 만듭니다. Service 클레스를 생성하셔도 됩니다. 저의 셈플 코드는 구글 셈플코드보다 클레스가 하나 적습니다. 

   1. MainActivity : Activity class입니다.

   2. InstanceIDListenerService : service class입니다.

   3. RegistrationIntentService : Intent service class입니다.

   4. GCMListenerService : service class입니다.

 진행을 하기전 Service와 Notification이 무엇인지 모르신다면 아래 주소로 가셔서 한번 보셨으면 합니다.

  Notification 설명 : http://twinw.tistory.com/48

  Service 설명 : http://twinw.tistory.com/49

  Service + Notification 통합 예제 :  http://twinw.tistory.com/50

1. Manifests.xml

  Manifests.xml의 상단에 gcm을 사용하기 위한 permission을 추가합니다. 여기서 주의하실 것이 <project name>을 자신의 프로젝트 이름으로 변경해 주셔야 합니다.

<uses-permission android:name="android.permission.WAKE_LOCK" /> <permission android:name="<project name>.permission.C2D_MESSAGE" android:protectionLevel="signature" /> <uses-permission android:name="<project name>.permission.C2D_MESSAGE" />

  메시지를 수신받기 위한 receiver를 추가합니다.

<receiver android:name="com.google.android.gms.gcm.GcmReceiver" android:exported="true" android:permission="com.google.android.c2dm.permission.SEND" > <intent-filter> <action android:name="com.google.android.c2dm.intent.RECEIVE" /> <category android:name="com.example.gcm" /> </intent-filter> </receiver>

  생성한 클레스가 service class이며 사용한다고 정의해 줍니다. 여기서도 주의하실 것이 <project name>을 자신의 프로젝트 이름으로 변경해 주셔야 합니다.

<service android:name="<project name>.GcmListenerService" android:exported="false" > <intent-filter> <action android:name="com.google.android.c2dm.intent.RECEIVE" /> </intent-filter> </service> <service android:name="<project name>.InstanceIDListenerService" android:exported="false"> <intent-filter> <action android:name="com.google.android.gms.iid.InstanceID" /> </intent-filter> </service> <service android:name="<project name>.RegistrationIntentService" android:exported="false"></service>

  Manifests.xml의 풀 코드입니다.

<?xml version="1.0" encoding="utf-8"?> <manifest xmlns:android="http://schemas.android.com/apk/res/android" package="jsy.gcmsample"> <uses-permission android:name="android.permission.WAKE_LOCK" /> <permission android:name="jsy.gcmsample.permission.C2D_MESSAGE" android:protectionLevel="signature" /> <uses-permission android:name="jsy.gcmsample.permission.C2D_MESSAGE" /> <application android:allowBackup="true" android:icon="@mipmap/ic_launcher" android:label="@string/app_name" android:supportsRtl="true" android:theme="@style/AppTheme"> <activity android:name=".MainActivity"> <intent-filter> <action android:name="android.intent.action.MAIN" /> <category android:name="android.intent.category.LAUNCHER" /> </intent-filter> </activity> <receiver android:name="com.google.android.gms.gcm.GcmReceiver" android:exported="true" android:permission="com.google.android.c2dm.permission.SEND" > <intent-filter> <action android:name="com.google.android.c2dm.intent.RECEIVE" /> <category android:name="com.example.gcm" /> </intent-filter> </receiver> <service android:name="jsy.gcmsample.GcmListenerService" android:exported="false" > <intent-filter> <action android:name="com.google.android.c2dm.intent.RECEIVE" /> </intent-filter> </service> <service android:name="jsy.gcmsample.InstanceIDListenerService" android:exported="false"> <intent-filter> <action android:name="com.google.android.gms.iid.InstanceID" /> </intent-filter> </service> <service android:name="jsy.gcmsample.RegistrationIntentService" android:exported="false"></service> </application> </manifest>

2. MainActivity.java

  MainActivity입니다. BroadcastReceiver를 이용하여 RegistrationIntentService에서 보낸 로컬 메시지를 수신하여 버튼의 글과 색상을 변경합니다.

package jsy.gcmsample; import android.content.BroadcastReceiver; import android.content.Context; import android.content.Intent; import android.content.IntentFilter; import android.graphics.Color; import android.os.Bundle; import android.support.v4.content.LocalBroadcastManager; import android.support.v7.app.AppCompatActivity; import android.util.Log; import android.view.View; import android.widget.Button; import android.widget.ProgressBar; import android.widget.TextView; import android.widget.Toast; import com.google.android.gms.common.ConnectionResult; import com.google.android.gms.common.GooglePlayServicesUtil; public class MainActivity extends AppCompatActivity { private Button mButton; private ProgressBar mProgressBar; private TextView mTextView; private BroadcastReceiver mRegistrationBroadcastReceiver; @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_main); mTextView = (TextView) findViewById(R.id.TextView); mProgressBar = (ProgressBar) findViewById(R.id.ProgressBar); mProgressBar.setVisibility(ProgressBar.GONE); mButton = (Button) findViewById(R.id.registerButton); registBroadcastReceiver(); mButton.setOnClickListener(new View.OnClickListener() { @Override public void onClick(View v) { if (checkPlayServices()) { mProgressBar.setVisibility(ProgressBar.VISIBLE); getInstanceIdToken(); } else Toast.makeText(getApplication(), "This device can not use GCM", Toast.LENGTH_SHORT).show(); } }); } public void getInstanceIdToken() { Intent intent = new Intent(this, RegistrationIntentService.class); startService(intent); } //Google Play Service를 사용할 수 있는 환경이지를 체크한다. private boolean checkPlayServices() { int resultCode = GooglePlayServicesUtil.isGooglePlayServicesAvailable(this); if (resultCode != ConnectionResult.SUCCESS) { if (GooglePlayServicesUtil.isUserRecoverableError(resultCode)) { GooglePlayServicesUtil.getErrorDialog(resultCode, this, 1000).show(); } else { Log.i("TAG", "This device is not supported."); finish(); } return false; } return true; } //화면에서 앱이 동작할 때 LocalBoardcastManager를 등록합니다. @Override protected void onResume() { super.onResume(); LocalBroadcastManager.getInstance(this).registerReceiver(mRegistrationBroadcastReceiver, new IntentFilter("registrationComplete")); } //화면에서 사라지면 등록된 LocalBoardcast를 모두 해제합니다. @Override protected void onPause() { LocalBroadcastManager.getInstance(this).unregisterReceiver(mRegistrationBroadcastReceiver); super.onPause(); } //BroadcastReceiver 함수입니다. public void registBroadcastReceiver(){ mRegistrationBroadcastReceiver = new BroadcastReceiver() { @Override public void onReceive(Context context, Intent intent) { String action = intent.getAction(); if(action.equals("registrationComplete")){ mProgressBar.setVisibility(ProgressBar.GONE); mButton.setText("Registration Complete"); mButton.setTextColor(Color.RED); mButton.setEnabled(false); String token = intent.getStringExtra("token"); mTextView.setText(token); } } }; } }

3. activity_main.xml

  MainActivity의 xml 파일입니다.

<?xml version="1.0" encoding="utf-8"?> <RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android" xmlns:tools="http://schemas.android.com/tools" android:layout_width="match_parent" android:layout_height="match_parent" android:paddingLeft="@dimen/activity_horizontal_margin" android:paddingRight="@dimen/activity_horizontal_margin" android:paddingTop="@dimen/activity_vertical_margin" android:paddingBottom="@dimen/activity_vertical_margin" android:background="#ffffff" tools:context=".MainActivity"> <Button android:id="@+id/registerButton" android:layout_width="fill_parent" android:layout_height="wrap_content" android:text="Registration Button" android:layout_alignParentBottom="true" android:layout_alignParentStart="true" android:textColor="#ffffff" android:background="#467ed7"/> <TextView android:layout_width="match_parent" android:layout_height="wrap_content" android:id="@+id/TextView" android:textColor="#000000" android:textAppearance="?android:attr/textAppearanceMedium" android:text="Click the Button" android:layout_above="@+id/ProgressBar" android:layout_alignParentTop="true" /> <ProgressBar android:layout_width="wrap_content" android:layout_height="wrap_content" android:id="@+id/ProgressBar" android:layout_gravity="center_horizontal" android:layout_centerVertical="true" android:layout_centerHorizontal="true" /> </RelativeLayout>

4. InstanceIDListenerService.java

  gcm에서 제공하는 Service를 extends하고 있습니다.

package jsy.gcmsample; import android.content.Intent; public class InstanceIDListenerService extends com.google.android.gms.iid.InstanceIDListenerService { private static final String TAG = "MyInstanceIDLS"; @Override public void onTokenRefresh() { Intent intent = new Intent(this, RegistrationIntentService.class); startService(intent); } }

5. RegistrationIntentService.java

  Device의 Id인 token을 등록합니다. 또한 LocalBroadcastManager를 이용하여 등록 완료를 MainActivity에게 알려줍니다.

package jsy.gcmsample; import android.app.IntentService; import android.content.Intent; import android.support.v4.content.LocalBroadcastManager; import android.util.Log; import com.google.android.gms.gcm.GoogleCloudMessaging; import com.google.android.gms.iid.InstanceID; import java.io.IOException; public class RegistrationIntentService extends IntentService { private static final String TAG = "RegIntentService"; public RegistrationIntentService() { super(TAG); } @Override protected void onHandleIntent(Intent intent) { // GCM을 위한 Instance ID를 가져옵니다. InstanceID instanceID = InstanceID.getInstance(this); String token = null; try { //json파일에 들어있는 데이터를 가져와서 토큰을 조회합니다. token = instanceID.getToken(getString(R.string.gcm_defaultSenderId),GoogleCloudMessaging.INSTANCE_ID_SCOPE, null); Log.i(TAG, "GCM Registration Token: " + token); Intent registrationComplete = new Intent("registrationComplete"); registrationComplete.putExtra("token", token); LocalBroadcastManager.getInstance(this).sendBroadcast(registrationComplete); } catch (IOException e) { e.printStackTrace(); } } }

6. GcmListenerService.java

  GCM서버에서 보낸 message를 수신하는 service입니다. 받은 메세지를 Notification으로 알려줍니다.

package jsy.gcmsample; import android.app.NotificationManager; import android.app.PendingIntent; import android.content.Context; import android.content.Intent; import android.media.RingtoneManager; import android.net.Uri; import android.os.Bundle; import android.support.v4.app.NotificationCompat; import android.util.Log; public class GcmListenerService extends com.google.android.gms.gcm.GcmListenerService { private static final String TAG = "MyGcmListenerService"; //메세지를 받았을 때 동작하는 함수입니다. @Override public void onMessageReceived(String from, Bundle data) { String title = data.getString("title"); String message = data.getString("message"); Log.d(TAG, "From: " + from); Log.d(TAG, "Title: " + title); Log.d(TAG, "Message: " + message); sendNotification(title, message); } //메세지를 알림으로 보여주는 함수입니다. private void sendNotification(String title, String message) { Intent intent = new Intent(this, MainActivity.class); intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP); PendingIntent pendingIntent = PendingIntent.getActivity(this, 0 /* Request code */, intent, PendingIntent.FLAG_ONE_SHOT); Uri defaultSoundUri= RingtoneManager.getDefaultUri(RingtoneManager.TYPE_NOTIFICATION); NotificationCompat.Builder notificationBuilder = new NotificationCompat.Builder(this) .setSmallIcon(R.mipmap.ic_launcher) .setContentTitle(title) .setContentText(message) .setAutoCancel(true) .setSound(defaultSoundUri) .setContentIntent(pendingIntent); NotificationManager notificationManager = (NotificationManager) getSystemService(Context.NOTIFICATION_SERVICE); notificationManager.notify(0, notificationBuilder.build()); } }

6. Sample Code(Sender-html & php)

 

  Sender는 html로 구현한 웹 페이지와 구글 서버로 데이터를 전송할 php로 구현하였습니다. 아마 서버 프로그램에 아무런 설정을 하지 안으시고 동작을 시키시면 curl에 관한 오류가 발생할 것입니다. 해당 오류는 서버 프로그램의 설정에서 php_curl.dll을 사용한다고 변경해주시면 됩니다. 이 부분은 유저 분들의 서버 프로그램이 각각 다를 것이기 때문에 설명하지 않겠습니다.

그리고 테스트는 loop back(127.0.0.1)이나 개인 주소로 하여 테스트 해주시기 바랍니다.

1. gcmsender.html

<!DOCTYPE html> <head> <title>GCM Sender</title> <meta charset="utf-8" /> </head> <form action="gcmsend.php" method="post"> <p>title : <input name="title" type="text" /></p> <p>message : <input name="message" type="text" /></p> <input type="submit" value="Send Notification" /> </form>

2. gcmsender.php

<?php $title = $_POST['title']; $message =$_POST['message']; $regid = "Your API ID"; // 헤더 부분 $headers = array( 'Content-Type:application/json', 'Authorization:key=Your API key' ); // 푸시 내용, data 부분을 자유롭게 사용해 클라이언트에서 분기할 수 있음. $arr = array(); $arr['data'] = array(); $arr['data']['title'] = $title; $arr['data']['message'] =$message; $arr['registration_ids'] = array(); $arr['registration_ids'][0] = "Client(device) Token Id"; $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, 'https://android.googleapis.com/gcm/send'); curl_setopt($ch, CURLOPT_HTTPHEADER, $headers); curl_setopt($ch, CURLOPT_POST, true); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); curl_setopt($ch, CURLOPT_POSTFIELDS,json_encode($arr)); $response = curl_exec($ch); curl_close($ch); // 푸시 전송 결과 반환. $obj = json_decode($response); // 푸시 전송시 성공 수량 반환. $cnt = $obj->{"success"}; echo $cnt; ?>

  해당 코드로 테스트 할 시, 기본적인 GCM API 키와 같은 데이터를 php에 작성해 주셔야합니다. 또한 php에 작성해야하는 Device Token ID는 안드로이드에서 등록 번튼을 누르고 로그 검색을 통해 쉽게 알 수있습니다. 

  추가로 100개의 디바이스에게 메시지를 전송한다고 가정했을 때 php에 Token ID를 100개 적어 한번에 보내는 것이 100번 보내는 것보다 빠릅니다.