更新记录

1.0.0(2026-07-15)

首次发布


平台兼容性

CJ NFC 插件

ly-nfc 是一个 uni-app 插件市场的 uni_modules UTS API 插件,用于封装 App 端 Android NFC 能力。

平台

平台 支持
App-Android 支持
App-iOS 暂不支持
H5 / 小程序 暂不支持

Android NFC 不需要运行时权限,但需要声明 android.permission.NFC。插件已在 utssdk/app-android/AndroidManifest.xml 中声明。

安装

把插件目录放到项目:

uni_modules/cj-nfc

页面中按插件根路径导入:

import {
  getNfcStatus,
  openNfcSettings,
  startNfcReader,
  stopNfcReader,
  writeNfcText,
  writeNfcUri
} from '@/uni_modules/cj-nfc'

API

getNfcStatus()

同步获取 NFC 状态。

const status = getNfcStatus()
console.log(status.isSupported, status.isEnabled)

返回:

{
  errMsg: string
  isSupported: boolean
  isEnabled: boolean
}

openNfcSettings(options)

打开系统 NFC 设置页。

openNfcSettings({
  success(res) {
    console.log(res.errMsg)
  },
  fail(err) {
    console.log(err.errCode, err.errMsg)
  }
})

startNfcReader(options)

开启 NFC 读卡。贴近标签后会多次触发 onDiscovered

startNfcReader({
  noPlatformSounds: false,
  success(res) {
    console.log('reader started', res.errMsg)
  },
  onDiscovered(res) {
    console.log(res.tag.id)
    console.log(res.tag.records)
  },
  fail(err) {
    console.log(err.errCode, err.errMsg)
  }
})

stopNfcReader(options)

停止 NFC 读卡。

stopNfcReader({
  success(res) {
    console.log(res.errMsg)
  }
})

writeNfcText(options)

等待贴卡并写入 NDEF Text 记录。默认写入成功后自动停止 reader mode。

writeNfcText({
  text: 'hello uni-app',
  language: 'zh',
  autoStop: true,
  success(res) {
    console.log(res.tag.id)
  },
  fail(err) {
    console.log(err.errCode, err.errMsg)
  }
})

writeNfcUri(options)

等待贴卡并写入 NDEF URI 记录。

writeNfcUri({
  uri: 'https://uniapp.dcloud.net.cn',
  success(res) {
    console.log(res.tag.id)
  }
})

注意

  • Android 系统的 NFC 读写必须在真机上测试,模拟器一般没有 NFC 硬件。
  • writeNfcTextwriteNfcUri 仅支持 NDEF 标签;非 NDEF 标签会返回错误。
  • iOS CoreNFC 需要额外 entitlement、系统弹窗会话和设备限制,本版本先返回不支持。

隐私、权限声明

1. 本插件需要申请的系统权限列表:

android.permission.NFC:用于访问设备 NFC 硬件,在用户主动使用 NFC 读卡、写卡功能时读取或写入 NFC 标签。 android.hardware.nfc:声明插件使用 NFC 硬件

2. 本插件采集的数据、发送的服务器地址、以及数据用途说明:

本插件不采集、不存储、不上传用户个人信息,不连接任何服务器,无服务器地址。 用户主动调用 NFC 读卡功能时,插件仅在本机读取 NFC 标签信息,包括标签 ID、技术类型、NDEF 文本、URI 或载荷内容,并通过回调返回给宿主应用使用。 用户主动调用 NFC 写卡功能时,插件仅将宿主应用传入的文本或 URI 写入用户贴近的 NFC 标签。 插件本身不对读取到的 NFC 数据进行保存、统计、分析或上传。如宿主应用需要保存或上传相关数据,应由宿主应用在自身隐私政策中另行说明。

3. 本插件是否包含广告,如包含需详细说明广告表达方式、展示频率:

无。本插件不包含广告,不集成任何广告 SDK,不展示开屏、弹窗、信息流、横幅或激励视频广告。

暂无用户评论。