如何返回验证结果？

Question

我有一个 ASP.NET MVC 站点，它使用 CommandService。该命令服务负责执行命令，但在执行每个命令之前需要验证每个命令，因此有一个返回 ValidationResult 的 Validate 操作，看起来像（简化的）：

public class ValidationResult
{
  public List<string> ErrorCodes { get; set; }
}

我想改进这一点，因为当前有一个列表返回字符串，例如“UserDoesNotExist”或“TitleIsMandatory”，当然这不是最好的方法。

最好返回强类型的东西。但我怎样才能做到这一点呢？

选项 1：使用一个大枚举，例如：

public enum ErrorCode { UserDoesNotExist, TitleIsMandatory}

public class ValidationResult
{
  public List<ErrorCode> ErrorCodes { get; set; }
}

我不知道创建这么大的枚举并将所有域错误代码放入其中是否是一个好主意？

选项 2：使用类

public class ErrorCode {}
public class UserDoesNotExist : ErrorCode {}
public class TitleIsMandatory : ErrorCode {}

public class ValidationResult
{
  public List<ErrorCode> ErrorCodes { get; set; }
}

更干净，但更难使用？

你会怎么做，或者我错过了其他选择？

Answer 1

所以这就是我解决它的方法。首先，主 ValidationResult 类如下所示：

 public class ValidationResult
{        
    public List<ValidationResultItem> ValidationResultItems { get; set; }

    public bool IsAcceptable
    {
        get { return (ValidationResultItems == null || !ValidationResultItems.Any(vri => !vri.IsAcceptable)); }
    }       

    public void Add(ValidationResultItem propertyValidationResultItem)
    {
        ValidationResultItems.Add(propertyValidationResultItem);
    }

    public void Add(IEnumerable<ValidationResultItem> validationResultItems)
    {
        ValidationResultItems.AddRange(validationResultItems);
    }       
}

ValidationResultItem 是一个抽象类：

public abstract class ValidationResultItem
{
    private ResultType _resultType;

    protected ValidationResultItem(ResultType resultType, string message)
    {
        ResultType = resultType;
        Message = message;
    }

    public bool IsAcceptable { get; private set; }
    public string Message { get; private set; }
    public ResultType ResultType
    {
        get { return _resultType; }
        set { _resultType = value; IsAcceptable = (_resultType != ResultType.Error); }
    } 
}

它有两种实现：

public class PropertyValidationResultItem : ValidationResultItem
{        
    public PropertyValidationResultItem(ResultType resultType, string message, string propertyName, object attemptedValue) : base(resultType, message)
    {            
        PropertyName = propertyName;           
        AttemptedValue = attemptedValue;
    }

    public string PropertyName { get; private set; }        
    public object AttemptedValue { get; private set; }             
}

每个

public abstract class BusinessValidationResultItem : ValidationResultItem
{
    protected BusinessValidationResultItem(ResultType resultType, string message) : base(resultType, message)
    {
    }
}

命令处理程序都有自己的 BusinessValidationResultItem 实现，例如：

public class AddArticleBusinessValidationResultItem : BusinessValidationResultItem
{
    public enum AddArticleValidationResultCode { UserDoesNotExist, UrlTitleAlreadyExists, LanguageDoesNotExist }

    public AddArticleBusinessValidationResultItem(ResultType resultType, string message, AddArticleValidationResultCode code)
        : base(resultType, message)
    {
        Code = code;
    }

    public AddArticleValidationResultCode Code { get; set; }
}

这意味着如果客户端获取 ValidationResult，他可以强制转换BusinessValidationResultItem 到具体的 AddArticleBusinessValidationResultItem ，因此在 switch 语句中使用特定枚举 - 避免魔术字符串。

Answer 2

我的 REST api 非常相似，如果存在验证错误，则会将字符串消息与对象一起返回给用户。

例如：

[DataContract]
public class ApiErrorResult : ApiResult<IList<ErrorCodes>>
{
    public ApiErrorResult(String message)
    {
        Code = ApiCode.ValidationError;
        Error = message;
    }
}

那么 ApiResult 是：

public class ApiResult<T>
{

    [DataMember]
    public ApiCode Code
    {
        get;
        set;
    }

    [DataMember]
    public String Error
    {
        get;
        set;
    }

    [DataMember]
    public T Context
    {
        get;
        set;
    }
}

因此，如果它是验证错误，则上下文将包含等效的验证错误代码。如果不是，我将实际结果存储在上下文中并返回 ApiResult 而不是 ApiErrorResult

希望这会有所帮助。

Answer 3

当然这不是最好的方法。

为什么不呢？字符串有什么问题吗？如果您担心一致性，可以使用资源文件或常量。字符串在层之间会更便携，但这取决于您的设计。无论如何，您可能需要一个 ErrorCode（字符串或枚举）和一个 ErrorMessage（字符串）。我假设您需要将此错误转换为用户更可读的内容？

您应该研究评论之一中提到的内置验证。验证来自System.ComponentModel.DataAnnotations，与MVC无关。您可以在 MVC 范围之外进行验证，这是一个示例：

var validationContext = new ValidationContext(yourObject, null, null);
var validationResults = new List<ValidationResult>();

Validator.TryValidateObject(yourObject, validationContext, validationResults);

HTH...

Answer 4

也许是一个愚蠢的观察，但为什么不在客户端进行验证呢？行为良好的客户端应该在提交命令之前验证命令。行为不当的客户端不会验证和提交，但也不会找回失败的原因（这有什么意义 - 即使从安全角度来看也是不可取的）。当然，在服务器端，您应该重新验证并以某种方式记录无效命令，以便运维人员知道他们需要解决/调查某些故障。如果您的客户采用不同的技术，那么在语言中立的 DSL 中定义验证并从该 DSL 中以您喜欢的任何技术/语言生成代码可能会很有用（不过这里还有其他选项）。