AndroidアプリKeyEvent取得時の挙動がうまくいきません

Question

前提・実現したいこと

AndroidStudioにて短い時間内に端末のバックボタンが二回押下されたらアプリを終了できるようにしました。ここまでは安定して実行できました。
さらに、メニューバーが開いていれば一度目のバックボタンが押されたときはメニューバーを閉じるようにし、閉じた状態でバックボタンが二回押下されたらアプリを終了できるようにしようと思いました。

　するとメニューバーを開いるときにバックボタンを押下するとメニューバーは正しく閉じたのですが、アプリを終了するための一度目の押下としても反応してしまいました。

何か他の原因があるでしょうか？

発生している問題・エラーメッセージ

にメニューバーが開いているときにバックボタン押下でメニューバーは正しく閉じますが、
終了するための一度目のバックボタンとしても反応し、トーストも表示されてしまいます。
ログはこんなことになっています。
それぞれ一回ずつしかバックボタンを押下していないのになぜかKeyEventが二回拾われているように見えます

-----------------メニューバーが閉じている時の一度目のバックボタン押下時------------------
D/menuOpened: false
D/pressed: false
    false
D/menuOpened: false
D/pressed: true
----------------メニューボタンで開いたとき-------------------
D/menuButton: メニュー表示
---------------メニューバーが開いているときの一度目のバックボタン押下--------------------
D/menuOpened: true
D/pressed: false
D/menuButton: メニュー非表示
D/menuOpened: false
D/pressed: false
    false
---------------時間内に二回のバックボタン押下--------------------
D/menuOpened: false
D/pressed: false
    false
D/menuOpened: false
D/pressed: true
D/menuOpened: false
D/pressed: true
D/menuOpened: false
D/pressed: true
-----------------ここでアプリは正常終了する-------------------

レイアウトソースコード

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context=".MainActivity">

    <Button
        android:id="@+id/menuButton"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="MenuButton"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toTopOf="parent" />

    <androidx.constraintlayout.widget.ConstraintLayout
        android:id="@+id/menuBar"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:layout_marginTop="55dp"
        android:layout_marginEnd="100dp"
        android:layout_marginRight="100dp"
        android:background="@color/black"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toTopOf="parent">

    </androidx.constraintlayout.widget.ConstraintLayout>
</androidx.constraintlayout.widget.ConstraintLayout>

アクティビティソースコード

package com.example.myapplication

import androidx.appcompat.app.AppCompatActivity
import android.os.Bundle
import android.os.CountDownTimer
import android.util.Log
import android.view.KeyEvent
import android.view.View.GONE
import android.view.View.VISIBLE
import android.widget.Button
import android.widget.Toast
import androidx.constraintlayout.widget.ConstraintLayout

class MainActivity: AppCompatActivity(){
    // 一度目のBackボタンが押されたかどうかを判定するフラグ
    private var pressed = false

    // メニューバー開閉フラグ
    private var menuOpened = false
    // 開閉するメニューバー
    lateinit var menuBar: ConstraintLayout
    //タイマー
    private var keyEventTimer: CountDownTimer? = null

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        val menuButton = findViewById<Button>(R.id.menuButton)
            menuBar = findViewById(R.id.menuBar)
            menuBar.visibility = GONE
        // 二度バックボタンが押されるときのタイマー
        keyEventTimer = object : CountDownTimer(1000, 100) {
            override fun onTick(millisUntilFinished: Long) {
            }
            override fun onFinish() {
                pressed = false
            }
        }
        menuButton.setOnClickListener{
            Log.d("menuButton", "メニューバー表示")
            menuBar.visibility = VISIBLE
            menuOpened = true
        }

    }

    fun closeMenuBar(){
        menuBar.visibility = GONE
        Log.d("menuButton", "メニューバー非表示")
        menuOpened = false
    }
    override fun dispatchKeyEvent(event: KeyEvent): Boolean {
        if (event.keyCode == KeyEvent.KEYCODE_BACK) {
            Log.d("menuOpened", menuOpened.toString())
            Log.d("pressed", pressed.toString())
            if (menuOpened){
                closeMenuBar()
///////////////////////ここを変えてみたりしたが同じ結果/////////////////////
                return false
///////////////////////////////////////////////////////////////////////////
            } else if (!pressed) {
                Log.d("pressed",pressed.toString())
                keyEventTimer!!.cancel()
                keyEventTimer!!.start()

                Toast.makeText(this, "終了する場合は、もう一度バックボタンを押してください", Toast.LENGTH_SHORT).show()
                pressed = true
///////////////////////ここを変えてみたりしたが同じ結果/////////////////////
                return false
///////////////////////////////////////////////////////////////////////////
            } else
                return super.dispatchKeyEvent(event)
        }
        return super.dispatchKeyEvent(event)
    }
}

試したこと

KeyEventの戻り値を変えたりしましたが結果は同じでした。

端末の問題(壊れているとか？)かと思って以下の端末で試しましたが結果は同じでした
Pixel 4 API 28 (Emulator)
Sony SO-03K (実機)
Sony SO-51A (実機)

補足情報（FW/ツールのバージョンなど）

AndroidStudio4.1.2
Kotlin 1.4.21

を使いました。

Answer 1

dispatchKeyEvent の先頭に

        Log.d("dispatchKeyEvent", event.toString())

を入れると分かりますが、キーイベントは action が ACTION_DOWN と ACTION_UP の 2 回来ます。

メニュー非表示状態では、
・ACTION_DOWN で pressed = true になる
・ACTION_UP では super.dispatchKeyEvent(event) を呼ぶが、ACTION_UP の場合は何もしない
ので、結果的に期待通りの動作になってます。

一方、メニュー表示状態では、
・ACTION_DOWN でメニューを非表示にする
・ACTION_UP で pressed = true になる
ため、次のバックボタン押下で終了してしまいます。

修正方法としては、event.action をチェックしても良いのですが、dispatchKeyEvent ではなく onBackPressed メソッドをオーバーライドするのが良いと思います。
参考: [Android] バックキー押下時の onBackPressed() - うら紙のメモ

Comments

[tattys]

大変丁寧にご回答いただきありがとうございます。しかも速い！！
言われてみれば納得のいく原因でした。
早速修正したいと思います。