Androidで新しい通知を検出する方法！NotificationListenerServiceの実装手順を解説

このチュートリアルでは、Androidアプリで新しい通知を検出する方法を解説します。NotificationListenerServiceを利用することで、端末に届く通知の追加・削除をリアルタイムで検知でき、通知の内容や発行元のパッケージ名を取得することも可能になります。

本記事では、通知を検知してその結果を画面に表示するシンプルなサンプルアプリを、ステップごとに作成していきましょう。

ステップ1: 新規プロジェクトの作成

Android Studioを起動し、「File」→「New Project」を選択します。必要な項目をすべて入力して、新しいプロジェクトを作成してください。

ステップ2: コールバック用インターフェースの作成(MyListener.java)

まず、通知イベントをActivity側へ伝えるためのコールバックインターフェースを定義します。以下のコードをsrc/MyListener.javaに追加しましょう。

public interface MyListener {
   void setValue (String packageName) ;
}

ステップ3: 通知監視サービスの作成(NotificationService.java)

次に、NotificationListenerServiceを継承したサービスクラスを作成します。このサービスは、通知が投稿された際にonNotificationPosted()が、削除された際にonNotificationRemoved()がそれぞれ呼び出される仕組みです。以下のコードをsrc/NotificationService.javaに追加してください。

package app.tutorialspoint.com.notifyme ;
import android.content.Context ;
import android.service.notification.NotificationListenerService ;
import android.service.notification.StatusBarNotification ;
import android.util.Log ;
public class NotificationService extends NotificationListenerService {
   private String TAG = this .getClass().getSimpleName() ;
   Context context ;
   static MyListener myListener ;
   @Override
   public void onCreate () {
      super .onCreate() ;
      context = getApplicationContext() ;
   }
   @Override
   public void onNotificationPosted (StatusBarNotification sbn) {
      Log. i ( TAG , "********** onNotificationPosted" ) ;
      Log. i ( TAG , "ID :" + sbn.getId() + " \t " + sbn.getNotification(). tickerText + " \t " + sbn.getPackageName()) ;
      myListener .setValue( "Post: " + sbn.getPackageName()) ;
   }
   @Override
   public void onNotificationRemoved (StatusBarNotification sbn) {
      Log. i ( TAG , "********** onNotificationRemoved" ) ;
      Log. i ( TAG , "ID :" + sbn.getId() + " \t " + sbn.getNotification(). tickerText + " \t " + sbn.getPackageName()) ;
      myListener .setValue( "Remove: " + sbn.getPackageName()) ;
   }
   public void setListener (MyListener myListener) {
      NotificationService. myListener = myListener ;
   }
}

ステップ4: メニューリソースの作成(menu_main.xml)

設定画面(通知リスナーアクセスの許可画面)へ遷移するためのメニュー項目を定義します。以下のコードをres/menu/menu_main.xmlに追加しましょう。

<? xml version = "1.0" encoding = "utf-8" ?>
<menu xmlns: android = "https://schemas.android.com/apk/res/android"
   xmlns: app = "https://schemas.android.com/apk/res-auto"
   xmlns: tools = "https://schemas.android.com/tools"
   tools :context = ".MainActivity" >
   <item
      android :id = "@+id/action_settings"
      android :orderInCategory = "100"
      android :title = "Settings"
      app :showAsAction = "never" />
</menu>

ステップ5: レイアウトの作成(activity_main.xml)

次に、通知を作成するボタンと、検知した通知情報を表示するTextViewを配置したレイアウトを作成します。以下のコードをres/layout/activity_main.xmlに追加してください。

<? xml version = "1.0" encoding = "utf-8" ?>
<RelativeLayout xmlns: android = "https://schemas.android.com/apk/res/android"
   xmlns: tools = "https://schemas.android.com/tools"
   android :layout_width = "match_parent"
   android :layout_height = "match_parent"
   android :padding = "16dp"
   tools :context = ".MainActivity" >
   <Button
      android :id = "@+id/btnCreateNotification"
      android :layout_width = "wrap_content"
      android :layout_height = "wrap_content"
      android :layout_alignParentStart = "true"
      android :layout_alignParentTop = "true"
      android :layout_alignParentEnd = "true"
      android :text = "Create Notification" />
   <ScrollView
      android :layout_width = "match_parent"
      android :layout_height = "match_parent"
      android :layout_below = "@+id/btnCreateNotification"
      android :layout_alignStart = "@+id/btnCreateNotification"
      android :layout_alignEnd = "@+id/btnCreateNotification"
      android :layout_alignParentBottom = "true" >
      <TextView
         android :id= "@+id/textView"
         android :layout_width= "match_parent"
         android :layout_height= "wrap_content"
         android :text= "NotificationListenerService Example"
         android :textAppearance= "?android:attr/textAppearanceMedium" />
   </ScrollView>
</RelativeLayout>

ステップ6: メインアクティビティの実装(MainActivity.java)

ここでは、ボタンをタップすると通知を発行する処理と、メニューから通知リスナーの設定画面を開く処理、そして検知した通知をTextViewに表示する処理を実装します。以下のコードをsrc/MainActivity.javaに追加しましょう。

なお、Android 8.0(APIレベル26)以降では通知チャンネルが必須となるため、Build.VERSION.SDK_INTの判定を行い、OSバージョンに応じてチャンネルを作成しています。

package app.tutorialspoint.com.notifyme ;
import android.app.NotificationChannel ;
import android.app.NotificationManager ;
import android.content.Intent ;
import android.os.Bundle ;
import android.support.v4.app.NotificationCompat ;
import android.support.v7.app.AppCompatActivity ;
import android.view.Menu ;
import android.view.MenuItem ;
import android.view.View ;
import android.widget.Button ;
import android.widget.TextView ;
public class MainActivity extends AppCompatActivity implements MyListener {
   private TextView txtView ;
   public static final String NOTIFICATION_CHANNEL_ID = "10001" ;
   private final static String default_notification_channel_id = "default" ;
   @Override
   protected void onCreate (Bundle savedInstanceState) {
      super .onCreate(savedInstanceState) ;
      setContentView(R.layout. activity_main ) ;
      new NotificationService().setListener( this ) ;
      txtView = findViewById(R.id. textView ) ;
      Button btnCreateNotification = findViewById(R.id. btnCreateNotification ) ;
      btnCreateNotification.setOnClickListener( new View.OnClickListener() {
         @Override
         public void onClick (View v) {
            NotificationManager mNotificationManager = (NotificationManager) getSystemService( NOTIFICATION_SERVICE ) ;
            NotificationCompat.Builder mBuilder = new NotificationCompat.Builder(MainActivity. this, default_notification_channel_id ) ;
            mBuilder.setContentTitle( "My Notification" ) ;
            mBuilder.setContentText( "Notification Listener Service Example" ) ;
            mBuilder.setTicker( "Notification Listener Service Example" ) ;
            mBuilder.setSmallIcon(R.drawable. ic_launcher_foreground ) ;
            mBuilder.setAutoCancel( true ) ;
            if (android.os.Build.VERSION. SDK_INT >= android.os.Build.VERSION_CODES. O ) {
               int importance = NotificationManager. IMPORTANCE_HIGH ;
               NotificationChannel notificationChannel = new NotificationChannel( NOTIFICATION_CHANNEL_ID , "NOTIFICATION_CHANNEL_NAME" , importance) ;
               mBuilder.setChannelId( NOTIFICATION_CHANNEL_ID ) ;
               assert mNotificationManager != null;
               mNotificationManager.createNotificationChannel(notificationChannel) ;
            }
            assert mNotificationManager != null;
            mNotificationManager.notify(( int ) System. currentTimeMillis () , mBuilder.build()) ;
         }
      }) ;
   }
   @Override
   public boolean onCreateOptionsMenu (Menu menu) {
      getMenuInflater().inflate(R.menu. menu_main , menu) ; //Menu Resource, Menu
      return true;
   }
   @Override
   public boolean onOptionsItemSelected (MenuItem item) {
      switch (item.getItemId()) {
         case R.id. action_settings :
            Intent intent = new Intent("android.settings.ACTION_NOTIFICATION_LISTENER_SETTINGS" ) ;
            startActivity(intent) ;
            return true;
         default :
            return super .onOptionsItemSelected(item) ;
      }
   }
   @Override
   public void setValue (String packageName) {
      txtView .append( " \n " + packageName) ;
   }
}

ステップ7: マニフェストの設定(AndroidManifest.xml)

最後に、通知リスナーサービスをマニフェストに登録します。ここで重要なのは、android.permission.BIND_NOTIFICATION_LISTENER_SERVICEパーミッションの指定と、NotificationListenerServiceアクションのintent-filterの宣言です。この設定により、システムが本サービスを通知リスナーとして認識できるようになります。

<? xml version = "1.0" encoding = "utf-8" ?>
<manifest xmlns: android = "https://schemas.android.com/apk/res/android"
   package = "app.tutorialspoint.com.notifyme" >
   <uses-permission android :name = "android.permission.VIBRATE" />
   <application
      android :allowBackup = "true"
      android :icon = "@mipmap/ic_launcher"
      android :label = "@string/app_name"
      android :roundIcon = "@mipmap/ic_launcher_round"
      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>
      <service
         android :name = ".NotificationService"
         android :label = "@string/app_name"
         android :permission = "android.permission.BIND_NOTIFICATION_LISTENER_SERVICE" >
         <intent-filter>
            <action android :name = "android.service.notification.NotificationListenerService" />
         </intent-filter>
      </service>
   </application>
</manifest>

アプリの実行と動作確認

それでは、アプリを実行してみましょう。実機のAndroidスマートフォンをPCに接続している前提で説明します。Android Studioからプロジェクト内のアクティビティファイルを開き、ツールバーの「Run」アイコンをクリックしてください。実行デバイスとして自分のモバイル端末を選択すると、端末にアプリのデフォルト画面が表示されます。

アプリを起動したら、メニューの「Settings」から通知リスナーアクセスを許可してください。その後「Create Notification」ボタンをタップして通知を発行すると、通知の投稿・削除のイベントが検知され、画面下部のTextViewにパッケージ名が逐次表示されます。