webpack入门学习笔记16 —— 定义全局变量和环境变量

1. 写在前面

我们在做项目的过程中,可能会需要预先定义一些项目全局变量,比如项目的名称、项目的本地端口、项目的API地址等。也会定义一些环境变量,比如当前是开发模式还是生产模式等。

对于这些变量,我们当前可以在项目中进行定义,但是我认为这不是最好的一种解决方案,最好的实践方式是在webpack的配置文件中定义这些变量,然后我们就可以直接在项目中使用这些变量。

2. 定义全局变量和环境变量

在webpack的配置文件中配置全局变量和环境变量,需要使用到一个插件,即 DefinePlugin 。这是webpack自带的插件,所以我们不用安装,可以直接使用。使用方式如下:

比如我们要在webpack的配置文件中,定义项目的名称为 "Allen APP",项目的API地址为 "www.fengzhen8023.com",那么可以在 webpack.config.js 中添加如下代码:

let webpack = require("webpack");

module.exports = {
    plugins: [
        new webpack.DefinePlugin({
            APP_NAME: JSON.stringify("Allen App"),
            API_SERVER: JSON.stringify("www.fengzhen8023.com")
        })
    ]
}

这里将其他的配置规则省略了,如果你想看其他的配置规则,可以查看我的 GitHub仓库 - webpack-learning ,或者通过本文末尾的链接,跳转到我之前的博客中进行查看。

在webpack配置文件中成功定义全局变量之后,在项目的其他代码文件中,无需导入这些变量,就可以直接使用,比如可以直接把这些变量打印出来:

// 项目中的index.js文件

console.log("APP_NAME: ", APP_NAME);
console.log("API_SERVER: ", API_SERVER);

3. 定义变量时候的规则说明

在webpack配置文件中定义全局变量的时候,你可能会想:我定义的变量基本都是字符串类型,所以可以使用以下代码进行定义:

module.exports = {
    plugins: [
        new webpack.DefinePlugin({
            APP_NAME: "Allen App",
            API_SERVER: "www.fengzhen8023.com"
        })
    ]
}

如果使用上述代码进行配置,在启动项目的时候会遇到报错。这里我们虽然使用双引号的形式把 "Allen App" 赋值给APP_NAME,但是webpack在配置的时候,会忽略双引号,直接把 Allen App 赋值给APP_NAME,但是 Allen App 没有定义,所以就会报错。

如果我们想要使用字符串来定义全局变量的时候,可以借助 JSON.stringify() 这个函数,因为这个函数返回的结果是一个字符串,符合我们的预期。

不过这里倒是给我们一个启发,如果你想要使用表达式的形式定义全局变量,或者是想要给全局变量赋值一个布尔类型的值,那么可以使用以下配置规则:

module.exports = {
    plugins: [
        new webpack.DefinePlugin({
            EXPRESSION: "1+1",
            BOOLEAN: "true"
        })
    ]
}

这样配置完成之后,在项目文件中打印这两个全局变量,结果如下:

// 项目中的index.js文件

console.log("EXPRESSION: ", EXPRESSION);        // 结果为数值类型的值: 2
console.log("API_SERVER: ", API_SERVER);        // 结果为布尔类型的值: true

4. 关于使用全局变量的报错说明

如果你在项目中使用 eslint 来校验代码,那么使用全局变量的时候,可能会编译报错,比如以下报错信息:

image

这也算是eslint和webpack.DefinePlugin插件的一个冲突,要解决这个问题,可以在使用全局变量的过程中,添加一行注释,来告诉eslint,这里的代码不用进行 未定义检测 ,代码如下:

/* eslint-disable no-undef */
console.log("EXPRESSION: ", EXPRESSION);
console.log("BOOLEAN: ", BOOLEAN);

如此一来,报错的问题就解决了。

上一篇: webpack入门学习笔记15 —— Webpack中的三个小插件

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

推荐阅读更多精彩内容

  • 全局安装webpack 全局安装webpack会有个问题,就是当你有两个项目依赖于不同版本的webpack,就会有...
    説好的妹紙呢阅读 1,816评论 0 11
  • 写在开头 先说说为什么要写这篇文章, 最初的原因是组里的小朋友们看了webpack文档后, 表情都是这样的: (摘...
    Lefter阅读 5,285评论 4 31
  • 目录第1章 webpack简介 11.1 webpack是什么? 11.2 官网地址 21.3 为什么使用 web...
    lemonzoey阅读 1,734评论 0 1
  • 原文首发于:Webpack 3,从入门到放弃 Update (2017.8.27) : 关于 output.pub...
    昵称都被用完了衰阅读 1,896评论 4 19
  • 2019.2.19咖啡冥想 财富目标:2019年3月30之前收入5万人民币。 动机:智慧的路上自己成为榜样,我要种...
    冰山轩儿阅读 245评论 0 0