Cordova 3.x 基础(14) -- 使用Hooks自定义build过程

本文介绍了Cordova项目的Hooks机制,包括Module-level与Project-specific两种类型,脚本执行顺序及如何通过环境变量获取信息等内容,并提供了几个实用的Hooks示例。
Hooks本身是一些脚本代码,可以使用任何语言(比如:nodejs、shell等),用来自定义Cordova CLI命令,位于Cordova项目的根目录hooks文件夹下。主要目的是扩展Cordova CLI框架,在应用的build生命周期中插入自定义的build构建内容。

[b](1)Hooks的种类[/b]
①Module-level Hooks
面向的是扩展Cordova平台的,这个是相对比较大的项目的,所以一般都很少用到,有兴趣可以去Google一下“Cordova EventEmitter method”。
[url=https://www.npmjs.org/package/cordova]https://www.npmjs.org/package/cordova[/url]

②Project-specific Hooks
所有的脚本文件必须放在Cordova CLI命令对应的before 或 after文件夹中。
hooks/before_xxx
hooks/after_xxx
其中xxx就是Cordova CLI对应的命令,比如:prepare、build等。

[b](2)脚本执行顺序[/b]
before_xxx 或 after_xxx 文件夹中的脚本文件是按字母的顺序排序后依次执行的。这里的字母顺序还跟使用的平台有关,比如:Windows下ae.js在aG.js之前, 而Linux下aG.js在ae.js之前。所以最好是在你的脚本文件名前添加3到4位的数字来标示它的顺序。
比如:
[quote]001_copy_files.js
010_copy_resources.js
020_modify_config_files.sh
120_delete_modified_files.js[/quote]

[b](3)Hook脚本文件[/b]
脚本文件被执行时,默认会把根目录路径作为第一个参数传递给脚本文件。

Node.js
[quote]#!/usr/bin/env node
var fs = require('fs');

var rootdir = process.argv[2];

// ... using rootdir[/quote]

Shell Script
[quote]#!/bin/sh

ROOTDIR=$1

# ... using $ROOTDIR[/quote]

脚本文件中可以通过环境变量来获取其他参数:
[list]
[*]CORDOVA_VERSION:Cordova CLI的版本
[*]CORDOVA_PLATFORMS:逗号隔开的platforms一览
[*]CORDOVA_PLUGINS:逗号隔开的plugin IDs一览
[*]CORDOVA_HOOK:执行中hook的路径
[*]CORDOVA_CMDLINE:Cordova CLI命令后的参数
[/list]

[quote]#!/usr/bin/env node

console.log("process.env.CORDOVA_VERSION: "+process.env.CORDOVA_VERSION);
console.log("process.env.CORDOVA_PLATFORMS: "+process.env.CORDOVA_PLATFORMS);
console.log("process.env.CORDOVA_PLUGINS: "+process.env.CORDOVA_PLUGINS);
console.log("process.env.CORDOVA_HOOK: "+process.env.CORDOVA_HOOK);
console.log("process.env.CORDOVA_CMDLINE: "+process.env.CORDOVA_CMDLINE);[/quote]
[img]http://dl2.iteye.com/upload/attachment/0094/8819/07c21825-280c-304d-a16d-3ed74744135f.png[/img]

在脚本文件中你可以使用脚本语言的所有功能。但是在build之前首先要确保你的脚本文件能够正常执行。

[b](4)停止build[/b]
在hook脚本中,我们有时候需要停止整个build,比如:在before_prepare做单元测试的时候,如果测试失败,就应该停止build。hook脚本中如果返回值不是0,就会停止build。
[quote]#!/usr/bin/env node

console.log("unable to complete the hook");
process.exit(1);[/quote]
[img]http://dl2.iteye.com/upload/attachment/0094/8817/353a2cd6-7479-3a98-a165-77d502b17c61.png[/img]

[b](5)常用Hook[/b]
[list][*]添加工程所需的plugins(after_platform_add)
[*]拷贝icons、splash screens等resource到各个平台(after_prepare)
[*]运行单元测试(before_build)
[*]替换一些配置信息,比如:api服务器地址(after_prepare)[/list]

Cordova在build的时候是把www文件夹原封不动的Copy到了platform的www文件夹中,如果有人反编译你的app文件就能够获得你的所有源码。所以有必要创建一个hook来对你的代码进行安全处理。

根据JSON串的定义在Build之前生成menu.xml来支持Android的原生菜单
[url=https://github.com/ktty1220/cordova-native-menu/blob/master/hooks/before_build/native-menu.js]https://github.com/ktty1220/cordova-native-menu/blob/master/hooks/before_build/native-menu.js[/url]

参考:
[url=https://github.com/apache/cordova-cli/blob/master/templates/hooks-README.md]https://github.com/apache/cordova-cli/blob/master/templates/hooks-README.md[/url]
[url=https://leanpub.com/developingwithcordovacli/read]https://leanpub.com/developingwithcordovacli/read[/url]
[url=https://gist.github.com/dpogue/4100866]https://gist.github.com/dpogue/4100866[/url]
[url=http://devgirl.org/2013/11/12/three-hooks-your-cordovaphonegap-project-needs/]http://devgirl.org/2013/11/12/three-hooks-your-cordovaphonegap-project-needs/[/url]
[url=http://www.mooreds.com/wordpress/cordova-cli]http://www.mooreds.com/wordpress/cordova-cli[/url]
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值