在 Rust 套用中從環境變量和檔中獲取配置

2024-09-01碼農

在執行應用程式時，我們常常需要將外部數據傳遞到應用程式內部，並獲取這些數據。

這些數據可以來自任何來源，例如環境變量、命令列參數、檔等。

本文將深入探討如何在 Rust 應用程式中優雅地處理配置，特別關註從環境變量和檔中獲取配置資訊。

配置管理的重要性

在軟體開發中，尤其是在構建和部署復雜應用程式時，配置管理至關重要。配置管理不善可能導致各種問題，例如：

難以維護： 當配置分散在程式碼庫的各個角落時，更新和維護配置變得非常困難。

容易出錯： 手動更改配置容易出錯，尤其是在大型計畫中。

可移植性差： 將應用程式部署到不同的環境（例如開發、測試和生產）可能需要手動修改配置，這既耗時又容易出錯。

因此，采用結構化的方式管理配置至關重要。

Rust 中的配置管理庫

Rust 生態系提供了幾個優秀的庫，用於從各種來源載入和管理配置。其中， config 和 dotenv 庫的組合非常強大，可以實作靈活且易於維護的配置管理方案。

config: 這個庫提供了一種統一的方式來處理來自不同來源的配置，例如：

檔（TOML、JSON、YAML、INI、HJSON）

環境變量

命令列參數

預設值

dotenv: 這個庫允許你從 .env 檔中載入環境變量。這在開發過程中非常有用，因為你可以輕松地更改配置，而無需修改程式碼。

使用 `config` 和 `dotenv` 庫

讓我們透過一個簡單的範例來演示如何使用 config 和 dotenv 庫來管理 Rust 應用程式的配置。

1. 添加依賴項

首先，將以下依賴項添加到你的 Cargo.toml 檔中：

[dependencies] serde = { version = "1.0", features = ["derive"] } config = "0.13" dotenv = "0.15"

2. 建立配置檔

接下來，建立一個名為 config 的目錄，並在其中建立一個名為 default.toml 的檔。

default.toml :

[server] host = "127.0.0.1" port = 8080 [database] url = "postgres://localhost:5432/mydb"

你可以根據需要添加更多配置檔，例如 development.toml 、 production.toml 等。

3. 建立 .env 檔

在計畫的根目錄下建立一個名為 .env 的檔。

.env :

DATABASE_URL=postgres://remotehost:5432/myproductiondb

4. 載入和存取配置

現在，讓我們編寫一些程式碼來載入和存取配置。

use config::{ConfigError, Config, File, Environment}; use serde::Deserialize; #[derive(Debug, Deserialize)] pubstructSettings { pub server: ServerConfig, pub database: DatabaseConfig, } #[derive(Debug, Deserialize)] pubstructServerConfig { pub host: String, pub port: i32, } #[derive(Debug, Deserialize)] pubstructDatabaseConfig { pub url: String, } impl Settings { pubfnnew() -> Result<Self, ConfigError> { letmut cfg = Config::new(); // 從預設配置檔載入 cfg.merge(File::with_name("config/default"))?; // 從特定環境的配置檔載入（例如，開發環境） // 這將覆蓋預設配置中的任何匹配值 if cfg.get_bool("development").unwrap_or(false) { cfg.merge(File::with_name("config/development").required(false))?; } // 從 .env 檔載入環境變量 // 這將覆蓋之前載入的任何匹配值 cfg.merge(Environment::with_prefix("APP").separator("__"))?; // 將配置反序列化為 Settings 結構體 cfg.try_into() } } fnmain() -> Result<(), ConfigError> { let settings = Settings::new()?; println!("{:?}", settings); Ok(()) }