如何返回验证结果？

Question

我有一个使用 CommandService 的 ASP.NET MVC 站点。该命令服务负责执行命令，但在执行命令之前，需要对每个命令进行验证，因此有一个返回 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（字符串）。我假设您需要将此错误转换为对用户更具可读性的内容？

您应该查看其中一个 cmets 中提到的内置验证。验证来自 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

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