Flutter NFC功能插件mdd_nfc_kit的使用

概述

mdd_nfc_kit 是一个用于在 Android、iOS 和浏览器上实现 NFC 功能的 Flutter 插件。它支持多种 NFC 标签类型，并提供了读取和写入 NDEF 记录的功能。此外，该插件还允许通过原始命令与智能卡等设备进行通信。

支持的功能：

• 读取和写入符合以下标准的标签/卡的元数据和 NDEF 记录：
  • ISO 14443 Type A/B（NFC-A/NFC-B/MIFARE Classic/Plus/Ultralight/DESFire）
  • ISO 18092（NFC-F/FeliCa）
  • ISO 15963（NFC-V）
• 使用符合以下标准的标签/卡发送原始命令：
  • ISO 7816 智能卡（APDUs 层 4）
  • 其他设备支持的技术（原始命令层 3）

注意：由于 API 限制，并非所有操作在两个平台上都受支持。

该库使用了 ndef 库来处理 NDEF 记录的编码和解码。

设置

感谢插件 nfc_manager 提供这些说明。

Android

1. 在 AndroidManifest.xml 中添加以下权限：

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

iOS

1. 在 entitlements 文件中添加以下权限：

   com.apple.developer.nfc.readersession.formats
   

2. 在 Info.plist 中添加以下键值对：

   <key>NFCReaderUsageDescription</key>
   <string>需要 NFC 功能以完成此操作。</string>
   

   <key>com.apple.developer.nfc.readersession.felica.systemcodes</key>
   <array>
       <!-- 添加所需的系统代码 -->
   </array>
   <key>com.apple.developer.nfc.readersession.iso7816.select-identifiers</key>
   <array>
       <!-- 添加所需的 SELECT 命令标识符 -->
   </array>
   

   警告：对于 iOS 14.5 及更早版本，在启用 readIso18092 或 readIso15693 的情况下调用 poll 之前，必须提前添加上述键值对，否则 NFC 将在重启前完全不可用（参见 GitHub Issue）。
3. 打开 Runner.xcworkspace 并导航到项目设置，选择 Signing & Capabilities，然后点击左上角的 + Capability，选择 Near Field Communication Tag Reading。

Web

该插件的 Web 版本实际上并不支持浏览器中的 NFC 功能，而是通过特定的 WebUSB 协议，使得 Flutter 程序能够以平台无关的方式与双接口（NFC/USB）设备通信。

确保你理解上述声明和协议后再使用此插件。

使用示例

以下是一个简单的示例代码：

import 'package:mdd_nfc_kit/mdd_nfc_kit.dart';
import 'package:ndef/ndef.dart' as ndef;

void main() async {
  // 检查 NFC 是否可用
  var availability = await FlutterNfcKit.nfcAvailability;
  if (availability != NFCAvailability.available) {
    print("NFC 不可用！");
    return;
  }

  // 开始扫描 NFC 标签
  var tag = await FlutterNfcKit.poll(
    timeout: Duration(seconds: 10), // 超时时间仅适用于 Android
    iosMultipleTagMessage: "发现多个标签！", // iOS 多标签提示消息
    iosAlertMessage: "扫描您的标签", // iOS 扫描提示消息
  );

  print("扫描到的标签: ${jsonEncode(tag)}");

  // 如果标签支持 ISO 7816
  if (tag.type == NFCTagType.iso7816) {
    // 发送 APDU 命令
    var result = await FlutterNfcKit.transceive(
      "00B0950000", // APDU 命令
      Duration(seconds: 5), // 超时时间
    );
    print("命令结果: $result");
  }

  // iOS 仅限：动态设置提示消息
  await FlutterNfcKit.setIosAlertMessage("扫描成功！");

  // 如果标签支持 NDEF 读取
  if (tag.ndefAvailable) {
    // 解码后的 NDEF 记录
    print("解码的 NDEF 记录:");
    for (var record in await FlutterNfcKit.readNDEFRecords(cached: false)) {
      print(record.toString());
    }

    // 原始 NDEF 记录（十六进制字符串）
    print("原始 NDEF 记录:");
    for (var record in await FlutterNfcKit.readNDEFRawRecords(cached: false)) {
      print(jsonEncode(record).toString());
    }
  }

  // 如果标签支持 NDEF 写入
  if (tag.ndefWritable) {
    // 写入解码后的 NDEF 记录
    await FlutterNfcKit.writeNDEFRecords([
      new ndef.UriRecord.fromUriString("https://github.com/nfcim/mdd_nfc_kit")
    ]);

    // 写入原始 NDEF 记录
    await FlutterNfcKit.writeNDEFRawRecords([
      new NDEFRawRecord("00", "0001", "0002", "0003", ndef.TypeNameFormat.unknown)
    ]);
  }

  // 结束 NFC 会话
  await FlutterNfcKit.finish();

  // iOS 仅限：结束时显示提示信息
  await FlutterNfcKit.finish(iosAlertMessage: "操作成功");
  // 或者
  await FlutterNfcKit.finish(iosErrorMessage: "操作失败");
}