什么是 npm 包 convict
npm 包 convict 是一个用于管理配置的 Node.js 模块。它可以帮助开发人员轻松地管理应用程序的配置，使其能够在不同环境中运行。convict 具有类型检查和默认值功能，减少了出现配置错误的可能性。
安装 npm 包 convict
使用 npm 命令进行安装：
npm install convict
使用 npm 包 convict
导入 convict
在脚本中导入 convict：
const convict = require('convict');定义和加载配置文件
使用 convict，我们可以定义一个配置文件的结构，例如：
-- -------------------- ---- -------
----- ------ - ---------
---- -
---- ------------ -------------
------- -------------- -------------- --------
-------- --------------
---- ----------
--
----- -
---- ---- ---- -- ------
------- -------
-------- -----
---- ------
-
---以上代码定义了 env 和 port 两个配置参数，其中 env 参数是必选参数，可以通过环境变量 NODE_ENV 来设置；port 参数是可选参数，格式为端口号格式，如果不设置则默认值为 8080，可以通过环境变量 PORT 来设置。
然后，我们可以通过加载一个 JSON 配置文件来加载配置：
config.loadFile('./config.json');JSON 配置文件的内容示例：
{
"env": "production",
"port": 3000
}获取和设置配置参数
我们可以使用 get() 方法获取配置参数的值：
const env = config.get('env');我们也可以使用 has() 方法来检查配置参数是否存在：
if (config.has('port')) {
// do something
}我们可以通过 set() 方法来设置配置参数的值：
config.set('port', 3000);当我们设置的值不符合定义的格式时，就会抛出一个异常。为了避免抛出异常，我们可以使用 validate() 方法来验证配置参数是否正确：
config.validate({ allowed: 'strict' }); // throws an error when a config parameter is not correct在上面的代码中，当发现一个配置参数不正确时，validate() 方法会抛出异常。我们还可以使用一个回调函数来处理异常：
config.validate({ allowed: 'strict' }, function (err) {
if (err) {
console.error(err);
}
});使用默认值
如果我们没有指定某个配置参数的值，会使用默认值：
const port = config.get('port'); // will return 8080 if not set配置文件的命名空间
我们可以使用命名空间来分组配置文件：
-- -------------------- ---- -------
----- ------ - ---------
--- -
----- -
---- --------- ---- ---------
-------- ------------
---- --------- -- ----------- -------- -- -------
--
----- -
---- --------- ------
-------- -----
---- ---------
-
--
------- -
-------- -------
-
---在上面的例子中，我们定义了 db 和 secret 两个命名空间。可以使用点号表示层级关系，例如 config.get('db.host')。
子模块
我们可以使用 add() 方法，向 convict 中添加子模块。子模块可以有他们自己的完整的配置定义和默认值。这个功能使得大的项目可以使用多个文件独立定义配置。
-- -------------------- ---- -------
------------
----- -
----- -
------- -------
-------- ---
---- ------
-
-
---在上面的例子中，我们定义了一个名为 http 的子模块，它可以通过 config.get('http.port') 访问。
配置参数的定义
convict 可以定义各种类型的配置参数。下面是一些常用的类型：
String一个字符串。Number一个数字。Boolean一个布尔值。Object一个对象。Array一个数组。Function一个函数。RegExp一个正则表达式。Date一个日期对象。
我们还可以使用一个自定义的格式，它必须是一个带有 validate() 方法的对象。
以下是一个自定义的参数格式的示例：
-- -------------------- ---- -------
----- ----- - -
--------- -------- ----- -
-- ----------------------- -
----- --- -------------- ---- - - -----
-
--
------- -------- ----- -
-- ------- --- --- --------- -
------ ----
-
------ -----------
-
--
------ - ---------
---- -
------- ------
-------- -----------------------
-
---在上面的代码中，我们定义了一个名为 isUrl 的自定义格式。它定义了两个方法：validate() 方法校验参数是否合法，coerce() 方法将参数转换为合法的格式。
总结
在本文中，我们学习了 npm 包 convict 的使用方法。我们首先了解了 convict 的一些基本概念，例如如何导入 convict 模块、如何定义和加载配置文件。我们还学习了如何获取和设置配置参数，如何使用默认值，如何使用命名空间和子模块等高级功能。
使用 convict，我们可以轻松地管理应用程序的配置文件，避免了手动处理配置文件时出现的问题，提高了开发效率和质量。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/66081