有效载荷和 serde

结构级别的属性，如 rename_all，将传播到有效载荷。当存在修改字段名称的属性时，返回的错误中的任何字段名称都将表示为原始（即客户端有效载荷）。

validify 会以不同的方式处理几个特殊的 serde 属性；rename、with 和 deserialize_with。强烈建议将这些属性与任何其他 serde 属性分开注解，因为它们会根据有效载荷进行解析。

rename 属性被 validify 用于在验证过程中设置任何错误的字段名称。with 和 deserialize_with 将被转移到有效载荷字段，并创建一个特殊的反序列化函数，该函数将调用原始函数并将结果包裹在选项中。如果自定义反序列化器已经返回一个选项，则不会执行任何操作。

模式验证

可以使用以下方式执行模式级别的验证

use validify::{Validify, ValidationErrors, schema_validation, schema_err};
#[derive(validify::Validify)]
#[validate(validate_testor)]
struct Testor {
    a: String,
    b: usize,
}

#[schema_validation]
fn validate_testor(t: &Testor) -> Result<(), ValidationErrors> {
  if t.a.as_str() == "yolo" && t.b < 2 {
    schema_err!("Invalid Yolo", "Cannot yolo with b < 2");
  }
}

#[schema_validation] proc 宏将函数扩展为

fn validate_testor(t: &Testor) -> Result<(), ValidationErrors> {
    let mut errors = ValidationErrors::new();
    if t.a == "yolo" && t.b < 2 {
        errors.add(ValidationError::new_schema("Invalid Yolo").with_message("Cannot yolo with b < 2".to_string()));
    }
    if errors.is_empty() { Ok(()) } else { Err(errors) }
}

这使得模式验证更易于使用且简洁。像字段级别的验证一样，模式级别的验证在修改之后执行。

错误

主要的ValidationError是一个具有2个变体的枚举，分别是Field和Schema。Field错误，正如其名所示，在字段验证失败时创建，通常在未使用自定义处理器的情况下自动生成（自定义字段验证函数始终必须返回一个结果，其Err变体为ValidationError）。

如果您想与错误一起提供消息，可以直接在属性中指定（对代码也是如此），例如

#[validate(contains(value= "某种内容",消息= "不包含某种内容",代码= "MUST_CONTAIN"))]

请注意，以这种方式指定验证时，所有属性参数都必须指定为NameValue对。这意味着如果您写下

#[validate(contains("某种内容",消息= "Bla"))],

您将得到一个错误，因为解析器期望的是单个值或多个名称值对。

field_err!宏在自定义函数中创建字段错误时提供了一种简写方法。

位置

位置以类似于JSON指针的方式跟踪每个错误。当使用自定义验证时，返回的错误中指定的任何字段名称都将用于该字段的地址。请注意，处理散列map/set集合时，位置可能不可靠，因为这些集合的项目顺序没有保证。

错误位置显示将取决于原始客户端有效负载，即它们将以原始有效负载接收到的样子显示（例如，当使用serde的rename_all时）。任何被覆盖的字段名称将按原样显示。

模式

Schema错误通常由用户在模式验证中创建。schema_err!宏和#[schema_validation]提供了一种创建模式错误的便捷方式。所有错误都组合到一个ValidationErrors结构中，该结构包含所有验证错误的向量。

参数

当合理时，validify会自动将失败参数及其所针对的目标值附加到创建的错误中，以向客户端提供更多清晰度并节省一些手动工作。

始终附加的一个参数是actual字段，它代表在验证期间违反字段的目标属性的值。一些验证器将表示字段预期值的附加数据附加到错误中。

示例

Date[times]s

use chrono::{NaiveDate, NaiveDateTime};

#[derive(Debug, validify::Validate)]
struct DateTimeExamples {
    #[validate(time(op = before, target = "2500-04-20", format = "%Y-%m-%d", inclusive = true))]
    before: NaiveDate,
    #[validate(time(op = before, target = "2500-04-20T12:00:00.000", format = "%Y-%m-%-dT%H:%M:%S%.3f"))]
    before_dt: NaiveDateTime,
    #[validate(time(op = after, target = "2022-04-20", format = "%Y-%m-%d"))]
    after: NaiveDate,
    #[validate(time(op = after, target = "2022-04-20T12:00:00.000", format = "%Y-%m-%-dT%H:%M:%S%.3f"))]
    after_dt: NaiveDateTime,
    #[validate(time(op = in_period, target = "2022-04-20", format = "%Y-%m-%d", weeks = -2))]
    period: NaiveDate,
}

使用路由处理程序

    use validify::{Validify, Payload, ValidifyPayload};

    #[derive(Debug, Validify, Payload)]
    struct JsonTest {
        #[modify(lowercase)]
        a: String,
        #[modify(trim, uppercase)]
        #[validate(length(equal = 11))]
        b: String,
    }

    // This would normally come from a framework
    struct Json<T>(T);

    fn test() {
      let jt = JsonTest {
          a: "MODIFIED".to_string(),
          b: "    makemeshout    ".to_string(),
      };
      let json = Json(JsonTestPayload::from(jt));
      mock_handler(json)
    }

    fn mock_handler(data: Json<JsonTestPayload>) {
      let data = data.0;
      let data = JsonTest::validify_from(data.into()).unwrap();
      mock_service(data);
    }

    fn mock_service(data: JsonTest) {
      assert_eq!(data.a, "modified".to_string());
      assert_eq!(data.b, "MAKEMESHOUT".to_string())
    }

在测试目录中查看更多示例

贡献

如果您对如何改进Validify有任何想法，例如您发现有用的常用验证或更好的错误消息，请毫不犹豫地打开一个问题或PR。所有想法都欢迎！