Cordova自定义iOS插件 调用原生sdk

1、安装Cordova

sudo npm install -g Cordova

2、使用Cordova 创建打包工程

cordova create 项目名称 BundleID 工程名字
//例如cordova create GameSDK com.gamesdk.YLe GameSDK

创建bundleId为com.gamesdk.YLe的名为GameSDK 的工程

3、增加平台

cd MyApp
cordova platform add browser(平台)
cordova platform add ios 增加iOS平台
image.png

这时候已经生成了打包的工程信息

4、安装plugman

sudo npm install -g plugman

5、使用plugman生成插件框架

plugman create --name [插件名] --plugin_id [插件ID] --plugin_version [插件版本号]
例子:
plugman create --name GameSDKPlugin --plugin_id cordova-plugin-gamesdkplugin --plugin_version 1.0.0

6、进入插件平台,生成平台插件

//进入插件目录
cd  Game
//增加平台android 和 iOS 
plugman platform add --platform_name android
plugman platform add --platform_name ios

我们只看iOS部分的,此时插件模板建立完毕。

7、初始化插件

npm init

结果在此过程中出现的提示


image.png

8、将插件增加到cordova项目

进入到cordova的项目下面
cordova plugin add  插件所在的目录

将插件添加到iOS的项目中

9、将插件打包到iOS平台里面

cordova build ios

我们 将插件打包到ios的项目中。
我们可以查看Staging->www->plugins下面我们会看到添加到ios项目工程里的插件
我们整个的过程基本完成了。
接下来我们就制作插件。

插件制作

上面我们已经制作了插件,但是插件的内容我们还未来写,接下来我们来看这个插件。
我可以看到我们才开始的文件的结构是这样的:


image.png

接下来我们就要操作修改文件:

GameSDKPlugin.h

#import <Cordova/CDV.h>

@interface GameSDKPlugin : CDVPlugin 
- (void)coolMethod:(CDVInvokedUrlCommand*)command;
@end

GameSDKPlugin.m

传递2个参数并返回2个结果

/********* GameSDKPlugin.m Cordova Plugin Implementation *******/

#import "GameSDKPlugin.h"

@implementation GameSDKPlugin

- (void)coolMethod:(CDVInvokedUrlCommand*)command
{
    NSLog(@"coolMethod use");
    CDVPluginResult* pluginResult = nil;
    NSString* name = [command.arguments objectAtIndex:0];
    NSString* userNo = [command.arguments objectAtIndex:1];


    if (name != nil && [name length] > 0 && userNo != nil && [userNo length] > 0) {
        // pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsString:echo];
        pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsArray:@[name, userNo]];
    } else {
        pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR];
    }

    [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId];
}

@end

解释:

1、文件生成了一个CDVPluginResult 的对象,这个对象存放着此次调用的结果,我们可以看到这个对象中除了状态之外还有返回的参数。
2、回调,我通过commandDelegate 将结果回调给www/下的xxx.js文件,根据是success还是failure回调相应的结果。
3、我们可以看返回的状态值都有什么

typedef enum {
     CDVCommandStatus_NO_RESULT = 0,
     CDVCommandStatus_OK,
     CDVCommandStatus_CLASS_NOT_FOUND_EXCEPTION,
     CDVCommandStatus_ILLEGAL_ACCESS_EXCEPTION,
     CDVCommandStatus_INSTANTIATION_EXCEPTION,
     CDVCommandStatus_MALFORMED_URL_EXCEPTION,
     CDVCommandStatus_IO_EXCEPTION,
     CDVCommandStatus_INVALID_ACTION,
     CDVCommandStatus_JSON_EXCEPTION,
     CDVCommandStatus_ERROR
     } CDVCommandStatus;

4、我们可以看给最终对象添加返回值的时候的参数的方法:

+ (CDVPluginResult*)resultWithStatus:(CDVCommandStatus)statusOrdinal;
     + (CDVPluginResult*)resultWithStatus:(CDVCommandStatus)statusOrdinal messageAsString:(NSString*)theMessage;
     + (CDVPluginResult*)resultWithStatus:(CDVCommandStatus)statusOrdinal messageAsArray:(NSArray*)theMessage;
     + (CDVPluginResult*)resultWithStatus:(CDVCommandStatus)statusOrdinal messageAsInt:(int)theMessage;
     + (CDVPluginResult*)resultWithStatus:(CDVCommandStatus)statusOrdinal messageAsNSInteger:(NSInteger)theMessage;
     + (CDVPluginResult*)resultWithStatus:(CDVCommandStatus)statusOrdinal messageAsNSUInteger:(NSUInteger)theMessage;
     + (CDVPluginResult*)resultWithStatus:(CDVCommandStatus)statusOrdinal messageAsDouble:(double)theMessage;
     + (CDVPluginResult*)resultWithStatus:(CDVCommandStatus)statusOrdinal messageAsBool:(BOOL)theMessage;
     + (CDVPluginResult*)resultWithStatus:(CDVCommandStatus)statusOrdinal messageAsDictionary:(NSDictionary*)theMessage;
     + (CDVPluginResult*)resultWithStatus:(CDVCommandStatus)statusOrdinal messageAsArrayBuffer:(NSData*)theMessage;
     + (CDVPluginResult*)resultWithStatus:(CDVCommandStatus)statusOrdinal messageAsMultipart:(NSArray*)theMessages;
     + (CDVPluginResult*)resultWithStatus:(CDVCommandStatus)statusOrdinal messageToErrorObject:(int)errorCode;

YLeGameSDKPlugin.js

为了再plugin.xml 中区分其中标签的不同,我们就讲js的文件名字修改,这样可以看出不同。

var exec = require('cordova/exec');
function GameSDK() {};
GameSDK.prototype.coolMethod = function (name,userNo, success, error) {
    exec(success, error, 'GameSDKPlugin', 'coolMethod', [name,userNo]);
};
var gameSDKModel = new GameSDK();
module.exports = gameSDKModel;

plugin.xml

这是插件的配置文件

<?xml version='1.0' encoding='utf-8'?>
<plugin id="cordova-plugin-gamesdkplugin" version="1.0.0"
  xmlns="http://apache.org/cordova/ns/plugins/1.0"
  xmlns:android="http://schemas.android.com/apk/res/android">
  <name>GameSDKPlugin</name>
  <js-module name="YleGameSDKPlugin" src="www/YleGameSDKPlugin.js">
    <clobbers target="YleGameSDKPlugin" />
  </js-module>
  <platform name="ios">
    <config-file parent="/*" target="config.xml">
      <feature name="GameSDKPlugin">
        <param name="ios-package" value="GameSDKPlugin" />
      </feature>
    </config-file>
    <header-file src="src/ios/GameSDKPlugin.h" />
    <source-file src="src/ios/GameSDKPlugin.m" />
  </platform>
</plugin>

在iOS的工程中,我们的调用如下:index.html

<!DOCTYPE html>
<html>
    <head>
        <title>TestPlugin</title>
        <meta http-equiv="Content-type" content="text/html; charset=utf-8">
            <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
            <script type="text/javascript" charset="utf-8">
                function gameSdkPlugin() {
                    YleGameSDKPlugin.coolMethod("YLe","001",alertSuccess,alertFail);
                }
            
                function alertSuccess(msg) {
                    alert(msg);
                }
            
                function alertFail(msg) {
                    alert('调用OC失败: ' + msg);
                }
                </script>
            </head>
    
    <body style="padding-top:50px">
        <button style="font-size:17px;" onclick="gameSdkPlugin();">调用gameSdkPlugin</button> <br>
    </body>
</html>

我们最后的结果是:


image.png

github

插件: cordovaIosPlugin
插件demo:cordovaIosPluginDemo

注意:

使用例子的时候最好重新引入一下,因为我是在本地做的,引入的路径是本地的,可能出现调不起的状态。

另外:

查看当前的项目所有的插件:

cordova plugin list

结果:

cordova-plugin-gamesdkplugin 1.0.0 "GameSDKPlugin"
cordova-plugin-whitelist 1.3.3 "Whitelist"

删除插件:

cordova plugin rm cordova-plugin-gamesdkplugin

删除插件直接使用你生成的Id就好了也就是你上面list的这些插件的插件ID。

好了,我这接下来就是去VUE项目中调用插件了.

补充

有些喜欢使用箭头函数的,我又改了一下。

YLeGameSDKPlugin.js

GameSDK.prototype.coolMethod = (name,userNo, success, error)  => {
    exec(success, error, 'GameSDKPlugin', 'coolMethod', [name,userNo]);
};

调用也做了相应修改

YleGameSDKPlugin.coolMethod("YLe","001",msg=>{alert(msg)},err=>{alert("调用OC失败"+ msg)});

注意:

亲身体验,这个YLeGameSDKPlugin.js里面的方法不要使用=>箭头函数,这个函数会导致低版本的ios开机是白屏,这好像是由于低版本的ios对ES6低版本的语法不支持,不能解析造成的,注意将箭头函数改成function的方式使用.

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

推荐阅读更多精彩内容

  • 发现 关注 消息 iOS 第三方库、插件、知名博客总结 作者大灰狼的小绵羊哥哥关注 2017.06.26 09:4...
    肇东周阅读 12,098评论 4 62
  • github排名https://github.com/trending,github搜索:https://gith...
    小米君的demo阅读 4,589评论 2 38
  • 有时候自己做事情还挺快的也很准确,但是和周围的人在一起时,我经常放不开自己,感觉顾虑太多,像个不懂事的孩子,做事效...
    若山12369阅读 92评论 0 0
  • 在中国,毁掉一个美景最简单最有效的方式,就是让大家知道这个地方,哈哈,这当然是一句玩笑话,大家喜欢旅游吗?我相信应...
    陈思妍阅读 628评论 1 2
  • 烨子墨阅读 142评论 0 0