使用flutter进行app开发,一定会用到手机的部分权限,包括通知推送、定位、相册、存储、相机、麦克风等。
而权限的检查和获取,最受欢迎的就是通过permission_handler这个插件来实现。
本文用最通俗的语言教大家怎么使用这个插件获取手机权限,并封装成一个非常通用的dart文件。
目录
插件安装
权限设置
基本使用
一、获取权限状态
二、申请权限
用户拒绝权限请求后的处理
跳转到应用设置界面
封装
插件安装
flutter pub add permission_handler
关于插件的具体内容,可以查看pub.dev:permission_handler
权限设置
本文将以iOS“通知推送”权限为例
- 在 ios/Runner/Info.plist 文件中加入权限
// ios/Runner/Info.plist
// ...
<dict>
// ...其它设置
<!-- 通知推送 -->
<key>PermissionGroupNotification</key>
<string>Notification</string>
// ...其它设置
</dict>
- 在 ios/Podfile 文件中加入想要获取的权限列表
post_install do |installer|
installer.pods_project.targets.each do |target|
flutter_additional_ios_build_settings(target)
# 以上为flutter自动生成的一些配置
# 加入以下权限申请列表代码
target.build_configurations.each do |config|
config.build_settings['GCC_PREPROCESSOR_DEFINITIONS'] ||= [
'$(inherited)',
## 通知推送
'PERMISSION_NOTIFICATIONS=1',
]
end
# 权限申请列表结束
end
end
- 注意:如果是“通知推送”权限,需要在 AppDelegate.swift 文件中进行如下操作,其它权限不需要:
@objc class AppDelegate: FlutterAppDelegate {
override func application(
_ application: UIApplication,
didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
) -> Bool {
// ....
// **加入以下内容
// This is required to make any communication available in the action isolate.
FlutterLocalNotificationsPlugin.setPluginRegistrantCallback { (registry) in
GeneratedPluginRegistrant.register(with: registry)
}
// 根据设计,iOS应用程序在应用程序处于前台时不显示通知,除非配置为这样。
if #available(iOS 10.0, *) {
UNUserNotificationCenter.current().delegate = self as UNUserNotificationCenterDelegate
}
// **加入以上内容
// ...
GeneratedPluginRegistrant.register(with: self)
return super.application(application, didFinishLaunchingWithOptions: launchOptions)
}
}
至此,所有基本设置已完成,建议重新build项目。
基本使用
一、获取权限状态
var status = await Permission.notification.status;
print(status);
status
有以下几种值:
-
isDenied
:
在 iOS 上代表还未申请权限;
在android上代表还未申请权限或之前拒绝了权限。 -
isGranted
:拥有全部权限。 isLimited
:拥有部分权限。isRestricted
:拥有部分权限(仅限iOS)。isPermanentlyDenied
:权限已被永久拒绝。
二、申请权限
通过调用 request() 来获取权限。在iOS上,首次申请权限才会自动弹出权限申请的对话框
// 申请通知权限:
await Permission.notification.request();
// 同时申请多个权限:
await [
Permission.notification,
Permission.photos,
].request();
用户拒绝权限请求后的处理
android:申请权限时,
如果用户选择"拒绝",status
将保持为isDenied
,以后可以再次调用request()
来取得权限;
如果用户选择"拒绝并不再询问",status
将变为isPermanentlyDenied
,即以后无法再调用request()
来取得权限,必须去应用设置界面手动开启权限。
iOS:首次申请权限时,如果用户选择了"拒绝",status
将变为isPermanentlyDenied
,即以后无法再调用request()
来取得权限,必须去应用设置界面手动开启权限。
跳转到应用设置界面
openAppSettings();
封装
为了方便权限的检查和请求,可以有两种方式进行封装:
1. 封装成方法,在该方法内进行权限判断并弹窗来进行权限说明和操作。这种方式比较简单,但是有个弊端就是当用户去到应用设置界面操作权限后,返回应用时无法自动判断用户操作情况。所以推荐使用第二种方法。
2. 封装成一个页面,这个页面只有一个透明的Container,当需要进行权限判断时,导航至该页面,在这个页面创建时进行权限判断和操作。当用户去到应用设置界面操作权限后,返回应用时使用 WidgetsBindingObserver 的 didChangeAppLifecycleState(AppLifecycleState state) 方法来再次进行权限判断。以下为封装之后的文件 permission_request.dart ,可直接复制粘贴后使用。
import 'dart:io';
import 'package:flutter/cupertino.dart';
import 'package:flutter/services.dart';
import 'package:permission_handler/permission_handler.dart';
/// 权限检查及请求
///
/// 外部可通过此方法来进行权限的检查和请求,将自动跳转到`PermissionRequestPage`页面。
///
/// 传入 `Permission` 以及对应的权限名称 `permissionTypeStr`,如果有权限则返回 `Future true`
///
/// `isRequiredPermission` 如果为 `true`,则 "取消" 按钮将执行 "退出app" 的操作
Future<bool> permissionCheckAndRequest(
BuildContext context,
Permission permission,
String permissionTypeStr,{
bool isRequiredPermission = false
}) async {
if (!await permission.status.isGranted) {
await Navigator.of(context).push(
PageRouteBuilder(
opaque: false,
pageBuilder: ((context, animation, secondaryAnimation) {
return PermissionRequestPage(permission, permissionTypeStr, isRequiredPermission: isRequiredPermission);
}))
);
} else {
return true;
}
return false;
}
class PermissionRequestPage extends StatefulWidget {
const PermissionRequestPage(this.permission, this.permissionTypeStr,{super.key, this.isRequiredPermission = false});
final Permission permission;
final String permissionTypeStr;
final bool isRequiredPermission;
@override
State<PermissionRequestPage> createState() => _PermissionRequestPageState();
}
class _PermissionRequestPageState extends State<PermissionRequestPage> with WidgetsBindingObserver {
bool _isGoSetting = false;
late final List<String> msgList;
@override
void initState() {
super.initState();
WidgetsBinding.instance.addObserver(this);
msgList = [
"${widget.permissionTypeStr}功能需要获取您设备的${widget.permissionTypeStr}权限,否则可能无法正常工作。\n是否申请${widget.permissionTypeStr}权限?",
"${widget.permissionTypeStr}权限不全,是否重新申请权限?",
"没有${widget.permissionTypeStr}权限,您可以手动开启权限",
widget.isRequiredPermission ? "退出应用" : "取消"
];
checkPermission(widget.permission);
}
@override
void didChangeAppLifecycleState(AppLifecycleState state) {
super.didChangeAppLifecycleState(state);
// 监听 app 从后台切回前台
if (state == AppLifecycleState.resumed && _isGoSetting) {
checkPermission(widget.permission);
}
}
/// 校验权限
void checkPermission(Permission permission) async {
final status = await permission.status;
if (status.isGranted) {
_popPage();
return;
}
// 还未申请权限或之前拒绝了权限(在 iOS 上为首次申请权限,拒绝后将变为 `永久拒绝权限`)
if (status.isDenied) {
showAlert(permission, msgList[0], msgList[3], _isGoSetting ? "前往应用中心" : "确定");
}
// 权限已被永久拒绝
if (status.isPermanentlyDenied) {
_isGoSetting = true;
showAlert(permission, msgList[2], msgList[3], _isGoSetting ? "前往应用中心" : "确定");
}
// 拥有部分权限
if (status.isLimited) {
if (Platform.isIOS || Platform.isMacOS) _isGoSetting = true;
showAlert(permission, msgList[1], msgList[3], _isGoSetting ? "前往应用中心" : "确定");
}
// 拥有部分权限(仅限 iOS)
if (status.isRestricted) {
if (Platform.isIOS || Platform.isMacOS) _isGoSetting = true;
showAlert(permission, msgList[1], msgList[3], _isGoSetting ? "前往应用中心" : "确定");
}
}
void showAlert(Permission permission, String message, String cancelMsg, String confirmMsg) {
showCupertinoDialog(
context: context,
builder: (context) {
return CupertinoAlertDialog(
title: const Text("温馨提示"),
content: Text(message),
actions: [
CupertinoDialogAction(
child: Text(cancelMsg),
onPressed: () {
widget.isRequiredPermission ? _quitApp() : _popDialogAndPage(context);
}),
CupertinoDialogAction(
child: Text(confirmMsg),
onPressed: () {
if (_isGoSetting) {
openAppSettings();
_isGoSetting = true;
} else {
requestPermisson(permission);
}
_popDialog(context);
})
],
);
}
);
}
/// 申请权限
void requestPermisson(Permission permission) async {
// 申请权限
await permission.request();
// 再次校验
checkPermission(permission);
}
@override
void dispose() {
WidgetsBinding.instance.removeObserver(this);
super.dispose();
}
@override
Widget build(BuildContext context) {
return Container();
}
/// 退出应用程序
void _quitApp() {
SystemChannels.platform.invokeMethod("SystemNavigator.pop");
}
/// 关闭整个权限申请页面
void _popDialogAndPage(BuildContext dialogContext) {
_popDialog(dialogContext);
_popPage();
}
/// 关闭弹窗
void _popDialog(BuildContext dialogContext) {
Navigator.of(dialogContext).pop();
}
/// 关闭透明页面
void _popPage() {
Navigator.of(context).pop();
}
}
在外部想要检查及获取权限的地方,调用permissionCheckAndRequest方法即可:
// 导入封装好的文件
import 'package:xxxx/permission_request.dart';
// ...其它代码
ElevatedButton(
onPressed: () async {
// 调用封装好的权限检查和请求方法
bool result = await permissionCheckAndRequest(
context,
Permission.notification,
"通知"
);
if (result) print("已拥有该权限");
},
child: const Text("权限检查")
)