Cordova config.xml环境变量

时间:2017-09-21 13:43:47

标签: cordova ionic3

场景:

我正在构建一个Ionic3应用程序,而我的config.xml有一些我希望能够根据我的环境更改的数据(例如,我想要我的Facebook应用程序ID有不同的发展,分期和生产价值。)

我实现了创建模板config.xml(文件为config.tpl.xml)和before_prepare cordova挂钩,以使用正确的值替换模板中的变量并保存config.xml中生成的内容。

cordova挂钩使用npmes6-template-strings

npm install es6-template-strings --save-dev

钩子是:

#!/usr/bin/env node
var fs = require('fs');
var path = require('path');
var compile = require('es6-template-strings/compile');
var resolveToString = require('es6-template-strings/resolve-to-string');

var ROOT_DIR = process.argv[2];
var FILES = {
    SRC: "config.tpl.xml",
    DEST: "config.xml"
};

var env = process.env.NODE_ENV || 'dev';
var envFile = 'src/environments/environment.' + env + '.json';

var srcFileFull = path.join(ROOT_DIR, FILES.SRC);
var destFileFull = path.join(ROOT_DIR, FILES.DEST);
var configFileFull = path.join(ROOT_DIR, envFile);

var templateData = fs.readFileSync(srcFileFull, 'utf8');

var configData = fs.readFileSync(configFileFull, 'utf8');
var config = JSON.parse(configData);

var compiled = compile(templateData);
var content = resolveToString(compiled, config);

fs.writeFileSync(destFileFull, content);

我在src/environments/目录中有针对不同环境的文件,这些文件是根据我构建NODE_ENV时定义的cordova值选择的。例如,如果NODE_ENV=prod(生产),那么它将使用文件environment.prod.json

{
    ...
    "FACEBOOK_APP_ID": "11111111",
    "FACEBOOK_APP_NAME": "My Facebook App Name",
    ...
    "PUSH_SENDER_ID": "22222222",
    ...
}

执行钩子时,这部分在cordova.tpl.xml

<plugin name="cordova-plugin-facebook4" spec="~1.7.4">
    <variable name="APP_ID" value="${FACEBOOK_APP_ID}" />
    <variable name="APP_NAME" value="${FACEBOOK_APP_NAME}" />
</plugin>
<plugin name="phonegap-plugin-push" spec="~1.9.2">
    <variable name="SENDER_ID" value="${PUSH_SENDER_ID}" />
</plugin>

变得像:

<plugin name="cordova-plugin-facebook4" spec="~1.7.4">
    <variable name="APP_ID" value="11111111" />
    <variable name="APP_NAME" value="My Facebook App Name" />
</plugin>
<plugin name="phonegap-plugin-push" spec="~1.9.2">
    <variable name="SENDER_ID" value="22222222" />
</plugin>

问题:

到目前为止一切顺利。问题是,当对config.xml进行一些自动更改(如添加插件)时,它不会反映在cordova.tpl.xml中,所以我必须记住手动进行更改。

虽然现在完成它的方式仍然比必须像以前一样添加每个环境变量要好得多(这是一个维护噩梦并且容易出错),我仍然需要每次添加/更改/删除模板一个插件(不那么频繁,当我忘记它时很容易发现问题,但仍远离理想状态)。

我的问题:

我想知道是否有办法避免这些手动更改,但继续使用像我现在这样做的环境变量。

如果可能的话,可以实现对config.xml进行config.tpl.xml的自动更改(就像添加带--save的插件一样),但我没有&#39;找到关于此的任何cordova选项。

或者使用config.xml作为模板并将其发送到定义了变量的其他地方(例如www/config.xml),并使用其他位置的config.xml来使用构建应用程序(不是根目录中的config.xml,即模板)。我只会更改钩子中的srcdest文件(分别为config.xmlwww/config.xml)。但我也找不到实现这个目标的方法。

对此有何想法?

(它不需要是一个离子特定的解决方案。)

更新(2017-10-13)

根据Bobby的答案,我在安装和卸载插件时实现了我想要的效果。我创建了4个钩子:after_plugin_addafter_plugin_rmbefore_plugin_addbefore_plugin_rm

before挂钩将模板(config.tpl.xml)复制到config.xml文件中,after挂钩执行相反的操作。

before_plugin_addbefore_plugin_rm挂钩如下:

#!/usr/bin/env node
var fs = require('fs');
var path = require('path');

var ROOT_DIR = process.argv[2];
var FILES = {
    SRC: 'config.tpl.xml',
    DEST: 'config.xml'
};

var srcFileFull = path.join(ROOT_DIR, FILES.SRC);
var destFileFull = path.join(ROOT_DIR, FILES.DEST);

var templateData = fs.readFileSync(srcFileFull, 'utf8');
fs.writeFileSync(destFileFull, templateData);

after_plugin_addafter_plugin_rm挂钩几乎完全相同,只需交换FILES.SRCFILES.DEST值。

1 个答案:

答案 0 :(得分:3)

一种解决方案可能是为 before_plugin_install after_plugin_install 创建挂钩。

On before_plugin_install copy the cordova.tpl.xml to cordova.xml.
... Plugin is installed ...
On after_plugin_install copy cordova.xml to cordova.tpl.xml