Rust环境变量管理库default-env使用指南

简介

default-env是一个简化Rust项目中环境变量管理的库，它提供了跨平台的环境变量处理能力，并允许为变量设置默认值，使项目配置更加简单和健壮。

主要特性

• 跨平台环境变量处理
• 支持设置默认值
• 类型安全的变量获取
• 支持.env文件
• 简洁的API设计

安装

在Cargo.toml中添加依赖：

[dependencies]
default-env = "0.1"

基本使用方法

1. 获取环境变量（带默认值）

use default_env::default_env;

// 获取环境变量，如果不存在则使用默认值
let db_url = default_env!("DATABASE_URL", "postgres://localhost:5432/mydb");
println!("Database URL: {}", db_url);

2. 必须存在的环境变量

use default_env::require_env;

// 获取必须存在的环境变量，不存在时会panic
let api_key = require_env!("API_KEY");
println!("API Key: {}", api_key);

3. 类型转换

use default_env::default_env;

// 获取并转换为整数
let port: u16 = default_env!("PORT", "8080").parse().unwrap();
println!("Server port: {}", port);

// 获取并转换为布尔值
let debug_mode: bool = default_env!("DEBUG", "false").parse().unwrap();
println!("Debug mode: {}", debug_mode);

4. 使用.env文件

首先在项目根目录创建.env文件：

DATABASE_URL=postgres://user:pass@localhost:5432/mydb
API_KEY=secret123
PORT=3000
DEBUG=true

然后在代码中使用：

#[macro_use]
extern crate default_env;

fn main() {
    dotenv::dotenv().ok(); // 加载.env文件
    
    let db_url = default_env!("DATABASE_URL", "postgres://localhost:5432/mydb");
    let api_key = require_env!("API_KEY");
    let port: u16 = default_env!("PORT", "8080").parse().unwrap();
    let debug_mode: bool = default_env!("DEBUG", "false").parse().unwrap();
    
    println!("DB URL: {}", db_url);
    println!("API Key: {}", api_key);
    println!("Port: {}", port);
    println!("Debug mode: {}", debug_mode);
}

高级用法

1. 自定义错误处理

use default_env::default_env;

fn get_config() -> Result<(), Box<dyn std::error::Error>> {
    let db_url = match std::env::var("DATABASE_URL") {
        Ok(val) => val,
        Err(_) => default_env!("DATABASE_URL", "postgres://localhost:5432/mydb").to_string(),
    };
    
    // 其他配置处理...
    Ok(())
}

2. 多环境配置

#[macro_use]
extern crate default_env;

fn load_config(env: &str) {
    let env_file = format!(".env.{}", env);
    dotenv::from_filename(env_file).ok();
    
    let db_url = default_env!("DATABASE_URL", "postgres://localhost:5432/mydb");
    println!("Using DB URL: {}", db_url);
}

fn main() {
    let env = std::env::var("APP_ENV").unwrap_or_else(|_| "development".to_string());
    load_config(&env);
}

最佳实践

1. 在项目根目录下创建.env.example文件，列出所有需要的环境变量及其示例值
2. 在文档中明确说明项目依赖的环境变量
3. 对敏感信息（如API密钥）使用require_env!确保它们必须被设置
4. 为开发环境提供合理的默认值
5. 在CI/CD流程中验证所有必需的环境变量是否已设置

完整示例demo

// 完整示例：使用default-env管理多环境配置
#[macro_use]
extern crate default_env;

use std::error::Error;

// 应用配置结构体
#[derive(Debug)]
struct AppConfig {
    db_url: String,
    api_key: String,
    port: u16,
    debug: bool,
    env: String,
}

impl AppConfig {
    // 加载配置
    fn load() -> Result<Self, Box<dyn Error>> {
        // 确定当前环境
        let env = std::env::var("APP_ENV").unwrap_or_else(|_| "dev".to_string());
        
        // 加载对应环境的.env文件
        let env_file = format!(".env.{}", env);
        dotenv::from_filename(env_file).ok();
        
        // 获取配置值
        Ok(Self {
            db_url: default_env!("DATABASE_URL", "postgres://localhost:5432/mydb").to_string(),
            api_key: require_env!("API_KEY").to_string(),
            port: default_env!("PORT", "8080").parse()?,
            debug: default_env!("DEBUG", "false").parse()?,
            env,
        })
    }
}

fn main() -> Result<(), Box<dyn Error>> {
    // 加载配置
    let config = AppConfig::load()?;
    
    println!("应用配置:");
    println!("环境: {}", config.env);
    println!("数据库URL: {}", config.db_url);
    println!("API密钥: {}", "***隐藏***"); // 实际应用中不要打印敏感信息
    println!("端口: {}", config.port);
    println!("调试模式: {}", config.debug);
    
    Ok(())
}

总结

default-env库通过提供简洁的宏和默认值支持，大大简化了Rust项目中的环境变量管理。它特别适合需要跨平台部署和不同环境配置的项目，能够减少配置错误并提高开发效率。