Flutter短信获取插件sms_retriever_api_plus的使用
Flutter短信获取插件sms_retriever_api_plus的使用
通过使用SMS Retrieval API,你可以在Android应用中自动执行基于短信的用户验证,而无需用户手动输入验证码,也不需要额外的应用权限。当你在应用中实现自动短信验证时,验证流程看起来像这样:
参考资料
Google Identity SMS Retrieval API文档
开始使用
要获取应用签名。这一步是必需的,因为短信功能依赖于它。 生成签名时,需要根据不同的构建类型(调试、发布、Google Play商店)更改密钥。
// 获取应用签名
String appSignature = await SmsRetrieverApiPlus.getSignature();
启动监听短信功能:
// 初始化并开始监听短信
String message = await SmsRetrieverApiPlus.initSMSAPI();
生成应用签名用于keystore文件:
keytool -storepass storepass -alias alias -exportcert -keystore file | xxd -p | tr -d "[:space:]" | xxd -r -p | base64 | cut -c1-11
示例短信:
[#] 你的示例代码是:
123456
appSignature
输出
完整示例代码
以下是完整的示例代码,展示了如何使用sms_retriever_api_plus
插件来获取短信内容:
import 'package:flutter/material.dart';
import 'dart:async';
import 'package:sms_retriever_api_plus/sms_retriever_api_plus.dart';
void main() {
runApp(const MyApp());
}
class MyApp extends StatefulWidget {
const MyApp({Key? key}) : super(key: key);
[@override](/user/override)
State<MyApp> createState() => _MyAppState();
}
class _MyAppState extends State<MyApp> {
String _signature = ""; // 应用签名
String _initSMSAPI = ""; // 初始化短信监听状态
[@override](/user/override)
void initState() {
super.initState();
getSignature(); // 初始化获取应用签名
}
/// 获取应用签名
Future<void> getSignature() async {
String signature = "";
try {
signature = await SmsRetrieverApiPlus.getSignature() ?? '未知平台版本';
} catch (e) {
debugPrint(e.toString());
}
if (!mounted) return;
setState(() {
_signature = signature;
});
}
[@override](/user/override)
Widget build(BuildContext context) {
return MaterialApp(
home: Scaffold(
appBar: AppBar(
title: const Text('插件示例应用'),
),
body: Column(
mainAxisAlignment: MainAxisAlignment.center,
children: [
Center(
child: Text('签名: $_signature\n'),
),
ElevatedButton(
onPressed: () async {
await getMessage(); // 启动短信监听
},
child: const Text("初始化短信监听")),
Center(
child: Text('$_initSMSAPI\n'),
),
],
),
),
);
}
/// 获取短信内容
Future<void> getMessage() async {
String status = await SmsRetrieverApiPlus.initSMSAPI() ?? '未知平台版本';
setState(() {
_initSMSAPI = status;
});
}
}
更多关于Flutter短信获取插件sms_retriever_api_plus的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html
更多关于Flutter短信获取插件sms_retriever_api_plus的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html
当然,下面是一个关于如何使用 sms_retriever_api_plus
插件在 Flutter 中获取短信验证码的示例代码。这个插件利用 Google 的 SMS Retriever API 来自动读取设备上的短信验证码,而无需用户手动输入。
1. 添加依赖
首先,在你的 pubspec.yaml
文件中添加 sms_retriever_api_plus
依赖:
dependencies:
flutter:
sdk: flutter
sms_retriever_api_plus: ^x.y.z # 请替换为最新版本号
然后运行 flutter pub get
来获取依赖。
2. 配置 Android 项目
在 android/app/src/main/AndroidManifest.xml
中添加必要的权限和接收器:
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
package="com.example.yourapp">
<uses-permission android:name="android.permission.RECEIVE_SMS" />
<uses-permission android:name="android.permission.READ_SMS" />
<application
... >
<!-- SMS Retriever API Receiver -->
<receiver android:name="com.google.android.gms.auth.api.phone.SmsRetrieverApi$SmsRetrieverReceiver"
android:exported="true"
android:permission="com.google.android.gms.auth.api.phone.PERMISSION">
<intent-filter>
<action android:name="com.google.android.gms.auth.api.phone.SMS_RETRIEVED" />
</intent-filter>
</receiver>
...
</application>
</manifest>
注意:虽然 RECEIVE_SMS
和 READ_SMS
权限在这里被声明,但使用 SMS Retriever API 实际上不需要这些权限来获取短信验证码,它们仅用于传统方式读取短信。
3. 实现 Flutter 代码
在你的 Flutter 项目中,你可以这样使用 sms_retriever_api_plus
插件:
import 'package:flutter/material.dart';
import 'package:sms_retriever_api_plus/sms_retriever_api_plus.dart';
void main() {
runApp(MyApp());
}
class MyApp extends StatefulWidget {
@override
_MyAppState createState() => _MyAppState();
}
class _MyAppState extends State<MyApp> {
String? _otpCode;
@override
void initState() {
super.initState();
_startSmsListener();
}
void _startSmsListener() async {
SmsRetrieverApiPlus smsRetrieverApi = SmsRetrieverApiPlus();
SmsListener? smsListener;
smsListener = SmsListener(
onSmsRetrieved: (SmsMessage message) {
setState(() {
// 假设短信验证码是5-6位数字
RegExp exp = RegExp(r'\d{5,6}');
Iterable<RegExpMatch> matches = exp.allMatches(message.body ?? '');
if (matches.isNotEmpty) {
_otpCode = matches.first.group(0)!;
}
});
smsRetrieverApi.stopSmsListener(); // 停止监听,避免多次触发
},
onError: (Object error) {
print("Error occurred: $error");
},
);
try {
await smsRetrieverApi.startSmsListener(smsListener: smsListener);
} catch (e) {
print("Failed to start SMS listener: $e");
}
}
@override
Widget build(BuildContext context) {
return MaterialApp(
home: Scaffold(
appBar: AppBar(
title: Text('SMS Retriever API Example'),
),
body: Center(
child: _otpCode != null
? Text('OTP Code: $_otpCode')
: Text('Waiting for OTP...'),
),
),
);
}
}
4. 测试
- 确保你的设备已经安装了 Google Play 服务,因为 SMS Retriever API 依赖于它。
- 运行你的 Flutter 应用。
- 发送一个包含验证码的短信到你的设备。
- 应用应该会自动读取并显示验证码。
这个示例展示了如何使用 sms_retriever_api_plus
插件来监听并读取短信验证码。请注意,实际应用中可能还需要处理更多的边缘情况和错误处理。