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

简介: 背景:app采用uni实现需求: iOS App前台后台离线(杀死情况下)推送语音播报(到账xx元、收款播报、自定义推送铃)。实现方式:uni-app 原生插件(支持iOS Extension)

引言

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

实现方式:uni-app 原生插件(支持iOS Extension)

术语: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(扩展)。

插件获取方式:

  1. 插件市场:todo (500)
  2. 公z号: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通知扩展,极_光推送则可以。

3.4 原生插件支持付费

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

see also

目录
相关文章
|
6天前
|
安全 数据处理 Swift
深入探索iOS开发中的Swift语言特性
本文旨在为开发者提供对Swift语言在iOS平台开发的深度理解,涵盖从基础语法到高级特性的全面分析。通过具体案例和代码示例,揭示Swift如何简化编程过程、提高代码效率,并促进iOS应用的创新。文章不仅适合初学者作为入门指南,也适合有经验的开发者深化对Swift语言的认识。
24 9
|
5天前
|
Android开发 Swift iOS开发
探索安卓与iOS开发的差异和挑战
【10月更文挑战第37天】在移动应用开发的广阔舞台上,安卓和iOS这两大操作系统扮演着主角。它们各自拥有独特的特性、优势以及面临的开发挑战。本文将深入探讨这两个平台在开发过程中的主要差异,从编程语言到用户界面设计,再到市场分布的不同影响,旨在为开发者提供一个全面的视角,帮助他们更好地理解并应对在不同平台上进行应用开发时可能遇到的难题和机遇。
|
3天前
|
iOS开发 开发者
探索iOS开发中的SwiftUI框架
【10月更文挑战第39天】在苹果的生态系统中,SwiftUI框架以其声明式语法和易用性成为开发者的新宠。本文将深入SwiftUI的核心概念,通过实际案例展示如何利用这一框架快速构建用户界面,并探讨其对iOS应用开发流程的影响。
|
6天前
|
JSON 前端开发 API
探索iOS开发之旅:打造你的第一个天气应用
【10月更文挑战第36天】在这篇文章中,我们将踏上一段激动人心的旅程,一起构建属于我们自己的iOS天气应用。通过这个实战项目,你将学习到如何从零开始搭建一个iOS应用,掌握基本的用户界面设计、网络请求处理以及数据解析等核心技能。无论你是编程新手还是希望扩展你的iOS开发技能,这个项目都将为你提供宝贵的实践经验。准备好了吗?让我们开始吧!
|
9天前
|
存储 数据可视化 Swift
探索iOS开发之旅:从新手到专家
【10月更文挑战第33天】在这篇文章中,我们将一起踏上一场激动人心的iOS开发之旅。无论你是刚刚入门的新手,还是已经有一定经验的开发者,这篇文章都将为你提供宝贵的知识和技能。我们将从基础的iOS开发概念开始,逐步深入到更复杂的主题,如用户界面设计、数据存储和网络编程等。通过阅读这篇文章,你将获得成为一名优秀iOS开发者所需的全面技能和知识。让我们一起开始吧!
|
1月前
|
Java Android开发 Swift
安卓与iOS开发对比:平台选择对项目成功的影响
【10月更文挑战第4天】在移动应用开发的世界中,选择合适的平台是至关重要的。本文将深入探讨安卓和iOS两大主流平台的开发环境、用户基础、市场份额和开发成本等方面的差异,并分析这些差异如何影响项目的最终成果。通过比较这两个平台的优势与挑战,开发者可以更好地决定哪个平台更适合他们的项目需求。
109 1
|
1月前
|
设计模式 安全 Swift
探索iOS开发:打造你的第一个天气应用
【9月更文挑战第36天】在这篇文章中,我们将一起踏上iOS开发的旅程,从零开始构建一个简单的天气应用。文章将通过通俗易懂的语言,引导你理解iOS开发的基本概念,掌握Swift语言的核心语法,并逐步实现一个具有实际功能的天气应用。我们将遵循“学中做,做中学”的原则,让理论知识和实践操作紧密结合,确保学习过程既高效又有趣。无论你是编程新手还是希望拓展技能的开发者,这篇文章都将为你打开一扇通往iOS开发世界的大门。
|
1月前
|
搜索推荐 IDE API
打造个性化天气应用:iOS开发之旅
【9月更文挑战第35天】在这篇文章中,我们将一起踏上iOS开发的旅程,通过创建一个个性化的天气应用来探索Swift编程语言的魅力和iOS平台的强大功能。无论你是编程新手还是希望扩展你的技能集,这个项目都将为你提供实战经验,帮助你理解从构思到实现一个应用的全过程。让我们开始吧,构建你自己的天气应用,探索更多可能!
63 1
|
2月前
|
IDE Android开发 iOS开发
探索Android与iOS开发的差异:平台选择对项目成功的影响
【9月更文挑战第27天】在移动应用开发的世界中,Android和iOS是两个主要的操作系统平台。每个系统都有其独特的开发环境、工具和用户群体。本文将深入探讨这两个平台的关键差异点,并分析这些差异如何影响应用的性能、用户体验和最终的市场表现。通过对比分析,我们将揭示选择正确的开发平台对于确保项目成功的重要作用。
|
11天前
|
设计模式 前端开发 Swift
探索iOS开发:从初级到高级的旅程
【10月更文挑战第31天】在这篇文章中,我们将一起踏上iOS开发的旅程。无论你是初学者还是有经验的开发者,这篇文章都将为你提供有价值的信息和技巧。我们将从基础开始,逐步深入到更高级的技术和概念。让我们一起探索iOS开发的世界吧!