开源项目 envconfig-rs 使用教程-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00138/article/details/141582515

开源项目 envconfig-rs 使用教程

envconfig-rsBuild a config structure from environment variables in Rust without boilerplate项目地址:https://gitcode.com/gh_mirrors/en/envconfig-rs

项目介绍

envconfig-rs 是一个 Rust 库，旨在帮助开发者从环境变量中初始化配置结构。通过使用自定义的派生宏，envconfig-rs 可以显著减少初始化配置所需的样板代码，使得配置管理更加简洁和高效。

项目快速启动

安装

首先，在 Cargo.toml 文件中添加 envconfig 依赖：

[dependencies]
envconfig = "0.10.0"

基本使用示例

假设你的应用程序依赖以下环境变量：DB_HOST 和 DB_PORT，并且你希望初始化一个 Config 结构体，可以使用以下代码：

use envconfig::Envconfig;

#[derive(Envconfig)]
pub struct Config {
    #[envconfig(from = "DB_HOST")]
    pub db_host: String,
    #[envconfig(from = "DB_PORT", default = "5432")]
    pub db_port: u16,
}

fn main() {
    // 假设以下环境变量已设置
    std::env::set_var("DB_HOST", "127.0.0.1");

    // 从环境变量初始化配置
    let config = Config::init_from_env().unwrap();
    assert_eq!(config.db_host, "127.0.0.1");
    assert_eq!(config.db_port, 5432);
}

应用案例和最佳实践

嵌套配置

配置可以嵌套。只需在嵌套字段上添加 #[envconfig(nested = true)] 属性：

#[derive(Envconfig)]
pub struct DbConfig {
    #[envconfig(from = "DB_HOST")]
    pub host: String,
    #[envconfig(from = "DB_PORT", default = "5432")]
    pub port: u16,
}

#[derive(Envconfig)]
pub struct Config {
    #[envconfig(nested = true)]
    pub db: DbConfig,
    #[envconfig(from = "HOSTNAME")]
    pub hostname: String,
}

自定义类型

envconfig 依赖于 FromStr 特性。如果你想在配置中使用自定义类型，你需要为你的自定义类型实现 FromStr 特性。例如，扩展 DbConfig 结构体以包含一个表示数据库驱动的枚举：

pub enum DbDriver {
    Postgresql,
    Mysql,
}

impl std::str::FromStr for DbDriver {
    type Err = String;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s.trim().to_lowercase().as_ref() {
            "postgres" => Ok(DbDriver::Postgresql),
            "mysql" => Ok(DbDriver::Mysql),
            _ => Err(format!("Unknown DB driver: {}", s)),
        }
    }
}

#[derive(Envconfig)]
pub struct DbConfig {
    #[envconfig(from = "DB_DRIVER")]
    pub driver: DbDriver,
}