yang-base 0.1.0

个人使用构建后端服务器
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
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
//! 字段验证器
//!
//! 提供灵活的字段值验证机制,支持长度验证、数值范围验证、格式验证和自定义验证。

use crate::error::BaseError;
use regex::Regex;
use serde::{Deserialize, Serialize};
use std::sync::Arc;

/// 自定义验证函数类型
///
/// 接收字段名和字段值,返回验证结果
pub type ValidatorFn = Arc<dyn Fn(&str, &serde_json::Value) -> Result<(), BaseError> + Send + Sync>;

/// 字段验证器
///
/// 定义各种字段值验证规则,包括:
/// - 长度验证:MinLength, MaxLength
/// - 数值范围验证:Min, Max
/// - 格式验证:Email, Phone, Url
/// - 正则表达式验证:Regex
/// - 自定义验证:Custom
///
/// # 示例
///
/// ```rust
/// use yang_base::table::Validator;
/// use serde_json::json;
///
/// // 最小长度验证
/// let validator = Validator::MinLength(5);
/// assert!(validator.validate("username", &json!("alice")).is_ok());
/// assert!(validator.validate("username", &json!("bob")).is_err());
///
/// // 邮箱格式验证
/// let validator = Validator::Email;
/// assert!(validator.validate("email", &json!("user@example.com")).is_ok());
/// assert!(validator.validate("email", &json!("invalid")).is_err());
///
/// // 数值范围验证
/// let validator = Validator::Min(0.0);
/// assert!(validator.validate("age", &json!(18)).is_ok());
/// assert!(validator.validate("age", &json!(-5)).is_err());
/// ```
#[derive(Clone)]
pub enum Validator {
    /// 最小长度验证
    ///
    /// 验证字符串的字符数不小于指定值。
    ///
    /// # 示例
    ///
    /// ```rust
    /// use yang_base::table::Validator;
    /// use serde_json::json;
    ///
    /// let validator = Validator::MinLength(3);
    /// assert!(validator.validate("name", &json!("abc")).is_ok());
    /// assert!(validator.validate("name", &json!("ab")).is_err());
    /// ```
    MinLength(usize),

    /// 最大长度验证
    ///
    /// 验证字符串的字符数不大于指定值。
    ///
    /// # 示例
    ///
    /// ```rust
    /// use yang_base::table::Validator;
    /// use serde_json::json;
    ///
    /// let validator = Validator::MaxLength(10);
    /// assert!(validator.validate("name", &json!("short")).is_ok());
    /// assert!(validator.validate("name", &json!("this is too long")).is_err());
    /// ```
    MaxLength(usize),

    /// 最小值验证
    ///
    /// 验证数值不小于指定值。
    ///
    /// # 示例
    ///
    /// ```rust
    /// use yang_base::table::Validator;
    /// use serde_json::json;
    ///
    /// let validator = Validator::Min(0.0);
    /// assert!(validator.validate("age", &json!(18)).is_ok());
    /// assert!(validator.validate("age", &json!(-5)).is_err());
    /// ```
    Min(f64),

    /// 最大值验证
    ///
    /// 验证数值不大于指定值。
    ///
    /// # 示例
    ///
    /// ```rust
    /// use yang_base::table::Validator;
    /// use serde_json::json;
    ///
    /// let validator = Validator::Max(100.0);
    /// assert!(validator.validate("score", &json!(95)).is_ok());
    /// assert!(validator.validate("score", &json!(150)).is_err());
    /// ```
    Max(f64),

    /// 邮箱格式验证
    ///
    /// 验证字符串是否为有效的邮箱格式(包含 @ 符号)。
    ///
    /// # 示例
    ///
    /// ```rust
    /// use yang_base::table::Validator;
    /// use serde_json::json;
    ///
    /// let validator = Validator::Email;
    /// assert!(validator.validate("email", &json!("user@example.com")).is_ok());
    /// assert!(validator.validate("email", &json!("invalid")).is_err());
    /// ```
    Email,

    /// 手机号格式验证
    ///
    /// 验证字符串是否为有效的手机号格式(仅包含数字和连字符)。
    ///
    /// # 示例
    ///
    /// ```rust
    /// use yang_base::table::Validator;
    /// use serde_json::json;
    ///
    /// let validator = Validator::Phone;
    /// assert!(validator.validate("phone", &json!("13800138000")).is_ok());
    /// assert!(validator.validate("phone", &json!("138-0013-8000")).is_ok());
    /// assert!(validator.validate("phone", &json!("invalid")).is_err());
    /// ```
    Phone,

    /// URL 格式验证
    ///
    /// 验证字符串是否为有效的 URL 格式(以 http:// 或 https:// 开头)。
    ///
    /// # 示例
    ///
    /// ```rust
    /// use yang_base::table::Validator;
    /// use serde_json::json;
    ///
    /// let validator = Validator::Url;
    /// assert!(validator.validate("website", &json!("https://example.com")).is_ok());
    /// assert!(validator.validate("website", &json!("http://example.com")).is_ok());
    /// assert!(validator.validate("website", &json!("invalid")).is_err());
    /// ```
    Url,

    /// 正则表达式验证
    ///
    /// 使用正则表达式验证字符串格式。
    ///
    /// # 示例
    ///
    /// ```rust
    /// use yang_base::table::Validator;
    /// use serde_json::json;
    ///
    /// let validator = Validator::Regex(r"^\d{6}$".to_string());
    /// assert!(validator.validate("code", &json!("123456")).is_ok());
    /// assert!(validator.validate("code", &json!("12345")).is_err());
    /// ```
    Regex(String),

    /// 自定义验证函数
    ///
    /// 使用自定义函数进行验证,提供最大的灵活性。
    ///
    /// # 示例
    ///
    /// ```rust
    /// use yang_base::table::Validator;
    /// use yang_base::error::BaseError;
    /// use serde_json::json;
    /// use std::sync::Arc;
    ///
    /// let validator = Validator::Custom(Arc::new(|field_name, value| {
    ///     if let Some(s) = value.as_str() {
    ///         if s.contains("forbidden") {
    ///             return Err(BaseError::ValidationFailed(
    ///                 field_name.to_string(),
    ///                 "包含禁止的词汇".to_string(),
    ///             ));
    ///         }
    ///     }
    ///     Ok(())
    /// }));
    ///
    /// assert!(validator.validate("content", &json!("normal text")).is_ok());
    /// assert!(validator.validate("content", &json!("forbidden word")).is_err());
    /// ```
    Custom(ValidatorFn),
}

impl Validator {
    /// 获取验证器的显示名称
    ///
    /// # 返回值
    ///
    /// 返回验证器的中文显示名称
    ///
    /// # 示例
    ///
    /// ```rust
    /// use yang_base::table::Validator;
    ///
    /// assert_eq!(Validator::MinLength(5).display_name(), "最小长度");
    /// assert_eq!(Validator::Email.display_name(), "邮箱格式");
    /// ```
    pub fn display_name(&self) -> &str {
        match self {
            Validator::MinLength(_) => "最小长度",
            Validator::MaxLength(_) => "最大长度",
            Validator::Min(_) => "最小值",
            Validator::Max(_) => "最大值",
            Validator::Email => "邮箱格式",
            Validator::Phone => "手机号格式",
            Validator::Url => "URL格式",
            Validator::Regex(_) => "正则表达式",
            Validator::Custom(_) => "自定义验证",
        }
    }

    /// 验证字段值是否符合验证规则
    ///
    /// # 参数
    ///
    /// - `field_name`: 字段名称(用于错误消息)
    /// - `value`: 要验证的值
    ///
    /// # 返回值
    ///
    /// 如果验证通过返回 Ok(()),否则返回相应的错误
    ///
    /// # 示例
    ///
    /// ```rust
    /// use yang_base::table::Validator;
    /// use serde_json::json;
    ///
    /// let validator = Validator::MinLength(5);
    /// assert!(validator.validate("username", &json!("alice")).is_ok());
    /// assert!(validator.validate("username", &json!("bob")).is_err());
    /// ```
    pub fn validate(&self, field_name: &str, value: &serde_json::Value) -> Result<(), BaseError> {
        match self {
            // 最小长度验证
            Validator::MinLength(min_len) => {
                if let Some(s) = value.as_str() {
                    let len = s.chars().count();
                    if len < *min_len {
                        return Err(BaseError::ValidationFailed(
                            field_name.to_string(),
                            format!("字符串长度不能小于 {},当前长度: {}", min_len, len),
                        ));
                    }
                    Ok(())
                } else {
                    Err(BaseError::ValidationFailed(
                        field_name.to_string(),
                        "MinLength 验证器只能用于字符串类型".to_string(),
                    ))
                }
            }

            // 最大长度验证
            Validator::MaxLength(max_len) => {
                if let Some(s) = value.as_str() {
                    let len = s.chars().count();
                    if len > *max_len {
                        return Err(BaseError::ValidationFailed(
                            field_name.to_string(),
                            format!("字符串长度不能大于 {},当前长度: {}", max_len, len),
                        ));
                    }
                    Ok(())
                } else {
                    Err(BaseError::ValidationFailed(
                        field_name.to_string(),
                        "MaxLength 验证器只能用于字符串类型".to_string(),
                    ))
                }
            }

            // 最小值验证
            Validator::Min(min_val) => {
                let num = if let Some(n) = value.as_f64() {
                    n
                } else if let Some(n) = value.as_i64() {
                    n as f64
                } else if let Some(n) = value.as_u64() {
                    n as f64
                } else {
                    return Err(BaseError::ValidationFailed(
                        field_name.to_string(),
                        "Min 验证器只能用于数值类型".to_string(),
                    ));
                };

                if num < *min_val {
                    return Err(BaseError::ValidationFailed(
                        field_name.to_string(),
                        format!("数值不能小于 {},当前值: {}", min_val, num),
                    ));
                }
                Ok(())
            }

            // 最大值验证
            Validator::Max(max_val) => {
                let num = if let Some(n) = value.as_f64() {
                    n
                } else if let Some(n) = value.as_i64() {
                    n as f64
                } else if let Some(n) = value.as_u64() {
                    n as f64
                } else {
                    return Err(BaseError::ValidationFailed(
                        field_name.to_string(),
                        "Max 验证器只能用于数值类型".to_string(),
                    ));
                };

                if num > *max_val {
                    return Err(BaseError::ValidationFailed(
                        field_name.to_string(),
                        format!("数值不能大于 {},当前值: {}", max_val, num),
                    ));
                }
                Ok(())
            }

            // 邮箱格式验证
            Validator::Email => {
                if let Some(s) = value.as_str() {
                    if !s.contains('@') {
                        return Err(BaseError::ValidationFailed(
                            field_name.to_string(),
                            "邮箱格式无效,必须包含 @ 符号".to_string(),
                        ));
                    }
                    Ok(())
                } else {
                    Err(BaseError::ValidationFailed(
                        field_name.to_string(),
                        "Email 验证器只能用于字符串类型".to_string(),
                    ))
                }
            }

            // 手机号格式验证
            Validator::Phone => {
                if let Some(s) = value.as_str() {
                    // 检查是否只包含数字和连字符
                    if !s.chars().all(|c| c.is_ascii_digit() || c == '-') {
                        return Err(BaseError::ValidationFailed(
                            field_name.to_string(),
                            "手机号格式无效,只能包含数字和连字符".to_string(),
                        ));
                    }
                    Ok(())
                } else {
                    Err(BaseError::ValidationFailed(
                        field_name.to_string(),
                        "Phone 验证器只能用于字符串类型".to_string(),
                    ))
                }
            }

            // URL 格式验证
            Validator::Url => {
                if let Some(s) = value.as_str() {
                    if !s.starts_with("http://") && !s.starts_with("https://") {
                        return Err(BaseError::ValidationFailed(
                            field_name.to_string(),
                            "URL 格式无效,必须以 http:// 或 https:// 开头".to_string(),
                        ));
                    }
                    Ok(())
                } else {
                    Err(BaseError::ValidationFailed(
                        field_name.to_string(),
                        "Url 验证器只能用于字符串类型".to_string(),
                    ))
                }
            }

            // 正则表达式验证
            Validator::Regex(pattern) => {
                if let Some(s) = value.as_str() {
                    let re = Regex::new(pattern).map_err(|e| {
                        BaseError::ValidationFailed(
                            field_name.to_string(),
                            format!("正则表达式无效: {}", e),
                        )
                    })?;

                    if !re.is_match(s) {
                        return Err(BaseError::ValidationFailed(
                            field_name.to_string(),
                            format!("值不匹配正则表达式: {}", pattern),
                        ));
                    }
                    Ok(())
                } else {
                    Err(BaseError::ValidationFailed(
                        field_name.to_string(),
                        "Regex 验证器只能用于字符串类型".to_string(),
                    ))
                }
            }

            // 自定义验证函数
            Validator::Custom(func) => func(field_name, value),
        }
    }
}

// 实现 Debug trait(Custom 变体需要特殊处理)
impl std::fmt::Debug for Validator {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Validator::MinLength(len) => write!(f, "MinLength({})", len),
            Validator::MaxLength(len) => write!(f, "MaxLength({})", len),
            Validator::Min(val) => write!(f, "Min({})", val),
            Validator::Max(val) => write!(f, "Max({})", val),
            Validator::Email => write!(f, "Email"),
            Validator::Phone => write!(f, "Phone"),
            Validator::Url => write!(f, "Url"),
            Validator::Regex(pattern) => write!(f, "Regex(\"{}\")", pattern),
            Validator::Custom(_) => write!(f, "Custom(<function>)"),
        }
    }
}

// 为了支持序列化,我们需要一个辅助结构
// 注意:Custom 验证器无法序列化,会被跳过
#[derive(Debug, Serialize, Deserialize)]
#[serde(tag = "type", content = "value")]
enum ValidatorSerde {
    MinLength(usize),
    MaxLength(usize),
    Min(f64),
    Max(f64),
    Email,
    Phone,
    Url,
    Regex(String),
}

impl Serialize for Validator {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        let serde_variant = match self {
            Validator::MinLength(len) => ValidatorSerde::MinLength(*len),
            Validator::MaxLength(len) => ValidatorSerde::MaxLength(*len),
            Validator::Min(val) => ValidatorSerde::Min(*val),
            Validator::Max(val) => ValidatorSerde::Max(*val),
            Validator::Email => ValidatorSerde::Email,
            Validator::Phone => ValidatorSerde::Phone,
            Validator::Url => ValidatorSerde::Url,
            Validator::Regex(pattern) => ValidatorSerde::Regex(pattern.clone()),
            Validator::Custom(_) => {
                // Custom 验证器无法序列化,返回错误
                return Err(serde::ser::Error::custom("Custom 验证器无法序列化"));
            }
        };
        serde_variant.serialize(serializer)
    }
}

impl<'de> Deserialize<'de> for Validator {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: serde::Deserializer<'de>,
    {
        let serde_variant = ValidatorSerde::deserialize(deserializer)?;
        Ok(match serde_variant {
            ValidatorSerde::MinLength(len) => Validator::MinLength(len),
            ValidatorSerde::MaxLength(len) => Validator::MaxLength(len),
            ValidatorSerde::Min(val) => Validator::Min(val),
            ValidatorSerde::Max(val) => Validator::Max(val),
            ValidatorSerde::Email => Validator::Email,
            ValidatorSerde::Phone => Validator::Phone,
            ValidatorSerde::Url => Validator::Url,
            ValidatorSerde::Regex(pattern) => Validator::Regex(pattern),
        })
    }
}