posted at 2017-12-04

Androidの通知をカスタムする(API21以降)

皆さんGoogle Homeは購入しましたか？

自分は miniだけ購入して、音楽再生や天気を教えてもらうなどデフォルトの機能を使っています。

音楽再生にはSpotifyで連携しています。Google Homeで再生中のとき、スマホに再生中の通知が表示されます。

今回のテーマはその通知です。
Google Homeが表示する通知が地味にリッチなので真似出来ないかなと思い、実装方法を調査しました。

こんな通知。展開したり折りたたむと、アニメーションします。

NotificationCompat.Style

通知の種類はいくつか用意されています。

BigTextStyle などは馴染みがあると思いますが、今回のSpotfiyの通知は MediaStyle というものでした。

音楽系のサービスで利用されている MediaStyle と、通知領域をカスタムできる DecoratedCustomViewStyle と DecoratedMediaCustomViewStyle について紹介します。

Style を変更するには NoficationCompat.Builder で Style を設定します。

builder.setStyle(NotificationCompat.BigTextStyle().also { 
    // Styleならではの記述
})

MediaStyle

MediaStyle はSupport Library 26.0.0から v4 media-compat library に移ったようです。なので依存関係に追加が必要です。

implementation "com.android.support:support-media-compat:27.0.2"

Styleは以下のようになります。 android.support.v4.media.appからimportするので注意が必要です。android.support.v4.app と NotificationCompat が被ります。

builder.setStyle(android.support.v4.media.app.NotificationCompat.MediaStyle()
                        .setShowActionsInCompactView(0)
                )

MediaSession が必要かと思いきや、無くても利用可能です。

通常の通知と異なり、 NotificationCompat.Builder#addAction で追加したActionは、通知領域の中に表示されます。

MediaStyle#setShowActionsInCompactView の引数で、compact 状態のときに表示するActionを指定できます。追加したAction順にintで指定します。

以下の例は、 setShowActionsInCompactView(0) で、Actionを3つ追加したものです。

DecoratedCustomViewStyle

通知のViewは RemoteViews を使うことでカスタムできますが、バージョン間や端末による違いなどを考慮する必要がでてきます。また、Actionが正しく表示されなくなります。

これらの問題を解決しつつ、カスタムできるStyleが DecoratedCustomViewStyle です。

builder.setStyle(NotificationCompat.DecoratedCustomViewStyle())

カスタムViewを適応できる状態は3種類あります。

ContentView
- 通知領域で折りたたまれてる状態です。
- こちらを変更するにはNotificationCompat.Builder#setCustomContentViewを使います。
- NotificationCompat.Builder#setContent は内部的には Deprecated になっているので利用しないようにしましょう。
BigContentView
- 通知領域で展開されてる状態です。
- こちらを変更するにはNotificationCompat.Builder#setCustomBigContentViewを使います。
HeadsUpContentView
- HeadsUp通知で表示されてる状態です。
- こちらを設定していない場合は ContentView が表示されます。
- こちらを変更するにはNotificationCompat.Builder#setCustomHeadsUpContentViewを使います。
- HeadUp通知の最大領域は、Nougat以降では148dpになるようです。
  - それ以上カスタムViewで表示させようとすると見切れます。

比較するとわかりますが、デフォルトで用意される領域は残しつつカスタムViewが適応できる形です。

DecoratedCustomViewStyle	デフォルト

DecoratedMediaCustomViewStyle

DecoratedMediaCustomViewStyle も MediaStyle と同様に、 v4 media-compat library から利用します。

Styleは以下のようになります。

builder.setStyle(android.support.v4.media.app.NotificationCompat.DecoratedMediaCustomViewStyle()
                        .setShowActionsInCompactView(0)
                )