管理跨不同环境的多个配置文件可能具有挑战性,并且有多种工具正试图用不同的方法解决这个问题。但是,在本文中,我们将学习如何使用 node-config[1] 跨不同部署环境创建和管理 Node.js 配置文件。
Node-config允许你在你的Node应用程序中为不同的部署环境创建配置文件。有了它,你可以定义一个你打算跨环境重复使用的默认配置文件,然后将默认配置扩展到其他环境,如开发、暂存等。
你可以使用一些临时的命令行参数来覆盖这些参数,比如在你的命令行参数中加入NODE_ENV=development
。
Node-config使创建和管理一个在所有部署环境中共享的一致的配置界面变得更加容易。
为了更好地理解如何设置这个配置,让我们使用一个Node应用样本。首先,在你的终端上运行下面的命令来克隆这个资源库,或者从这里下载并解压它。
git clone https://github.com/ezesundayeze/node-env-sample
要安装 Node 依赖项,请运行:
npm install
因为node-config是一个npm包,我们可以通过运行这些命令中的任何一个来用npm或yarn安装它。
npm install config
或者
yarn add config
Node-config 支持许多文件扩展名。在发布时,当前版本的 node-config (3.3.6) 支持以下扩展:
- .json
- .json5
- .hjson
- .yaml or .yml
- .coffee
- .js
- .cson
- .properties
- .toml
- .ts
- .xml
这意味着你可以用任何一个支持的扩展来创建你的配置文件,但为你的项目选择一个扩展并在整个构建过程中坚持使用它是有意义的。
在本教程中,我们将使用 .json
扩展名。
创建一个 config
目录并向其中添加一个 config/default.json
文件。这将是默认配置文件,并将包含所有默认环境变量。
在我们的示例应用程序中它应该是这样的:
config/default.json
{
"server": {
"host": "localhost",
"port": 0,
}
}
我们将在我们的应用程序中通过导入 config
和使用 get
方法访问变量来访问它。
const config = require('config');
const port = config.get('server.port');
const host = config.get('server.host');
让我们创建一个 server.js
文件并添加以下代码。
const express = require('express');
const config = require('config');
const app = express();
const port = config.get('server.port');
const host = config.get('server.host');
app.get('/', (req, res) => {
res.send('Hello World');
});
const server = app.listen(port, host, (err) => {
if (err) {
console.log(err);
process.exit(1);
}
console.log(`Server is running on ${host}:${server.address().port}`);
});
你可以在你的应用程序的其他部分以类似的方式使用node-config。
你可以通过创建其他配置文件来扩展默认的配置文件。例如,你可以为开发、生产、QA、暂存、本地等创建配置文件。让我们来介绍一下我们将在我们的应用程序中使用的配置文件的主要类型。
创建本地配置文件是为了覆盖你的配置文件的部署版本。例如,对于你的开发部署,你可以有一个 local-development.json
文件来存储你所有的本地开发配置——它反映了你在部署的开发环境中期望的那种行为。
因此,你可以拥有这样的东西:
local-{instance}.EXT
local-{deployment}.EXT
local-{deployment}-{instance}.EXT
你也可以使用简短和完整的主机名来定义你在特定平台上的配置文件,以防你要在多个实例上进行部署。例如,您可以有一个 {short_hostname}
,它将代表您的服务器名称直到第一个点。如果您的主机名是 demo.example.com
,则配置可以是 demo.EXT (demo.json)
。
此外,如果您的 {full_hostname}
是您的整个服务器名称,则您可以在 {short_hostname}
与其他机器发生冲突时使用它。因此,在您的主机名是 demo.example.com
的情况下,您的配置文件名将是 demo.example.com.json
。
你可能还想创建一个自定义的配置文件来容纳一些环境变量的覆盖。Node-config提供了对配置文件类型的支持,你可以用 custom-environment-variables.EXT(custom-environment-variables.json)
的名字来定义。
如果您的环境变量没有设置,使用它们的服务就会中断。所以,你应该确保你的环境变量已经过测试。Node-config 提供了多个实用程序,其中之一是 config.has()
方法,它允许您验证是否设置了环境变量。
你可以创建一个测试文件或将其添加到你的预提交钩子中,以确保你的配置文件都已设置好。
以下是如何使用 config.has()
检查配置变量是否存在的示例:
if (config.has('dbConfig')) {
...
}
你也可以在你的Jest测试中使用它,像这样:
const config = require('config');
test('Server config exist', () => {
expect(config.has("server")).toBe(true);
});
test('Default config exist', () => {
expect(config.has("server.port")).toBe(true);
expect(config.has("server.host")).toBe(true);
});
使用命令行覆盖允许你从你的终端或命令行中即时指定配置参数。你需要在启动应用程序时通过指定 NODE_CONFIG='{...}'
命令来设置配置,参数必须是JSON字符串的格式。
下面是一个例子:
NODE_CONFIG='{"server": {"host":"192.168.43.13", "port":"3030"}}' npm run dev
JSON 值周围的单引号允许您安全地使用双引号。在某些情况下,根据您的操作系统,您可能需要对某些字符进行转义。您还可以使用命令行导出来避免一直键入命令。
在你的终端上运行下面的命令将覆盖你的服务器的主机和端口或你选择覆盖的任何其他配置。
export NODE_CONFIG='{"server": {"host":"192.168.43.13", "port":"3030"}}'
如果您更喜欢使用 JavaScript,可以在调用配置库之前将其添加到您的服务器文件中,如下所示:
const express = require('express');
process.env.NODE_CONFIG = '{"server": {"host":"localhost", "port":"3030"}}';
const config = require('config');
诀窍是在配置加载之前将 NODE_CONFIG
变量设置为 JSON 字符串。
发生这种情况是因为命令行覆盖优先于所有其他类型的覆盖。下面是一些在使用 node-config 时不能用作环境变量的保留字,因为库提供了它们的实现,可能会与您的实现冲突。
get
has
util
getConfigSources
makeHidden
makeImmutable
setModuleDefaults
watch
_attachProtoDeep
_cloneDeep
_diffDeep
这不是一个详尽的列表,所以一定要查看文档。
有一些插件可以让你高效地使用 node-config 和 Docker 来管理密钥,一个插件可以让你自动重新加载 node-config[2](你可能已经知道,配置不会在文件更改时自动加载),以及允许您取消缓存您的配置(uncache your config)[3]变量的插件。
使用 node-config 时,有无数种方法可以配置您的 Node 应用程序。有了它,您可以轻松管理您的配置文件并根据需要扩展它们,从而在您的项目中实现最大的灵活性、可靠性和一致性。谢谢阅读。
原文:https://blog.logrocket.com/creating-configuration-files-node-js-using-node-config/
[1]node-config: https://github.com/lorenwest/node-config
[2]重新加载 node-config: https://github.com/MrBoolean/node-config-uncached
[3]取消缓存您的配置(uncache your config): https://www.npmjs.com/package/config-reloadable
本文由哈喽比特于2年以前收录,如有侵权请联系我们。
文章来源:https://mp.weixin.qq.com/s/PMqc1thABIXdzZLxE1c_NA
京东创始人刘强东和其妻子章泽天最近成为了互联网舆论关注的焦点。有关他们“移民美国”和在美国购买豪宅的传言在互联网上广泛传播。然而,京东官方通过微博发言人发布的消息澄清了这些传言,称这些言论纯属虚假信息和蓄意捏造。
日前,据博主“@超能数码君老周”爆料,国内三大运营商中国移动、中国电信和中国联通预计将集体采购百万台规模的华为Mate60系列手机。
据报道,荷兰半导体设备公司ASML正看到美国对华遏制政策的负面影响。阿斯麦(ASML)CEO彼得·温宁克在一档电视节目中分享了他对中国大陆问题以及该公司面临的出口管制和保护主义的看法。彼得曾在多个场合表达了他对出口管制以及中荷经济关系的担忧。
今年早些时候,抖音悄然上线了一款名为“青桃”的 App,Slogan 为“看见你的热爱”,根据应用介绍可知,“青桃”是一个属于年轻人的兴趣知识视频平台,由抖音官方出品的中长视频关联版本,整体风格有些类似B站。
日前,威马汽车首席数据官梅松林转发了一份“世界各国地区拥车率排行榜”,同时,他发文表示:中国汽车普及率低于非洲国家尼日利亚,每百户家庭仅17户有车。意大利世界排名第一,每十户中九户有车。
近日,一项新的研究发现,维生素 C 和 E 等抗氧化剂会激活一种机制,刺激癌症肿瘤中新血管的生长,帮助它们生长和扩散。
据媒体援引消息人士报道,苹果公司正在测试使用3D打印技术来生产其智能手表的钢质底盘。消息传出后,3D系统一度大涨超10%,不过截至周三收盘,该股涨幅回落至2%以内。
9月2日,坐拥千万粉丝的网红主播“秀才”账号被封禁,在社交媒体平台上引发热议。平台相关负责人表示,“秀才”账号违反平台相关规定,已封禁。据知情人士透露,秀才近期被举报存在违法行为,这可能是他被封禁的部分原因。据悉,“秀才”年龄39岁,是安徽省亳州市蒙城县人,抖音网红,粉丝数量超1200万。他曾被称为“中老年...
9月3日消息,亚马逊的一些股东,包括持有该公司股票的一家养老基金,日前对亚马逊、其创始人贝索斯和其董事会提起诉讼,指控他们在为 Project Kuiper 卫星星座项目购买发射服务时“违反了信义义务”。
据消息,为推广自家应用,苹果现推出了一个名为“Apps by Apple”的网站,展示了苹果为旗下产品(如 iPhone、iPad、Apple Watch、Mac 和 Apple TV)开发的各种应用程序。
特斯拉本周在美国大幅下调Model S和X售价,引发了该公司一些最坚定支持者的不满。知名特斯拉多头、未来基金(Future Fund)管理合伙人加里·布莱克发帖称,降价是一种“短期麻醉剂”,会让潜在客户等待进一步降价。
据外媒9月2日报道,荷兰半导体设备制造商阿斯麦称,尽管荷兰政府颁布的半导体设备出口管制新规9月正式生效,但该公司已获得在2023年底以前向中国运送受限制芯片制造机器的许可。
近日,根据美国证券交易委员会的文件显示,苹果卫星服务提供商 Globalstar 近期向马斯克旗下的 SpaceX 支付 6400 万美元(约 4.65 亿元人民币)。用于在 2023-2025 年期间,发射卫星,进一步扩展苹果 iPhone 系列的 SOS 卫星服务。
据报道,马斯克旗下社交平台𝕏(推特)日前调整了隐私政策,允许 𝕏 使用用户发布的信息来训练其人工智能(AI)模型。新的隐私政策将于 9 月 29 日生效。新政策规定,𝕏可能会使用所收集到的平台信息和公开可用的信息,来帮助训练 𝕏 的机器学习或人工智能模型。
9月2日,荣耀CEO赵明在采访中谈及华为手机回归时表示,替老同事们高兴,觉得手机行业,由于华为的回归,让竞争充满了更多的可能性和更多的魅力,对行业来说也是件好事。
《自然》30日发表的一篇论文报道了一个名为Swift的人工智能(AI)系统,该系统驾驶无人机的能力可在真实世界中一对一冠军赛里战胜人类对手。
近日,非营利组织纽约真菌学会(NYMS)发出警告,表示亚马逊为代表的电商平台上,充斥着各种AI生成的蘑菇觅食科普书籍,其中存在诸多错误。
社交媒体平台𝕏(原推特)新隐私政策提到:“在您同意的情况下,我们可能出于安全、安保和身份识别目的收集和使用您的生物识别信息。”
2023年德国柏林消费电子展上,各大企业都带来了最新的理念和产品,而高端化、本土化的中国产品正在不断吸引欧洲等国际市场的目光。
罗永浩日前在直播中吐槽苹果即将推出的 iPhone 新品,具体内容为:“以我对我‘子公司’的了解,我认为 iPhone 15 跟 iPhone 14 不会有什么区别的,除了序(列)号变了,这个‘不要脸’的东西,这个‘臭厨子’。