Flutter本地认证插件local_auth_android的使用
Flutter本地认证插件local_auth_android的使用
local_auth_android
是 local_auth
插件的 Android 实现部分。这个插件允许你在 Flutter 应用中使用设备的生物识别功能(如指纹、面部识别等)进行用户身份验证。
使用方法
该插件是被认可的联邦插件,这意味着你可以直接使用 local_auth
插件,而不需要单独添加 local_auth_android
到你的 pubspec.yaml
文件中。然而,如果你需要直接调用 local_auth_android
的 API,则需要手动将其添加到你的项目依赖中。
示例代码
下面是一个完整的示例应用,展示了如何使用 local_auth_android
进行生物识别认证:
import 'dart:async';
import 'package:flutter/material.dart';
import 'package:local_auth/local_auth.dart';
import 'package:local_auth_android/local_auth_android.dart';
void main() {
runApp(const MyApp());
}
class MyApp extends StatefulWidget {
const MyApp({Key? key}) : super(key: key);
@override
State<MyApp> createState() => _MyAppState();
}
class _MyAppState extends State<MyApp> {
final LocalAuthentication _auth = LocalAuthentication();
bool _isBiometricSupported = false;
List<BiometricType> _availableBiometrics = [];
String _authorized = 'Not Authorized';
bool _isAuthenticating = false;
@override
void initState() {
super.initState();
_checkBiometricSupport();
}
Future<void> _checkBiometricSupport() async {
try {
_isBiometricSupported = await _auth.isDeviceSupported();
_availableBiometrics = await _auth.getAvailableBiometrics();
} on PlatformException catch (e) {
print(e);
}
setState(() {});
}
Future<void> _authenticate() async {
try {
setState(() {
_isAuthenticating = true;
_authorized = 'Authenticating';
});
final authenticated = await _auth.authenticate(
localizedReason: 'Please authenticate to proceed',
options: const AuthenticationOptions(stickyAuth: true),
authMessages: const <AuthMessages>[
AndroidAuthMessages(
signInTitle: '生物识别登录',
cancelButton: '取消',
),
],
);
setState(() {
_isAuthenticating = false;
_authorized = authenticated ? 'Authorized' : 'Not Authorized';
});
} on PlatformException catch (e) {
print(e);
setState(() {
_isAuthenticating = false;
_authorized = 'Error - ${e.message}';
});
}
}
Future<void> _cancelAuthentication() async {
await _auth.stopAuthentication();
setState(() => _isAuthenticating = false);
}
@override
Widget build(BuildContext context) {
return MaterialApp(
home: Scaffold(
appBar: AppBar(
title: const Text('Local Auth Example'),
),
body: Padding(
padding: const EdgeInsets.all(16.0),
child: Column(
mainAxisAlignment: MainAxisAlignment.center,
children: [
Text('Biometric supported: $_isBiometricSupported\n'),
Text('Available biometrics: $_availableBiometrics\n'),
Text('Current State: $_authorized\n'),
if (_isAuthenticating)
ElevatedButton(
onPressed: _cancelAuthentication,
child: const Row(
mainAxisSize: MainAxisSize.min,
children: [
Text('Cancel Authentication'),
Icon(Icons.cancel),
],
),
)
else
ElevatedButton(
onPressed: _authenticate,
child: const Row(
mainAxisSize: MainAxisSize.min,
children: [
Text('Authenticate'),
Icon(Icons.perm_device_information),
],
),
),
],
),
),
),
);
}
}
说明
- 初始化和状态检查:在
initState
中调用_checkBiometricSupport
方法来检查设备是否支持生物识别以及当前设备支持哪些类型的生物识别。 - 认证过程:通过
_authenticate
方法启动认证流程,用户可以选择使用指纹或面部识别等方式进行身份验证。 - 取消认证:如果认证过程中需要取消,可以调用
_cancelAuthentication
方法。
这个示例展示了如何集成并使用 local_auth_android
插件来进行生物识别认证,并提供了一个简单的 UI 界面来展示认证状态和结果。希望这对你有所帮助!
更多关于Flutter本地认证插件local_auth_android的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html
更多关于Flutter本地认证插件local_auth_android的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html
当然,以下是如何在Flutter项目中使用local_auth_android
插件进行本地认证的示例代码。不过需要注意的是,local_auth_android
实际上并不是一个官方或广泛使用的Flutter插件名称。更常见的插件名称是local_auth
,它支持iOS和Android的本地认证功能。
以下示例将使用local_auth
插件,因为它同时支持Android和iOS,并且更广泛地被使用。
1. 添加依赖
首先,在pubspec.yaml
文件中添加local_auth
依赖:
dependencies:
flutter:
sdk: flutter
local_auth: ^x.y.z # 请替换为最新版本号
然后运行flutter pub get
来安装依赖。
2. 使用local_auth插件
下面是一个简单的Flutter应用示例,展示了如何使用local_auth
插件进行本地认证(指纹/面部识别):
import 'package:flutter/material.dart';
import 'package:local_auth/local_auth.dart';
void main() {
runApp(MyApp());
}
class MyApp extends StatelessWidget {
@override
Widget build(BuildContext context) {
return MaterialApp(
title: 'Local Auth Demo',
theme: ThemeData(
primarySwatch: Colors.blue,
),
home: AuthScreen(),
);
}
}
class AuthScreen extends StatefulWidget {
@override
_AuthScreenState createState() => _AuthScreenState();
}
class _AuthScreenState extends State<AuthScreen> {
final LocalAuthentication _localAuth = LocalAuthentication();
bool _authenticated = false;
Future<void> _checkBiometrics() async {
bool canCheckBiometrics;
try {
canCheckBiometrics = await _localAuth.canCheckBiometrics;
} on PlatformException catch (e) {
print("Failed to check biometrics: '${e.message}'.");
canCheckBiometrics = false;
}
if (!canCheckBiometrics) {
setState(() {
_authenticated = false;
});
showDialog(
context: context,
builder: (context) => AlertDialog(
title: Text('Biometrics not available'),
content: Text('Your device doesn\'t support biometrics.'),
actions: <Widget>[
FlatButton(
child: Text('OK'),
onPressed: () {
Navigator.of(context).pop();
},
),
],
),
);
} else {
List<BiometricType> availableBiometrics = await _localAuth.getAvailableBiometrics();
print("Available biometrics: $availableBiometrics");
bool authenticated = await _localAuth.authenticateWithBiometrics(
localizedReason: 'Please authenticate to continue');
setState(() {
_authenticated = authenticated;
});
if (_authenticated) {
showDialog(
context: context,
builder: (context) => AlertDialog(
title: Text('Authenticated'),
content: Text('Biometric authentication successful!'),
actions: <Widget>[
FlatButton(
child: Text('OK'),
onPressed: () {
Navigator.of(context).pop();
},
),
],
),
);
} else {
showDialog(
context: context,
builder: (context) => AlertDialog(
title: Text('Authentication failed'),
content: Text('Biometric authentication failed.'),
actions: <Widget>[
FlatButton(
child: Text('OK'),
onPressed: () {
Navigator.of(context).pop();
},
),
],
),
);
}
}
}
@override
Widget build(BuildContext context) {
return Scaffold(
appBar: AppBar(
title: Text('Local Auth Demo'),
),
body: Center(
child: Column(
mainAxisAlignment: MainAxisAlignment.center,
children: <Widget>[
Text(
_authenticated ? 'Authenticated' : 'Not Authenticated',
style: TextStyle(fontSize: 24),
),
SizedBox(height: 20),
ElevatedButton(
onPressed: _checkBiometrics,
child: Text('Authenticate'),
),
],
),
),
);
}
}
解释
- 依赖添加:在
pubspec.yaml
中添加local_auth
依赖。 - 创建UI:使用Material Design创建了一个简单的UI,包含一个按钮和一个显示认证状态的文本。
- 认证逻辑:在
_checkBiometrics
函数中,首先检查设备是否支持生物识别,然后尝试进行生物识别认证。根据认证结果更新UI。
注意事项
- 确保在AndroidManifest.xml和Info.plist中配置了必要的权限和描述,以便应用能够使用生物识别功能。
- 在实际开发中,处理认证失败的情况可能需要更复杂的逻辑,例如重试次数限制等。
希望这个示例能帮到你!如果你有任何其他问题,请随时提问。