配置React应用程序的方法有很多,本文中将向大家展示猪齿鱼平台前端的新环境变量方案,该方案可以实现在运行时配置,所以不需要针对每个环境都进行构建。 配置React应用程序的方法有很多,本文中将向大家展示Choerodon平台前端的新环境变量方案,该方案可以实现在运行时配置,所以不需要针对每个环境都进行构建。
希望能够将React应用程序使用Docker运行,只构建一次,能够在任何地方运行,并且希望在运行时提供重新配置容器的时机,允许在docker-compose文件内进行变量配置。
例如:
version: "3.2"services: my-react-app: image: my-react-app ports: - "3000:80" environment: - "API_URL=production.example.com"*注: 在开发中,有两种不同的环境变量。一是在编译时已确定的,通过类似config.js的配置文件进行配置;而另一种是在部署时(运行时)才确定的,比较常见的是根据环境进行区分的一些变量,比如API请求地址前缀,根据部署的环境不同而不同。当前端镜像生成后,需要通过外部去注入这个变量。
原来的方案将两种变量混合在一起,导致很难区分到底哪些是可以通过环境变量注入修改的。
代码如下:
// updateWebpackConfig.jsconst { apimGateway } = choerodonConfig;?...?if (mode === 'start') { defaultEnterPoints = { APIM_GATEWAY: apimGateway, };} else if (mode === 'build') { if (isChoerodon) { defaultEnterPoints = getEnterPointsConfig(); }}?const mergedEnterPoints = { NODE_ENV: env, ...defaultEnterPoints, ...enterPoints(mode, env),};const defines = Object.keys(mergedEnterPoints).reduce((obj, key) => { obj[`process.env.${key}`] = JSON.stringify(process.env[key] || mergedEnterPoints[key]); return obj;}, {});?customizedWebpackConfig.plugins.push( new webpack.DefinePlugin(defines),?...// getEnterPointsConfig.jsconst enterPoints = { APIM_GATEWAY: 'localhost:apimgateway',};?export default function getEnterPointsConfig() { return enterPoints;}具体步骤为:
当为本地启动(start,development)时:
为了便于管理,在@choerodon/boot/lib/containers/common/constants中有如下代码:
export const TYPE = `${process.env.TYPE}`;export const RESOURCES_LEVEL = `${process.env.RESOURCES_LEVEL || ''}`;export const APIM_GATEWAY = `${process.env.APIM_GATEWAY}`;export const UI_CONFIGURE = `${process.env.UI_CONFIGURE}`;export const EMAIL_BLOCK_LIST = `${process.env.EMAIL_BLOCK_LIST}`;在代码中就可以使用了。
当为生产环境(build, product)时:
#!/bin/bashset -e?find /usr/share/nginx/html -name '*.js' | xargs sed -i "s localhost:8080 $PRO_API_HOST g"find /usr/share/nginx/html -name '*.html' | xargs sed -i "s localhost:titlename $PRO_TITLE_NAME g"?exec "$@"使用脚本去进行全局搜索,然后进行字符替换。
可见,当为product环境时,只有环境变量才起效(本地设置的值是无效的)。

通过上一章节和示意图的分析,可以发现如下缺点:
增加环境变量是很复杂的:当增加一个环境变量,要修改至少三处地方(enterpoint.sh, contants.js, updateWebpackConfig.js)。如果使用@choerodon/boot的其他项目要加入一个环境变量(这个变量可能只有该项目使用),即使boot(启动器项目,脚手架)没有做任何修改,也必须增加了变量发布一个新版本。
而且从上文可以看出,界定哪些变量是config.js中配置,哪些是环境变量注入是很不明确的(或者说是随@choerodon/boot开发者确定的)
无法明确知道变量是否还在使用。
部署生产环境时,有些变量是必须有环境变量的(一般的逻辑是环境变量覆盖用户变量再覆盖默认值)。
还是使用shell脚本的方式,但这次直接生成js文件,通过window.env = {}来注入一个全局的变量,使用时只要通过window._env_yourVarName来获取即可。
具体分为如下几个文件:
#!/bin/bash?mode=$1?# Recreate config filerm -rf ./env-config.jstouch ./env-config.js?# Add assignment echo "window._env_ = {" >> ./env-config.js?# Read each line in .env file# Each line represents key=value pairswhile read -r line || [[ -n "$line" ]];do # Split env variables by character `=` if printf '%s\n' "$line" | grep -q -e '='; then varname=$(printf '%s\n' "$line" | sed -e 's/=.*//') varvalue=$(printf '%s\n' "$line" | sed -e 's/^[^=]*=//') fi? # Read value of current variable if exists as Environment variable value=$(printf '%s\n' "${!varname}") # Otherwise use value from .env file [[ -z $value ]] && value=${varvalue} # Append configuration property to JS file echo " $varname: \"$value\"," >> ./env-config.jsdone < .env?while read -r line || [[ -n "$line" ]];do # Split env variables by character `=` if printf '%s\n' "$line" | grep -q -e '='; then varname=$(printf '%s\n' "$line" | sed -e 's/=.*//') varvalue=$(printf '%s\n' "$line" | sed -e 's/^[^=]*=//') fi? # Read value of current variable if exists as Environment variable value=$(printf '%s\n' "${!varname}") # Otherwise use value from .env file [[ -z $value ]] && value=${varvalue} # Append configuration property to JS file echo " $varname: \"$value\"," >> ./env-config.jsdone < .default.env?echo "}" >> ./env-config.js?echo "// ${mode}" >> ./env-config.js步骤解析:
由于考虑到window平台的开发者,在node内部调用shell脚本可能不会运行,所以用node模拟了一套上述方案,在本地开发和打包时,使用node进行环境变量的合并,当使用环境变量注入时,调用shell脚本进行合并。
将@choerodon/boot版本进行升级
在项目根目录下(和package.json同级)创建.env文件(如果没有自定义变量可以不创建)
以键=值的形式写入变量,如
SERVER=http://choerodon.com.cnAUTH_URL=https://api.choerodon.com.cn/oauth/login开发环境时,通过webpack-dev-server生成的html文件在内存中,那env-config.js写到哪?
通过配置contentBase来加载
// start.jsconst serverOptions = { quiet: true, hot: true, ...devServerConfig, // contentBase: path.join(process.cwd(), output), contentBase: [path.join(__dirname, '../../'), ...], historyApiFallback: true, host: 'localhost',};WebpackDevServer.addDevServerEntrypoints(webpackConfig, serverOptions);shell的当前目录相对于命令运行时的目录而不是文件目录
spawn.sync(shellPath, ['development'], { cwd: path.join(__dirname, '../../../'), stdio: 'inherit' });通过指明cwd命令来改变当前文件路径。
当为本地启动(start,development)时:
当为生产环境打包(build,product)时:
(全部复制是为了应对环境变量注入,也要考虑不注入环境变量的情况,此时env-config.js就是最终的变量)
环境变量替换时:
▍哪些变量适合放在这
当采用新的模式后,所有的决定权都在于开发人员(需要慎重),开发人员可以自己声明一个变量,然后在代码中使用,这时当部署生产环境时,可以在.env中声明一个值,然后通过环境变量去覆盖,也可以只是声明这个值(类似于原来的config.js中配置)。
但是总的来说,建议仔细考虑哪些变量是应该作为环境变量注入的。
有两种比较方便的判断方式:
▍加入了环境变量后不起效
加入了环境变量后,可以在node_modules/@choerodon/boot/env-config.js中查看,自己的环境变量到底有没有被注入,如果被别的库覆盖,可以考虑起个独特的名字或者和他人进行商议(后期会考虑当环境变量重复时,进行警告等检测)。
当部署后,可以通过浏览器直接打开env-config.js文件来查看变量的情况。

▍原来的环境变量方案会被剔除吗
暂时不会剔除原先的环境变量方案,即还是可以通过costants.js中获取部分环境变量值,但是不排除在今后剔除这种模式。
▍当环境变量不是字符类型时怎么处理
一般环境变量都是以字符形式注入的,非字符形式可以通过config.js进行处理(如钩子函数等),或者通过序列化来进行处理(JSON.stringfiy)。
如上所述,构建时配置将满足大多数场景,既可以自定义增加变量,用自定义的值作为最终指,也可以用环境变量覆盖。
本文由猪齿鱼技术团队原创,转载请注明出处