一些关于环境变量的总结

做的项目多了,就接触到很多种process.env的设置方式,有时候难免会有些迷糊,这里做些总结

准备工作

环境变量是一些我们不想在代码里处理的变量,它可以让我们写的代码与它所运行的环境联系起来。我们工作中常常都会用到环境变量,但是很多时候我们用的并不是那么的得心应手,特别是在它的作用域问题上。

最常见的环境变量的设置是在.bash_profile文件中export出来

export AWS_SECRET_ACCESS_KEY=foo
export AWS_ACCESS_KEY_ID=bar

然后在node程序(其他的程序中有自己的获取方式)中你就可以直接使用了

var secretAccessKey = process.env.AWS_SECRET_ACCESS_KEY;
var accessKeyId = process.env.AWS_ACCESS_KEY_ID;

这种方式最大的缺点就是如果有两个程序,需要不同的accessKeyId和secretAccessKey,这样我们就得修改变量的名字,比如加上前缀proA_accessKeyId等,如果有三个甚至更多呢,这样的处理方式就肯定不是我们想要的了

最理想的就是每个程序有自己的环境变量配置,下面我们看下在node、npm、webpack中如何使用环境变量

1. node中使用环境变量

我们常见的方式是这种方式

NODE_ENV=production node index.js

这种方式最大的问题就是变量一多,写起来有点长,也不便于维护。所以如果你写node程序的话,你可能需要dotenv,他通过项目根目录的.env文件来维护环境变量

DB_HOST=localhost
DB_USER=root
DB_PASS=s1mpl3

然后就能这样使用了

require('dotenv').config()
var db = require('db')
db.connect({
  host: process.env.DB_HOST,
  username: process.env.DB_USER,
  password: process.env.DB_PASS
})

dotenv还支持preload功能。就是你不想在代码里留下这句require('dotenv').config(),毕竟这对有洁癖的人来说还是难以忍受的,你可以使用 node的--require (-r)选项

node -r dotenv/config your_script.js

当然webpack的工程中也可以使用dotenv,只不过是有时候webpack.DefinePlugin基本就够用了

2. npm中使用环境变量

npm对于环境变量的使用最多的应该是在package.json的scripts模块中

  • package.json文件中的变量

package.json vars
The package.json fields are tacked onto the npm_package_ prefix. So, for instance, if you had {"name":"foo", "version":"1.2.5"} in your package.json file, then your package scripts would have the npm_package_name environment variable set to "foo", and the npm_package_version set to "1.2.5"

上面这段是官方文档中摘下来的,就是告诉我们package.json文件中的key值都会被设置成以npm_package_为前缀的环境变量,比如如果你的package.json文件中有这么一段{"name":"foo", "version":"1.2.5"} ,那么你在package scripts 中就可以使用$npm_package_name变量了,它的值就是foo,自然你也可以在js代码中使用process.env.npm_package_name获取到它的值

不过现在都是开源时代,谁还看文档啊,直接看源码就好了

有个例外,如果是config模块的值还会被设置成以npm_config_前缀的环境变量,使用上和上面一致

当然如果我们只需要在js代码中使用package中的信息,还是通过require的方式获取显得更加方便

const package = require('./package.json')
console.log(package.version)
  • package.json文件中scripts模块的环境变量
    我们对已有的环境变量可以$xxx和${xxx}这两种方式使用
{
  scripts:{
    "argv": "echo $npm_package_version",    
    "argv": "echo ${npm_package_version}",  
  }
}

我们还可以设置环境变量,我们常看到的就是这样了

// NODE_ENV就是我们设置的环境变量,通过process.env.NODE_ENV就可以使用了
{
  scripts:{
    "build": "NODE_ENV=production webpack --config config/webpack/production.config.js"
  }
}

当然这其实都是bash和node的知识范畴

3. webpack中使用环境变量

上面node和npm设置的环境变量在webpack中都可以使用,而webpack中我们还可以看到一种定义方式,就是通过DefinePlugin来定义

  new webpack.DefinePlugin({
    'process.env': {
      NODE_ENV: "production"
    },
    PRODUCTION: JSON.stringify(true),
    RELEASE: JSON.stringify(process.env.RELEASE)
  })

这种定义方式本质上有点类似 process.env.NODE_ENV = "production"这种js代码直接赋值的方式,为什么类似呢,因为它还是有区别的,区别就是在build出来的代码上你可以看待到process.env.NODE_ENV会直接被production字符串替换(注意:并不是简单的直接替换,它是根据AST来替换的)。因为并非真正的设置到了环境变量中,所以我们不能把需要环境变量的地方依赖于它,否则不会有效果

4.总结

其实这里的应该都是属于node中的环境变量,毕竟npm和webpack都是用node跑的,所以node的环境变量的设置方式对三者都有效,只是npm和webpack有些是自己封装过的设置方式,其设置只对自己有效罢了

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,456评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,370评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,337评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,583评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,596评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,572评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,936评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,595评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,850评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,601评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,685评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,371评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,951评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,934评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,167评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,636评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,411评论 2 342

推荐阅读更多精彩内容

  • 无意中看到zhangwnag大佬分享的webpack教程感觉受益匪浅,特此分享以备自己日后查看,也希望更多的人看到...
    小小字符阅读 8,134评论 7 35
  • GitChat技术杂谈 前言 本文较长,为了节省你的阅读时间,在文前列写作思路如下: 什么是 webpack,它要...
    萧玄辞阅读 12,669评论 7 110
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,585评论 18 139
  • -01- “王阿爹,你说这沙漠可真教人害怕,我们已经走了两个多小时,可周遭的环境就和没变过一样,天是天沙是沙的.....
    江南的故事酒馆阅读 943评论 1 1
  • 时光静好,终是沧桑;岁月无言,不曾回望。许些惋惜,却迎不回曾经的一份拥有;许些安慰,却找不到心中的一份安然。可能...
    风吹过指尖沙阅读 221评论 0 0