rokkonet

PC・Androidソフトウェア・アプリの開発・使い方に関するメモ

android開発　ActivityResultContractsによるパーミッション取得（権限取得／permission取得）

android開発

2023 Mar. 05.
2022 Mar. 11.

出典　Android の位置情報の権限要求（フォアグラウンド）について

 Android 7.0　android 11で動作確認した
　Android 7.0ではパーミッション取得確認ダイアログに「今後表示しない」チェックボックスが表示された
　Android11では「今後表示しない」が表示されなかった

概要

requestPermissions / onRequestPermissionsResultがdeprecatedになった
ActivityResultContractsを利用する
shouldShowRequestPermissionRationale()の使い方に注意する　　参考ページ： android開発 shouldShowRequestPermissionRationale() - rokkonet
android SDKバージョンが22以下ではパーミッション取得処理は不要

外部ストレージ読込権限を取得する例

AndroidManifest.xml

READ_EXTERNAL_STORAGE権限許可を記述する

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="PROJECT">

    <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />

    <application

build.gradle(:app)

viewBindingを記述

plugins {
    id 'com.android.application'
    id 'org.jetbrains.kotlin.android'
}

android {
    compileSdk 32

    defaultConfig {
        applicationId "net.sytes.rokkosan.mygetpermission"
        minSdk 24
        targetSdk 32
        versionCode 1
        versionName "1.0"

        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
    }

    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
        }
    }
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
    kotlinOptions {
        jvmTarget = '1.8'
    }
    buildFeatures {
        viewBinding true
    }
}

dependencies {

    implementation 'androidx.core:core-ktx:1.7.0'
    implementation 'androidx.appcompat:appcompat:1.4.1'
    implementation 'com.google.android.material:material:1.5.0'
    implementation 'androidx.constraintlayout:constraintlayout:2.1.3'
    testImplementation 'junit:junit:4.13.2'
    androidTestImplementation 'androidx.test.ext:junit:1.1.3'
    androidTestImplementation 'androidx.test.espresso:espresso-core:3.4.0'
}

activity_main.xml

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

    <TextView
        android:id="@+id/tvResult"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="Hello World!"
        app:layout_constraintBottom_toTopOf="@id/btnGetPermission"
        app:layout_constraintLeft_toLeftOf="parent"
        app:layout_constraintRight_toRightOf="parent"
        app:layout_constraintTop_toTopOf="parent" />

    <Button
        android:id="@+id/btnGetPermission"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="@string/get_permission"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintLeft_toLeftOf="parent"
        app:layout_constraintRight_toRightOf="parent"
        app:layout_constraintTop_toBottomOf="@id/tvResult" />

</androidx.constraintlayout.widget.ConstraintLayout>

strings.xml

<resources>
    <string name="app_name">MyGetPermission</string>
    <string name="get_permission">Get_Permission</string>
    <string name="failed_permission">Failed getting permission</string>
    <string name="already_rejected_permission">Already reejected to get permission</string>
    <string name="got_permission">Got_Permission</string>
    <string name="please_open_configuration">ストレージ読込みの権限が拒否されました。設定から読込権限を許可してください</string>
    <string name="go_to_configuration">設定を開く</string>
    <string name="ok">OK</string>
    <string name="dismiss">Dismiss</string>
    <string name="please_require_permission">ストレージ読込権限が必要です。許可しますか?</string>
    <string name="reason_for_permission">ストレージファイル読み込みに読込権限の許可が必要です。設定を開きますか?</string>
</resources>

MainActivity.kt

package net.sytes.rokkosan.mygetpermission

// 2022 Mar. 26.
// 2022 Mar. 11.
// Ryuichi Hashimoto.

import android.Manifest
import android.content.Context
import android.content.SharedPreferences
import android.content.pm.PackageManager
import androidx.appcompat.app.AppCompatActivity
import android.os.Bundle
import androidx.activity.result.contract.ActivityResultContracts
import androidx.core.content.ContextCompat
import net.sytes.rokkosan.mygetpermission.databinding.ActivityMainBinding

class MainActivity : AppCompatActivity() {
    private val binding: ActivityMainBinding by lazy { ActivityMainBinding.inflate(layoutInflater) }

    private val myPermission = Manifest.permission.READ_EXTERNAL_STORAGE
    private var isCheckedNotAskAgain: Boolean = false
    private val sharedPref: SharedPreferences by lazy { this.getSharedPreferences("myPref", Context.MODE_PRIVATE) }

    // registerForActivityResult()を定義してlaunch()を呼び出すと、
    // パーミッションが許可されていない時はユーザーにパーミッション許可を促すダイアログが表示される。
    // パーミッションが「許可された時」「許可されなかった時」のコールバック関数を記述する
    private val permisLauncher = registerForActivityResult(
        ActivityResultContracts.RequestPermission()
    ) { granted ->
        if (granted) {
            // パーミッションが取得されている時
            // パーミッション取得後にすべき処理に移る
            isCheckedNotAskAgain = false
            with (sharedPref.edit()) {
                putBoolean("isCheckedNotAskAgain", isCheckedNotAskAgain)
                apply()
            }
            myWorkWithPermission()
        } else {
            // パーミッションを取得していない
            if (shouldShowRequestPermissionRationale(myPermission)) {
                // パーミッション取得を拒否され、
                // 「今後表示しない」は選択されていない
                isCheckedNotAskAgain = false
                with (sharedPref.edit()) {
                    putBoolean("isCheckedNotAskAgain", isCheckedNotAskAgain)
                    apply()
                }
            } else {
                // パーミッション取得を拒否され、
                // 「今後表示しない」が選択されて再リクエストも拒否されている
                isCheckedNotAskAgain = true
                with (sharedPref.edit()) {
                    putBoolean("isCheckedNotAskAgain", isCheckedNotAskAgain)
                    apply()
                }
            }
            myWorkWithoutPermission()
        }
    }

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(binding.root)

        isCheckedNotAskAgain = sharedPref.getBoolean("isCheckedNotAskAgain", false)

        binding.btnGetPermission.setOnClickListener{
            getMyPermission()
        }
    }

    /*
     * パーミッションを取得するメソッド
     *   パーミッションが取得されれば
     *
     *   パーミッションが取得されなければ
     *
    */
    private fun getMyPermission() {
        if ( ContextCompat.checkSelfPermission(this, myPermission) ==
            PackageManager.PERMISSION_GRANTED) {
            // 既にパーミッションが取得されている時
            // パーミッション取得後にすべき処理に移る
            isCheckedNotAskAgain = false
            with (sharedPref.edit()) {
                putBoolean("isCheckedNotAskAgain", isCheckedNotAskAgain)
                apply()
            }
            myWorkWithPermission()
        } else {
            // パーミッション未取得
            if (isCheckedNotAskAgain) {
                // 過去に権限取得を拒否され、「今後表示しない」が選択されて再リクエストも拒否されている
                // ダイアログでユーザーに説明し、ユーザーが望めば設定画面を表示する
                val openConfigDialogFragment = OpenConfigDialogFragment()
                openConfigDialogFragment.show(supportFragmentManager, "simple")

                // ダイアログ後の処理
                if ( ContextCompat.checkSelfPermission(this, myPermission) ==
                        PackageManager.PERMISSION_GRANTED) {
                    // （設定画面で）パーミッションを取得している
                    isCheckedNotAskAgain = false
                    with (sharedPref.edit()) {
                        putBoolean("isCheckedNotAskAgain", isCheckedNotAskAgain)
                        apply()
                    }
                    myWorkWithPermission()
                } else {
                    // パーミッション未取得。
                    // shouldShowRequestPermissionRationale()に応じて
                    // isCheckedNotAskAgainを設定し保存する
                    if (shouldShowRequestPermissionRationale(myPermission)) {
                        // 「今後表示しない」は選択されていない
                        isCheckedNotAskAgain = false
                        with (sharedPref.edit()) {
                            putBoolean("isCheckedNotAskAgain", isCheckedNotAskAgain)
                            apply()
                        }
                    } else {
                        // 「今後表示しない」が選択されている
                        isCheckedNotAskAgain = true
                        with (sharedPref.edit()) {
                            putBoolean("isCheckedNotAskAgain", isCheckedNotAskAgain)
                            apply()
                        }
                    }
                    myWorkWithoutPermission()
                }
            } else {
                // パーミッションを取得しておらず、
                // 過去に権限取得で再リクエストの拒否はしていない。
                permisLauncher.launch(myPermission)
            }
        }
    }

    // パーミッション取得後に行うこと
    private fun myWorkWithPermission(){
        binding.tvResult.text = getString(R.string.got_permission)
    }

    // パーミッション取得しなかった時に行うこと
    private fun myWorkWithoutPermission(){
        binding.tvResult.text = getText(R.string.failed_permission)
    }
}

OpenConfigDialogFragment.kt

package net.sytes.rokkosan.mygetpermission

// 2022 Mar. 21.
// 2022 Mar. 12.
// Ryuichi Hashimoto

import android.app.AlertDialog
import android.app.Dialog
import android.content.DialogInterface
import android.content.Intent
import android.net.Uri
import android.os.Bundle
import android.provider.Settings
import androidx.fragment.app.DialogFragment

// Grateful for https://developer.android.com/guide/topics/ui/dialogs?hl=ja
class OpenConfigDialogFragment: DialogFragment() {
    override fun onCreateDialog(savedInstanceState: Bundle?): Dialog {
        return activity?.let {
            val builder = AlertDialog.Builder(it)
            builder.setMessage(R.string.reason_for_permission)
                .setPositiveButton(R.string.ok,
                    DialogInterface.OnClickListener { dialog, id ->
                        // このアプリの設定画面への暗黙的インテントを用意する
                        val packageName = context?.applicationContext?.packageName
                        val intent = Intent(
                            Settings.ACTION_APPLICATION_DETAILS_SETTINGS,
                            Uri.parse("package:${packageName}")
                        )
                        // 新しいタスクで設定画面を開く
                        //   https://developer.android.google.cn/guide/components/activities/tasks-and-back-stack?hl=ja
                        intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK)
                        startActivity(intent)
                    })
                .setNegativeButton(R.string.dismiss,
                    DialogInterface.OnClickListener { dialog, id ->
                        // User cancelled the dialog
                    })
            // Create the AlertDialog object and return it
            builder.create()
        } ?: throw IllegalStateException("Activity cannot be null")
    }
}

以下、旧文

2022 Feb. 12.
2022 Jan. 30.

build.gradle(:app)に記入したコンパイル設定

android {
    compileSdk 31

    defaultConfig {
        minSdk 24
        targetSdk 31

パーミッションを取得するkotlinコード

出典　https://codechacha.com/ja/android-request-runtime-permissions/

val PERMISSION_READ_EX_STOR: Int = 100

// パーミッションがあれば処理を進める。無ければ取得する
if ( isGrantedReadStorage()) {
    // permission is given
    // YOU CAN CONTINUE YOUR WORK WITH EXTERNAL_STORAGE HERE
    myWork()
} else {
    requestPermissions(arrayOf(Manifest.permission.READ_EXTERNAL_STORAGE), PERMISSION_READ_EX_STOR)
    // requestPermissions()の結果に応じた処理がonRequestPermissionsResult()で行われる
}

// アプリにパーミッションが付与されているかどうかを確認するメソッド
fun isGrantedReadStorage(): Boolean {
    return (checkSelfPermission(Manifest.permission.READ_EXTERNAL_STORAGE)
            == PackageManager.PERMISSION_GRANTED)
}

// requestPermissions()の結果に対する処理を行うメソッド
override fun onRequestPermissionsResult(
        requestCode: Int, permissions: Array<String>, grantResults: IntArray) {

    when (requestCode) {
        PERMISSION_READ_EX_STOR -> {
            if (grantResults.isEmpty()) {
                // STOP WORK
                throw RuntimeException("Empty permission result")
            }
            if (grantResults[0] == PackageManager.PERMISSION_GRANTED) {
                // permission is got.
                // YOU CAN CONTINUE YOUR WORK WITH EXTERNAL_STORAGE HERE
                myWork()

            } else {  // no permission is got
                if (shouldShowRequestPermissionRationale(
                        Manifest.permission.READ_EXTERNAL_STORAGE)) {
                    // permission request was denied.
                    // User declined, but system can still ask for more
                    // request permission agein
                    requestPermissions( arrayOf(Manifest.permission.READ_EXTERNAL_STORAGE), PERMISSION_READ_EX_STOR)
                } else {
                    // permission request was denied and requested "no not ask".
                    // User declined and i can't ask.
                    // CODES in case of rejection to get permission here
                }
            }
        }
    }
}

// パーミッション取得後の処理を記述した関数
fun myWork() {
  // Codes to work with permission
}