アクティビティがクラッシュした際にAndroidの通知をクリアする方法

この記事では、アクティビティ（アプリ）がクラッシュした場合に、表示中のAndroid通知を自動的にクリアする方法を解説します。アプリが予期せず強制終了しても、不要な通知がステータスバーに残らないようにする実装テクニックを、サンプルコードとともに紹介します。

手順1：新規プロジェクトの作成

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

手順2：レイアウトファイル（activity_main.xml）の作成

res/layout/activity_main.xml に以下のコードを追加します。画面には通知を作成するためのボタンを1つ配置しています。

<?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_alignParentEnd="true"
        android:layout_centerInParent="true"
        android:text="Create Notification" />

</RelativeLayout>

手順3：MainActivity の実装

src/MainActivity.java に以下のコードを追加します。ボタンをタップすると、通知チャンネルを作成したうえで通知を表示します。

package app.tutorialspoint.com.notifyme;

import android.app.NotificationChannel;
import android.app.NotificationManager;
import android.app.PendingIntent;
import android.content.Intent;
import android.os.Bundle;
import android.support.v4.app.NotificationCompat;
import android.support.v7.app.AppCompatActivity;
import android.view.View;

public class MainActivity extends AppCompatActivity {

    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);
    }

    public void createNotification(View view) {
        Intent notificationIntent = new Intent(getApplicationContext(), MainActivity.class);
        notificationIntent.putExtra("fromNotification", true);
        notificationIntent.setFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP | Intent.FLAG_ACTIVITY_SINGLE_TOP);
        PendingIntent pendingIntent = PendingIntent.getActivity(this, 0, notificationIntent, 0);

        NotificationManager mNotificationManager = (NotificationManager) getSystemService(NOTIFICATION_SERVICE);
        NotificationCompat.Builder mBuilder = new NotificationCompat.Builder(MainActivity.this, default_notification_channel_id);
        mBuilder.setContentTitle("My Notification");
        mBuilder.setContentIntent(pendingIntent);
        mBuilder.setColor(getColor(R.color.colorPrimary));
        mBuilder.setContentText("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());
    }
}

手順4：CrashHandler クラスの作成

src/CrashHandler.java として新しいクラスを作成し、以下のコードを追加します。このクラスは Thread.UncaughtExceptionHandler を実装しており、捕捉されなかった例外（＝クラッシュ）が発生した瞬間に uncaughtException() が呼び出されます。その中で NotificationManager.cancel() を実行することで、通知を削除しています。

package app.tutorialspoint.com.notifyme;

import android.app.NotificationManager;
import android.content.Context;

public class CrashHandler implements Thread.UncaughtExceptionHandler {

    private static final int NOTIFICATION_ID = 12345;
    private Thread.UncaughtExceptionHandler defaultUEH;
    private NotificationManager notificationManager;

    public CrashHandler(Context context) {
        this.defaultUEH = Thread.getDefaultUncaughtExceptionHandler();
        notificationManager = (NotificationManager) context.getSystemService(Context.NOTIFICATION_SERVICE);
    }

    @Override
    public void uncaughtException(Thread t, Throwable e) {
        if (notificationManager != null) {
            try {
                notificationManager.cancel(NOTIFICATION_ID);
            } catch (Throwable ex) {
                ex.printStackTrace();
            }
        }
        notificationManager = null;
        defaultUEH.uncaughtException(t, e);
    }
}

CrashHandler の登録

CrashHandler を有効にするには、MainActivity の onCreate() 内で以下のようにシステムへ登録します。

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);
    // クラッシュ時に通知をクリアするハンドラを登録
    Thread.setDefaultUncaughtExceptionHandler(new CrashHandler(this));
}

手順5：AndroidManifest.xml の設定

最後に、AndroidManifest.xml に以下のコードを記述します。

<?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>

    </application>

</manifest>

動作のポイント

通知IDを揃える：クラッシュ時に通知を確実にキャンセルするには、notify() で通知を発行する際のIDと、CrashHandler 内の NOTIFICATION_ID（12345）を一致させる必要があります。System.currentTimeMillis() をIDに使うと毎回異なる値になるため、固定IDでの発行をおすすめします。

デフォルトハンドラへの委譲：uncaughtException() の最後で defaultUEH.uncaughtException(t, e) を呼び出すことで、システム標準のクラッシュ処理（ログ出力など）も引き続き正常に動作します。