· Android GCM

Androidプロジェクトの新規作成からプッシュ通知受信確認まで

  • このエントリーをはてなブックマークに追加

はじめに

1年ぐらい前にプッシュ通知を実装したときから設定方法が若干変わっていたので、この記事がいつまで有効かはわかりませんが、Androidプロジェクトの新規作成からプッシュ通知受信確認までを書いておこうと思います。

この記事を書いている時点で使用しているAndroid Studioのバージョンは1.5.1です。(AS2.0.0beta6が出ててバージョンアップしようか迷ってるという時期です。)

さて、最初にAndroid StudioでEmptyActivityを指定して、PushNotificationSampleという名前のNewProjectを作成しておきます。その前提で以下、話を進めていきます。

サンプルプロジェクトリポジトリ

全体のプロジェクトはkwmt/PushNotificationSampleに置いています。

Configurationファイル(JSONファイル)を準備する

Add Google Services にアクセスして、Configuration fileを作成します。

作成したgoogle-services.jsonをapp/の直下に置きます。

※Flavor毎に異なったgoogle-services.jsonを使いたい場合は、 google-services:2.0.0-bata3からできそうという話があったが、実際動かないらしいので、betaとれるの待つしかなのかなぁ。

※google-services-gcmを追加したあと、gradleをsyncする時にgoogle-services.jsonファイルがないと下記のようなエラーが出ますのでご注意下さい。

Error:Execution failed for task ':app:processDebugGoogleServices'.
> File google-services.json is missing from module root folder. The Google Services Plugin cannot function without it.

build.gradleを編集

google-servicesを追加する

プロジェクトトップのbuild.gradleを編集します。

--- a/build.gradle
+++ b/build.gradle
@@ -5,8 +5,9 @@ buildscript {
         jcenter()
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:1.5.0'
-
+        classpath 'com.android.tools.build:gradle:2.0.0-beta6'
+        // https://develop  ers.google.com/cloud-messaging/android/client
+        classpath 'com.google.gms:google-services:2.0.0-beta6'
         // NOTE: Do not place your application dependencies here; they belong
         // in the individual module build.gradle files
     }

このままビルドすると2.10が必須と言われるので、

Warning:Gradle version 2.10 is required. Current version is 2.8. If using the gradle wrapper, try editing the distributionUrl in /PushNotificationSample/gradle/wrapper/gradle-wrapper.properties to gradle-2.10-all.zip

gradle-wrapper.propertiesファイルを2.10にします。

--- a/gradle/wrapper/gradle-wrapper.properties
+++ b/gradle/wrapper/gradle-wrapper.properties
@@ -3,4 +3,4 @@ distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-2.8-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-2.10-all.zip

ビルドに失敗するようなら、Preferences(⌘,)で、 Build, Exectuion, Deployment -> Build Tools -> Gradleに行き、Project-level settingsのパスが2.8のままになっている可能性があるので、Use default gradle wrapperにチェックを選択しておくとよいと思います。

app/build.gradleを編集します

dependenciesplay-services-gcmを追加し、最下部にapply pluginを記入します。 play-servicesにしてないのは、65k method limit対策です。 ただでさえライブラリをたくさん使用するので、余計なライブラリを入れたくないためです。

--- a/app/build.gradle
+++ b/app/build.gradle
@@ -23,4 +23,7 @@ dependencies {
     compile fileTree(dir: 'libs', include: ['*.jar'])
     testCompile 'junit:junit:4.12'
     compile 'com.android.support:appcompat-v7:23.1.1'
+    compile 'com.google.android.gms:play-services-gcm:8.4.0'
 }
+
+apply plugin: 'com.google.gms.google-services'
\ No newline at end of file

AndroidManifestを編集

パーミッションを追加

--- a/app/src/main/AndroidManifest.xml
+++ b/app/src/main/AndroidManifest.xml
@@ -2,6 +2,19 @@
 <manifest package="net.kwmt27.pushnotificationsample"
           xmlns:android="http://schemas.android.com/apk/res/android">
 
+    <uses-permission android:name="android.permission.INTERNET"/>
+
+    <!-- GCM permission -->
+    <!--
+        Android: Is it possible to read package name inside AndroidManifest.xml file
+        http://stackoverflow.com/a/25186503
+    -->
+    <permission android:name="${applicationId}.permission.C2D_MESSAGE"
+                android:protectionLevel="signature" />
+    <uses-permission android:name="${applicationId}.permission.C2D_MESSAGE"/>
+    <uses-permission android:name="android.permission.WAKE_LOCK" />
+
+
     <application
         android:allowBackup="true"
         android:icon="@mipmap/ic_launcher"

必要なクラスを宣言します

applicationタグの中に下記を宣言します。

GCMからアプリに送ったメッセージを扱うGcmReceiver、 RegitrationTokenを取得と端末個別情報登録の担当するRegistrationIntentService、 Registration tokenが更新されたときの処理を担当するInstanceIDListenerService、 Push受信時の処理を担当する(実際にPush通知を受け取ってからの処理を担当する)GcmListenerService。

また、Android4.4KitKat以前をサポートしたい場合は、GcmReceiverにREGISTRATIONパーミッションを付ける必要があります。

--- a/app/src/main/AndroidManifest.xml
+++ b/app/src/main/AndroidManifest.xml
@@ -15,6 +28,51 @@
                 <category android:name="android.intent.category.LAUNCHER"/>
             </intent-filter>
         </activity>
+
+        <!-- GCM 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" />
+
+                <!--
+                    If you want to support pre-4.4 KitKat devices, add the following action to the intent filter declaration for the receiver:
+                    <action android:name="com.google.android.c2dm.intent.REGISTRATION" />
+                    https://developers.google.com/cloud-messaging/android/client#manifest
+                -->
+                <action android:name="com.google.android.c2dm.intent.REGISTRATION" />
+                <category android:name="${applicationId}" />
+            </intent-filter>
+        </receiver>
+
+        <service
+            android:name=".RegistrationIntentService"
+            android:exported="false">
+            <intent-filter>
+                <action android:name="com.google.android.gms.iid.InstanceID"/>
+            </intent-filter>
+        </service>
+
+        <!-- GCM Listener -->
+        <service
+            android:name=".MyGcmListenerService"
+            android:exported="false" >
+            <intent-filter>
+                <action android:name="com.google.android.c2dm.intent.RECEIVE" />
+            </intent-filter>
+        </service>
+
+        <!-- GCM InstanceId listener -->
+        <service
+            android:name=".MyInstanceIDListenerService"
+            android:exported="false">
+            <intent-filter>
+                <action android:name="com.google.android.gms.iid.InstanceID"/>
+            </intent-filter>
+        </service>
+
     </application>
 
 </manifest>

宣言したクラスを作成します

IntentServiceを継承したRegistrationIntentService、GcmListenerServiceを継承したMyGcmListenerService、InstanceIDListenerServiceを継承したMyInstanceIDListenerServiceを作成します。

以下は基本的に、googleのsampleを参考にしています。

RegistrationIntentService.java

RegistrationIntentServiceは、GoogleのGCMコネクションサーバーからRegistration Tokenを受け取って、自分のプロジェクトのプッシュ通知のメッセージを送信するAPIサーバーなどにRegistration Tokenを送信するのを担当します。

Registration Tokenを受け取るには instanceID.getToken(SENDER_ID)を使用します。SENDER_IDはstringリソースIDR.string.gcm_defaultSenderIdを指定していますが、google-services.jsonから取得することができ、gcm_defaultSenderIdを自分で追加する必要はありません。

InstanceID instanceID = InstanceID.getInstance(this);
String token = instanceID.getToken(getString(R.string.gcm_defaultSenderId),
        GoogleCloudMessaging.INSTANCE_ID_SCOPE, null);
sendRegistrationToServer(token);

sendRegistrationToServerメソッドはprivateで、自分のAPIサーバーにRegistration Tokenを登録し、登録完了したコールバックでPrefereceに、”Registration Tokenをサーバーに登録した”という情報を保存しています。

アプリ起動時に呼ばれることになるため、MainActivitystartServiceします。

MyInstanceIDListenerService.java

InstanceIDListenerServiceを継承したMyInstanceIDListenerService#onTokenRefreshメソッドは、Registration tokenが更新された時に呼ばれます。更新されるとAPIサーバーも更新する必要があるため、onTokenRefreshメソッド内でRegistration Tokenを受け取ってAPIサーバーに登録するRegistrationIntentServicestartServiceしています。

Intent intent = new Intent(this, RegistrationIntentService.class);
startService(intent);

ちなみに、このときRegistrationIntentServiceはすでにstartしていますが、startServiceはネストしない(つまり動いてるサービスはストップしてからstartする)ので、複数サービスはstartされませんので安心です。

MyGcmListenerService.java

以上でプッシュ通知を受け取る設定ができた感じで、あとは実際にプッシュ通知を受けてどうするかの処理が必要です。それはGcmListenerServiceを継承したMyGcmListenerServiceが担当し、プッシュ通知が来たらonMessageReceivedメソッドが呼ばれます。

@Override
public void onMessageReceived(String from, Bundle data) {
    String message = data.getString("message");
    sendNotification(message);
}

data.getString("message")で指定しているmessageのキーはプッシュ通知を送るサーバーとインターフェースを決める必要があります。 sendNotificationメソッドはprivateで、Notificationに表示しています。

プッシュ通知の受信確認

以上で基本的なプッシュ通知の設定は完了ですので、通知が受信できるか確認してみます。 プッシュ通知の送信サーバーを書くのもいいですが、以下のcurlでも確認できます。

curl --header "Authorization: key=<Server API Key>" --header Content-Type:"application/json" https://android.googleapis.com/gcm/send -d "{\"registration_ids\":[\"<Registration Token>\"],\"data\":{\"message\":\"Hello\"}}"

通知バーにHelloというメッセージが表示されたら成功です。

PlayServicesのチェック

プッシュ通知設定の最後に、GCMはGooglePlayServicesライブラリに依存していて、このライブラリのバージョンが古かったりすると正しくプッシュ通知が受信できないなどの不具合を生む可能性がありますので、バージョンチェックは必要になるでしょう。 PlayServicesUtilsというクラスにバージョンを確認するcheckGooglePlayServicesメソッドを記述しています。もしバージョンが古かったりすると、更新してください的なメッセージを表示してくれます。ここでは、更新されなかったらActivityを終了するようにしています。

public static boolean checkGooglePlayServices(final Activity activity) {
    GoogleApiAvailability apiAvailability = GoogleApiAvailability.getInstance();
    final int resultCode = apiAvailability.isGooglePlayServicesAvailable(activity);
    if (resultCode == ConnectionResult.SUCCESS){
        return true;
    }

    apiAvailability.getErrorDialog(activity, resultCode, 0, new DialogInterface.OnCancelListener() {
        @Override
        public void onCancel(DialogInterface dialogInterface) {
            activity.finish();
        }
    }).show();
    return  false;
}

このチェックを利用して、チェックOKならRegistrationIntentServiceを開始するようにMainActivityを編集します。

-- a/app/src/main/java/net/kwmt27/pushnotificationsample/MainActivity.java
+++ b/app/src/main/java/net/kwmt27/pushnotificationsample/MainActivity.java
     protected void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);
         setContentView(R.layout.activity_main);
+        // GooglePlayServicesのバージョンチェック
+        if (PlayServicesUtils.checkGooglePlayServices(this)) {
+            Intent intent = new Intent(this, RegistrationIntentService.class);
+            startService(intent);
+        }
+    }
+
+    @Override
+    protected void onResume() {
+        super.onResume();
+        // GooglePlayServicesのバージョンチェック
+        PlayServicesUtils.checkGooglePlayServices(this);
     }
 }

補足

プッシュ通知に関しては以上で終わりです。ただ、Registration TokenをServerに送信したり、送信したことをPreferenceに保存したりしていて、その部分も実装する必要がありますので、その部分についても書いておきます。

Registration TokenをServerに送信

RegistrationIntentServicesendRegistrationToServerというメソッドを作成しました。その中身は、HTTP通信で自分のサーバーにRegistration Tokenを送信するという内容になります。 実装方法はAsyncTaskを使ったり、HTTPクライアントライブラリを使ったりいろいろありますが、ここでは okhttp3というHTTPクライントライブラリを使いました。

MVCを想定しているので(MVPがよさそうという記事もありますが)、モデルからリクエストします。HTTPリクエスト部分を共通化したいため、ApiRequestというモデルに実際のHTTPリクエスト処理を記述しています。

Preferenceに保存する

また、Registration TokenをAPIサーバーに送信したかどうかをPreferenceに保存しますので、保存する処理をGcmModelに記述しています。

Dagger

この記事のサンプルプロジェクトでは Daggerも導入していますが、直接プッシュ通知には関係ないため説明は省略します。

参考

  • このエントリーをはてなブックマークに追加
  • LinkedIn
  • Tumblr
  • Reddit
  • Google+
  • Pinterest
  • Pocket