验证错误层次结构设计

Question

在我们的系统中，我们有一个实体Product ，它可能具有各种自定义属性。 产品的属性集可能因产品而异，并存储在List<Property>类型的字段中。 属性具有不同的类型（字符串，整数，双精度型），并且可能具有一些特殊的特性，例如，它们可能是多值的，可能是s特定范围的值，给定列表中的值等。该属性的值始终包含在字符串字段Value 。

现在，我当前的问题是实现这些属性的验证，而我对于采用哪种方法来表示验证结果有些困惑。 我必须满足的要求：-验证结果将被其他应用程序层使用，因此生成的API应该清晰易用-每个错误都应具有不同的表示形式-API的用户应具有足够的信息来理解错误详细信息（例如，对于范围错误，应提供最小可能值，最大可能值和实际值）

到目前为止，我已经考虑了以下方法：

1. 类层次结构。 有一个基础抽象类ValidationError ，每个特定的错误将反映在继承的类中。 如果错误有任何具体说明，则相应的类将具有必要的字段来存储所有信息。 例：

    public abstract class ValidationError { // common fields and methods, if any } public class IncorrectFormatValidationError : ValidationError { // just empty class, nothing to add here } public class RangeValidationError : ValidationError { public object MinValue { get; set; } public object MaxValue { get; set; } } 

   由于各种各样的空类，这种方法对我来说似乎是多余的。 此外，使用此类API似乎不正确（ if (typeof(error) == typeof(RangeValidationError)) -废话！）。 但这是我想到的第一件事。

2. 错误枚举以及必要时的类层次结构。 所有错误都用枚举表示。 大多数情况下使用一个类ValidationError ，并且当特定错误需要其他信息时，将创建继承者，基本上与第一种方法相同。 例：

    public enum ValidationErrors { IncorrectFormat, ValueNotWithinRange, ... } public class ValidationError { public ValidationErrors ErrorType { get; set; } public ValidationError(ValidationErrors type) { this.ErrorType = type; ... } // common fields and methods, if any } public class RangeValidationError : ValidationError { public object MinValue { get; set; } public object MaxValue { get; set; } public RangeValidationError(object minValue, object maxValue) : base(ValidationErrors.ValueNotWithinRange) { ... } } 

   这种方法看起来好多了，但是也有缺点。 最大的一个问题是，作为API用户，我们不能保证当我们ValueNotWithinRange类型为ValueNotWithinRange的错误时，我们正在处理RangeValidationError类型的类，如果不是，我们将如何处理？ 通常，我想拥有一些设计级别的功能，即使在这种情况下，这种功能也可以防止，因为我不是开发API的人。 这种方法的另一个问题是，如果大多数错误最终都需要一些其他信息，那么我们最终将获得相同的方法编号1。

是否有人对这两种方法有共同的想法或建议更好的方法？ 如有任何回应，我将不胜感激。 提前致谢。

Answer 1

退后一步，重新考虑整个“代表验证错误的多个类”方法可能是一个好主意，因为几乎可以保证您已经具有验证器的层次结构。

给定以下条件，可以完美地指定任何验证错误：

1. 验证器未能接受属性值
2. 物业名称
3. 无法验证的值

验证程序实例上已经存在任何进一步的信息（例如，范围限制，不匹配的正则表达式），可以通过该信息进行访问。

那么，只有一个看起来像这样的验证错误类怎么办：

public sealed class ValidationError
{
    public Validator Validator { get; set; }
    public string PropertyName { get; set; }
    public object AttemptedValue { get; set; }
}

Answer 2

您可能想看看FluentValidation之类的东西 。 它轻巧，直观，涵盖了许多验证方案。

如果您对FluentValidation使用的验证结果不满意，则可以始终将它们包装在您自己的自定义验证错误类中。 至少您将免费获得许多基本功能。