我一直在开发一些Node应用程序，我一直在寻找一种存储部署相关设置的良好模式。在Django世界(我来自那里)，常见的做法是有一个settings.py文件包含标准设置(时区等)，然后有一个local_settings.py用于部署特定的设置，即。要与什么数据库通信、什么memcache套接字、管理员的电子邮件地址等等。
我一直在为Node寻找类似的模式。只要一个配置文件就好了，这样它就不必与app.js中的其他所有东西挤在一起，但我发现有一种方法在源代码控制之外的文件中拥有特定于服务器的配置很重要。同一款应用可以部署在不同设置的服务器上，必须处理合并冲突，这不是我的乐趣所在。
那么是否存在某种框架/工具，或者每个人都只是自己拼凑一些东西?
我用一个包装。Json为我的包和config.js为我的配置，它看起来像:
var config = {};
config.twitter = {};
config.redis = {};
config.web = {};
config.default_stuff = ['red','green','blue','apple','yellow','orange','politics'];
config.twitter.user_name = process.env.TWITTER_USER || 'username';
config.twitter.password= process.env.TWITTER_PASSWORD || 'password';
config.redis.uri = process.env.DUOSTACK_DB_REDIS;
config.redis.host = 'hostname';
config.redis.port = 6379;
config.web.port = process.env.WEB_PORT || 9980;
module.exports = config;
我从我的项目加载配置:
var config = require('./config');
然后我可以从config.db_host, config.db_port等访问我的东西…这让我可以使用硬编码的参数，如果我不想在源代码控制中存储密码，也可以使用存储在环境变量中的参数。
我还生成了一个包。Json和插入依赖项部分:
"dependencies": {
"cradle": "0.5.5",
"jade": "0.10.4",
"redis": "0.5.11",
"socket.io": "0.6.16",
"twitter-node": "0.0.2",
"express": "2.2.0"
}
当我将项目克隆到本地机器时，我运行npm install来安装包。更多信息请点击这里。
项目存储在GitHub中，并为我的生产服务器添加了遥控器。
很久以后，我发现了一个非常好的Node.js模块来管理配置:nconf。
举个简单的例子:
var nconf = require('nconf');
// First consider commandline arguments and environment variables, respectively.
nconf.argv().env();
// Then load configuration from a designated file.
nconf.file({ file: 'config.json' });
// Provide default values for settings not provided above.
nconf.defaults({
'http': {
'port': 1337
}
});
// Once this is in place, you can just use nconf.get to get your settings.
// So this would configure `myApp` to listen on port 1337 if the port
// has not been overridden by any of the three configuration inputs
// mentioned above.
myApp.listen(nconf.get('http:port'));
它还支持在Redis中存储设置，编写配置文件，并且有一个相当可靠的API，并且还得到了一个更受尊敬的Node.js商店Nodejitsu的支持，作为Flatiron框架计划的一部分，所以它应该是相当经得起未来的。
在Github上查看nconf。
您还可以查看node-config，它根据$HOST和$NODE_ENV变量(有点像RoR)加载配置文件:文档。
这对于不同的部署设置(开发、测试或生产)非常有用。
我的解决办法相当简单:
在./config/index.js中加载环境配置
var env = process.env.NODE_ENV || 'development'
, cfg = require('./config.'+env);
module.exports = cfg;
在./config/config.global.js中定义一些默认值
var config = module.exports = {};
config.env = 'development';
config.hostname = 'dev.example.com';
//mongo database
config.mongo = {};
config.mongo.uri = process.env.MONGO_URI || 'localhost';
config.mongo.db = 'example_dev';
重写。/config/config.test.js中的默认值
var config = require('./config.global');
config.env = 'test';
config.hostname = 'test.example';
config.mongo.db = 'example_test';
module.exports = config;
在./models/user.js中使用:
var mongoose = require('mongoose')
, cfg = require('../config')
, db = mongoose.createConnection(cfg.mongo.uri, cfg.mongo.db);
在测试环境中运行应用程序:
NODE_ENV=test node ./app.js
只需要用exports做一个简单的settings.js:
exports.my_password = 'value'
然后，在你的脚本中，执行require:
var settings = require('./settings.js');
所有的设置现在将可用的设置变量:
settings.my_password // 'value'
您可以从Node v0.5开始要求JSON文件。X(引用这个答案)
json:
{
"username" : "root",
"password" : "foot"
}
app.js:
var config = require('./config.json');
log_in(config.username, config.password);
除了这个答案中提到的nconf模块，以及这个答案中提到的node-config模块，还有node-iniparser和IniReader，它们看起来更简单。ini配置文件解析器。
另一个选项是为验证添加模式。像nconf一样，它支持从环境变量、参数、文件和json对象的任何组合中加载设置。
来自README的例子:
var convict = require('convict');
var conf = convict({
env: {
doc: "The applicaton environment.",
format: ["production", "development", "test"],
default: "development",
env: "NODE_ENV"
},
ip: {
doc: "The IP address to bind.",
format: "ipaddress",
default: "127.0.0.1",
env: "IP_ADDRESS",
},
port: {
doc: "The port to bind.",
format: "port",
default: 0,
env: "PORT"
}
});
入门文章: 用节点罪犯驯服构型
我在游戏中有点晚了，但我在这里或其他地方都找不到我需要的东西，所以我自己写了一些东西。
我对配置机制的要求如下:
支持前端。如果前端不能使用该配置有什么意义? 支持settings-override .js -看起来一样，但允许重写settings.js中的配置。这里的思想是在不更改代码的情况下轻松修改配置。我发现它对saas很有用。
尽管我不太关心支持环境，但它将解释如何轻松地将其添加到我的解决方案中
var publicConfiguration = {
"title" : "Hello World"
"demoAuthToken" : undefined,
"demoUserId" : undefined,
"errorEmail" : null // if null we will not send emails on errors.
};
var privateConfiguration = {
"port":9040,
"adminAuthToken":undefined,
"adminUserId":undefined
}
var meConf = null;
try{
meConf = require("../conf/dev/meConf");
}catch( e ) { console.log("meConf does not exist. ignoring.. ")}
var publicConfigurationInitialized = false;
var privateConfigurationInitialized = false;
function getPublicConfiguration(){
if (!publicConfigurationInitialized) {
publicConfigurationInitialized = true;
if (meConf != null) {
for (var i in publicConfiguration) {
if (meConf.hasOwnProperty(i)) {
publicConfiguration[i] = meConf[i];
}
}
}
}
return publicConfiguration;
}
function getPrivateConfiguration(){
if ( !privateConfigurationInitialized ) {
privateConfigurationInitialized = true;
var pubConf = getPublicConfiguration();
if ( pubConf != null ){
for ( var j in pubConf ){
privateConfiguration[j] = pubConf[j];
}
}
if ( meConf != null ){
for ( var i in meConf ){
privateConfiguration[i] = meConf[i];
}
}
}
return privateConfiguration;
}
exports.sendPublicConfiguration = function( req, res ){
var name = req.param("name") || "conf";
res.send( "window." + name + " = " + JSON.stringify(getPublicConfiguration()) + ";");
};
var prConf = getPrivateConfiguration();
if ( prConf != null ){
for ( var i in prConf ){
if ( prConf[i] === undefined ){
throw new Error("undefined configuration [" + i + "]");
}
exports[i] = prConf[i];
}
}
return exports;
解释
undefined means this property is required null means it is optional meConf - currently the code is target to a file under app. meConf is the overrides files which is targeted to conf/dev - which is ignored by my vcs. publicConfiguration - will be visible from front-end and back-end. privateConfiguration - will be visible from back-end only. sendPublicConfiguration - a route that will expose the public configuration and assign it to a global variable. For example the code below will expose the public configuration as global variable myConf in the front-end. By default it will use the global variable name conf. app.get("/backend/conf", require("conf").sendPublicConfiguration);
覆盖逻辑
privateConfiguration与publicConfiguration和meConf合并。 publicConfiguration检查每个键是否有覆盖，并使用该覆盖。这样我们就不会暴露任何隐私。
添加环境支持
即使我不觉得“环境支持”有用，也许有人会。
要添加环境支持，您需要将meConf require语句更改为以下内容(伪代码)
If (environment == "production") { meConf = require("../conf/dev/meConf").production; ｝
If (environment == "development") { meConf = require("../conf/dev/meConf").development; ｝
类似地，每个环境可以有一个文件
meConf.development.js
meConf.production.js
然后导入正确的。 其余的逻辑保持不变。
你们使用npm来启动你的脚本(env等)吗?
如果你使用.env文件，你可以将它们包含在package.json中 并使用NPM来源/启动它们。
例子:
{
"name": "server",
"version": "0.0.1",
"private": true,
"scripts": {
"start": "node test.js",
"start-dev": "source dev.env; node test.js",
"start-prod": "source prod.env; node test.js"
},
"dependencies": {
"mysql": "*"
}
}
然后运行NPM脚本:
$ npm start-dev
描述在这里https://gist.github.com/ericelliott/4152984 这都要归功于埃里克·埃利奥特
您可以将Konfig用于特定于环境的配置文件。它自动加载json或yaml配置文件，它有默认值和动态配置功能。
Konfig repo的一个例子:
File: config/app.json
----------------------------
{
"default": {
"port": 3000,
"cache_assets": true,
"secret_key": "7EHDWHD9W9UW9FBFB949394BWYFG8WE78F"
},
"development": {
"cache_assets": false
},
"test": {
"port": 3001
},
"staging": {
"port": #{process.env.PORT},
"secret_key": "3F8RRJR30UHERGUH8UERHGIUERHG3987GH8"
},
"production": {
"port": #{process.env.PORT},
"secret_key": "3F8RRJR30UHERGUH8UERHGIUERHG3987GH8"
}
}
在发展:
> config.app.port
3000
在生产环境中，假设我们使用$ NODE_ENV=生产PORT=4567节点app.js启动应用程序
> config.app.port
4567
详情:https://github.com/vngrs/konfig
你也可以看看dotenv，它遵循了十二要素应用程序的原则。
我曾经使用节点配置，但出于这个原因创建了dotenv。它的灵感完全来自ruby的dotenv库。
用法很简单:
var dotenv = require('dotenv');
dotenv.load();
然后你只需要创建一个。env文件，把你的设置放在那里，就像这样:
S3_BUCKET=YOURS3BUCKET
SECRET_KEY=YOURSECRETKEYGOESHERE
OTHER_SECRET_STUFF=my_cats_middle_name
这是nodejs的dotenv。
我只是使用了一个alt示例，因为我想要比典型的.json文件更灵活，但不希望它被抽象到一个需要依赖的库中，就像这样。基本上，导出一个立即调用的函数，该函数返回一个带有我想要设置的值的对象。有很大的灵活性。
module.exports = function(){
switch(node_env){
case 'dev':
return
{ var1 = 'development'};
}
}();
这里有一个更好的解释和完整的例子。使用Node.js中的配置文件
我知道这是一个非常老的帖子。但是我想分享我的配置环境变量的模块，我认为这是一个非常灵活的解决方案。 下面是模块json-configurator
var configJson = {
'baseUrl': 'http://test.com',
'$prod_baseUrl': 'https://prod.com',
'endpoints': {
'users': '<%= baseUrl %>/users',
'accounts': '<%= baseUrl %>/accounts'
},
foo: 'bar',
foobar: 'foobar',
$prod_foo: 'foo in prod',
$test_foo: 'foo in test',
deep:{
veryDeep: {
publicKey: 'abc',
secret: 'secret',
$prod_secret: 'super secret'
}
}
};
var config = require('json-configurator')(configJson, 'prod');
console.log(config.deep.veryDeep.secret)
// super secret
console.log(config.endpoints.users)
// https://prod.com/users
然后你可以使用process.env。NODE_ENV来获取环境的所有变量。
您可以使用pconf: https://www.npmjs.com/package/pconf
例子:
var Config = require("pconf");
var testConfig = new Config("testConfig");
testConfig.onload = function(){
testConfig.setValue("test", 1);
testConfig.getValue("test");
//testConfig.saveConfig(); Not needed
}
在这里，我将全身心地投入其中，因为这些答案中没有一个解决了几乎任何系统都需要的所有关键组件。注意事项:
公共配置(可以从前端看到)vs私有配置(guy mograbi说对了)。并确保它们是分开的。 钥匙一样的秘密 默认值vs特定于环境的覆盖 前端包
以下是我如何进行配置:
config.default.private.js - In version control, these are default configuration options that can only be seen by your backend. config.default.public.js - In version control, these are default configuration options that can be seen by backend and frontend config.dev.private.js - If you need different private defaults for dev. config.dev.public.js - If you need different public defaults for dev. config.private.js - Not in version control, these are environment specific options that override config.default.private.js config.public.js - Not in version control, these are environment specific options that override config.default.public.js keys/ - A folder where each file stores a different secret of some kind. This is also not under version control (keys should never be under version control).
I use plain-old javascript files for configuration so I have the full power of the javascript langauge (including comments and the ability to do things like load the default config file in the environment-specific file so they can then be overridden). If you want to use environment variables, you can load them inside those config files (tho I recommend against using env vars for the same reason I don't recommend using json files - you don't have the power of a programming language to construct your config).
每个键在一个单独的文件中的原因是为了安装程序的使用。这允许您有一个安装程序，在机器上创建密钥并将它们存储在密钥文件夹中。如果不这样做，当你加载无法访问密钥的配置文件时，安装程序可能会失败。通过这种方式，您可以遍历目录并加载该文件夹中的任何关键文件，而不必担心在任何给定版本的代码中哪些存在哪些不存在。
由于您可能在私有配置中加载了密钥，因此您绝对不希望在任何前端代码中加载私有配置。虽然严格来说，将前端代码库与后端代码库完全分离可能更理想，但很多时候，PITA是一个足够大的障碍，阻止人们这样做，从而导致私有配置与公共配置。但是我做了两件事来防止在前端加载私有配置:
我有一个单元测试，确保我的前端包不包含我在私有配置中的一个密钥。 我将前端代码放在与后端代码不同的文件夹中，并且我有两个名为“config.js”的不同文件-一端一个。对于后端，config.js加载私有配置，对于前端，它加载公共配置。然后你总是只需要('config')，而不用担心它来自哪里。
最后一件事:您的配置应该通过一个完全独立于任何其他前端代码的文件加载到浏览器中。如果捆绑前端代码，公共配置应该作为一个完全独立的包构建。否则，你的配置就不再是真正的配置了——它只是你代码的一部分。配置需要能够在不同的机器上有所不同。
我在这里尝试了一些建议的解决方案，但对它们不满意，所以我创建了自己的模块。它被称为微配置，主要的区别是它尊重约定而不是配置，所以你可以只需要这个模块并开始使用它。
你存储你的配置在纯js，或json文件从/config文件夹。首先它加载default.js文件，然后是/config目录下的所有其他文件，然后它根据$NODE_ENV变量加载特定于环境的配置。
它还允许使用local.js或特定于环境的/config/env/$NODE_ENV.local.js覆盖本地开发的配置。
你可以在这里看看:
https://www.npmjs.com/package/mikro-config
https://github.com/B4nan/mikro-config
长期以来，我一直使用这里的解决方案中提到的方法。然而，人们对明文保密的安全性存在担忧。您可以在配置之上使用另一个包，以便安全位得到照顾。
看看这个:https://www.attosol.com/secure-application-secrets-using-masterkey-in-azure-key-vault/
我将创建一个文件夹，配置一个命名为config.js的文件，稍后我会在需要的地方使用这个文件，如下所示
config.js的例子
module.exports = {
proxyURL: 'http://url:port',
TWITTER: {
consumerkey: 'yourconsumerkey',
consumerSecrete: 'yourconsumersecrete'
},
GOOGLE: {
consumerkey: 'yourconsumerkey',
consumerSecrete: 'yourconsumersecrete'
},
FACEBOOK: {
consumerkey: 'yourconsumerkey',
consumerSecrete: 'yourconsumersecrete'
}
}
然后，如果我想在某处使用这个配置文件
我将首先导入如下
Var config = require('./config');
，我可以访问如下的值
const oauth = OAuth({
consumer: {
key: config.TWITTER.consumerkey,
secret: config.TWITTER.consumerSecrete
},
signature_method: 'HMAC-SHA1',
hash_function(base_string, key) {
return crypto.createHmac('sha1', key).update(base_string).digest('base64');
}
});
最好将“开发”和“生产”配置分开。
我用以下方法: 这是我的config/index.js文件:
const config = {
dev : {
ip_address : '0.0.0.0',
port : 8080,
mongo :{
url : "mongodb://localhost:27017/story_box_dev",
options : ""
}
},
prod : {
ip_address : '0.0.0.0',
port : 3000,
mongo :{
url : "mongodb://localhost:27017/story_box_prod",
options : ""
}
}
}
对于require配置使用如下:
const config = require('../config')[process.env.NODE_ENV];
然后你可以使用你的配置对象:
const ip_address = config.ip_address;
const port = config.port;
只需使用npm模块配置(超过300000次下载)
https://www.npmjs.com/package/config
节点配置为应用程序部署组织分层配置。
它允许您定义一组默认参数，并为不同的部署环境(开发、qa、登台、生产等)扩展它们。
$ npm install config
$ mkdir config
$ vi config/default.json
{
// Customer module configs
"Customer": {
"dbConfig": {
"host": "localhost",
"port": 5984,
"dbName": "customers"
},
"credit": {
"initialLimit": 100,
// Set low for development
"initialDays": 1
}
}
}
$ vi config/production.json
{
"Customer": {
"dbConfig": {
"host": "prod-db-server"
},
"credit": {
"initialDays": 30
}
}
}
$ vi index.js
var config = require('config');
//...
var dbConfig = config.get('Customer.dbConfig');
db.connect(dbConfig, ...);
if (config.has('optionalFeature.detail')) {
var detail = config.get('optionalFeature.detail');
//...
}
$ export NODE_ENV=production
$ node index.js
下面是本文启发的一个简洁的方法。它不需要任何额外的包，除了无处不在的lodash包。此外，它还允许您使用特定于环境的覆盖来管理嵌套默认值。
首先，在包的根路径中创建一个配置文件夹，如下所示
package
|_config
|_ index.js
|_ defaults.json
|_ development.json
|_ test.json
|_ production.json
这是index.js文件
const _ = require("lodash");
const defaults = require("./defaults.json");
const envConf = require("./" + (process.env.NODE_ENV || "development") + ".json" );
module.exports = _.defaultsDeep(envConf, defaults);
现在我们假设有一个默认值。像这样的Json
{
"confKey1": "value1",
"confKey2": {
"confKey3": "value3",
"confKey4": "value4"
}
}
和发展。像这样的Json
{
"confKey2": {
"confKey3": "value10",
}
}
如果你执行config = require('./config')，你会得到这样的结果
{
"confKey1": "value1",
"confKey2": {
"confKey3": "value10",
"confKey4": "value4"
}
}
注意，除了在特定于环境的文件中定义的值外，您可以得到所有的默认值。因此，您可以管理配置层次结构。使用defaultsDeep可以确保您甚至可以拥有嵌套的默认值。
npm i config
In config/default.json
{
"app": {
"port": 3000
},
"db": {
"port": 27017,
"name": "dev_db_name"
}
}
In config/production.json
{
"app": {
"port": 4000
},
"db": {
"port": 27000,
"name": "prod_db_name"
}
}
In index.js
const config = require('config');
let appPort = config.get('app.port');
console.log(`Application port: ${appPort}`);
let dbPort = config.get('db.port');
console.log(`Database port: ${dbPort}`);
let dbName = config.get('db.name');
console.log(`Database name: ${dbName}`);
console.log('NODE_ENV: ' + config.util.getEnv('NODE_ENV'));
$ node index.js
Application port: 3000
Database port: 27017
Database name: dev_db_name
NODE_ENV: development
For production
$ set NODE_ENV=production
$ node index.js
Application port: 4000
Database port: 27000
Database name: prod_db_name
NODE_ENV: production
如何使用TypeScript。
export const loadConfig = () => {
const configLoadeded = configLoader.util.toObject() as any
Config = configLoadeded
}
export interface ConfigI {
productName: string;
productId: string;
googleCloudApiKey: string;
}
有点晚了(只有10年)，但我使用的config.js结构如下:
const env = process.env.NODE_ENV || 'development';
var config_temp = {
default:{
port: 3000,
mysql_host: "localhost",
logging_level: 5,
secret_api_key: process.env.SECRET_API_KEY
},
development: {
logging_level: 10
},
production: {
port: 3001,
mysql_host: "not-localhost"
}
};
var config = {
...config_temp.default,
...config_temp[env]
}
module.exports = config;
然后我加载配置:
var config = require('./config');
var port = config.port;
这样:
env变量的读取包含在config.js文件中，因此我可以避免这种丑陋的情况:NODE_ENV || 'development']。 config.js文件可以在代码的repo中上传，因为敏感变量继续由process.env处理。 如果default:{和custom_env:{中都包含同一个元素，则只保留第二个元素。 没有专用文件夹和多个文件(像在配置中)
现在，在使用数据库时，最简单的方法是完全不处理配置文件，因为部署环境更容易设置，只需使用单个环境变量(例如，将其称为DB_CONNECTION)，并根据需要向其传递任何额外的配置数据。
配置数据举例:
const config = {
userIds: [1, 2, 3],
serviceLimit: 100,
// etc., configuration data of any complexity
};
// or you can read it from a config file
创建一个连接字符串，包含数据库驱动程序不关心的额外参数:
import {ConnectionString} from 'connection-string';
const cs = new ConnectionString('postgres://localhost@dbname', {
user: 'user-name',
password: 'my-password',
params: {
config
}
});
然后我们可以生成结果字符串存储在环境中:
cs.toString();
//=>postgres://localhost:my-password@dbname?config=%7B%22userIds%22%3A%5B1%2C2%2C3%5D%2C%22serviceLimit%22%3A100%7D
所以你把它存储在你的环境中，比如说DB_CONNECTION，在客户端进程中你可以通过process.env.DB_CONNECTION读取它:
const cs = new ConnectionString(process.env.DB_CONNECTION);
const config = JSON.parse(cs.params?.config); // parse extra configuration
//=> { userIds: [ 1, 2, 3 ], serviceLimit: 100 }
通过这种方式，您将在单个环境变量中同时拥有连接和所需的所有额外配置，而不需要打乱配置文件。
我使用Dotenv-Flow进行配置管理。
这和预期的一样。通常情况下你会有多个 本地、开发、登台和生产等环境。看这些 步骤创建您自己的环境。
1. 我喜欢流动。
2. 创建像.env | .env.dev | .env.prod这样的文件。
出于测试目的，复制此内容
.env
DATABASE_HOST=global
DATABASE_PORT=global
DATABASE_USER=global
DATABASE_PASS=global
DATABASE_NAME=global
.env.dev
DATABASE_NAME=dev
DATABASE_PASS=dev
.env.prod
DATABASE_NAME=prod
DATABASE_PASS=prod
现在使用这些环境变量创建一个测试文件。
. js
console.log('database host:', process.env.DATABASE_HOST);
console.log('database port:', process.env.DATABASE_PORT);
console.log('database user:', process.env.DATABASE_USER);
console.log('database pass:', process.env.DATABASE_PASS);
console.log('database name:', process.env.DATABASE_NAME);
现在使用这些命令运行脚本。
node -r dotenv-flow/config test.js
node -r dotenv-flow/config test.js --node-env=dev
node -r dotenv-flow/config test.js --node-env=prod
如果您在特定的文件夹中创建这些环境变量文件，就像我在envs文件夹中创建这些文件一样，那么使用下面的命令。
node -r dotenv-flow/config test.js --dotenv-flow-path=./envs
node -r dotenv-flow/config test.js --dotenv-flow-path=./envs --node-env=dev
node -r dotenv-flow/config test.js --dotenv-flow-path=./envs --node-env=prod
尝试使用properties-gen https://www.npmjs.com/package/properties-gen
node-config与node-config非常相似，后者加载配置基础文件，并根据所设置的环境使用ext文件对其进行扩展，但这是一个按需运行且完全可配置的cli。
npx properties-gen init
要创建cli配置，然后将其安装到项目中
npm install properties-gen --save-dev
定义您的配置文件(基本和扩展)，并在构建过程之前或在项目中启动开发服务器之前运行generate命令。
{
"name": "myApp",
"scripts": {
"config": "properties-gen generate",
"dev": "npm run config && next dev",
"build": "npm run config && next build",
"start": "next start"
}
}
一件很酷的事情是，您可以定义多个配置组，以防您需要生成多个输出，例如特定于客户端和服务器的文件。
