PermissionsDispatcher是一个针对Android运行时权限管理的开源库,目前已经在GitHub上收获了10.7k科star,被广泛应用于Android项目中,还是很有学习的价值的。
源码中的README已经写的很详尽了,本文仅作摘抄。此外,由于该库未提供多个权限连续申请场景,故本文重点补充此处。
Github源码:https://github.com/permissions-dispatcher/PermissionsDispatcher
配置依赖
dependencies {
//权限申请库
api "com.github.hotchemi:permissionsdispatcher:3.1.0"
//权限申请库需要的处理工具(哪里用 哪里添加)
annotationProcessor "com.github.hotchemi:permissionsdispatcher-processor:3.1.0"
}
声明权限
AndroidManifest.xml中配置想要的运行时权限,比如:
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.CAMERA"/>
代码调用
在需要弹窗的Activity或者Fragment的类名上增加注解@RuntimePermissions
,并使用@NeedsPermission
注解修饰需要权限的方法,该方法会在用户同意该权限后执行该方法,如果用户已经同意,则PermisssionDispatcher框架会在权限检查点调用该方法。另外,还有用户拒绝权限、永久拒绝等交互的注解,但不是必须实现的方法。
触发权限弹窗
MainActivityPermissionsDispatcher.getCameraPermissionWithPermissionCheck(this);
同意权限后处理
@NeedsPermission({Manifest.permission.WRITE_EXTERNAL_STORAGE,Manifest.permission.READ_EXTERNAL_STORAGE})
public void getStoragePermission() {
Log.i(TAG, "getStoragePermission");
}
相关注解
注解名 | 必须 | 描述 |
---|---|---|
@RuntimePermissions | ✓ | 注册 Activity or Fragment 可以处理权限请求 |
@NeedsPermission | ✓ | 用户同意授予权限后执行该方法 |
@OnShowRationale | 当用户拒绝一次后再次请求权限时会调用,用于想用户解释为何要申请该权限,劝导用户同意 | |
@OnPermissionDenied | 用户拒绝授予权限后执行该方法 | |
@OnNeverAskAgain | 用户拒绝授予权限并选中“不再询问”后执行该方法 |
遇到的坑
1、needsPermission等回调同意权限第一次不执行
追加一个onRequestPermissionsResult
的重写,具体原理还没搞明白,怀疑是跨线程的原因,知道的小伙伴给个留个言吧。谢谢~
@Override
public void onRequestPermissionsResult(int requestCode, String[] permissions, int[] grantResults) {
super.onRequestPermissionsResult(requestCode, permissions, grantResults);
xxxPermissionsDispatcher.onRequestPermissionsResult(this, requestCode, grantResults);
}
2、多个需要单独处理的权限
写在更新,用运行中权限就应该尽量避免在onCreate里一次性申请各种权限。这种处理并不符合RuntimePermission设计的初衷。
开发过程中遇到过一个页面在onCreate()
时就需要多个权限,简单的罗列XxxPermissionsDispatcher.xxxWithPermissionCheck
方法,会发现只会弹出第一个权限弹窗,其他的权限会在下一次进入该页面时显示,原因应该是弹窗冲突了。所以需要根据弹出顺序在每一个权限处理的回调方法中调用下一个权限的触发方法(@NeedsPermission
、@OnPermissionDenied
、@OnNeverAskAgain
),注意都要调用一遍。
在此可以使用Handler来将几个权限请求顺序化处理,以便于后续代码的阅读与维护,具体实现如下。
package com.example.developerlab;
import androidx.annotation.NonNull;
import androidx.appcompat.app.AppCompatActivity;
import android.Manifest;
import android.os.Bundle;
import android.os.Handler;
import android.os.Looper;
import android.os.Message;
import android.util.Log;
import permissions.dispatcher.NeedsPermission;
import permissions.dispatcher.OnNeverAskAgain;
import permissions.dispatcher.OnPermissionDenied;
import permissions.dispatcher.RuntimePermissions;
@RuntimePermissions
public class MainActivity extends AppCompatActivity {
private static final String TAG = MainActivity.class.getSimpleName();
private static final int REQUEST_CAMERA_PERMISSION_DONE = 1001;
private Handler permissionHandler;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
permissionHandler = new Handler(Looper.myLooper()) {
@Override
public void handleMessage(@NonNull Message msg) {
super.handleMessage(msg);
switch (msg.what) {
case REQUEST_CAMERA_PERMISSION_DONE: // 当请求完一个权限后再触发下一个权限的申请
MainActivityPermissionsDispatcher.getStoragePermissionWithPermissionCheck(MainActivity.this);
break;
default:
Log.w(TAG, "Undefine message id:" + msg.what);
}
}
};
MainActivityPermissionsDispatcher.getCameraPermissionWithPermissionCheck(this);
}
@NeedsPermission({Manifest.permission.WRITE_EXTERNAL_STORAGE,
Manifest.permission.READ_EXTERNAL_STORAGE})
public void getStoragePermission() {
Log.i(TAG, "getStoragePermission");
}
@NeedsPermission(Manifest.permission.CAMERA)
public void getCameraPermission() {
Log.i(TAG, "getCameraPermission");
notifyRequestCameraPermission();
}
@OnPermissionDenied(Manifest.permission.CAMERA)
public void cmeraPermissionDenied() {
Log.i(TAG, "cmeraPermissionDenied");
notifyRequestCameraPermission();
}
@OnNeverAskAgain(Manifest.permission.CAMERA)
public void cmeraNeverAskAgain() {
Log.i(TAG, "cmeraNeverAskAgain");
notifyRequestCameraPermission();
}
private void notifyRequestCameraPermission() {
Message msg = Message.obtain(permissionHandler);
msg.what = REQUEST_CAMERA_PERMISSION_DONE;
msg.sendToTarget();
}
}