Ionic Cordova NFC NDEF监听器订阅事件未触发问题排查

问题 #

在Ionic Cordova应用中使用NFC PhoneGap API时遇到问题：NDEF监听器已成功附加，但subscribe事件未被触发。相关代码及控制台输出如下：

函数代码 #

startNFCReading() {
console.log('Starting NFC reading...');

        if (!this.nfc) {
            console.log('NFC library not found');
            return;
        }

        this.nfc
            .enabled()
            .then(() => {
                console.log('NFC enabled');
                const attachListener = this.nfc.addNdefListener(
                    (event: any) => {
                        console.log('Successfully attached ndef listener');
                    },
                    (err: any) => {
                        console.log('Error attaching ndef listener', err);
                    }
                ).subscribe((event) => {
                        console.log('received ndef message. the tag contains: ', event);
                        console.log('decoded tag id', this.nfc.bytesToHexString(event.tag.id));
                        this.getProduct(event.tag.ndefMessage);
                }
                );
            })
            .catch((e) => {
                console.log('NFC not enabled', e);
                // Handle NFC not enabled error here, e.g., show a user-friendly message.
            });
        console.log('After subscription');

    }

控制台输出 #

Starting NFC reading...
7239.d181bf1e42e46154a791.js:1 After subscription
7239.d181bf1e42e46154a791.js:1 NFC enabled
7239.d181bf1e42e46154a791.js:1 Successfully attached ndef listener

控制台显示NDEF监听器已成功附加，但未进入subscribe事件逻辑，调试后问题仍存在，请求分析原因并提供解决方法。

可能原因及解决办法 #

• NFC标签不符合NDEF格式
  只有符合NDEF标准的标签才能触发addNdefListener的subscribe事件。如果标签是空白、格式非NDEF（比如Mifare Classic未格式化），或者存储的数据不是NDEF结构，监听器不会响应。
  解决：用NFC工具类APP检查标签是否为NDEF格式，若不是则重新格式化为NDEF并写入测试数据后重试。

• 权限配置缺失或不正确
  Cordova NFC插件需要特定权限才能正常读取标签，Android和iOS的权限要求不同：

  • Android：需要NFC权限，以及Android 10+需要ACCESS_FINE_LOCATION权限（NFC读取被归类为位置相关操作）。
  • iOS：需要在info.plist中添加NFCReaderUsageDescription描述，说明应用使用NFC的原因。
    解决：
    1. 检查config.xml中是否添加了正确的权限配置：

       <!-- Android权限 -->
       <uses-permission android:name="android.permission.NFC" />
       <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
       <uses-feature android:name="android.hardware.nfc" android:required="true" />
       
       <!-- iOS权限 -->
       <platform name="ios">
           <config-file parent="NFCReaderUsageDescription" target="*-Info.plist">
               <string>读取NFC标签获取产品信息</string>
           </config-file>
       </platform>
       

    2. 对于Android 10+，确保应用运行时已获取位置权限，可在代码中主动请求：

       import { AndroidPermissions } from '@ionic-native/android-permissions/ngx';
       
       constructor(private androidPermissions: AndroidPermissions) {}
       
       async requestPermissions() {
           const result = await this.androidPermissions.requestPermission(
               this.androidPermissions.PERMISSION.ACCESS_FINE_LOCATION
           );
           if (!result.hasPermission) {
               // 提示用户授权位置权限
           }
       }
       

• 插件版本兼容性问题
  Ionic/Cordova版本与NFC插件版本不匹配，可能导致事件回调逻辑异常。比如旧版插件的addNdefListener返回的Observable行为与新版不一致。
  解决：

  1. 卸载当前NFC插件：cordova plugin remove phonegap-nfc
  2. 安装最新稳定版：cordova plugin add phonegap-nfc
  3. 确保@ionic-native/nfc包版本与Ionic版本匹配（比如Ionic 5对应@ionic-native/nfc@5.x，Ionic 6对应@ionic-native/nfc@6.x）。

• 监听器订阅未保持引用
  如果订阅对象仅存在于局部作用域，可能被垃圾回收机制回收，导致事件失效。当前代码中attachListener定义在then回调内部，未保存到组件类属性中，存在被回收的风险。
  解决：将订阅对象声明为组件的类属性，确保作用域持久：

  export class YourComponent {
      private nfcSubscription: any; // 类属性保存订阅引用
  
      startNFCReading() {
          // ... 其他代码 ...
          this.nfc.enabled().then(() => {
              this.nfcSubscription = this.nfc.addNdefListener(...)
                  .subscribe((event) => {
                      // 回调逻辑
                  });
          });
      }
  
      // 组件销毁时取消订阅，避免内存泄漏
      ngOnDestroy() {
          if (this.nfcSubscription) {
              this.nfcSubscription.unsubscribe();
          }
      }
  }
  

• 设备NFC硬件或系统限制
  部分设备的NFC硬件可能故障，或者系统中其他应用占用了NFC资源（比如支付类应用），导致当前应用无法获取NFC事件。
  解决：

  1. 重启设备后重试；
  2. 关闭其他可能使用NFC的应用；
  3. 用其他NFC测试APP验证设备是否能正常读取标签，排除硬件故障。

内容的提问来源于stack exchange，提问作者subhos