Export or Not Export in Environment File

Ryan Li

2019-12-10

tech

Bash, Env, Shell

背景

在项目中需要使用 envsubst 从模板生成配置文件. 发现如果在环境变量文件 env.conf (或 .env 等) 中不使用 export 命令, envsubst 无法获取到所需的环境变量.

构建模板文件 src.txt

now foo here: ${FOO}

创建环境变量配置文件 env.conf:

FOO=bar

创建执行脚本 subenv.sh:

source env.conf

echo $FOO

envsubst < "src.txt" > "env-tar.txt"

执行脚本 [subenv.sh](http://subenv.sh) 查看生成的 env-tar.txt 文件:

now foo here:

创建环境变量配置文件 exp.conf

1	export FOO=bar

创建执行脚本 subexp.sh:

source exp.conf

echo $FOO

envsubst < "src.txt" > "exp-tar.txt"

执行脚本 [subexp.sh](http://subexp.sh) 查看生成文件 exp-tar.txt:

now foo here: bar

可以看到, 在环境变量配置文件中使用 export, 在脚本中使用 envsubst 才能获取到所需的环境变量.

如果使用上面的脚本测试时, 可以发现无论是否使用 export, echo 都能正确地拿到所需的环境变量.

在配置文件中是否应该使用 export, 也存在着不同的声音. 在一个相关高票回答下, 就有这么一个评论:

If using this .env file between systems, inserting export would break it for things like Java, SystemD, or other tools

且不关心什么方案是更好的实践, 我们希望能找到一个通用的方案.

在这个回答中, 我们找到了目前最好的解决方案:

-o allexport enables all following variable definitions to be exported. +o allexport disables this feature.

1
2
3

set -o allexport
source conf-file
set +o allexport

经实践, 如果我们将 subenv.sh 改造成如下:

set -o allexport
source env.conf
set +o allexport

echo $FOO

envsubst < "src.txt" > "env-tar.txt"

即可在输出文件中获得符合期待的结果:

1	new foo here: bar