参考文章链接:https://www.cnblogs.com/liaolijun/p/4794831.html
扩展插件JS API 编写
开发者在实现JS层API时首先要定义一个插件类别名,并需要在IOS工程的PandoraApi.bundle\feature.plist文件中声明插件类别名和Native层扩展插件类的对应关系
JS扩展方法的实现
同步返回JS扩展方法实现
在实现同步扩展方法时,开发者需要调用JS Plugin Bridge window.plus.bridge.execSync()方法,该方法可同步获取Native插件返回的运行结果。
void plus.bridge.execSync(Stringservice,Stringaction,Arrayargs);
service: 插件类别名
action: 调用Native层插件方法名称。
args: 参数列表。
异步返回JS扩展方法实现
在实现异步扩展方法时,开发者需要调用JS Plugin Bridge的plus.bridge.exec()方法,该方法会通知Native层插件执行指定方法,运行结果会通过回调的方式通知JS层
void plus.bridge.exec(Stringservice,Stringaction,Arrayargs);
service: 插件类别名
action: 调用Native层插件方法名称。
args: 参数列表。
扩展插件JS API代码示例(可直接copy到自己的JS类里面使用),类名为NativePlugin:
! function(root, factory) {
if (typeof exports == 'object' && typeof module != 'undefined') {
module.exports = factory()
} else if (typeof define == 'function' && define.amd) {
define(factory)
} else {
document.addEventListener('plusready', function() {
// 修改此处为插件命名 注释---1
var moduleName = 'uniappPlugin';
root.plus[moduleName] = factory()
}, false);
}
}(this, function() {
//在此处定义自己的方法 注释---2
var _BARCODE = 'uniappPlugin';
var plugintest = {
/** 跳转原生登录页面 */
JumpNativeLoginView: function(successCallback, errorCallback) {
var success = typeof successCallback !== 'function' ? null : function(args) {
successCallback(args);
},
fail = typeof errorCallback !== 'function' ? null : function(code) {
errorCallback(code);
};
// 注释---3
var callbackID = plus.bridge.callbackId(success, fail);
// 注释---4
return plus.bridge.exec(_BARCODE, "pushLogin", [callbackID]);
}
});
在其它页面调用
NativePlugin.JumpNativeLoginView(function(result){},function(error){});
iOS原生端开发步骤
一 创建插件类
开发者新创建的类需要继承“PGPlugin”类实现第三方插件扩展。
创建一个继承自“PGPlugin”类的Objective-c类
在源文件中引入头文件“PGPlugin.h”和“PGMethod.h”
二 编写插件的方法
开发者可根据需求,在JS层通过调用不同的JS Plugin Bridge方法,将扩展方法定义为同步执行或异步执行。
同步执行的方法会阻塞当前JS代码的执行,并同步获取Native层扩展方法返回的运行结果。
异步执行方法不会阻塞当前JS代码的执行,需要开发者用回调的方式接收Native层的执行结果。
但需要注意,在调用plus.bridge.exec或plus.bridge.execSync方法时,传入的第一个参数是插件的别名,开发者需要声明别名和Native代码类名的对应关系。传入的第二个参数(调用插件的方法名),需要和要调用的扩展插件的方法名一致,否则无法通过JS调用到Native层扩展类方法。
异步方法:
开发者在编写异步方法时可通过PGPlugin类的回调方法将Native扩展方法运行结果返回到调用页面。使用方法如下
Native层代码实现
-(void)pushLogin:(PGMethod*)commands{
if(commands){
注意:这里可以直接调用登录,但是我们有时登录会有用户信息需要返回到uniapp,所以下面的result就可以替换成用户信息了,记得要转成json字符串返回去。记住数组的第一个一定是callbackid。
// CallBackid 异步方法的回调id,H5+ 会根据回调ID通知JS层运行结果成功或者失败NSString*cbId=[commands.argumentsobjectAtIndex:0];
// 用户的参数会在第二个参数传回,可以按照Array方式传入,NSArray*pArray=[commands.argumentsobjectAtIndex:1];
// 如果使用Array方式传递参数NSString*pResultString=[NSStringstringWithFormat:@"%@ %@ %@ %@",[pArrayobjectAtIndex:0],[pArrayobjectAtIndex:1],[pArrayobjectAtIndex:2],[pArrayobjectAtIndex:3]]
// 运行Native代码结果和预期相同,调用回调通知JS层运行成功并返回结果PDRPluginResult*result=[PDRPluginResultresultWithStatus:PDRCommandStatusOKmessageAsString:pResultString];
// 如果Native代码运行结果和预期不同,需要通过回调通知JS层出现错误,并返回错误提示//PDRPluginResult *result = [PDRPluginResult resultWithStatus:PDRCommandStatusError messageAsString:@"惨了! 出错了! 咋(wu)整(liao)"];
// 通知JS层Native层运行结果,JS Pluginbridge会根据cbid找到对应的回调方法并触发
[selftoCallback:cbIdwithReslut:[result toJSONString]];
}
}
同步方法:
同步扩展方法可通过返回值的方式,将Native层扩展插件的运行结果返回给调用该方法的HTML页面。同步方法返回值类型为NSData,传入参数为PGMethod类型。在返回结果较复杂时建议用户使用JSON格式的字符串。
-(NSData *)pushLogin:(PGMethod*)commands{
// 根据传入获取参数
NSString*pArgument1=[command.arguments objectAtIndex:0];
NSString*pArgument2=[command.arguments objectAtIndex:1];
NSString*pArgument3=[command.arguments objectAtIndex:2];
NSString*pArgument4=[command.arguments objectAtIndex:3];
// 拼接成字符串NSString*pResultString=[NSStringstringWithFormat:@"%@ %@ %@ %@",pArgument1,pArgument2,pArgument3,pArgument4];
// 按照字符串方式返回结果
return[selfresultWithString:pResultString];
}
三 关联JS插件名和原生类
开发者在编写扩展插件时需要在JS层定义一个扩展插件的别名,并需要在改方法被调用之前,在H5+基座中注册项两者之间的对应关系。否则5+SDK无法准确的找到Native层的扩展插件。
5+ SDK 提供了两种注册对应关系的方式。
在plist文件中声明对应关系
在编写JS时同时需要修改PandoraAPI.bundle中feature.plist文件,在其中添加JS插件别名和Native插件类的对应关系,SDK基座会根据对应关系查找并生成相应的Native对象并执行对应的方法。
调用PDRCore的接口声明对应关系
开发者还可以通过调用PDRCore提供的设置接口来声明对应关系,该接口不但可以设置JS别名和Native扩展类名之间的关系,还可以注册扩展插件的JS层代码。该声明方法通常在PDRCore初始化后调用。开发者也可以自行决定声明的时机,但是必须在调用该扩展方法的html页面加载之前执行声明。
因为之前弄过Android端的交互(本人已经清楚了交互),所以iOS这里我只是写了个大概,防止自己忘记了步骤流程,如果需要看更详情的说明,请前往文章开头的地址。
还有一种就是直接iOS原生针对uniapp单向的数据传输,这个有空的时候会给大家再写篇文章。谢谢大家的支持。