Android
 Computer >> コンピューター >  >> プログラミング >> Android

【Android開発】AlarmManagerでアラームを設定する方法をKotlinで解説

AndroidのAlarmManagerとは?

Androidアプリ開発において、指定した時刻に処理を実行したいケースは多くあります。例えば、通知の送信や定期処理の実行などです。そんなときに活躍するのがAlarmManager(アラームマネージャー)です。AlarmManagerを使うことで、アプリが動作していなくても、指定した時刻にシステムが処理を起動してくれます。

この記事では、TimePickerで選択した時刻にアラームを設定するサンプルアプリを通じて、AlarmManagerの基本的な使い方をKotlinで解説します。

手順1:新規プロジェクトを作成する

まず、Android Studioを開き、メニューから「File → New Project」を選択して、必要な項目を入力して新しいプロジェクトを作成しましょう。言語はKotlinを選択しておくと、後述のコードをそのまま利用できます。

手順2:レイアウトファイル(activity_main.xml)を編集する

次に、res/layout/activity_main.xmlに以下のコードを追加します。画面には時刻を選択するためのTimePickerと、アラームを設定するためのButtonを配置しています。

<?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="8dp"
   tools:context=".MainActivity">
   <LinearLayout
      android:id="@+id/linearLayout"
      android:layout_width="match_parent"
      android:layout_height="wrap_content"
      android:layout_centerVertical="true"
      android:orientation="vertical">
   <TimePicker
      android:id="@+id/timePicker"
      android:layout_width="wrap_content"
      android:layout_height="wrap_content" />
   <Button
      android:layout_gravity="center"
      android:id="@+id/buttonAlarm"
      android:layout_width="wrap_content"
      android:layout_height="wrap_content"
      android:text="Set Alarm" />
   </LinearLayout>
</RelativeLayout>

手順3:MainActivityにアラーム処理を実装する

続いて、src/MainActivity.ktに以下のコードを記述します。ボタンがタップされたら、TimePickerで選択された時刻をCalendarに設定し、その時刻にアラームが発火するようAlarmManagerへ登録します。

import android.app.AlarmManager
import android.app.PendingIntent
import android.content.BroadcastReceiver
import android.content.Context
import android.content.Intent
import android.os.Build
import android.os.Bundle
import android.util.Log
import android.widget.Button
import android.widget.TimePicker
import android.widget.Toast
import androidx.appcompat.app.AppCompatActivity
import java.util.*
class MainActivity : AppCompatActivity() {
   lateinit var btnSetAlarm: Button
   lateinit var timePicker: TimePicker
   override fun onCreate(savedInstanceState: Bundle?) {
      super.onCreate(savedInstanceState)
      setContentView(R.layout.activity_main)  
      title = "KotlinApp"
      timePicker = findViewById(R.id.timePicker)
      btnSetAlarm = findViewById(R.id.buttonAlarm)
      btnSetAlarm.setOnClickListener {
         val calendar: Calendar = Calendar.getInstance()
         if (Build.VERSION.SDK_INT >= 23) {
            calendar.set(calendar.get(Calendar.YEAR), calendar.get(Calendar.MONTH), calendar.get(Calendar.DAY_OF_MONTH), timePicker.hour, timePicker.minute, 0)
         }
         else {
            calendar.set(calendar.get(Calendar.YEAR),
            calendar.get(Calendar.MONTH),
            calendar.get(Calendar.DAY_OF_MONTH),
            timePicker.currentHour,
            timePicker.currentMinute, 0)
         }
         setAlarm(calendar.timeInMillis)
      }
   }
   private fun setAlarm(timeInMillis: Long) {
      val alarmManager = getSystemService(Context.ALARM_SERVICE) as AlarmManager
      val intent = Intent(this, MyAlarm::class.java)
      val pendingIntent = PendingIntent.getBroadcast(this, 0, intent, 0)
      alarmManager.setRepeating(AlarmManager.RTC, timeInMillis, AlarmManager.INTERVAL_DAY, pendingIntent)
      Toast.makeText(this, "Alarm is set", Toast.LENGTH_SHORT).show()
   }
   private class MyAlarm : BroadcastReceiver() {
      override fun onReceive(context: Context, intent: Intent) {
         Log.d("Alarm Bell", "Alarm just fired")
      }
   }
}

コードのポイント

このコードで注目すべき点は以下の通りです。

  • APIレベル23(Android 6.0)以降ではtimePicker.hour / timePicker.minuteを使用し、それ以前のバージョンではcurrentHour / currentMinuteを使い分けています。
  • PendingIntent.getBroadcast()を使って、アラーム発火時にBroadcastReceiver(ここではMyAlarmクラス)へ通知を送ります。
  • setRepeating()AlarmManager.INTERVAL_DAYを指定することで、毎日同じ時刻に繰り返しアラームが実行されます。

手順4:AndroidManifest.xmlを確認する

androidManifest.xmlには、以下のようにメインアクティビティの宣言が含まれていればOKです。BroadcastReceiverを別ファイルとして定義する場合は、<receiver>タグでの宣言も必要になります。

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="https://schemas.android.com/apk/res/android" package="com.example.q11">
   <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>

アプリを実行して動作を確認する

それでは、実際にアプリを起動して動作を確認してみましょう。Android端末をPCに接続し、Android Studioのツールバーから「Run」アイコンをクリックします。接続した実機を選択して実行すると、端末に以下のような画面が表示されます。

【Android開発】AlarmManagerでアラームを設定する方法をKotlinで解説

TimePickerで時刻を選択して「Set Alarm」ボタンをタップすると「Alarm is set」というトーストが表示され、指定した時刻になるとLogcatに「Alarm just fired」というログが出力されます。

まとめ

本記事では、AndroidのAlarmManagerを使って、TimePickerで指定した時刻にアラームを設定する方法を紹介しました。ポイントは以下の3つです。

  • AlarmManagergetSystemService()で取得する
  • 発火時に実行する処理をPendingIntentBroadcastReceiverで定義する
  • setRepeating()で繰り返し間隔を指定できる

なお、Android 8.0以降ではバックグラウンド制限が強化されているため、実運用ではsetExactAndAllowWhileIdle()や通知チャンネルの設定なども検討するとよいでしょう。ぜひ本サンプルをベースに、自分のアプリに合わせたアラーム機能を実装してみてください。

  1. 【Android】スナックバー(Snackbar)の使い方をステップごとに解説

    このチュートリアルでは、Androidアプリでスナックバー(Snackbar)を使用する方法を、サンプルコードとともに段階的に解説します。スナックバーは画面下部に短いメッセージを一時的に表示できるUIコンポーネントで、Toastとは異なり「再試行(RETRY)」などのアクションボタンを組み込めるのが大きな特徴です。 手順1:新規プロジェクトを作成する Android Studioを起動し、メニューから「File」→「New Project」を選択します。必要な項目をすべて入力して、新しいプロジェクトを作成しましょう。 手順2:レイアウトファイル(activity_main.xml)を編集する

  2. 【Android】NavigationViewの実装方法をステップごとに解説

    この記事では、AndroidアプリでNavigationView(ナビゲーションビュー)を使用してドロワーメニューを実装する方法を、ステップごとに詳しく解説します。ハンバーガーアイコンから開閉できるサイドメニューは、多くのアプリで採用されている定番のUIです。ステップ1:新しいプロジェクトを作成するAndroid Studioを開き、File → New Project を選択して、必要な情報を入力し新しいプロジェクトを作成します。テンプレートには「Navigation Drawer Activity」を選ぶと、後の作業がスムーズになります。ステップ2:activity_main.xml にコ