robotech 1.5.1

Backend service implementation for the RoboTech platform, providing RESTful APIs and business logic for web applications.
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

use crate::web::HealthCheckConfig;
use crate::web::cors::CorsConfig;
use crate::web::https::HttpsConfig;
use ipnet::IpNet;
use serde::Deserialize;
use std::time::Duration;
use wheel_rs::serde::{duration_serde, vec_ipnet_serde, vec_serde};
use wheel_rs::urn_utils::Urn;

#[derive(Debug, Deserialize, Clone)]
#[serde(rename_all = "kebab-case")]
pub struct WebServerConfig {
    /// 绑定的IP地址
    #[serde(with = "vec_serde", default = "bind_default")]
    pub bind: Vec<String>,
    /// Web服务器的端口号(默认0)
    #[serde(default = "port_default")]
    pub port: Option<u16>,

    /// 监听地址列表(监听地址格式: ip+':'+port，例如127.0.0.1:80或\[::\]:80)
    #[serde(with = "vec_serde", default = "listen_default")]
    pub listen: Vec<String>,

    /// 是否启用端口复用(默认关闭)
    ///
    /// * 启用端口复用是为了实现无缝重启服务器，发指令重启服务器时，会在新的服务器启动完成后，才会关闭旧的服务器，达到无缝重启服务器的效果
    /// * 如果绑定监听的是随机端口，会自动禁用，因为随机端口新旧服务器的端口就不会冲突
    #[serde(default = "reuse_port_default")]
    pub reuse_port: bool,

    /// 是否启用Https(默认关闭)
    #[serde(default)]
    pub https: Option<HttpsConfig>,

    /// 只允许本地访问的URN列表(默认为空)
    #[serde(default)]
    pub local_only_urns: Vec<Urn>,

    /// 禁止访问的URN列表(默认为空)
    #[serde(default)]
    pub forbidden_urns: Vec<Urn>,

    /// ip白名单
    #[serde(default, with = "vec_ipnet_serde")]
    pub ip_white_list: Vec<IpNet>,

    /// ip黑名单
    #[serde(default, with = "vec_ipnet_serde")]
    pub ip_black_list: Vec<IpNet>,

    /// 是否启用日志(默认关闭)
    #[serde(default)]
    pub log_enabled: bool,

    /// CORS配置(不设置默认不开启)
    #[serde(default)]
    pub cors: Option<CorsConfig>,

    /// 是否暴露健康检查(默认不暴露，只能本地访问)
    #[serde(default)]
    pub health_check: HealthCheckConfig,

    #[serde(with = "duration_serde", default = "start_wait_timeout_default")]
    pub start_wait_timeout: Duration,

    #[serde(with = "duration_serde", default = "start_retry_interval_default")]
    pub start_retry_interval: Duration,

    #[serde(
        with = "duration_serde",
        default = "terminate_old_app_wait_timeout_default"
    )]
    pub terminate_old_app_wait_timeout: Duration,

    #[serde(
        with = "duration_serde",
        default = "terminate_old_app_retry_interval_default"
    )]
    pub terminate_old_app_retry_interval: Duration,
}

impl Default for WebServerConfig {
    fn default() -> Self {
        Self {
            bind: bind_default(),
            port: port_default(),
            listen: listen_default(),
            reuse_port: reuse_port_default(),
            https: None,
            forbidden_urns: vec![],
            local_only_urns: vec![],
            ip_white_list: vec![],
            ip_black_list: vec![],
            log_enabled: false,
            cors: None,
            health_check: HealthCheckConfig::default(),
            start_wait_timeout: start_wait_timeout_default(),
            start_retry_interval: start_retry_interval_default(),
            terminate_old_app_wait_timeout: terminate_old_app_wait_timeout_default(),
            terminate_old_app_retry_interval: terminate_old_app_retry_interval_default(),
        }
    }
}

fn bind_default() -> Vec<String> {
    vec![]
}
fn port_default() -> Option<u16> {
    None
}

fn listen_default() -> Vec<String> {
    vec![]
}

fn reuse_port_default() -> bool {
    false
}

fn start_wait_timeout_default() -> Duration {
    Duration::from_secs(10)
}
fn start_retry_interval_default() -> Duration {
    Duration::from_millis(500)
}
fn terminate_old_app_wait_timeout_default() -> Duration {
    Duration::from_secs(15)
}
fn terminate_old_app_retry_interval_default() -> Duration {
    Duration::from_millis(500)
}