跟着白菜一起开发一个属于自己的Cordova插件吧!GO,GO,GO!
准备工作
工具原料
- Mac 电脑
- Cordova环境
- Cordova工程
- xode
开始创建插件
打开终端,输入一下命令(PS:如果这里没有plugman命令,自己百度解决)
plugman create --name ibaicai --plugin_id com.lichanglong.ibaicai --plugin_version 1.0.0
插件的的目录结构
插件的目录结构,如图。src 目录下面是空的。
plugin.xml文件
該name
提供模組名稱的最後一部分。 如果你想要使用cordova.require
來導入你的外掛程式在 JavaScript 代碼中的其他部分,它一般
可以無論你喜歡,和它的唯一事項。 模組名稱為< js-module > 是你的外掛程式id
後, 跟名稱的值。 例如上面, id
為chrome.socket
的模組名稱是chrome.socket.Socket
.
<?xml version='1.0' encoding='utf-8'?>
<plugin id="com.lichanglong.ibaicai" version="1.0.0" xmlns="http://apache.org/cordova/ns/plugins/1.0" xmlns:android="http://schemas.android.com/apk/res/android">
<name>ibaicai</name>
<js-module name="ibaicai" src="www/ibaicai.js">
<clobbers target="cordova.plugins.ibaicai" />
</js-module>
</plugin>
ibaicai.js文件
var exec = require('cordova/exec');
exports.coolMethod = function(arg0, success, error) {
exec(success, error, "ibaicai", "coolMethod", [arg0]);
};
<!--这里要说活的是, success,errror都是一个回调,看我的调用代码就明白了,ibaicia:表示调用的ios类,也就是下面配置ios .h .m文件的别名。"coolMethod":表示调用类的的方法入口-->
好了,到此处的时候一个插件就圆圆滚滚的开发完成了。_!
好了,扯了会儿犊子,继续吧。还没完呢。
改造一下,plugin.xml里面的配置。
<?xml version='1.0' encoding='utf-8'?>
<plugin id="com.lichanglong.ibaicai" version="1.0.0" xmlns="http://apache.org/cordova/ns/plugins/1.0" xmlns:android="http://schemas.android.com/apk/res/android">
<name>ibaicai</name>
<js-module name="ibaicai" src="www/ibaicai.js">
<clobbers target="cordova.plugins.ibaicai" />
</js-module>
<!-- iOS -->
<platform name="ios">
<header-file src="src/ios/ibaicai.h" />
<source-file src="src/ios/ibaicai.m" />
<config-file target="config.xml" parent="/*">
<!--给ios的.h,.m文件起一个别名(PS:我的理解,如有错误,可以讨论,这个别名用于ibaicai.js的exec(success, error, "ibaicai", "coolMethod", [arg0]); 这段代码中的ibaicai-->
<feature name="ibaicai">
<!--ios 包, value:表示头文件的名字-->
<param name="ios-package" value="ibaicai" />
</feature>
</config-file>
</platform>
</plugin>
PS:这里的代码的意思我也就不在赘述了,详情请看plugins.xml
然后在在 ibaica/src/ 目录下添加两个文件ibaicai.h、ibaicai.m,这儿也直接贴上代码。
ibaicai.h
#import <Foundation/Foundation.h>
#import <Cordova/CDVPlugin.h>
#import "AppDelegate.h"
@interface ibaicai : CDVPlugin
{
}
-(void) coolMethod: (CDVInvokedUrlCommand*)command;
// retain command for async repsonses
@property (nonatomic, strong) CDVInvokedUrlCommand* command;
@end
ibaicai.m
#import "ibaicai.h"
@implementation ibaicai
@synthesize command;
- (void)coolMethod:(CDVInvokedUrlCommand*)command
{
NSLog(@"Cordova iOS plugin test");
}
@end
到这里了,白菜想说的是,这个简单的测试插件已经完全完成了,在js中可以直接调用了。是不是想问怎么调用呢?那么,请继续,看官们。其实,到这一步,一个插件的开发是完成了的(虽然,这个插件没有什么*用,但是也是一个插件呀!) ,那么接下来就是,向你自己的cordova工程添加我们的插件了。
给工程添加插件
打开终端,进入你的cordova工程目录,PS:这里的cordova工程已经添加了ios平台,详细的方法这里就不在赘述了;
输入以下命令:
cordova plugins add 这里是你插件的地址。这个地址可以是本地的地址,也可以是github上的地址(https://github.com/lichanglong2015/ibaicai)
eg:cordova plugins add https://github.com/lichanglong2015/ibaicai
编译工程
插件打好之后,编译以下cordova 工程,执行如下命令。
cordova build ios
调试插件
执行上面的代码之后,终端出现"** BUILD SUCCEEDED **"提示,则说明编译成功。打开testPlugins/platforms/ios/HelloCordova.xcodeproj,运行此项目(PS:快捷键‘command+r’);
这里我们用模拟器来测试,运行之后,你的Cordova程序在iOS模拟器上运行起来了,然后继续,打开Mac的safari->开发->Simulator->index.html(PS:开发菜单如果没有,自己百度怎么显示出来,这里不在赘述,打开之后其实就是一个类似于chrome的调试模式一样的。然后进入控制台,输入:
cordova.plugins.ibaicai.coolMethod(function(){alert("成功")},function(){alert("失败")}) ,
然后回车,回到xcode 看是否有输出信息。如果有,则证明js调用到了原生的ios了,这下想实现什么功能,就自由发挥吧.
结语
白菜研究Cordova插件有断时间了,中间是断断续续的,所踩过的坑基本也都说清楚了。唯一遗憾的我对代码的解释不够plugins.xml详解,其实把工程跑起来,然后对应着代码看,很容易就理解了。如果有问题,欢迎一起讨论。
最后,本文的crdova工程源码http://pan.baidu.com/s/1bSza4A