Flutter NFC读取插件flutter_nfc_reader的使用

一个帮助开发者使用iOS或Android设备内部硬件来读取和写入NFC标签的新Flutter插件。

系统会激活一个轮询读取会话，一旦识别到标签，该会话将自动停止。
您也可以通过专用函数手动触发停止事件。

支持的NFC格式

仅Android支持NFC标签写入

安装

在pubspec.yaml中添加依赖：

dependencies:
  flutter_nfc_reader:
    git:
      url: git://github.com/matteocrippa/flutter-nfc-reader.git
      ref: master

然后运行以下命令：

flutter packages get

最后在项目中导入：

import 'package:flutter_nfc_reader/flutter_nfc_reader.dart';

如何使用

Android设置

在AndroidManifest.xml顶部添加以下两行：

<uses-permission android:name="android.permission.NFC" />
<uses-feature
        android:name="android.hardware.nfc"
        android:required="true" />

在build.gradle (Module: app)中将minSdkVersion设置为18：

defaultConfig {
...
minSdkVersion 18
...
}

iOS设置

目前仅支持基于Swift的Flutter项目。

• 启用功能/近场通信标签读取。
• 在Info.plist文件中，添加隐私 - NFC扫描使用描述，并设置字符串值为"NFC Tag"。

在Podfile顶部添加以下代码：

platform :ios, '8.0'
use_frameworks!

读取NFC

此函数将在读取发生时返回一个Promise，在此之前读取会话保持打开状态。
Promise将返回一个NfcData模型，该模型包含以下内容：

• id: 标签的ID
• content: 标签的内容
• error: 如果发生任何错误

示例代码：

FlutterNfcReader.read().then((response) {
    print(response.content);
});

流式读取NFC

此函数将返回一个流，每次识别到标签时都会发出NfcData。
在iOS上也可以使用此方法，但iOS会在想要扫描NFC标签时始终显示底部弹窗。因此，当期望第二个值时，需要显式地将FlutterNfcReader.read()转换为流。订阅流时，read函数会自动调用一次。查看示例实现。

示例代码：

FlutterNfcReader.onTagDiscovered().listen((onData) {
  print(onData.id);
  print(onData.content);
});

写入NFC（仅限Android）

此函数将在写入发生时返回一个Promise，在此之前读取会话保持打开状态。
Promise将返回一个NfcData模型，该模型包含以下内容：

• content: 写入到标签的内容

示例代码：

FlutterNfcReader.write(" ", "tag content").then((response) {
    print(response.content);
});

读取与写入NFC（仅限Android）

您可以使用上述函数读取并随后写入NFC标签，如下所示：

FlutterNfcReader.read().then((readResponse) {
    FlutterNfcReader.write(" ", readResponse.content).then((writeResponse) {
        print('writed: ${writeResponse.content}');
    });
});

停止NFC

• status: NFC读取或写入停止的状态

示例代码：

FlutterNfcReader.stop().then((response) {
    print(response.status.toString());
});

有关更多详细信息，请查看演示应用程序。

iOS特定注意事项

在NFC扫描和写入方面，iOS的行为略有不同。

• 当前实现中无法获取标签的ID。
• 每次扫描对用户都是可见的，且会有底部弹窗提示。

开始使用

对于如何开始使用Flutter，请参阅我们的在线文档： Flutter官方文档

对于如何编辑插件代码，请参阅文档： Flutter插件开发指南

贡献

请先快速浏览贡献指南： 贡献指南

感谢所有贡献者！ 贡献者列表

要开发iOS项目，由于以下问题，您需要激活“遗留”构建系统： Flutter Issue #20685

示例代码

以下是完整的示例代码：

import 'package:flutter/material.dart';
import 'package:flutter_nfc_reader/flutter_nfc_reader.dart';

void main() => runApp(MyApp());

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Material App',
      home: Scaffold(
        appBar: AppBar(
          title: Text('Material App Bar'),
        ),
        body: Center(child: NfcScan()),
      ),
    );
  }
}

class NfcScan extends StatefulWidget {
  NfcScan({Key key}) : super(key: key);

  [@override](/user/override)
  _NfcScanState createState() => _NfcScanState();
}

class _NfcScanState extends State<NfcScan> {
  TextEditingController writerController = TextEditingController();

  [@override](/user/override)
  initState() {
    super.initState();
    writerController.text = 'Flutter NFC Scan';
    FlutterNfcReader.onTagDiscovered().listen((onData) {
      print(onData.id);
      print(onData.content);
    });
  }

  [@override](/user/override)
  void dispose() {
    // 清理控制器
    writerController.dispose();
    super.dispose();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Column(
      children: <Widget>[
        TextField(
          controller: writerController,
        ),
        RaisedButton(
          onPressed: () {
            FlutterNfcReader.read();
          },
          child: Text("Read"),
        ),
        RaisedButton(
          onPressed: () {
            FlutterNfcReader.write(" ", writerController.text).then((value) {
              print(value.content);
            });
          },
          child: Text("Write"),
        )
      ],
    );
  }
}