dotenvx - rust-dotenv

从dotenv crate派生。

这是一个v0.*版本！请期待各方面的错误和问题。

关于 dotenv

引用 bkeepers/dotenv

将配置存储在环境中是十二要素应用的一个原则。任何可能在部署环境之间改变的东西，例如数据库的资源句柄或外部服务的凭证，都应从代码中提取出来存储在环境变量中。

这个库旨在在设置环境变量不切实际的开发或测试环境中使用。如果可用，它会从名为.env的文件中加载环境变量，并将这些变量与操作系统提供的实际环境变量合并。

使用方法

最简单和最常见的方法是在应用程序启动时调用dotenv::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 dotenv::dotenv;
use std::env;

fn main() {
    dotenv().ok();

    for (key, value) in env::vars() {
        println!("{}: {}", key, value);
    }
}

变量替换

在 .env 文件中使用 $VARIABLE 语法可以重用变量。其语法和规则与 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"));
}

许可协议

本项目采用 MIT 许可协议。