uni-app如何调用原生插件 uni-app原生插件开发与配置流程

胖宇同学_1177

胖宇同学_1177

2026-04-29

470人浏览

原创

uni-app调用原生插件必须确保三处严格对齐:前端uni.requireNativePlugin()参数名、nativeplugins/目录下插件文件夹名、以及package.json中name字段和Android/iOS平台class值,任一拼写或路径错误均导致undefined或调用失败。

uni-app如何调用原生插件 uni-app原生插件开发与配置流程

uni-app 调用原生插件不是「写完就能用」,关键在于三处必须对齐:前端 uni.requireNativePlugin 的名字、nativeplugins/ 目录结构、以及 Android/iOS 工程中声明的插件类名或模块名。任一环节拼写或路径错一位,undefined 或 requireNativePlugin is not a function 就立刻出现。

nativeplugins 目录必须手动创建且命名严格固定

uni-app 不会自动识别原生插件,必须在项目根目录下显式创建名为 nativeplugins 的文件夹(注意大小写、无空格、无横线)。这个名称是硬编码进 uni-app 构建逻辑的,改任何字符都会导致插件完全不加载。

  • nativeplugins/YourPluginName/ 是插件一级目录,名字要和前端 uni.requireNativePlugin('YourPluginName') 中传入的字符串完全一致(区分大小写)
  • Android 插件必须在 nativeplugins/YourPluginName/android/ 下放 .aar 或 .jar 文件;iOS 插件则必须在 nativeplugins/YourPluginName/ios/ 下放 .framework 或源码文件
  • 不能把 .aar 放进 android/libs/ 这类子目录里——uni-app 只认 android/ 直接子目录下的二进制文件

package.json 必须放在 nativeplugins/插件名/ 根下且字段不可省略

每个插件目录下必须有 package.json,它不是可选配置,而是 uni-app 插件注册的唯一依据。缺失或格式错误会导致插件被静默忽略。

  • "name" 字段值必须与插件目录名、uni.requireNativePlugin() 参数三者完全一致
  • Android 插件必须包含 "_dp_nativeplugin.android.plugins" 数组,其中 "class" 值要精确到完整 Java 类路径,比如 "com.example.myplugin.MyModule" ——少一个点或大小写错,运行时报 NoClassDefFoundError
  • iOS 插件的 "_dp_nativeplugin.ios" 配置中,"class" 对应的是 Objective-C 类名(如 DCTestUniPlugin),不是 Swift 类名,也不是模块名
  • 如果插件只支持某平台,另一平台字段可省略,但不能留空对象或写 null

uni.requireNativePlugin 返回 undefined 的常见原因

这不是 JS 报错,而是插件根本没注册成功。别急着查代码逻辑,先确认这几点:

uni-app
uni-app

uni-app 是基于 Vue 的跨端开发框架,适合开发 H5、App、小程序、鸿蒙和多端业务应用。

下载
  • HBuilderX 项目是否已启用「原生插件支持」?检查 manifest.json → app-plus → usingComponents 是否为 true;未开启时所有原生插件均不可用
  • 是否在真机或自定义基座中运行?Web 和模拟器不支持原生插件,HBuilderX 默认运行的是标准基座,需用「发行 → 原生App-云打包」或「制作自定义调试基座」才能生效
  • Android 插件的 minSdkVersion 是否高于当前测试设备系统版本?例如插件设了 23,而手机是 Android 6.0(API 23),实际会因版本不匹配被跳过
  • iOS 插件是否已正确 link 到 HBuilder-uniPluginDemo 工程?Xcode 中看不到插件 target 或报 ld: framework not found,说明 SDK 路径引用失效

Android 插件 class 名和 iOS 类名容易混淆

同一个插件在两端的注册入口完全不同,但开发者常误以为可以复用名字。Java 的 class 是运行时加载的全限定类名;Objective-C 的 class 是编译期符号名,两者无映射关系。

  • Android 端:看 build.gradle 里的 namespace + Java 类文件路径,例如 namespace 'io.dcloud.uniplugin.richalert' + RichAlertWXModule.java → "class": "io.dcloud.uniplugin.richalert.RichAlertWXModule"
  • iOS 端:打开 Xcode,在插件 target 的 Classes/ 下找 .m 文件,其 @implementation XXX 后面的名字就是 class 值,比如 @implementation DCRichAlert → "class": "DCRichAlert"
  • 千万别把 iOS 的 DCRichAlert 当成 Android 的类名去填,也别把 Android 的 RichAlertWXModule 拿去 iOS 的 package.json 里用

最常被忽略的是:插件开发完成后,必须重新生成自定义调试基座(Android)或重新编译 HBuilder-uniPluginDemo(iOS),前端改了 package.json 或 JS 调用方式,不重打基座/重编译,等于没改。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2823

5

前端如何实现即时通讯
前端如何实现即时通讯

实现即时通讯的方法有WebSocket、Long Polling、Server-Sent Events、WebRTC等等。详细介绍:1、WebSocket,它可以在客户端和服务器之间建立持久连接,实现实时的双向通信,前端可以使用 WebSocket API来创建WebSocket连接,并通过发送和接收消息来实现即时通讯;2、Long Polling,是一种模拟实时通信的技术等等。

2023.10.09

6123

6

前端和后端的区别
前端和后端的区别

前端关注的是用户界面的设计和交互,而后端则注重数据处理和逻辑控制。想了解更多前端后端的相关内容,可以阅读本专题下面的文章。

2024.03.19

7070

13

php和前端的关联介绍
php和前端的关联介绍

php既可以作为前端语言,也可以作为后端语言。想了解更多php和前端的相关内容,可以阅读本专题下面的文章。

2024.03.22

6858

10

前端外包工作内容有哪些
前端外包工作内容有哪些

前端外包工作内容包括:1. 网站和应用程序开发;2. 用户界面和交互设计;3. 用户体验优化;4. 设计和视觉开发;5. 跨浏览器兼容性;6. 性能优化;7. 维护和更新;8. 项目管理和沟通。想了解更多前端的相关内容,可以阅读本专题下面的文章。

2024.05.22

983

5

Tailwind CSS 如何制作导航栏和卡片
Tailwind CSS 如何制作导航栏和卡片

用 Tailwind CSS 制作导航栏和卡片,可先搭建语义化结构,再组合 Flex、Grid、间距、圆角与阴影类。这里整理横向导航、移动端菜单、卡片网格及悬停效果的相关文章,帮助你把常见页面组件做得清晰且适配不同屏幕。

2026.11.03

0

17

Tailwind CSS 响应式布局怎么写
Tailwind CSS 响应式布局怎么写

Tailwind CSS 响应式布局通常从移动端样式写起,再用 sm、md、lg 等前缀调整不同屏幕宽度下的网格、间距和导航。本专题整理断点配置、Grid 与 Flex 自适应布局及常见溢出问题,帮助你逐步完成多设备适配。

2026.11.03

0

19

Tailwind CSS 常用类名怎么记
Tailwind CSS 常用类名怎么记

Tailwind CSS 类名很多,先按布局、间距、文字、颜色和状态分组记忆,再通过官方文档检索具体写法。本专题结合类名排序、动态拼接失效、自定义实用类等问题,帮助你建立常用类名的速查方法。

2026.11.03

0

12

码上飞入口地址合集
码上飞入口地址合集

本专题汇总了码上飞(CodeFlying)的官方入口地址合集,涵盖官网主站及网页版在线使用入口,支持注册登录后直接在线体验零代码AI应用生成。同时整理了APP端下载渠道与小程序入口,助你快速访问平台,通过自然语言描述需求即可生成应用、小程序或网站。

2026.11.03

0

10

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
uni-app从入门到实战教程
uni-app从入门到实战教程

共0课时 | 0人学习

uni-app x harmony开发指南
uni-app x harmony开发指南

共0课时 | 0人学习

uni-app鸿蒙运行和发行
uni-app鸿蒙运行和发行

共0课时 | 0人学习