12factor-config 中文文档教程

Question

12factor-config

一个只读取环境的配置模块。 对于 Node.js，这意味着 process.env。

注意 1：我们永远不会在此处的任何示例中使用 NODE_ENV，因为每个环境 应该指定它需要的一切，没有什么应该依赖于特定的 环境（例如“开发”、“测试”、“暂存”或“生产”）。

注意 2：这个包被认为是稳定的，所以很少提交这些 日子没有不活跃的迹象，只是稳定。 请使用并提交 PR 以查找错误。 新的 功能也会被考虑。

Stability

请注意，该项目的功能非常齐全。 问题将得到解决。 新的 如有必要，可以添加功能。 否则它不会有更多的版本 - 但是 放心，我会支持它和你。 该项目并没有死，它只是在休息。

Synopsis

首先，设置一些您的程序将查找的环境变量。 你不需要 设置任何具有“默认”的，但您确实需要设置任何“必需”的。

$ export REDIS_URL=redis://user:password@hostname:port/db
$ export APPNAME_PORT=8080

然后，在您的程序中：

var config = require('12factor-config');

var cfg = config({
    redisUrl : {
        env      : 'REDIS_URL',
        type     : 'string', // default
        required : true,
    },
    logfile : {
        env      : 'APPNAME_LOG_FILE',
        type     : 'string',
        default  : '/var/log/appname.log',
        required : true,
    },
    port : {
        env      : 'APPNAME_PORT',
        type     : 'integer',
        default  : '8000',
        required : true,
    },
    debug : {
        env      : 'APPNAME_DEBUG',
        type     : 'boolean',
        default  : false,
    },
    env : {
        // you really shouldn't use this, but some people/packages do
        env      : 'NODE_ENV',
        type     : 'enum',
        values   : [ 'development', 'test', 'stage', 'production', ],
    },
});

console.log(cfg);

应该输出如下

{
  redisUrl: 'redis://user:password@hostname:port/db',
  logfile: '/var/log/appname.log',
  port: 8080,
  debug: false,
  env: 'development'
}

内容： 建议在您的环境变量前加上与您的应用程序相关的前缀 上面后面的配置变量中显示的名称。 这主要是为了给你的变量命名空间而不是踩踏 超过其他已经定义的。 当然，您不需要在本地名称中使用前缀。

Valid Values

当您具有某些类型时，会执行一些转换以从字符串中获取它（因为 environment 只包含 string) 到所需的值。

• boolean - upper or lower case is allowed
  • true - 'true', 't', 'yes', 'y', 'on', '1'
  • false - 'false', 'f', 'no', 'n', 'off', '0'
  • any other value throws

What I Do

我通常有一个 lib/cfg.js，如下所示：

var config = require('12factor-config');

var cfg = config({
    // ... environment config here ...
});

module.exports = cfg;

通过这样做，应用程序中的所有其他文件都可以 require('lib/cfg.js')并获得 完全相同的配置。

Author

作者 Andrew Chilton - 推特。

License

麻省理工学院 - http://chilts.mit-license.org/2013/

（完）