iOS小技能: 开发 uni-app 原生插件(支持iOS Extension)

简介: 术语:uni原生插件指的是将`原生开发的功能按照规范封装成插件包`,然后即可在 uni-app 前端项目中通过js调用原生能力。

引言

背景:DCloud有活跃的插件市_场,https://ext.dcloud.net.cn/,并提供了变现、评价等机制。只有uniCloud插件和原生插件支持付费,其他类型插件不能设价格。

付费插件不支持下载,也就是付费原生插件目前不支持离线打包。

术语:uni原生插件指的是将原生开发的功能按照规范封装成插件包,然后即可在 uni-app 前端项目中通过js调用原生能力。

开发环境:

  1. Xcode 12.1 及以上版本
  2. 下载开发插件需要的 SDK包 并解压
  3. 安装 uni-app 开发工具 HBuilderX

I 开发 uni-app 原生插件

1.1 SDK 包结构说明

|--iOSSDK    
    |-- HBuilder-Hello                // uni-app 离线打包工程
    |-- HBuilder-uniPluginDemo        // uni-app 插件开发主工程 (本文档需要使用的工程)
    |-- SDK                            // 依赖库及依赖资源文件
    |-- Feature-iOS.xls                // 功能模块与依赖库对应关系说明表格
    |-- readme.txt                    // 目录说明

SDK 目录中的 HBuilder-uniPluginDemo为 uni原生插件开发主工程,该工程已经将各项配置都配置齐全,开发uni原生插件需要依赖此工程。

1.2 目录格式配置

uni原生插件(native plugin)提交DCloud插件市场需按以下目录格式配置:

package.json: 仅云端打包生效,json 格式,不能有注释。

{
    "name": "插件名称",
    "id": "插件标识,需要保证唯一性",
    "version": "插件版本号",
    "description": "插件描述信息",
    "_dp_type":"nativeplugin",
    "_dp_nativeplugin":{
        "android": {
            "plugins": [
                {
                    "type": "module|component, 必填, 根据插件类型选择",
                    "name": "必填, 注册插件的名称, 注意:module 的 name 必须以插件id为前缀或和插件id相同,比如 `DCTestUniPlugin-TestModule`,其中 DCTestUniPlugin 为插件的id,避免与其他插件冲突,component 的 name 没有强制要求,但是也要保证唯一比如 `dc-map`",
                    "class": "必填, 注册插件的类名"
                }
            ],
            "hooksClass": "可选, 事件钩子注册类名",
            "integrateType": "必填, 可取值aar|jar",
            "dependencies": [
                "可选, 依赖的库名称"
            ],
            "excludeDependencies": [
                "可选,需要排除的HX内置模块依赖库名称"  //HBuilderX3.1.18+支持:仅在插件与HX内置模块依赖库存在冲突时可能需要,使用前请在官方QQ交流群“DCloud原生开发者群”中联系管理员确认
            ],
            "compileOptions": {  //可选,Java编译参数配置
                "sourceCompatibility": "1.8",
                "targetCompatibility": "1.8"
            },
            "abis": [
                "可选, 支持的abi类型, 可取值armeabi-v7a|arm64-v8a|x86"
            ],
            "minSdkVersion": "可选,支持的Android最低版本,如21",
            "useAndroidX": false,   //可选,是否兼容使用AndroidX  3.2.5+版本后废弃该属性
            "permissions": [
                "可选, 要使用的Android权限列表"
            ],
            "parameters": {
                "插件需要配置的参数名称, 如appid": {
                    "des": "参数描述",
                    "key": "AndroidManifest.xml中添加meta-data节点!对应android:name属性值, 如GETUI_APPID",
                    "placeholder": "build.gradle中添加到manifestPlaceholders中的字段名"
                }
            }
        },
        "ios": {
            "plugins": [
                {
                    "type": "必填, module|component, 根据插件类型选择",
                    "name": "必填, 注册插件的名称, 通常与插件标识一致",
                    "class": "必填, 注册插件的类名" 
                }
            ],
            "integrateType": "必填, 可取值framework|library",
            "hooksClass": "可选, 事件钩子注册类名",
            "frameworks": [
                "依赖的系统库(系统库有.framework和.tbd和.dylib类型),和第三方.framework动态库;(.a 库或 .framework**静态库**直接放到ios根目录即可,不需要配置)"
            ],
            "embedFrameworks": [
                "依赖的.framework动态库(注意.framework动态库也需要在上面的 frameworks 节点添加配置,同样将动态库.framework文件放到 ios 目录)"
            ],
            "capabilities": {    // 配置应用的capabilities数据(根据XCode规范分别配置到entitlements和plist文件中)
                "entitlements": {    // 合并到工程entitlements文件的数据(json格式)
                },
                "plists": {    // 合并到工程Info.plist文件的数据(json格式)
                }
            },
            "plists": {    // 自定义配置工程Info.plist文件的数据(json格式),优先级高于capabilities->plists
            },
            "assets": [    //HBuilderX2.3.4及以上版本支持
                 "可选,插件要使用的xcassets文件列表,相对于ios目录的路径"
            ],
            "privacies": [
                "可选, 插件使用到的隐私列表,如NSPhotoLibraryUsageDescription"
            ],
            "embedSwift": false,   // 开启 swift 编译支持,如果插件使用了 swift 需要配置此项
            "deploymentTarget": "8.0, 可选,注意:使用 Xcode14 需配置为 "11.0"
            "validArchitectures": [    // 可选,支持的CPU架构类型
                 "arm64"    // 支持多个值,可取值:"arm64", "armv7",注意:使用 Xcode14 需要配置为 “arm64” 
            ],
            "parameters": {
                "插件需要配置的参数名称, 如appid": {
                    "des": "参数描述信息",
                    "key": "参数需要配置到info.plist中的键名, 嵌套时使用:分割,如getui:appid"
                }
            },
            "resources": [
                "可选, 插件要使用的资源文件列表,相对于ios目录的路径 ,HX 3.2.0+ 版本不在推荐使用,请参考文档下面的 “依赖资源文件” 说明"
            ]
        }
    }
}

II iOS Extension(扩展)

HBuilderX3.1.5+版本uni原生插件支持iOS Extension(扩展)。

需求: iOS App前台后台离线(杀死情况下)推送语音播报(到账xx元、收款播报、自定义推送铃)。

插件获取方式:

  1. 插件市场:todo (500)
  2. 公号:iOS逆向: 离线包x10, 源码是x15。

2.1 插件作者配置

首先在XCode环境中编译出ipa,将ipa解压后在Payload/XXX.app/PlugIns/ 下可以找到.appex文件 将.appex添加到uni原生插件下的 ios/Plugins/ 目录中即可。

2.2 插件使用者配置

默认情况下云端打包不会包含uni原生插件中的iOS扩展,需要在nativeplugins/XX-XXX插件目录下添加ios-extension.json文件配置使用iOS扩展。

插件的目录结构如下:

需要插件作者在使用说明中详细描述告诉插件使用者如何配置ios-extension.json文件
-- HelloUniApp项目目录
  |-- nativeplugins
    |-- KN-NotificationService(实际包含iOS Extension的uni原生插件标识)
      |-- ios-extension.json
      |-- ios-XXXExt.mobileprovision #在苹果开发者中心下载

ios-extension.json文件格式如下:

{
  "XXX.appex": {      //必填,多个iOS Extension需使用多个节点
    "identifier": "uni.XXX.ext",                //必填,Bundle identifier
    "profile": "ios-XXXExt.mobileprovision",    //必填,Provisioning Profile,相对于插件目录的路径。注意:在插件目录中文件必须以ios开头,否则HX不会提交云端打包(后续版本会修复此Bug)
    "plists": {      //可选,合并到iOS Extension的Info.plist中的数据(json格式)
            "KNGroupIdentifier": "group.com.kn.KNDocument.pushvoice"

    },
    "entitlements": { //可选,覆盖iOS Extension的entitlements.plist中的数据(json格式)
                "com.apple.security.application-groups": ["group.com.kn.KNDocument.pushvoice"]

    }
  }
}

plists 可选,JSON类型,需要合并到iOS Extension插件Info.plist文件中的数据。

例如消息推送扩展,可在plists配置GroupIdentifier信息,便于 采用语音合成音频文件后,将文件写到AppGroups的Library/Sounds文件夹下,最后更改UNNotificationSound属性来自定义的收款到账语音
            "KNGroupIdentifier": "group.com.kn.KNDocument.pushvoice"

从info.plist 获取配置信息KNGroupIdentifier

    // 
    NSDictionary *infoDic=[[NSBundle mainBundle] infoDictionary];
    NSString*  VersionFrontNo =  [infoDic valueForKey:@"KNGroupIdentifier"];

entitlements 可选,JSON类型,需要覆盖到iOS Extension插件entitlements.plist中的数据。

    <key>com.apple.security.application-groups</key>
    <array>
        <string>group.com.kn.KNDocument.pushvoice</string>
    </array>

III 注意事项

3.1 用 Xcode14 制作的原生插件

需要在文档里写清楚仅支持 iOS11 及以上系统版本。

https://blog.csdn.net/z929118967/article/details/127089630
package.json 里添加如下配置
"ios": {
    "deploymentTarget": "11.0",    
    "validArchitectures": [    
        "arm64"
    ],
}
...

3.2 不要将系统的私有API暴露给JS

不要将 oc 的 runtime 暴露给 JS ,不要将一些诸如 dlopen() dlsym()respondsToSelector:performSelector:method_exchangeImplementations() 动态和不可控的方法暴露给JS,也不要将系统的私有API暴露给JS。否则将可能面临苹果上架审核问题。

3.3 使用推送插件收不到消息

  • 使用第三方推送插件时,云打包需要勾选Push模块,离线SDK需要引入liblibPush.a
  • 本地通知/个推/uniPush平台,在前台时,不会走apns通道,不走apns通道,就不会触发ios通知扩展,极_光推送则可以。

see also

目录
相关文章
|
23天前
|
前端开发 安全 开发工具
【11】flutter进行了聊天页面的开发-增加了即时通讯聊天的整体页面和组件-切换-朋友-陌生人-vip开通详细页面-即时通讯sdk准备-直播sdk准备-即时通讯有无UI集成的区别介绍-开发完整的社交APP-前端客户端开发+数据联调|以优雅草商业项目为例做开发-flutter开发-全流程-商业应用级实战开发-优雅草Alex
【11】flutter进行了聊天页面的开发-增加了即时通讯聊天的整体页面和组件-切换-朋友-陌生人-vip开通详细页面-即时通讯sdk准备-直播sdk准备-即时通讯有无UI集成的区别介绍-开发完整的社交APP-前端客户端开发+数据联调|以优雅草商业项目为例做开发-flutter开发-全流程-商业应用级实战开发-优雅草Alex
163 90
【11】flutter进行了聊天页面的开发-增加了即时通讯聊天的整体页面和组件-切换-朋友-陌生人-vip开通详细页面-即时通讯sdk准备-直播sdk准备-即时通讯有无UI集成的区别介绍-开发完整的社交APP-前端客户端开发+数据联调|以优雅草商业项目为例做开发-flutter开发-全流程-商业应用级实战开发-优雅草Alex
|
16天前
|
JavaScript 搜索推荐 Android开发
【01】仿站技术之python技术,看完学会再也不用去购买收费工具了-用python扒一个app下载落地页-包括安卓android下载(简单)-ios苹果plist下载(稍微麻烦一丢丢)-客户的麻将软件需要下载落地页并且要做搜索引擎推广-本文用python语言快速开发爬取落地页下载-优雅草卓伊凡
【01】仿站技术之python技术,看完学会再也不用去购买收费工具了-用python扒一个app下载落地页-包括安卓android下载(简单)-ios苹果plist下载(稍微麻烦一丢丢)-客户的麻将软件需要下载落地页并且要做搜索引擎推广-本文用python语言快速开发爬取落地页下载-优雅草卓伊凡
40 8
【01】仿站技术之python技术,看完学会再也不用去购买收费工具了-用python扒一个app下载落地页-包括安卓android下载(简单)-ios苹果plist下载(稍微麻烦一丢丢)-客户的麻将软件需要下载落地页并且要做搜索引擎推广-本文用python语言快速开发爬取落地页下载-优雅草卓伊凡
|
16天前
|
数据采集 JavaScript Android开发
【02】仿站技术之python技术,看完学会再也不用去购买收费工具了-本次找了小影-感觉页面很好看-本次是爬取vue需要用到Puppeteer库用node.js扒一个app下载落地页-包括安卓android下载(简单)-ios苹果plist下载(稍微麻烦一丢丢)-优雅草卓伊凡
【02】仿站技术之python技术,看完学会再也不用去购买收费工具了-本次找了小影-感觉页面很好看-本次是爬取vue需要用到Puppeteer库用node.js扒一个app下载落地页-包括安卓android下载(简单)-ios苹果plist下载(稍微麻烦一丢丢)-优雅草卓伊凡
46 7
【02】仿站技术之python技术,看完学会再也不用去购买收费工具了-本次找了小影-感觉页面很好看-本次是爬取vue需要用到Puppeteer库用node.js扒一个app下载落地页-包括安卓android下载(简单)-ios苹果plist下载(稍微麻烦一丢丢)-优雅草卓伊凡
|
22天前
|
机器学习/深度学习 存储 人工智能
MNN-LLM App:在手机上离线运行大模型,阿里巴巴开源基于 MNN-LLM 框架开发的手机 AI 助手应用
MNN-LLM App 是阿里巴巴基于 MNN-LLM 框架开发的 Android 应用,支持多模态交互、多种主流模型选择、离线运行及性能优化。
1321 14
MNN-LLM App:在手机上离线运行大模型,阿里巴巴开源基于 MNN-LLM 框架开发的手机 AI 助手应用
|
24天前
|
供应链 数据挖掘 API
1688APP 原数据 API 接口的开发、应用与收益
1688作为阿里巴巴旗下的B2B平台,汇聚海量供应商和商品资源。其APP原数据API接口为开发者提供获取商品详细信息的强大工具,涵盖商品标题、价格、图片等。通过注册开放平台账号、申请API权限并调用接口,开发者可构建比价工具、供应链管理及自动化上架工具等应用,提升用户体验与运营效率,创造新的商业模式。示例代码展示了如何使用Python调用API并解析返回结果。
90 8
|
20天前
|
安全 JavaScript 前端开发
小游戏源码开发之可跨app软件对接是如何设计和开发的
小游戏开发团队常需应对跨平台需求,为此设计了成熟的解决方案。流程涵盖游戏设计、技术选型、接口设计等。首先明确游戏功能与特性,选择合适的技术架构和引擎(如Unity或Cocos2d-x)。接着设计通用接口,确保与不同App的无缝对接,并制定接口规范。开发过程中实现游戏逻辑和界面,完成登录、分享及数据对接功能。最后进行测试优化,确保兼容性和性能,发布后持续维护更新。
|
21天前
|
前端开发 Java 测试技术
语音app系统软件源码开发搭建新手启蒙篇
在移动互联网时代,语音App已成为生活和工作的重要工具。本文为新手开发者提供语音App系统软件源码开发的启蒙指南,涵盖需求分析、技术选型、界面设计、编码实现、测试部署等关键环节。通过明确需求、选择合适的技术框架、优化用户体验、严格测试及持续维护更新,帮助开发者掌握开发流程,快速搭建功能完善的语音App。
|
4天前
|
人工智能 程序员 API
iOS|记一名 iOS 开发新手的前两次 App 审核经历
啥,这玩意也有新手保护期?
14 0
|
移动开发
关于APP,原生和H5开发技术的争论
App的开发技术,目前流行的两种方式,原生和Html5。原生分了安卓平台和ios平台(还有小众的黑莓、死去的塞班就不说了),H5就是Html5。 目前争论不休的问题,在早先前争论CS,BS架构的软件系统是一样一样的。原先BS,CS对用户而言的区别是需不需要安装客户端。BS是通过浏览器来访问,用PC,平板,Win,Mac都能访问,用户不需要下载额外的客户端,同时运维和升级提供很大的
2638 0
|
2月前
|
Dart 前端开发
【05】flutter完成注册页面完善样式bug-增加自定义可复用组件widgets-严格规划文件和目录结构-规范入口文件-开发完整的社交APP-前端客户端开发+数据联调|以优雅草商业项目为例做开发-flutter开发-全流程-商业应用级实战开发-优雅草央千澈
【05】flutter完成注册页面完善样式bug-增加自定义可复用组件widgets-严格规划文件和目录结构-规范入口文件-开发完整的社交APP-前端客户端开发+数据联调|以优雅草商业项目为例做开发-flutter开发-全流程-商业应用级实战开发-优雅草央千澈
122 75
【05】flutter完成注册页面完善样式bug-增加自定义可复用组件widgets-严格规划文件和目录结构-规范入口文件-开发完整的社交APP-前端客户端开发+数据联调|以优雅草商业项目为例做开发-flutter开发-全流程-商业应用级实战开发-优雅草央千澈

热门文章

最新文章

  • 1
    MNN-LLM App:在手机上离线运行大模型,阿里巴巴开源基于 MNN-LLM 框架开发的手机 AI 助手应用
  • 2
    原生鸿蒙版小艺APP接入DeepSeek-R1,为HarmonyOS应用开发注入新活力
  • 3
    【11】flutter进行了聊天页面的开发-增加了即时通讯聊天的整体页面和组件-切换-朋友-陌生人-vip开通详细页面-即时通讯sdk准备-直播sdk准备-即时通讯有无UI集成的区别介绍-开发完整的社交APP-前端客户端开发+数据联调|以优雅草商业项目为例做开发-flutter开发-全流程-商业应用级实战开发-优雅草Alex
  • 4
    【08】flutter完成屏幕适配-重建Android,增加GetX路由,屏幕适配,基础导航栏-多版本SDK以及gradle造成的关于fvm的使用(flutter version manage)-卓伊凡换人优雅草Alex-开发完整的社交APP-前端客户端开发+数据联调|以优雅草商业项目为例做开发-flutter开发-全流程-商业应用级实战开发-优雅草Alex
  • 5
    【Azure App Service】基于Linux创建的App Service是否可以主动升级内置的Nginx版本呢?
  • 6
    【Azure Function】Function App出现System.IO.FileNotFoundException异常
  • 7
    1688APP 原数据 API 接口的开发、应用与收益
  • 8
    PiliPala:开源项目真香,B站用户狂喜!这个开源APP竟能自定义主题+去广告?PiliPala隐藏功能大揭秘
  • 9
    APP-国内主流安卓商店-应用市场-鸿蒙商店上架之必备前提·全国公安安全信息评估报告如何申请-需要安全评估报告的资料是哪些-优雅草卓伊凡全程操作
  • 10
    语音app系统软件源码开发搭建新手启蒙篇