等网页元素上方在EUExDemoPlugin类中实现方法addView: removeView并在plugin.xml中声明addView方法有一个必选参数isScrollable 用来控制被添加的view是跟随网页滑动 还是固定在窗口上

EUtility 中有2个方法brwView: addSubviewToScrollView:,brwView: addSubview:分别对应了上述2种情况

用一个实例变量aView来管理被添加的View

@property(nonatomic,strong)UIView*aView;-(void)addView:(NSMutableArray*)inArguments{

if(self.aView){

//如果已经添加了view 直接返回

return;

}

if([inArguments count]<1){

//参数不传 直接返回

return;

}

id info=[inArguments[0]JSONValue];

if(!info||![info isKindOfClass:[NSDictionaryclass]]){

//参数解析后不是NSDictionary 直接返回

return;

}

if(!info[@"isScrollable"]){

//如果参数信息不包含isScrollable这个键 直接返回

return;

}

BOOL isScroll=[info[@"isScrollable"]boolValue];

//新建一个view，并将其背景设置为红色

UIView*view=[[UIViewalloc]initWithFrame:CGRectMake(10,400,300,200)];

view.backgroundColor=[UIColorredColor];

if(isScroll){

[EUtilitybrwView:self.meBrwView addSubviewToScrollView:view];

}else{

[EUtilitybrwView:self.meBrwView addSubview:view];

}

//插件对象持有此view,方便对其进行移除操作

self.aView=view;

}

-(void)removeView:(NSMutableArray*)inArguments{

if(self.aView){

[self.aView removeFromSuperview];

self.aView=nil;

}

}在网页中我们设置一个单选框用于控制是否跟随网页滑动，相关HTML以及JS代码如下

varaddView=function(){

//获取单选框的网页对象

varcheckbox1=document.getElementById("checkbox1");

//以单选框是否被勾选作为isScrollable的值，是个boolean

varjson={

isScrollable:checkbox1.checked

}

uexDemoPlugin.addView(JSON.stringify(json));

}

varremoveView=function(){

uexDemoPlugin.removeView();

}运行结果如下

在网页中展示一个viewController本小节介绍了插件如何在网页上展示原生的ViewController。

展示viewController的限制只能以present的方式从当前的网页controller中切换到你自己的viewController中;在插件工程中新建一个继承自UIViewController的类uexDemoPluginViewController,然后在它的view上添加一个按钮，按钮会调用EUExDemoPlugin中的dismissViewController方法；

uexDemoPluginViewController.h

@classEUExDemoPlugin;

@interfaceuexDemoPluginViewController:UIViewController

-(instancetype)initWithEUExObj:(EUExDemoPlugin*)euexObj;

@end

uexDemoPluginViewController.m

#import "uexDemoPluginViewController.h"

#import "EUExDemoPlugin.h"

@interfaceuexDemoPluginViewController()

@property(nonatomic,weak)EUExDemoPlugin*euexObj;

@end

@implementationuexDemoPluginViewController

-(instancetype)initWithEUExObj:(EUExDemoPlugin*)euexObj{

self=[superinit];

if(self){

_euexObj=euexObj;

}

returnself;

}

-(void)viewWillAppear:(BOOL)animated{

[superviewWillAppear:animated];

self.view.backgroundColor=[UIColorwhiteColor];

UIButton*button=[UIButtonbuttonWithType:UIButtonTypeSystem];

button.frame=CGRectMake(100,100,180,60);

[button setTitle:@"关闭ViewController"forState:UIControlStateNormal];

[button addTarget:selfaction:@selector(onCloseButtonClick:)forControlEvents:UIControlEventTouchUpInside];

[self.view addSubview:button];

}

-(void)onCloseButtonClick:(id)sender{

[self.euexObj dismissViewController];

}EUExDemoPlugin类中实现方法presentController并在plugin.xml中声明

@property(nonatomic,strong)uexDemoPluginViewController*aViewController;-(void)presentController:(NSMutableArray*)inArguments{

if(self.aViewController){

return;

}

uexDemoPluginViewController*controller=[[uexDemoPluginViewController alloc]initWithEUExObj:self];

[EUtilitybrwView:self.meBrwView presentViewController:controller animated:YES completion:nil];

self.aViewController=controller;

}EUExDemoPlugin类中实现方法dismissViewController 关闭被present的ViewController,并给前端一个监听回调onControllerClose

-(void)dismissViewController{

if(self.aViewController){

[self.aViewController dismissViewControllerAnimated:YES completion:^{

[selfcallbackJSONWithName:@"onControllerClose"object:nil];

self.aViewController=nil;

}];

}

}前端JS中封装相关的回调方法,然后执行uexDemoPlugin.presentController();

//在window.uexOnload中

uexDemoPlugin.onControllerClose=function(){

alert("controller 被关闭!")

}结果如下

4.生成插件包此步骤应该在您插件所有接口封装完毕，并在调试工程中测试完成后再进行

以下说明中均以范例插件uexDemoPlugin为例进行的操作。

在实际操作时,应该将所有出现的DemoPlugin替换成您自己的插件名字。

4.1 编译插件静态库.a文件确认插件调试工程已经关闭,然后打开静态库工程EUExDemoPlugin.xcodeproj

左上角的schemes管理中，选择EUExDemoPlugin - Generic iOS Device

点击Product-Build,生成插件的.a文件libuexDemoPlugin.a

4.2 编辑plugin.xmlplugin.xml主要记录了插件的接口信息

此plugin.xml和插件调试工程中的plugin.xml完全一样，您可以直接拷贝过来如果您的调试工程在同时调试多个插件,那么在拷贝完成之后应删去节点中其他插件的信息

或者以下列文本为基础,在节点中按照plugin.xml中注册插件方法的基本规则和如何在plugin.xml中注册一个同步方法完成plugin.xml的编辑

plugin.xml空白模板,是一个标准的xml文件

最终完成的plugin.xml示例如下

4.3编辑info.xmlinfo.xml主要记录了插件的版本信息

示例模板如下

uexName="name"version="3.0.x"build="x">

其中 name 替换成uex开头的插件名 x替换成当前插件的版本号(非负整数)

然后向plugin节点中加入各个版本的简介,这些简介以倒序加入,由一个节点和多个(可以为0个)节点构成。节点记录了当前版本的简介

节点记录了历史版本的简介

当插件版本更新时，应该讲当前的节点改为节点，同时在其之前添加新的节点

最终完成的info.xml范例如下

uexName="uexDemoPlugin"version="3.0.1"build="1">

1:添加其他开发说明的示例代码

0:AppCan iOS插件范例

4.4 获得插件包新建名为uexDemoPlugin的文件夹并进入。如果您进行了前文中提及所有的可选操作,那么在插件工程目录下面,应该自动生成了此文件夹,可以直接使用。

将libuexDemoPlugin.a,plugin.xml,info.xml拷贝至此文件夹中。如果您进行了前文中提及所有的可选操作,那么编译工程出来的.a文件将自动在此目录中生成。

根据具体情况,将可能存在的以下文件拷贝至此文件夹中,具体请看5.其他开发说明中的说明第三方库依赖的.bundle文件

第三方库的静态.framework文件

插件资源包uexDemoPlugin.bundle

插件配置文件uexDemoPlugin.plist

全部拷贝工作完成后，uexDemoPlugin文件夹内的内容如下图所示

以上所有步骤均完成后，返回上级目录,压缩uexDemoPlugin文件夹,得到插件zip包。

此zip包可以直接上传作为自定义插件包(目前ios自定义插件只支持在线打包环境，ide打包环境暂不支持)使用。

5.其他开发说明以下是一些您在开发过程中可能需要的说明。

所有说明均可在范例工程中找到相应的示例代码。

5.1 插件如何引入第三方库

插件引入第三方库的具体规则如下

第三方Library(.a文件),直接引入插件工程参与编译即可。

资源捆绑包(.bundle)和第三方静态framework(.framework),需要引入插件工程参与编译,生成插件包时也需要单独放入压缩包中,和插件.a处于同一目录下。调试时，.bundle和.framework需要在调试工程中再引入一遍，否则会无法找到相应的文件。

建议插件工程将引入的.bundle和.framework文件添加到Copy Files的Build Phase中,这样可以在编译时将这些文件直接复制至uexDemoPlugin文件夹中

动态framework,目前暂不支持。

5.2 插件如何引用资源文件本小节主要介绍了如何建立插件自己的资源捆绑包(.bundle文件)以供使用。

这里的资源文件包括但不限于xib,storyboard,png,jpg,json,xml,js,plist等文件

5.2.1 生成插件资源捆绑包的target选中插件静态库工程，然后点击菜单栏中的File - New - Target.. ,在弹出的对话框中选择OS X - Framework & Library - Bundle

product Name取名为uexDemoPluginBundle,点击finish完成创建。

修改此target的如下Build Settings将Product Name对应的值修改为 uexDemoPlugin

将Pre-configuration Build Products Path 修改为$SRCROOT/uexDemoPlugin(注1)

将Code Signing Identity 修改为Don't Code Sign

将Combine High Resolution Artwork修改为No(注2)

将Info.plist File的值置为空

在工程的uexDemoPluginBundle群组下,找到info.plist这个文件，右键选择delete，然后选择Move to Trash以删除该文件

为静态库target添加此bundle的target的依赖(注3)修改EUExDemoPlugin这个target的Build Phases ，在Target Dependicies中添加刚刚创建的bundle的target

注1:此settings是为了让build时将此bundle直接生成在uexDemoPlugin文件夹中

注2:如果你的资源包中不包含图片文件,那么此设置可跳过。

注3:这个设置是为了保证在插件clean时可以清除生成的bundle文件,在插件build时会自动生成新的bundle文件

接下来,可以把插件需要的资源文件全部添加至uexDemoPluginBundle这个target中即可

5.2.2 如何引用插件bundle中的资源文件EUtility提供了方法bundleForPlugin:用以寻找插件bundle对应的NSBundle实例。然后用NSBundle的方法pathForResource: ofType:获取资源路径加载资源即可。

bundle加载@ 2x ,@ 3x图片文件的处理方法

获取到NSBundle实例后,用NSBundle的pathForResource: ofType:并不能自动识别@ 2x,@ 3x的图片文件,最好用resourcePath方法获得实际路径，然后拼接得到图片路径。

示例如下

NSBundle*pluginBundle=[EUtilitybundleForPlugin:@"uexDemoPlugin"];

//从bundle中读取资源图片文件的示例

//直接用[pluginBundle pathForResource:@"sun" ofType:@"png"];只能匹配"sun.png"这个文件的路径，找不到会返回nil,而不会寻找文件"sun@2x.png"和"sun@3x.png".

NSString*path=[[pluginBundle resourcePath]stringByAppendingPathComponent:@"sun.png"];

UIImage*image=[UIImageimageWithContentsOfFile:path];

5.2.3 插件如何进行读取国际化文件Localizable.strings将国际化文件Localizable.strings放入插件bundle中，然后用EUtility.h中的方法uexPlugin: localizedString:得到国际化的字符串.示例如下

label.text=[EUtilityuexPlugin:@"uexDemoPlugin"localizedString:@"title"];

5.3 插件如何获取系统事件

5.3.1 ApplicationDelegate事件

AppCan会将大部分ApplicationDelegate事件分发到每个插件入口类，插件入口类用相应的类方法接收即可

目前插件入口类可供接收的类方法有

+(BOOL)application:(UIApplication*)application didFinishLaunchingWithOptions:(NSDictionary*)launchOptions;

+(void)application:(UIApplication*)app didRegisterForRemoteNotificationsWithDeviceToken:(NSData*)deviceToken;

+(void)application:(UIApplication*)app didFailToRegisterForRemoteNotificationsWithError:(NSError*)err;

+(void)application:(UIApplication*)application didReceiveRemoteNotification:(NSDictionary*)userInfo;

+(void)application:(UIApplication*)application didReceiveRemoteNotification:(NSDictionary*)userInfo fetchCompletionHandler:(void(^)(UIBackgroundFetchResult))completionHandler

+(void)application:(UIApplication*)application didReceiveLocalNotification:(UILocalNotification*)notification;

+(BOOL)application:(UIApplication*)application handleOpenURL:(NSURL*)url;

+(BOOL)application:(UIApplication*)application openURL:(NSURL*)url sourceApplication:(NSString*)sourceApplication annotation:(id)annotation;

+(void)applicationWillResignActive:(UIApplication*)application;

+(void)applicationDidBecomeActive:(UIApplication*)application;

+(void)applicationDidEnterBackground:(UIApplication*)application;

+(void)applicationWillEnterForeground:(UIApplication*)application;

+(void)applicationWillTerminate:(UIApplication*)application;

+(void)applicationDidReceiveMemoryWarning:(UIApplication*)application;

+(void)application:(UIApplication*)application performActionForShortcutItem:(UIApplicationShortcutItem*)shortcutItem completionHandler:(void(^)(BOOL))completionHandler

示例:

//EUExDemoPlugin.m中

staticNSDictionary*AppLaunchOptions;

+(BOOL)application:(UIApplication*)application didFinishLaunchingWithOptions:(NSDictionary*)launchOptions{

NSLog(@"app launched");

//存储launchOptions

AppLaunchOptions=launchOptions;

returnYES;

}

5.3.2 AppCan系统事件

AppCan引擎会额外分发如下事件至每个插件入口类

+(void)rootPageDidFinishLoading;//root页面加载完成的事件,在此事件触发后才能有效执行回调网页的相关方法

示例:

//第一个网页(root页面)加载完成时会触发此事件

//部分事件(比如application:didFinishLaunchingWithOptions:)触发时，第一个网页可能还没加载完成，因此无法当时回调给网页

//这些回调应该延迟至这个事件触发时再回调给root页面

+(void)rootPageDidFinishLoading{

NSString*jsStr=[NSStringstringWithFormat:@"if(uexDemoPlugin.onAppLaunched){uexDemoPlugin.onAppLaunched('%@');}",[AppLaunchOptionsJSONFragment]];

//在root页面执行JS脚本

[EUtilityevaluatingJavaScriptInRootWnd:jsStr];

AppLaunchOptions=nil;

}

5.4 插件如何配置info.plist新建uexDemoPlugin.plist文件,可以通过Xcode新建,也可以在文本编辑器中直接输入如下内容并另存为uexDemoPlugin.plist

打开刚刚新建的plist文件，然后在root下新建名为UexKeyValues的key,其Type选为Dictionary

在UexKeyValues这个dictionary中添加你需要添加到info.plist中的内容,打包服务器会自动将这些内容合入最后打包工程的info.plist中

配置完成后，将此uexDemoPlugin.plist放入uexDemoPlugin文件夹中

6.常见问题

上传插件时提示目录结构错误检查zip包目录结构是否缺失zip包解压缩后应该只有一个uexXXX开头的文件夹

文件夹内至少有libuexXXX.a,info.xml,plugin.xml这3个文件

首次上传插件时设置的插件名称应该是uex开头,且应该与info.xml,plugin.xml中的名称保持一致

如果是更新插件,确认info.xml中的版本号正确的递增了,以及节点正确填写了

在线打包时出现Undefined symbols for architecture xxx类型的报错:

出现这种错误主要有以下几种原因

生成.a的时候没有选择Generic iOS Device或者在用命令行编译时没有注明-sdk iphoneos,导致缺少对应的架构。解决方法:正确编译引擎.a并重新生成插件包进行在线打包

缺少依赖的第三方库或者第三方库本身架构缺失解决方法:添加同时拥有armv7和arm64架构的第三方库并重新生成插件包进行在线打包

缺少系统依赖库.如果这个库的依赖iOS版本比AppCan引擎的依赖版本高,那么此插件只能配合自定义引擎使用

反之,请去AppCan引擎github提issue或者在AppCan官方论坛发帖说明,我们会第一时间进行反馈.

目前AppCan引擎的依赖版本为iOS 7.0

在线打包时出现duplicate symbols for architecture xxx类型的报错:

出现这种错误的主要原因是类名冲突，请先根据日志找到冲突的类名以及它们分别所属的文件

如果是您的插件和非官方的插件冲突请联系插件作者协商解决

如果您的插件和官方插件或者引擎冲突如果此类是源自知名第三方库源码(比如SDWebImage等等),可以尝试只包含这些第三库的头文件使用

如果此类是您的自定义类或者包含您的自定义代码，那么应该优先尝试在类名前加上前缀避免冲突

如果此类属于第三方.a,那么应该尝试用libtool等工具将冲突的.o拆分出来,然后重新合并

如果以上方法都无法解决并且冲突来源于引擎,那么只能您的插件只能用自定义引擎,修改引擎源码配合使用