前言
前面我们有讲到权限申请相关文章,大家感兴趣的话可以参考以下文章:
PermissionsDispatcher动态权限申请
PermissionsDispatcher动态权限申请kotlin版
RxPermission申请权限
今天我们来讲讲ActivityResultLauncher
实现的动态权限申请。具体使用我已经将其封装成工具类
PermissionHelper
,下面就来具体讲下它的使用吧。
今天涉及内容:
1.添加依赖
2.PermissionHelper
中方法简单介绍
3.PermissionHelper
在MainActivity
中的使用
4.运行效果
5.PermissionHelper
相关源码
一.添加依赖
由于androidstudio
已经Compose
化,相关Activity
已经默认引用"androidx.activity:activity-compose:1.7.0"
,从而导致ActivityResultLauncher
在使用上无法识别,所以我们需要在app_module
的build.gradle
中引入以下依赖:
dependencies {
implementation("androidx.appcompat:appcompat:1.7.0")
//其他代码省略
//......
}
这样我们在使用ActivityResultLauncher
及相关方法的时候,才不会报错。
二. PermissionHelper 中方法简单介绍
作为权限申请的工具类PermissionHelper
中具有以下公开方法:
/**
* 监听权限返回处理
*
* @param listener 权限返回监听类
* @return 返回 ActivityResultLauncher<Array<String>> 对象
*/
fun getRequestPermissionLauncher(listener: IPermissionListener): ActivityResultLauncher<Array<String>>
/**
* 发起权限申请
*
* @param resultLauncher ActivityResultLauncher<Array<String>>对象
*/
fun requestPermissions(resultLauncher: ActivityResultLauncher<Array<String>>)
/**
* 检测是否permisson已经授权
*
* @param permission eg: Manifest.permission.READ_EXTERNAL_STORAGE
* @return boolean true:已授权 false:未授权
*/
fun checkSelfPermission(permission: String): Boolean
/**
* 检测是否需要给未授权权限给出拒绝理由
*
* @param permission eg: Manifest.permission.READ_EXTERNAL_STORAGE
* @return boolean true:需要给出拒绝理由 false:不需要给出拒绝理由
*/
fun checkShouldShowPermissionDescription(permission: String): Boolean
三. PermissionHelper 在 MainActivity 中的使用
代码示例中使用的是ViewBinding
初始化控件,大家如果对ViewBinding
使用不甚了解的话,可以参考以下文章:
ViewBinding(1) — 在Activity中使用
ViewBinding(2) — Activity中ViewBinding和include标签使用
ViewBinding(3) — ViewBinding在fragment中使用
ViewBinding(4) — ViewBinding在Adapter中使用
MainActivity
中申请权限是以读写和定位权限为例,所以需要在AndroidManifest.xml
中添加以下权限:
<!-- 读写权限 -->
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
<!-- 定位权限 -->
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"/>
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION"/>
接下来让我们看看PermissionHelper
在MainActivity
中的使用:
package com.example.kdemo.ui
import android.Manifest
import android.os.Bundle
import android.widget.Toast
import androidx.activity.result.ActivityResultLauncher
import androidx.appcompat.app.AppCompatActivity
import com.example.kdemo.R
import com.example.kdemo.bean.StudentBean
import com.example.kdemo.databinding.ActivityMainBinding
import com.example.kdemo.permission.PermissionHelper
import com.example.kdemo.util.LogUtil
class MainActivity : AppCompatActivity() {
private lateinit var mBinding:ActivityMainBinding
private lateinit var mPermissionHelper:PermissionHelper
private lateinit var mActivityResultLauncher:ActivityResultLauncher<Array<String>>
private var mPermissions = arrayOf(
Manifest.permission.READ_EXTERNAL_STORAGE,
Manifest.permission.WRITE_EXTERNAL_STORAGE,
Manifest.permission.ACCESS_FINE_LOCATION
)
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
mBinding = ActivityMainBinding.inflate(layoutInflater)
setContentView(mBinding.root)
initData()
setListener()
}
protected val initData = {
mBinding.mTvName.text="我是中国人"
var studentBean=StudentBean("小华",13)
LogUtil.i("studentBean=${studentBean}")
mPermissionHelper = PermissionHelper(this@MainActivity,mPermissions)
//监听申请结果
mActivityResultLauncher = mPermissionHelper.getRequestPermissionLauncher(object :
PermissionHelper.IPermissionListener {
override fun requestSuccess() {
LogUtil.i("permission request success")
}
override fun shouldShowPermissionDescription(descriptionList: MutableList<String>) {
LogUtil.i("permission request should show description dialog: ")
descriptionList.forEach {
LogUtil.i("description permission: $it")
}
}
override fun requestFail(requestFailList: MutableList<String>) {
LogUtil.i("permission request fail")
requestFailList.forEach {
LogUtil.i("fail permission: $it")
}
}
})
}
protected val setListener = {
mBinding.mTvName.setOnClickListener {
when(it.id){
// R.id.mTvName ->toast("大家好")
R.id.mTvName ->{
LogUtil.i("start request permission")
//申请权限
mPermissionHelper.requestPermissions(mActivityResultLauncher)
LogUtil.i("request permission over")
}
}
}
}
protected val toast: (String) -> Unit = {
Toast.makeText(this@MainActivity, it, Toast.LENGTH_SHORT).show()
}
}
从以上代码可以看到,MainActivity
在执行初始化操作时,我们初始化了PermissionHelper
对象并传入了权限数组。初始化ActivityResultLauncher
对象的时候监听权限申请的结果回调。然后在需要申请权限的地方调用:
//申请权限
mPermissionHelper.requestPermissions(mActivityResultLauncher)
需要注意的是,在权限申请回调中有三个方法:
//申请权限成功
fun requestSuccess()
//拒绝授权需要提供理由
fun shouldShowPermissionDescription(descriptionList: MutableList<String>)
//申请权限失败的权限列表
fun requestFail(requestFailList: MutableList<String>)
fun requestSuccess()
:权限申请成功的处理,在此处你可以做你app
内部需要处理的逻辑。
fun shouldShowPermissionDescription(descriptionList: MutableList<String>)
:权限被用户拒绝,然后你需要给出申请这些权限的理由,用于引导用户给予权限,此方法返回的是被用户拒绝的权限列表,你可以再此弹出dialog
并罗列被拒绝的权限,并给出各权限申请的理由以引导用户继续授权
fun requestFail(requestFailList: MutableList<String>)
申请用户授权失败,返回授权失败的权限列表,在此方法内,你可以罗列哪些权限申请被拒绝,并以弹出dialog
的方式告知用户
四.运行效果
此次运行后,界面先弹出是否授权位置,我选择拒绝,接着弹出是否授权拍照和相册权限的dialog
,我选择允许,然后运行的日志如下:
start request permission
request permission over
permission request fail
fail permission: android.permission.ACCESS_FINE_LOCATION
可以看到fun requestFail(requestFailList: MutableList<String>)
执行并返回位置授权失败。
五.PermissionHelper 相关源码
下面给出PermissionHelper
类源码: