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);
    }
}

变量替换

您可以使用 $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"));
}

许可证

本项目受MIT许可证许可。