Webpack 注入环境变量的原理主要通过插件和内置的定义机制来实现。具体步骤如下:
1. 使用 DefinePlugin
插件
Webpack 的 DefinePlugin
插件可以用来创建全局常量,这些常量会在编译时替换代码中的变量。这是注入环境变量的常见方式。
配置步骤
安装 Webpack:
npm install webpack --save-dev
配置 DefinePlugin
:
在 Webpack 配置文件 (webpack.config.js
) 中使用 DefinePlugin
插件来定义环境变量。
const webpack = require('webpack');
module.exports = {
// 其他配置
plugins: [
new webpack.DefinePlugin({
'process.env.NODE_ENV': JSON.stringify(process.env.NODE_ENV),
'process.env.API_URL': JSON.stringify(process.env.API_URL),
})
]
};
在代码中使用:
console.log('API URL:', process.env.API_URL);
在构建时,process.env.API_URL
会被替换为配置中的实际值。
2. 环境变量的定义
环境变量通常通过操作系统、CI/CD 环境、或 .env
文件进行定义。在开发过程中,可以通过 cross-env
等工具来设置环境变量:
设置环境变量
安装 cross-env
:
npm install cross-env --save-dev
在 package.json
的 scripts
部分配置:
"scripts": {
"start": "cross-env NODE_ENV=development webpack serve",
"build": "cross-env NODE_ENV=production webpack"
}
3. 使用 dotenv
插件(可选)
为了更方便地管理环境变量,特别是在开发环境中,可以使用 dotenv
插件将 .env
文件中的变量加载到 process.env
中。
配置步骤
安装 dotenv
:
npm install dotenv --save
在 Webpack 配置中加载环境变量:
const path = require('path');
const webpack = require('webpack');
require('dotenv').config();
module.exports = {
// 其他配置
plugins: [
new webpack.DefinePlugin({
'process.env.NODE_ENV': JSON.stringify(process.env.NODE_ENV),
'process.env.API_URL': JSON.stringify(process.env.API_URL),
})
]
};
创建 .env
文件:
NODE_ENV=development
API_URL=https://api.example.com