Rust配置管理库solar-config使用指南

简介

solar-config是一个轻量级、高效且灵活的Rust应用程序配置管理库。它提供了简单易用的API来加载、管理和访问应用程序配置，支持多种配置格式和环境变量覆盖。

主要特性

• 轻量级设计，无额外依赖
• 支持JSON、YAML、TOML等常见配置格式
• 环境变量覆盖支持
• 类型安全配置访问
• 灵活的配置源组合

安装

在Cargo.toml中添加依赖：

[dependencies]
solar-config = "0.3"

基本使用方法

1. 加载配置文件

use solar_config::Config;

fn main() {
    // 从文件加载配置
    let config = Config::from_file("config.toml").expect("Failed to load config");
    
    // 从字符串加载配置
    let config_str = r#"
        [database]
        host = "localhost"
        port = 5432
    "#;
    let config = Config::from_str(config_str).expect("Failed to parse config");
}

2. 访问配置值

let db_host: String = config.get("database.host").expect("Database host not found");
let db_port: i32 = config.get("database.port").expect("Database port not found");

println!("Database connection: {}:{}", db_host, db_port);

3. 环境变量覆盖

// 假设有环境变量 DATABASE_HOST=prod.db.example.com
let config = Config::from_file("config.toml")
    .with_env_prefix("APP") // 可选前缀
    .with_env_overrides(); // 启用环境变量覆盖

// 环境变量值会覆盖配置文件中的值
let db_host: String = config.get("database.host").unwrap();
assert_eq!(db_host, "prod.db.example.com");

高级用法

1. 多配置源合并

let base_config = Config::from_file("base_config.toml")?;
let dev_config = Config::from_file("dev_overrides.toml")?;

let merged = base_config.merge(&dev_config);

2. 类型安全配置结构

#[derive(Debug, Deserialize)]
struct DatabaseConfig {
    host: String,
    port: u16,
    username: String,
    password: String,
}

let db_config: DatabaseConfig = config.extract("database")?;

3. 默认值支持

let retry_count = config.get_or("api.retry_count", 3); // 默认3次

完整示例

use solar_config::Config;
use serde::Deserialize;

#[derive(Debug, Deserialize)]
struct AppConfig {
    database: DatabaseConfig,
    server: ServerConfig,
}

#[derive(Debug, Deserialize)]
struct DatabaseConfig {
    url: String,
    pool_size: u32,
}

#[derive(Debug, Deserialize)]
struct ServerConfig {
    host: String,
    port: u16,
}

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // 加载并解析配置
    let config = Config::from_file("config.toml")?
        .with_env_overrides();
    
    // 提取为类型安全结构
    let app_config: AppConfig = config.extract()?;
    
    println!("Server will run on {}:{}", 
        app_config.server.host, 
        app_config.server.port);
    
    Ok(())
}

配置文件示例 (config.toml)

[database]
url = "postgres://user:pass@localhost:5432/db"
pool_size = 10

[server]
host = "0.0.0.0"
port = 8080

总结

solar-config提供了简单而强大的配置管理能力，适合各种规模的Rust项目。它的轻量级设计和灵活的特性使得应用程序配置管理变得简单而高效。