最近公司有使用APICloud发开的需求,需要我这边提供一些模块包得封装。因为没有也是刚接触APICloud,所以也就在看官方文档 。下面讲一讲我再使用过程中得一点点东西。
首先,下载官方SDK,下载最新版本的模块开发SDK,找到里面的ModulesDevProject_iOS.zip,这里面包含ModuleDemo、ModulesDevProject和说明文件。ModuleDemo是一个官方的模块包封装和静态库生成的工程。ModulesDevProject则是可以让我们自己调试的工程。
模块类实现
2.1. 新建模块类
新建一个UZModuleDemo类,继承于UZModule类,其中UZModule类为模块的基类。模块开发过程中文件命名时提倡加前缀,以避免和其它模块冲突。
2.2. 模块生命周期
当前端js中调用模块方法时,模块首先会被初始化,引擎会调用其 - (id)initWithUZWebView:(UZWebView *)webView 方法;
当模块所在的页面被销毁时,引擎会调用其 - (void)dispose 方法。
2.3. 启动方法
如果模块需要在应用启动的时候就执行一些操作,那么首先得在module.json里面配置launchClassMethod,例如配置的方法为launch,然后在模块里面实现该方法,当应用启动时该方法就会被执行。
- + (void)launch{
- //在module.json里面配置的launchClassMethod,必须为类方法,引擎会在应用启动时调用配置的方法,模块可以在其中做一些初始化操作;下面代码为注册一个实现了UIApplicationDelegate协议方法的对象,该对象中方法就会在需要的时候被调用,通过此方式可以实现第三方应用回调url解析、推送等常用功能
- //UZApphandler 基础Object基类 可以做一些需要AppDelegate 实现的初始化 如初始化推送的AppKey等等
- // UZAppHandler *appHandler = [[UZAppHandler alloc] init];
- // [theApp addAppHandle:appHandler];
- }
2.4. 方法调用
实现 - (void)showAlert:(NSDictionary *)paramDict 方法,用于显示一个对话框,该方法需要在module.json里面配置,然后在前端js里面才可以调用该方法。
如果前端调用该方法时传入了一个function,那么在这里可以通过cbId字段获取该function对应的id,然后在需要的时候把数据通过该function回调给js。
- - (void)showAlert:(NSDictionary *)paramDict {
- _cbId = [paramDict integerValueForKey:@"cbId" defaultValue:-1];
- NSString *message = [paramDict stringValueForKey:@"msg" defaultValue:nil];
- UIAlertView *alert = [[UIAlertView alloc] initWithTitle:nil message:message delegate:self cancelButtonTitle:@"取消" otherButtonTitles:@"确定", nil nil];
- [alert show];
- }
2.5. 回调
我们在这里实现UIAlertViewDelegate中的 - (void)alertView:(UIAlertView *)alertView didDismissWithButtonIndex:(NSInteger)buttonIndex 方法,将用户点击的按钮index回调给js端,代码如下:
- - (void)alertView:(UIAlertView *)alertView didDismissWithButtonIndex:(NSInteger)buttonIndex {
- if (_cbId >= 0) {
- NSDictionary *ret = @{@"index":@(buttonIndex)};
- [self sendResultEventWithCallbackId:_cbId dataDict:ret errDict:nil doDelete:YES];
- }
- }
当然,也可以定义自己的方法method,同时要修改module.json的配置 注意不要[+]以及引号的英 汉。
- {
- "name":"moduleDemo",//模块包名一致
- "class":"UZModuleDemo",//模块类名
- "methods":["showAlert","method"],//自己定义的方法名
- "launchClassMethod":"launch"//是否执行launc类方法
- }
找到widget目录下html目录里面的module-con.html,我们在这里面调用showAlert等方法,如下
- var param = {
- msg:"Hello App!"
- };
- var demo = api.require('moduleDemo');//模块包名称 (module.json 这里 模块包名称 三者要一致)
- demo.showAlert(param, callBack);//传参数调用方法 和回调
- function callBack(ret, err){
- var msg;
- if (ret.index == 0){
- msg = "点击了第一个按钮";
- } else {
- msg = "点击了第二个按钮";
- }
- api.toast({
- msg:msg
- });
- }
调试好了之后,把添加 修改的文件 加入ModuleDemo的静态库工程(也可以自己创建),去掉没用的,选择iOS device编译,复制静态库文件。 创建文件夹名称和模块包一致,里面在创建target文件夹,把静态库文件粘贴进来,加入用到了第三方的Framework和bundle束也放进来。 target同级目录粘贴module.json文件,返回压缩成zip文件. 获取在apicloud创建的应用的Id 修改widget下config.xml 顶部的id,复制压缩widget文件。在apicloud控制台,转到该应用,选择代码部分,上传widget.zip 跳转模块中自定义模块上传模块包,名称必须和模块包名称一致。保存 编译,如果没有意外,你就能扫二维码 下载安装你的应用到手机了。 这里默认的时apicloud提供的证书,加入要改自己的就看证书栏目,都有教程的。Mark!