aerox_config 0.1.1

AeroX 配置管理模块
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
//! 配置管理系统
//!
//! 提供灵活的配置管理,支持服务器配置和环境变量。

use serde::{Deserialize, Serialize};
use std::path::Path;
use thiserror::Error;

/// 配置错误类型
#[derive(Error, Debug)]
pub enum ConfigError {
    /// IO 错误
    #[error("IO 错误: {0}")]
    Io(#[from] std::io::Error),

    /// 解析错误
    #[error("解析配置文件失败: {0}")]
    Parse(String),

    /// 验证错误
    #[error("配置验证失败: {0}")]
    Validation(String),

    /// 环境变量错误
    #[error("环境变量解析失败: {0}")]
    EnvVar(String),
}

/// 配置 Result 类型
pub type Result<T> = std::result::Result<T, ConfigError>;

/// 服务器配置
#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct ServerConfig {
    /// 绑定地址
    #[serde(default = "default_bind_address")]
    pub bind_address: String,

    /// 监听端口
    #[serde(default = "default_port")]
    pub port: u16,

    /// 最大连接数限制
    #[serde(default)]
    pub max_connections: Option<u32>,

    /// 每个连接每秒最大请求数
    #[serde(default = "default_max_requests_per_second_per_connection")]
    pub max_requests_per_second_per_connection: Option<u32>,

    /// 全局每秒最大请求数
    #[serde(default = "default_max_requests_per_second_total")]
    pub max_requests_per_second_total: Option<u32>,

    /// 是否启用 DDoS 防护
    #[serde(default = "default_enable_ddos_protection")]
    pub enable_ddos_protection: bool,

    /// 工作线程数量(None 表示使用 CPU 核心数)
    #[serde(default)]
    pub worker_threads: Option<usize>,
}

/// Reactor 模式配置
#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct ReactorConfig {
    /// Reactor 缓冲区大小
    #[serde(default = "default_reactor_buffer_size")]
    pub reactor_buffer_size: usize,

    /// 消息批处理大小
    #[serde(default = "default_batch_size")]
    pub batch_size: usize,

    /// 批处理超时时间(毫秒)
    #[serde(default = "default_batch_timeout")]
    pub batch_timeout_ms: u64,

    /// 连接超时时间(秒)
    #[serde(default = "default_connection_timeout")]
    pub connection_timeout_secs: u64,
}

impl Default for ServerConfig {
    fn default() -> Self {
        Self {
            bind_address: default_bind_address(),
            port: default_port(),
            max_connections: None,
            max_requests_per_second_per_connection: default_max_requests_per_second_per_connection(
            ),
            max_requests_per_second_total: default_max_requests_per_second_total(),
            enable_ddos_protection: default_enable_ddos_protection(),
            worker_threads: None,
        }
    }
}

impl Default for ReactorConfig {
    fn default() -> Self {
        Self {
            reactor_buffer_size: default_reactor_buffer_size(),
            batch_size: default_batch_size(),
            batch_timeout_ms: default_batch_timeout(),
            connection_timeout_secs: default_connection_timeout(),
        }
    }
}

impl ServerConfig {
    /// 从 TOML 文件加载配置
    pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Self> {
        let content = std::fs::read_to_string(path)
            .map_err(|e| ConfigError::Parse(format!("读取配置文件失败: {}", e)))?;

        let config: ServerConfig = toml::from_str(&content)
            .map_err(|e| ConfigError::Parse(format!("解析配置文件失败: {}", e)))?;

        Ok(config)
    }

    /// 从环境变量加载配置并覆盖
    ///
    /// 支持的环境变量:
    /// - AEROX_BIND_ADDRESS: 绑定地址
    /// - AEROX_PORT: 端口
    /// - AEROX_MAX_CONNECTIONS: 最大连接数
    /// - AEROX_ENABLE_DDOS_PROTECTION: 启用 DDoS 防护 (true/false)
    /// - AEROX_WORKER_THREADS: 工作线程数
    pub fn load_with_env_override(mut self) -> Result<Self> {
        // 绑定地址
        if let Ok(addr) = std::env::var("AEROX_BIND_ADDRESS") {
            self.bind_address = addr;
        }

        // 端口
        if let Ok(port_str) = std::env::var("AEROX_PORT") {
            self.port = port_str
                .parse()
                .map_err(|_| ConfigError::EnvVar("AEROX_PORT 必须是有效的 u16 数字".to_string()))?;
        }

        // 最大连接数
        if let Ok(max_conn) = std::env::var("AEROX_MAX_CONNECTIONS") {
            self.max_connections = Some(max_conn.parse().map_err(|_| {
                ConfigError::EnvVar("AEROX_MAX_CONNECTIONS 必须是有效的 u32 数字".to_string())
            })?);
        }

        // DDoS 防护
        if let Ok(ddos) = std::env::var("AEROX_ENABLE_DDOS_PROTECTION") {
            self.enable_ddos_protection = ddos.parse().map_err(|_| {
                ConfigError::EnvVar("AEROX_ENABLE_DDOS_PROTECTION 必须是 true 或 false".to_string())
            })?;
        }

        // 工作线程数
        if let Ok(threads) = std::env::var("AEROX_WORKER_THREADS") {
            self.worker_threads = Some(threads.parse().map_err(|_| {
                ConfigError::EnvVar("AEROX_WORKER_THREADS 必须是有效的 usize 数字".to_string())
            })?);
        }

        Ok(self)
    }

    /// 从文件加载并应用环境变量覆盖
    pub fn from_file_with_env<P: AsRef<Path>>(path: P) -> Result<Self> {
        Self::from_file(path)?.load_with_env_override()
    }

    /// 验证配置是否有效
    pub fn validate(&self) -> Result<()> {
        // 端口验证
        if self.port == 0 {
            return Err(ConfigError::Validation("端口不能为 0".to_string()));
        }

        // 地址验证
        if self.bind_address.is_empty() {
            return Err(ConfigError::Validation("绑定地址不能为空".to_string()));
        }

        // 工作线程数验证
        if let Some(threads) = self.worker_threads {
            if threads == 0 {
                return Err(ConfigError::Validation("工作线程数不能为 0".to_string()));
            }
            if threads > 512 {
                return Err(ConfigError::Validation(
                    "工作线程数过大 (建议 <= 512)".to_string(),
                ));
            }
        }

        // 最大连接数验证
        if let Some(max_conn) = self.max_connections {
            if max_conn == 0 {
                return Err(ConfigError::Validation("最大连接数不能为 0".to_string()));
            }
        }

        // 每连接请求数验证
        if let Some(reqs) = self.max_requests_per_second_per_connection {
            if reqs == 0 {
                return Err(ConfigError::Validation("每连接请求数不能为 0".to_string()));
            }
        }

        // 全局请求数验证
        if let Some(reqs) = self.max_requests_per_second_total {
            if reqs == 0 {
                return Err(ConfigError::Validation("全局请求数不能为 0".to_string()));
            }
        }

        Ok(())
    }

    /// 获取完整的绑定地址字符串
    pub fn bind_addr(&self) -> String {
        format!("{}:{}", self.bind_address, self.port)
    }

    /// 获取配置摘要信息
    pub fn summary(&self) -> String {
        format!(
            "AeroX 服务器配置:\n  地址: {}\n  最大连接数: {:?}\n  DDoS 防护: {}\n  工作线程: {:?}",
            self.bind_addr(),
            self.max_connections,
            self.enable_ddos_protection,
            self.worker_threads
        )
    }
}

// 默认值函数
fn default_bind_address() -> String {
    "0.0.0.0".to_string()
}

fn default_port() -> u16 {
    8080
}

fn default_max_requests_per_second_per_connection() -> Option<u32> {
    Some(1000)
}

fn default_max_requests_per_second_total() -> Option<u32> {
    Some(100_000)
}

fn default_enable_ddos_protection() -> bool {
    true
}

fn default_reactor_buffer_size() -> usize {
    8192
}

fn default_batch_size() -> usize {
    32
}

fn default_batch_timeout() -> u64 {
    10
}

fn default_connection_timeout() -> u64 {
    300
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_default_config() {
        let config = ServerConfig::default();
        assert_eq!(config.bind_address, "0.0.0.0");
        assert_eq!(config.port, 8080);
        assert!(config.validate().is_ok());
    }

    #[test]
    fn test_bind_addr() {
        let config = ServerConfig {
            bind_address: "127.0.0.1".to_string(),
            port: 9000,
            ..Default::default()
        };
        assert_eq!(config.bind_addr(), "127.0.0.1:9000");
    }

    #[test]
    fn test_validate_invalid_port() {
        let config = ServerConfig {
            port: 0,
            ..Default::default()
        };
        assert!(config.validate().is_err());
    }

    #[test]
    fn test_validate_empty_address() {
        let config = ServerConfig {
            bind_address: "".to_string(),
            ..Default::default()
        };
        assert!(config.validate().is_err());
    }

    #[test]
    fn test_validate_invalid_worker_threads() {
        let config = ServerConfig {
            worker_threads: Some(0),
            ..Default::default()
        };
        assert!(config.validate().is_err());
    }

    #[test]
    fn test_validate_too_many_worker_threads() {
        let config = ServerConfig {
            worker_threads: Some(1000),
            ..Default::default()
        };
        assert!(config.validate().is_err());
    }

    #[test]
    fn test_validate_invalid_max_connections() {
        let config = ServerConfig {
            max_connections: Some(0),
            ..Default::default()
        };
        assert!(config.validate().is_err());
    }

    #[test]
    fn test_env_override_port() {
        unsafe {
            std::env::set_var("AEROX_PORT", "9999");
        }
        let config = ServerConfig::default().load_with_env_override().unwrap();
        assert_eq!(config.port, 9999);
        unsafe {
            std::env::remove_var("AEROX_PORT");
        }
    }

    #[test]
    fn test_env_override_address() {
        unsafe {
            std::env::set_var("AEROX_BIND_ADDRESS", "127.0.0.1");
        }
        let config = ServerConfig::default().load_with_env_override().unwrap();
        assert_eq!(config.bind_address, "127.0.0.1");
        unsafe {
            std::env::remove_var("AEROX_BIND_ADDRESS");
        }
    }

    #[test]
    fn test_env_override_invalid_port() {
        unsafe {
            std::env::set_var("AEROX_PORT", "invalid");
        }
        let result = ServerConfig::default().load_with_env_override();
        assert!(result.is_err());
        unsafe {
            std::env::remove_var("AEROX_PORT");
        }
    }

    #[test]
    fn test_env_override_ddos_protection() {
        unsafe {
            std::env::set_var("AEROX_ENABLE_DDOS_PROTECTION", "false");
        }
        let config = ServerConfig::default().load_with_env_override().unwrap();
        assert!(!config.enable_ddos_protection);
        unsafe {
            std::env::remove_var("AEROX_ENABLE_DDOS_PROTECTION");
        }
    }

    #[test]
    fn test_env_override_max_connections() {
        unsafe {
            std::env::set_var("AEROX_MAX_CONNECTIONS", "5000");
        }
        let config = ServerConfig::default().load_with_env_override().unwrap();
        assert_eq!(config.max_connections, Some(5000));
        unsafe {
            std::env::remove_var("AEROX_MAX_CONNECTIONS");
        }
    }

    #[test]
    fn test_config_summary() {
        let config = ServerConfig::default();
        let summary = config.summary();
        assert!(summary.contains("0.0.0.0:8080"));
        assert!(summary.contains("AeroX 服务器配置"));
    }
}