简介
@1stg/app-config 是一个基于 Node.js 的前端应用配置库,正常情况下,前端应用需要根据不同的部署环境(如:开发、测试、生产等)切换不同的配置,这样的切换通常通过打包不同环境的代码来实现。但是如果可以将不同环境的配置作为标准化的配置文件进行维护,那么极大提高了配置的规范,统一管理的便利性。
@1stg/app-config 提供了一个可配置的 API,可以实现前端应用的动态配置,无论是在本地使用,还是在服务器端部署,都能够轻松实现。
安装
使用 npm 命令进行安装:
npm install @1stg/app-config
使用
导入配置文件
在项目的根目录中,创建一个名为 config 的文件夹,用于存储各个环境的配置文件,例如:
// config/dev.js module.exports = { apiUrl: "http://localhost:3000", debug: true };
// config/prod.js module.exports = { apiUrl: "http://api.mysite.com", debug: false };
由此可知,每个配置文件都应该是一个 Node.js 模块,在其中导出一个对象,其中包含配置信息。
初始化 app-config
例如,在入口文件中初始化 app-config:
// index.js const appConfig = require('@1stg/app-config'); const config = appConfig({ environment: process.env.NODE_ENV || 'dev', });
使用 app-config 中的配置
import appConfig from '@1stg/app-config'; console.log(appConfig.get('apiUrl')); console.log(appConfig.get('debug', true));
appConfig.get(key, defaultValue)
方法可接受两个参数:键名和默认值。
指南
通过 @1stg/app-config 这个库,我们可以将配置文件从代码中分离出来,实现配置的统一管理。而且,易于调整和配置。
示例代码
// config/dev.js module.exports = { apiUrl: "http://localhost:3000", debug: true };
// config/prod.js module.exports = { apiUrl: "http://api.mysite.com", debug: false };
-- -------------------- ---- ------- -- -------- ----- --------- - ---------------------------- ----- ------ - ----------- ------------ -------------------- -- ------ --- ---------------------------------- -- ----------------------- ------------------------------- ------- -- ----
// usage.js import appConfig from '@1stg/app-config'; console.log(appConfig.get('apiUrl')); // "http://localhost:3000" console.log(appConfig.get('debug', true)); // true
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/138907