Flutter短信监听插件smswatcher的使用

简介

A Flutter插件用于监听Android设备上的短信。该插件允许你实时接收短信更新并获取短信历史记录。

功能

• 实时监听新收到的短信。
• 获取存储在设备上的短信。
• 支持Stream和Future两种数据处理方式。

安装

将以下内容添加到你的pubspec.yaml文件中：

dependencies:
  smswatcher: ^0.0.3

然后运行命令：

flutter pub get

使用方法

导入插件

在你的Dart文件中导入插件：

import 'package:smswatcher/smswatcher.dart';

初始化插件

创建一个Smswatcher实例：

final _smswatcher = Smswatcher();

监听新收到的短信

使用StreamBuilder来实时监听新收到的短信：

StreamBuilder(
  stream: _smswatcher.getStreamOfSMS(),
  builder: (context, snapshot) {
    if (snapshot.hasData) {
      final sms = snapshot.data;
      return ListTile(
        title: Text(sms?["sender"] ?? "未知发送者"), // 发送者
        subtitle: Text(sms?["body"] ?? "无内容"), // 短信内容
      );
    } else {
      return Text("暂无新消息");
    }
  },
)

获取短信历史

使用FutureBuilder来获取所有已存储的短信：

FutureBuilder(
  future: _smswatcher.getAllSMS(),
  builder: (context, snapshot) {
    if (snapshot.hasData) {
      final smsList = snapshot.data as List;
      return ListView.builder(
        itemCount: smsList.length,
        itemBuilder: (context, index) {
          final sms = smsList[index];
          return ListTile(
            title: Text(sms["sender"] ?? "未知发送者"), // 发送者
            subtitle: Text(sms["body"] ?? "无内容"), // 短信内容
          );
        },
      );
    } else {
      return CircularProgressIndicator(); // 加载指示器
    }
  },
)

权限

Android

确保你的AndroidManifest.xml包含以下权限以接收和读取短信：

<uses-permission android:name="android.permission.RECEIVE_SMS"/>
<uses-permission android:name="android.permission.READ_SMS"/>

对于运行时权限，可以考虑使用permission_handler插件。

问题与贡献

请通过GitHub提交问题或功能请求。欢迎贡献！

以下是完整的示例代码：

import 'package:flutter/material.dart';
import 'package:permission_handler/permission_handler.dart';
import 'package:smswatcher/smswatcher.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatefulWidget {
  const MyApp({super.key});

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  final _smsListenerPlugin = Smswatcher();

  [@override](/user/override)
  void initState() {
    super.initState();
    Permission.sms.request();
  }

  [@override](/user/override)
  void dispose() {
    _smsListenerPlugin.dispose();
    super.dispose();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      debugShowCheckedModeBanner: false,
      home: Scaffold(
        floatingActionButtonLocation: FloatingActionButtonLocation.centerFloat,
        floatingActionButton: Column(
          mainAxisAlignment: MainAxisAlignment.end,
          children: [
            FloatingActionButton(
              onPressed: () {
                _smsListenerPlugin.getAllSMS();
              },
              child: const Icon(Icons.sms),
            ),
            const SizedBox(
              height: 20,
            )
          ],
        ),
        appBar: AppBar(
          title: const Text('短信获取应用'),
        ),
        body: SafeArea(
          child: SingleChildScrollView(
            child: Column(
              children: [
                SizedBox(
                  height: MediaQuery.of(context).size.height / 6,
                  child: Column(
                    children: [
                      const Text("正在监听最新消息",
                          style: TextStyle(fontWeight: FontWeight.bold)),
                      StreamBuilder(
                        stream: _smsListenerPlugin.getStreamOfSMS(),
                        builder: (context, snap) => ListTile(
                          title: Text(snap.data?["sender"] ?? "NA"),
                          subtitle: Text(snap.data?["body"] ?? "NA"),
                        ),
                      ),
                    ],
                  ),
                ),
                const Divider(height: 1),
                SizedBox(
                  height: MediaQuery.of(context).size.height / 1,
                  child: Column(
                    children: [
                      const Text("正在监听最新消息",
                          style: TextStyle(fontWeight: FontWeight.bold)),
                      FutureBuilder(
                        future: _smsListenerPlugin.getAllSMS(),
                        builder: (context, snap) {
                          if (!snap.hasData)
                            return const CircularProgressIndicator(); // 可选的加载状态
                          return Expanded(
                            child: ListView.builder(
                              itemCount: snap.data?.length ?? 0,
                              itemBuilder: (context, index) => ListTile(
                                title: Text(snap.data?[index]["sender"] ?? "NA"),
                                subtitle: Text(snap.data?[index]["body"] ?? "NA"),
                              ),
                            ),
                          );
                        },
                      ),
                    ],
                  ),
                ),
              ],
            ),
          ),
        ),
      ),
    );
  }
}