webpack.DefinePlugin使用介绍

做者：滴滴公共前端团队 - J

基本用法

这个插件用来定义全局变量，在webpack打包的时候会对这些变量作替换。
先看个例子

//webpack.config.js
var webpack = require('webpack');
var path = require('path');

module.exports = {
    entry: {
        index: "./js/index.js"
    },
    output: {
        path: "./dist/",
        filename: "js/[name].js",
        chunkFilename: "js/[name].js"
    },
    plugins: [
        new webpack.DefinePlugin({
            SOMETHINE: 'This is something we needed.'
        })
    ]
};

//index.js
console.log(SOMETHINE);复制代码

编译完的结果以下：

function(module, exports, __webpack_require__) {
   console.log((This Is The Test Text.));
}复制代码

能够看到代码中 SOMETHINE 被直接替换为 This is something we needed. 可是咱们的本意中 SOMETHINE 是一个字符串，而直接替换后却不是一个字符串。怎么办呢？

方法一：能够将 SOMETHINE 的值写成

SOMETHINE: '"This is something we needed."'复制代码

方法二： 借助 JSON.tringify ,转为字符串

SOMETHINE: JSON.stringify('This is something we needed.')复制代码

推荐使用方法二，它不只能够处理字符串，还能够处理Object中的字符串和Array。以下：

//webpack.config.js

 plugins: [
    new webpack.DefinePlugin({
        OBJ: JSON.stringify({"key1": "this is value"}),
        OBJ2: {"key1": "this is value"},
        OBJ3: {"key1": "'this is value'"},
        ARRAY: JSON.stringify(["value1", "value2"]),
        ARRAY2: ["value1", "value2"],
        ARRAY3: ["'value1'", "'value2'"]
    })
]

//index.js
console.log(OBJ);
console.log(OBJ2);
console.log(OBJ3);
console.log(ARRAY);
console.log(ARRAY2);
console.log(ARRAY3);复制代码

编译结果

console.log(({"key1":"this is value"})); // OBJ 正确
console.log(({"key1":this is value})); // OBJ2 this is value 被直接替换了，而非字符串
console.log(({"key1":'this is value'})); // OBJ3 正确
console.log((["value1","value2"])); // ARRAY 正确
console.log(({"0":value1,"1":value2})); // ARRAY2 直接写[]的形式，会被替换为object的类型，value1 和 value2 不是字符串
console.log(({"0":'value1',"1":'value2'})); // ARRAY3 正确复制代码

还剩下 Number 和 Boolean 两种变量类型，对于这两种类型，就不像上面介绍的这么麻烦了，直接写就行

//webpack.config.js

 plugins: [
    new webpack.DefinePlugin({
        NUMBER: 12,
        BOOL: true
    })
]

//index.js
console.log(NUMBER);
console.log(BOOL);复制代码

编译结果

console.log((12));
console.log((true));复制代码

实际运用

介绍了这么多，在实际使用中， DefinePlugin 最为经常使用的用途就是用来处理咱们开发环境和生产环境的不一样。好比一些 debug 的功能在生产环境中须要关闭、开发环境中和生产环境中 api 地址的不一样。以 vue-cli 生成的打包文件为例子，来看看在实际中的使用。

vue-cli 生成的目录中编译、打包相关的有两个文件夹 build 和 config 。

build 文件夹中找到 wbepack.dev.conf.js 和 webpack.prod.conf.js ，这两个文件中都经过 DefinePlugin 插件定义了 process.env 这个变量

// webpack.dev.conf.js
var config = require('../config')
...
new webpack.DefinePlugin({
  'process.env': config.dev.env
})

// webpack.prod.conf.js
var config = require('../config')
var env = config.build.env
...
new webpack.DefinePlugin({
  'process.env': env
})复制代码

config 中对 env 的定义分别放在 config/dev.env.js 和 config/prod.env.js 中

//config/index.js
module.exports = {
  build: {
    env: require('./prod.env'),
    ...
  },
  dev: {
    env: require('./dev.env'),
    ...
  }
}

//config/prod.env.js
module.exports = {
  NODE_ENV: '"production"'
}

//config/dev.env.js
var merge = require('webpack-merge')
var prodEnv = require('./prod.env')

module.exports = merge(prodEnv, {
  NODE_ENV: '"development"'
})复制代码

到此能够看到，在 wbepack.dev.conf.js 中最终为

'process.env': {NODE_ENV: '"development"'}复制代码

在 webpack.prod.conf.js 中最终为

'process.env': {NODE_ENV: '"production"'}复制代码

在咱们的代码中，若是部分只是在开发环境下才执行的逻辑，那么能够经过下面的方式

if ('development' === process.env.NODE_ENV) {
 // 开发环境下的逻辑
} else {
 // 生产环境下
}复制代码

---

欢迎关注DDFE
GITHUB：github.com/DDFE
微信公众号：微信搜索公众号“DDFE”或扫描下面的二维码