1 个不稳定版本
0.15.0 | 2022年9月15日 |
---|
#661 在 配置
38KB
894 行
rust-dotenv
dotenv 的分支,设计得更适合现代 Rust 和设计模式。
注意! 这是一个 v0.* 版本!预期会有各种错误和问题。强烈鼓励提交拉取请求和问题!
将 配置存储在环境中 是十二要素应用程序的一个原则。任何可能在部署环境之间发生变化的东西(如数据库的资源句柄或外部服务的凭据)都应从代码中提取到环境变量中。
这个库旨在在开发或测试环境中使用,在这些环境中设置环境变量不切实际。如果可用,它将从当前目录或其父目录中名为 .env
的文件中加载环境变量,并将这些变量与操作系统提供的实际环境变量混合。
用法
最简单、最常用的用法是在应用程序启动时调用 rotenv::dotenv
,这将从当前目录或其父目录中名为 .env
的文件中加载环境变量;之后,您只需调用 std::os
提供的环境相关方法即可。
如果您需要更细粒度的控制文件名或其位置,可以使用crate提供的from_filename
和from_path
方法。
dotenv_codegen
提供了dotenv!
宏,其行为与env!
相同,但在编译时首先尝试加载一个.env
文件。
示例
一个.env
文件看起来像这样
# a comment, will be ignored
REDIS_ADDRESS=localhost:6379
MEANING_OF_LIFE=42
您可以选择在每个行前加上单词export
,这将方便地在shell中导入整个文件。
使用Dotenv的示例项目可能如下所示
extern crate dotenv;
use rotenv::dotenv;
use std::env;
fn main() {
dotenv().ok();
for (key, value) in env::vars() {
println!("{}: {}", key, value);
}
}
变量替换
可以使用$VARIABLE
语法在.env
文件中重用变量。语法和规则与bash类似,以下是一个示例
VAR=one
VAR_2=two
# Non-existing values are replaced with an empty string
RESULT=$NOPE #value: '' (empty string)
# All the letters after $ symbol are treated as the variable name to replace
RESULT=$VAR #value: 'one'
# Double quotes do not affect the substitution
RESULT="$VAR" #value: 'one'
# Different syntax, same result
RESULT=${VAR} #value: 'one'
# Curly braces are useful in cases when we need to use a variable with non-alphanumeric name
RESULT=$VAR_2 #value: 'one_2' since $ with no curly braces stops after first non-alphanumeric symbol
RESULT=${VAR_2} #value: 'two'
# The replacement can be escaped with either single quotes or a backslash:
RESULT='$VAR' #value: '$VAR'
RESULT=\$VAR #value: '$VAR'
# Environment variables are used in the substutution and always override the local variables
RESULT=$PATH #value: the contents of the $PATH environment variable
PATH="My local variable value"
RESULT=$PATH #value: the contents of the $PATH environment variable, even though the local variable is defined
Dotenv将解析文件,按照注释中描述的方式替换变量。
使用dotenv!
宏
将dotenv_codegen
添加到您的依赖项中,并在crate顶部添加以下内容
#[macro_use]
extern crate dotenv_codegen;
然后,在您的crate中
fn main() {
println!("{}", dotenv!("MEANING_OF_LIFE"));
}
依赖项
~235KB