DCloud_iOS_XHY
DCloud_iOS_XHY
  • 发布:2019-04-04 11:17
  • 更新:2019-04-11 12:51
  • 阅读:2478

iOS——离线打包集成uni-app原生插件

分类:uni-app

预备环境

  • iOS 开发环境,Mac OS、XCode 10.0以上版本。
  • 下载 HBuilder 离线打包iOS版SDK(5+ SDK下载)。
  • 插件市场 原生插件

注意:本文档基于XCode10 其他版本如有问题请留言

预备知识

1.插件目录说明

|-- 插件目录结构  
    |-- android                     // android 插件  
    |-- ios                         // ios 插件  
    |-- package.json                // 插件配置文件  

原生插件目录结构都是固定的,其中 android 路径中放的是 android 端插件,ios 路径中放的是 ios 端插件,package.json 为插件的配置文件,配置了插件id、格式、插件资源以及插件所需权限等等,离线集成需要开发者根据 package.json 手动配置离线工程(通过 HBuilderX 云端打包插件打包机会自动完成配置)。

下面我们学习一下 package.json 配置的每个节点的含义以及如何手动将插件集成到离线工程中并添加相关配置项;

2.完整 package.json 配置文件说明

完整的 package.json 配置文件格式如下(已移除离线集成插件不需要关心的节点),下面对每个节点如何在离线工程中配置进行说明

注意:一些插件中可能不会包含所有的节点,只需按照下面的说明配置插件中包含的节点即可

{    
    "name": "插件名称",    
    "id": "插件标识",    
    "version": "插件版本号",    
    "description": "插件描述信息",    
    "_dp_type":"nativeplugin",    
    "_dp_nativeplugin":{    
        "ios": {    
            "plugins": [    
                {    
                    "type": "module|component, 插件类型",    
                    "name": "插件名称",    
                    "class": "插件的类名"     
                }    
            ],   
            "hooksClass": "插件事件钩子注册类名",    
            "frameworks": [    
                "插件依赖的系统framework库"    
            ],    
            "embedFrameworks": [    
                "依赖的framework动态库"    
            ],    
            "resources": [    
                "插件要使用的资源文件列表,相对于ios目录的路径"    
            ],    
            "headers": [    
                "插件需要使用的头文件列表,相对于ios目录的路径"    
            ],    
            "privacies": [    
                "插件使用到的隐私列表,如NSPhotoLibraryUsageDescription"    
            ],  
            "parameters": {    
                "插件需要配置的参数名称, 如appid": {    
                    "des": "参数描述信息",    
                    "key": "参数需要配置到infor.plist中的键名, 嵌套时使用:分割,如getui:appid"    
                }    
            }    
        }   
    }    
}    

plugins
hooksClass
插件信息,及插件事件钩子注册类名,找到离线工程的 info.plist 文件右键选择 Open As -> Source Code 源码查看,添加如下节点信息,并根据 package.json 中配置的信息修改对应项的值 hooksClass、type、name、class

注:工程中只能包含一个dcloud_uniplugins节点,如果配置多个插件只需在dcloud_uniplugins节点下配置多个dict节点即可

    <key>dcloud_uniplugins</key>  
    <array>  
        <dict>  
            <key>hooksClass</key>  
            <string>插件事件钩子注册类名</string>  
            <key>plugins</key>  
            <array>  
                <dict>  
                    <key>type</key>  
                    <string>插件类型</string>  
                    <key>name</key>  
                    <string>插件名称</string>  
                    <key>class</key>  
                    <string>插件的类名</string>  
                </dict>  
            </array>  
        </dict>  
    </array>  

frameworks
frameworks 为插件依赖的系统 framework 库,在工程的 Link Binary With Libraries 中点击下面的 + 号将插件所需的系统库添加进来即可


embedFrameworks
embedFrameworks 为插件依赖的动态 framework 库,需要以动态库的方式引入工程一定不要弄错,在工程的 Embed Frameworks 中点击下面的 + 号,在插件ios目录中将 embedFrameworks 中所配置的动态库添加进来

在弹窗中选择 Add Other 然后找到插件ios目录下面的动态 framework 库

其他 .a 静态库及 frameworks 静态库
除了 frameworks 节点及 embedFrameworks 节点中所配置的依赖库,在ios目录下面的其他 .a库文件 或 .framework库文件都为静态库,同样需要引入到工程中,同样在工程的 Link Binary With Libraries 中点击下面的 + 号将这些库也添加到工程

resources
resources 节点配置的是插件所需的资源文件,在工程的 Copy Bundle Resources 中点击下面的 + 号将插件所有资源文件添加到工程中


headers
headers 为插件所暴露的头文件,只需将这些文件直接拖入到工程中即可

privacies
privacies 为插件所需要到的系统权限,需要在 info.plist 中添加相应权限描述 如

parameters
parameters 中配置的信息也需要在 info.plist 中添加 举例:

"key": "getui:appid"

info.plist 中添加

<key>getui</key>  
<dict>  
    <key>appid</key>  
    <string>填写对应的appid</string>  
</dict>  

集成示例

1.插件市场下载uni-app原生插件(以RichAlert为例)

2.将下载的插件解压,将插件拷贝到离线工程根目录中

3.查看 package.json 文件并配置工程

这个插件配置信息比较简单只有 plugins 节点

{  
    "name": "RichAlert",  
    "id": "DCloud-RichAlert",  
    "version": "0.1.3",  
    "description": "示例插件",  
    "_dp_type":"nativeplugin",  
    "_dp_nativeplugin":{  
        "ios": {  
            "plugins": [  
                {  
                    "type": "module",  
                    "name": "DCloud-RichAlert",  
                    "class": "DCRichAlertModule"  
                }  
            ],  
            "integrateType": "library",  
            "deploymentTarget": "8.0"  
        }  
    }  
}  

在 info.plist 中添加 plugins 信息

<key>dcloud_uniplugins</key>  
    <array>  
        <dict>  
            <key>hooksClass</key>  
            <string></string>  
            <key>plugins</key>  
            <array>  
                <dict>  
                    <key>type</key>  
                    <string>module</string>  
                    <key>name</key>  
                    <string>DCloud-RichAlert</string>  
                    <key>class</key>  
                    <string>DCRichAlertModule</string>  
                </dict>  
            </array>  
        </dict>  
    </array>  

将ios目录下的.a库添加到工程中

至此本插件集成配置已完成

4.运行

示例工程 GitHub 地址: https://github.com/dcloudio/UniPluginPackage

0 关注 分享

要回复文章请先登录注册

DCloud_iOS_XHY

DCloud_iOS_XHY (作者)

回复 2047185642@qq.com:
这个节点是集成weex环境需要说明的,在离线sdk中会有说明,做插件前提是这部分已经搞定
2019-04-11 12:51
2047185642@qq.com

2047185642@qq.com

在 info.plist 中添加 plugins 信息这里应该是要再加上<key>dcloud_uninview_background</key>
<true/>这个节点。
2019-04-11 11:40