Flutter NFC读写插件ndef的使用

ndef 是一个用于解码和编码NDEF记录的Dart库，支持多种类型（按类型名称格式分组），包括：

• NFC Well-known Records (TNF 1 / urn:nfc:wkt:)，包含：

  • 文本 (class T)
  • URI带有知名前缀 (class U)
  • 数字签名 (class Sig)
  • 智能海报 (class Sp)，包括子记录：
    • 动作 (class act)
    • 大小 (class s)
    • 类型 (class t)
  • 连接切换 (class Hr/Hs/Hm/Hi/Hc/ac/cr)

• Media Records (TNF 2, 包含MIME数据)，包含：

  • 蓝牙简易配对 (class application/vnd.bluetooth.ep.oob)
  • 蓝牙低能耗 (class application/vnd.bluetooth.le.oob)

• Absolute URI Records (TNF 3)

• External Records (TNF 4 / urn:nfc:ext:)，包含：

  • Android应用程序记录 (class android.com:pkg)

注意：此库仍在积极开发中，可能会出现破坏性API更改和功能故障。欢迎提交问题和拉取请求，特别是在以下方面：

• Bug修复
• 支持新的记录类型

使用示例

编码与解码NDEF记录

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

void main() {
  // 编码
  var uriRecord = ndef.UriRecord.fromString("https://github.com/nfcim/ndef");
  var textRecord = ndef.TextRecord(text: "Hello");
  var encodedUriRecord = uriRecord.encode().toHexString(); /// 编码单个记录，并使用Uint8List上的扩展方法
  var encodedAllRecords = ndef.encodeNdefMessage([uriRecord, textRecord]).toHexString(); // 编码多个记录为一条消息

  // 解码
  var encodedTextRecord = "d1010f5402656e48656c6c6f20576f726c6421";
  var decodedRecords = ndef.decodeRawNdefMessage(encodedTextRecord.toBytes());
  assert(decodedRecords.length == 1);
  if (decodedRecords[0] is ndef.TextRecord) {
    assert(decodedRecords[0].text == "Hello");
  } else {
    // 我们不会到这里
  }

  // 数据绑定（通过实现payload作为动态getter/setter）
  var origPayload = uriRecord.payload!;
  print(origPayload.toHexString());
  uriRecord.content = "github.com/nfcim/flutter_nfc_kit";
  print(uriRecord.payload!.toHexString()); // 已更改
  uriRecord.payload = origPayload;
  print(uriRecord.content); // 变回原来

  // 部分解码记录
  var partiallyDecodedUrlRecord = ndef.decodePartialNdefMessage(
      ndef.TypeNameFormat.nfcWellKnown, utf8.encode("U"), origPayload,
      id: Uint8List.fromList([0x1, 0x2]));
}

完整示例代码

import 'dart:convert';
import 'dart:typed_data';

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

void main() {
  var encodedUrlRecord =
      "91011655046769746875622e636f6d2f6e6663696d2f6e64656651010b55046769746875622e636f6d";
  var urlRecords = [
    ndef.UriRecord.fromString("https://github.com/nfcim/ndef"),
    ndef.UriRecord.fromString("https://github.com")
  ];

  // 解码完整的NDEF消息（记录的连接）
  var decodedUrlRecords = ndef.decodeRawNdefMessage(encodedUrlRecord.toBytes());

  assert(urlRecords.length == decodedUrlRecords.length);

  for (int i = 0; i < urlRecords.length; i++) {
    var raw = urlRecords[i];
    var decoded = decodedUrlRecords[i];
    assert(decoded is ndef.UriRecord);
    assert((decoded as ndef.UriRecord).uri == raw.uri);
    print((decoded as ndef.UriRecord).toString());
  }

  // 修改记录通过数据绑定
  var origPayload = urlRecords[0].payload!;
  print('===================');
  print('original payload: ${origPayload.toHexString()}');
  print('original uri: ${urlRecords[0].uri}');

  // 更改URI
  print('===================');
  urlRecords[0].content =
      'github.com/nfcim/flutter_nfc_kit'; // 这也是我们很棒的库，快来看看！
  print(
      'payload after change content: ${urlRecords[0].payload!.toHexString()}'); // 在调用时编码
  print('uri after change content: ${urlRecords[0].uri}');

  // 通过使用payload恢复更改
  print('===================');
  urlRecords[0].payload = origPayload; // 在调用时解码
  print('payload after changed back: ${urlRecords[0].payload!.toHexString()}');
  print('uri after changed back: ${urlRecords[0].uri}');

  // 再次编码为消息（也规范MB & MF字段）
  var encodedAgain = ndef.encodeNdefMessage(urlRecords);
  assert(encodedAgain.toHexString() == encodedUrlRecord);
  print('encoded single record: ${urlRecords[0].encode().toHexString()}');

  // 也可以分别提供id、type和payload进行解码（通常来自手机API）
  print('===================');
  var partiallyDecodedUrlRecord = ndef.decodePartialNdefMessage(
      ndef.TypeNameFormat.nfcWellKnown, utf8.encode("U"), origPayload,
      id: Uint8List.fromList([0x1, 0x2]));
  assert(partiallyDecodedUrlRecord is ndef.UriRecord);
  print(
      'partially decoded record: ${partiallyDecodedUrlRecord as ndef.UriRecord}');
}

要了解更多详细信息，请参阅 官方文档 和 完整示例代码。

希望这能帮助您更好地理解和使用ndef库。如果您有任何问题或需要进一步的帮助，请随时提问！