cordova 自定义(plugin)插件开发

跟着白菜一起开发一个属于自己的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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,723评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,485评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,998评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,323评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,355评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,079评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,389评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,019评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,519评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,971评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,100评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,738评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,293评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,289评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,517评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,547评论 2 354
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,834评论 2 345

推荐阅读更多精彩内容